Skip to content

Commit 618cb7a

Browse files
committed
Doc updates
1 parent 8631141 commit 618cb7a

File tree

5 files changed

+58
-45
lines changed

5 files changed

+58
-45
lines changed

docs/moonbase/module/drivers.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,9 @@ The Drivers module defines layers and drivers.
1919
* Reorder: Nodes can be reordered, defining the order of executions (layouts, which layout is first in the chain of lights. Drivers and utilities: no difference)
2020
* Controls. A node can be switched on and off and has custom controls, which defines the parameters of the node
2121

22-
## Emoji coding:
23-
24-
* ☸️ Driver
25-
* ♫ Audio reactive FFT based
26-
* ♪ Audio reactive volume based
27-
2822
## Driver ☸️ nodes
2923

30-
| Name | Controls | Preview | Remarks
24+
| Name | Preview | Controls | Remarks
3125
| ---- | ----- | ---- | ---- |
3226
| ArtNet | | | |
3327
| FastLED Driver | | | Sends LED output to ESP32 gpio pins |

docs/moonbase/module/effects.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,57 +30,58 @@ The Effects module defines effects and modifiers. They run in a 'layer'.
3030
* Reorder: Nodes can be reordered, defining the order of executions (effects: which effect on top of the other effect. Modifiers: which modifier is done first, e.g. circle then multiply will yield to a different result than multiply then circle)
3131
* Controls. A node can be switched on and off and has custom controls, which defines the parameters of the node (e.g. effect speed).
3232

33-
## Emoji coding:
34-
35-
* 🔥 Effect
36-
* 🚨 Moving head color effect
37-
* 🗼 Moving head move effect
38-
* 💎 Modifier
39-
* 🎨 Using palette
40-
* 💡 WLED origin
41-
* 💫 MoonLight origin
42-
* ♫ Audio reactive FFT based
43-
* ♪ Audio reactive volume based
44-
* 🧊 also works on 3D
45-
4633
## Effect 🔥 Nodes
4734
🚧
4835
Precompiled effects can be found in [effects](https://github.com/MoonModules/MoonLight/blob/main/src/MoonLight/Nodes/Effects/Effects.h)
4936

50-
| Name | Controls | Preview | Remarks
37+
### MoonLight effects
38+
39+
| Name | Preview | Controls | Remarks
5140
| ---- | ----- | ---- | ---- |
52-
| Solid | <img width="320" src="https://github.com/user-attachments/assets/844bdbf1-b42b-4b5c-94f9-d1334bce2b10" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_000.gif) | Sends a solid RGB to all lights. Can be used as background to other effects, order it before other effects |
53-
| BouncingBalls | <img width="320" src="https://github.com/user-attachments/assets/30aa2614-d891-4d39-a789-72026f7ab036" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_091.gif) | |
54-
| Blurz | <img width="320" src="https://github.com/user-attachments/assets/b8f4111d-1f78-4ac0-a0f9-17909ad78599" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM163.gif) | |
55-
| DistortionWaves | <img width="320" src="" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_124.gif) | |
56-
| FreqMatrix | <img width="320" src="" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_138.gif) | |
57-
| GameOfLife | <img width="320" src="https://github.com/user-attachments/assets/18498c30-b249-4390-bfdf-084deedbfc49" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_172.gif) | |
58-
| GEQ | <img width="320" src="https://github.com/user-attachments/assets/ca485d1e-e6e4-4b4a-910f-eed7fde7a21f" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM139.gif) | |
59-
| GEQ3D | | | |
60-
| FreqSaws | <img width="320" src="https://github.com/user-attachments/assets/78828181-c1b3-4d0f-85dc-356ced10fcd9"/> | | |
6141
| Lines | | | |
62-
| Lissajous | <img width="320" src="https://github.com/user-attachments/assets/a28c19a7-012a-49bf-aff1-6b414c9d08dd" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM176.gif) | |
6342
| MoonMan | | | if USE_M5UNIFIED |
64-
| Noise2D | | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_146.gif) | |
65-
| NoiseMeter | | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_136.gif) | |
66-
| PaintBrush | | | |
6743
| Particles | | | |
68-
| PopCorn | | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_095.gif) | |
6944
| Rainbow | | | |
7045
| Random | | | |
7146
| Ripples | | | |
7247
| RubiksCube | | | |
73-
| ScrollingText | Speed: scrolling speed if the text is wider then the display width, Font: Different font sizes, Preset: one of the following: Auto, IP (.ddd), FPS (ddds), Time (HHMM), Uptime (s/m/h), Status 🛜 (AP/STA), Clients 🛜 (dC), Connected 🛜 (dCC) | | Shows system info on leds. You need at least 16*6 pixels for that (Panel 16x16 recommended) |
48+
| ScrollingText | | Speed: scrolling speed if the text is wider then the display width, Font: Different font sizes, Preset: one of the following: Auto, IP (.ddd), FPS (ddds), Time (HHMM), Uptime (s/m/h), Status 🛜 (AP/STA), Clients 🛜 (dC), Connected 🛜 (dCC) | Shows system info on leds. You need at least 16*6 pixels for that (Panel 16x16 recommended) |
7449
| Sinus | | | |
7550
| SphereMove | | | |
7651
| StarField | | | |
7752
| Praxis | | | |
78-
| Waverly | | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM165.gif) | |
7953
| Wave | | | |
8054
| FixedRectangle | | | |
8155

56+
### MoonModules effects
57+
58+
| Name | Preview | Controls | Remarks
59+
| ---- | ----- | ---- | ---- |
60+
| GEQ3D | | | |
61+
| PaintBrush | | | |
62+
| GameOfLife | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_172.gif) | <img width="320" src="https://github.com/user-attachments/assets/18498c30-b249-4390-bfdf-084deedbfc49" /> | |
63+
64+
65+
### WLED effects
66+
67+
| Name | Preview | Controls | Remarks
68+
| ---- | ----- | ---- | ---- |
69+
| Solid | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_000.gif) | <img width="320" src="https://github.com/user-attachments/assets/844bdbf1-b42b-4b5c-94f9-d1334bce2b10" /> | Sends a solid RGB to all lights. Can be used as background to other effects, order it before other effects |
70+
| BouncingBalls | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_091.gif) | <img width="320" src="https://github.com/user-attachments/assets/30aa2614-d891-4d39-a789-72026f7ab036" /> | |
71+
| Blurz | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM163.gif) | <img width="320" src="https://github.com/user-attachments/assets/b8f4111d-1f78-4ac0-a0f9-17909ad78599" /> | |
72+
| DistortionWaves | | <img width="320" src="" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_124.gif) |
73+
| FreqMatrix | | <img width="320" src="" /> | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_138.gif) |
74+
| GEQ | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM139.gif) | <img width="320" src="https://github.com/user-attachments/assets/ca485d1e-e6e4-4b4a-910f-eed7fde7a21f" /> | |
75+
| FreqSaws | | <img width="320" src="https://github.com/user-attachments/assets/78828181-c1b3-4d0f-85dc-356ced10fcd9"/> | |
76+
| Lissajous | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM176.gif) | <img width="320" src="https://github.com/user-attachments/assets/a28c19a7-012a-49bf-aff1-6b414c9d08dd" /> | |
77+
| Noise2D | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_146.gif) | | |
78+
| NoiseMeter | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_136.gif) | | |
79+
| PopCorn | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_095.gif) | | |
80+
| Waverly | ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/FX_MM165.gif) | | |
81+
8282
### Moving head effects
83-
| Name | Controls | Preview | Remarks
83+
84+
| Name | Preview | Controls | Remarks
8485
| ---- | ----- | ---- | ---- |
8586
| Troy1Color | | | |
8687
| Troy1Move | | | |

docs/moonlight/layouts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ A layout (🚥) defines what lights are connected to MoonLight. It defines the c
1616

1717
Set pins carefully. There is a check if a specific pin can be used for output / driving LEDs. See also the IO module. But not 100% garanteed. E.g pin 16 on esp32-d0-wrover crashes...
1818

19-
| Name | Controls | Preview | Remarks
19+
| Name | Preview | Controls | Remarks
2020
| ---- | ----- | ---- | ---- |
21-
| Panel | pin: to do add more pins | | Defines a 2D panel with width and height |
21+
| Panel | | pin: to do add more pins | Defines a 2D panel with width and height |
2222
| Panels | | | |
23-
| Cube | pin: to do add more pins | | Panel layout + depth |
23+
| Cube | | pin: to do add more pins | Panel layout + depth |
2424
| Rings | | | |
2525
| Wheel | | | |
2626
| HumanSizedCube | | | |

docs/moonlight/modifiers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ A modifier (💎) is an effect on an effect. It can change the size of the virtu
1111

1212
Modifier
1313

14-
| Name | Controls | Preview | Remarks
14+
| Name | Preview | Controls | Remarks
1515
| ---- | ----- | ---- | ---- |
1616
| Checkerboard | | | |
1717
| Circle | | | |
1818
| Mirror | | | |
1919
| Multiply | | | |
20-
| RippleYZ | shrink: shrinks the original size to towardsY and Z, towardsY: copies X into Y, towardsZ: copies XY into Z | | Takes lights of an effect and copies them to other lights. E.g. 1D effect will be rippled to 2D, 2D effect will be rippled to 3D |
21-
| Pinwheel | **Swirl**: option to bend the pinwheel., **Reverse** option., **Rotation Symmetry**: Controls the rotational symmetry of the pattern., **Petals** option to adjust the number of petals., **Ztwist** option for 3D fixtures to twist the pattern along the z-axis. | | Projects 1D/2D effects onto 2D/3D fixtures in a pinwheel pattern. The virtual layer width is the number of petals. The height is the distance from center to corner |
20+
| RippleYZ | | shrink: shrinks the original size to towardsY and Z, towardsY: copies X into Y, towardsZ: copies XY into Z | Takes lights of an effect and copies them to other lights. E.g. 1D effect will be rippled to 2D, 2D effect will be rippled to 3D |
21+
| Pinwheel | | **Swirl**: option to bend the pinwheel., **Reverse** option., **Rotation Symmetry**: Controls the rotational symmetry of the pattern., **Petals** option to adjust the number of petals., **Ztwist** option for 3D fixtures to twist the pattern along the z-axis. | Projects 1D/2D effects onto 2D/3D fixtures in a pinwheel pattern. The virtual layer width is the number of petals. The height is the distance from center to corner |
2222
| Rotate | | | |
2323
| Transpose | | | |

docs/moonlight/overview.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,22 @@ MoonLight
9999
* Physics
100100
* Live Scripts
101101

102-
🥜: MoonBase functionality which is specific for MoonLight but will be refactored to generic MoonLight functionality
102+
🥜: MoonBase functionality which is specific for MoonLight but will be refactored to generic MoonLight functionality
103+
104+
## Emoji coding
105+
106+
Effects, Modifiers, Layouts and drivers use emoji's to visualize their usage. See below for an overview:
107+
108+
* 🔥 Effect
109+
* 🎨 Using palette
110+
* 💡 WLED origin
111+
* 💫 MoonLight origin
112+
* 🚨 Moving head color effect
113+
* 🗼 Moving head move effect
114+
* 💎 Modifier
115+
* 🚥 Layout
116+
* ☸️ Driver
117+
118+
* ♫ Audio reactive FFT based
119+
* ♪ Audio reactive volume based
120+
* 🧊 3D supported (goals is that everything is 3D supported but it is 🚧)

0 commit comments

Comments
 (0)