Skip to content

Commit 74b4064

Browse files
committed
Docs nodes
1 parent 53042ca commit 74b4064

File tree

3 files changed

+9
-15
lines changed

3 files changed

+9
-15
lines changed

docs/moonbase/module/drivers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ The Drivers module defines layers and drivers.
1414
* Nodes: a list of Layouts and Drivers
1515
* Nodes can be added (+), deleted (🗑️) or edited (✎) or reordered (drag and drop). The node to edit will be shown below the list, press save (💾) if you want to preserve the change when the device is restarted
1616
* Reorder: Nodes can be reordered, defining the order of execution
17-
* Layouts:
18-
* Drivers:
17+
* Layouts: Need to be before drivers, multiple layouts can be added
18+
* Drivers: After Layouts, choose one LEDs driver and optionally add Art-Net and Audio Sync, reordering might need a restart.
1919
* Controls. A node can be switched on and off and has custom controls, which defines the behaviour of the node
2020
* See below for a list of existing Layouts and Drivers
2121

docs/moonlight/layouts.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,33 +16,27 @@ Want to add a a Layout to MoonLight, see [develop](https://moonmodules.org/MoonL
1616

1717
| Name | Preview | Controls | Remarks
1818
| ---- | ----- | ---- | ---- |
19-
| Panel | ![Panel](https://github.com/user-attachments/assets/1a69758a-81e3-4f1f-a47e-a242de105c93)| <img width="320" alt="Panel" src="https://github.com/user-attachments/assets/60e6ba73-8956-45bc-9706-581faa17ba16" /> | Defines a 2D panel with width and height |
20-
| Panels | ![Panels](https://github.com/user-attachments/assets/422b5842-773b-4173-99c5-7b25cd39b176) | <img width="320" alt="Panels" src="https://github.com/user-attachments/assets/ad5a15ea-f3f9-42b9-b8cf-196e7db92249" /> | |
21-
| Cube | ![Cube](https://github.com/user-attachments/assets/3ece6f28-519e-4ebf-b174-ea75c30e9fbe) | <img width="320" alt="Cube" src="https://github.com/user-attachments/assets/56393baa-3cc3-4c15-b0b2-dc72f25d36d1" /> | Panel layout + depth |
19+
| Panel | ![Panel](https://github.com/user-attachments/assets/1a69758a-81e3-4f1f-a47e-a242de105c93)| <img width="320" alt="Panel" src="https://github.com/user-attachments/assets/60e6ba73-8956-45bc-9706-581faa17ba16" /> | Defines a 2D panel with width and height<br>Wiring Order (orientation): horizontal (x), vertical (y), depth (z)<br>X++: starts at Top or bottom, Y++: starts left or right<br>snake aka serpentine layout|
20+
| Panels | ![Panels](https://github.com/user-attachments/assets/422b5842-773b-4173-99c5-7b25cd39b176) | <img width="320" alt="Panels" src="https://github.com/user-attachments/assets/ad5a15ea-f3f9-42b9-b8cf-196e7db92249" /> | Panel layout + Wiring order, directions and snake also for each panel |
21+
| Cube | ![Cube](https://github.com/user-attachments/assets/3ece6f28-519e-4ebf-b174-ea75c30e9fbe) | <img width="320" alt="Cube" src="https://github.com/user-attachments/assets/56393baa-3cc3-4c15-b0b2-dc72f25d36d1" /> | Panel layout + depth<br> Z++ starts front or back<br>multidimensional snaking, good luck 😜 |
2222
| Rings | ![Ring](https://github.com/user-attachments/assets/7f60871d-30aa-4ad4-8966-cdc9c035c034) | <img width="320" alt="Rings" src="https://github.com/user-attachments/assets/ee2165aa-cf01-48cd-9310-9cfde871ac33" /> | 241 LEDs in 9 rings |
2323
| Wheel | ![Wheel](https://github.com/user-attachments/assets/52a63203-f955-4345-a97b-edb0b8691fe1) | <img width="320" alt="Wheel" src="https://github.com/user-attachments/assets/7b83e30b-e2e1-49e6-ad80-5b6925b23018" /> | |
2424
| Human Sized Cube | ![HCS](https://github.com/user-attachments/assets/8e475f9d-ab7a-4b5c-835a-e0b4ddc28f0f) | <img width="320" alt="HCS" src="https://github.com/user-attachments/assets/de1eb424-6838-4af4-8652-89a54929bb03" /> | |
2525
| Single Line | ![Single line](https://github.com/user-attachments/assets/4ba5a3ac-9312-4bac-876d-cfa3dce41215) | <img width="320" alt="Single line" src="https://github.com/user-attachments/assets/70455279-646c-467d-b8e5-492b1aeae0fa" /> | |
2626
| Single Row | ![Single row](https://github.com/user-attachments/assets/a88cea0f-9227-4da4-9a43-b944fd8bef97) | <img width="320" alt="Single row" src="https://github.com/user-attachments/assets/9f9918b9-e1ee-43a8-a02d-7f1ee182888b" /> | |
27-
| SE16 | ![SE16](https://github.com/user-attachments/assets/45c7bec7-2386-4c42-8f24-5a57b87f0df9) | <img width="320" alt="SE16" src="https://github.com/user-attachments/assets/0efe941a-acf5-4a2c-a7d6-bdfa91574d1a" /> | Layout(s) for Stephan Electronics 16-Pin ESP32-S3 board, using the pins used on the board |
27+
| SE16 | ![SE16](https://github.com/user-attachments/assets/45c7bec7-2386-4c42-8f24-5a57b87f0df9) | <img width="320" alt="SE16" src="https://github.com/user-attachments/assets/0efe941a-acf5-4a2c-a7d6-bdfa91574d1a" /> | Layout(s) including pins for Stephan Electronics 16-Pin ESP32-S3 board<br>see below |
2828

2929
!!! warning "Chosing pins"
3030

3131
Choose the right pins with care. See also the IO module to see which pins can in general be used for LEDs (💡). But depending on a specific boards some pins might also be in use already.
3232

33-
### Panels and cubes
34-
35-
* orientation XYZ or YXZ, XZY or YZX, ZXY or ZYX: Vertical or horizontal or depth
36-
* X++ and Y++ (and Z++): X++: starts at Top or bottom, Y++: starts left or right (Z++ starts front or back)
37-
* snake X, Y (Z): is the first axis in snake / serpentine layout?, (multidimensional snaking, good luck 😜)
38-
3933
### SE16
4034

4135
16 channel LED strip driver by Stephane Electronics
4236

4337
<img width="320" alt="SE16" src="https://raw.githack.com/MoonModules/MoonLight/refs/heads/main/firmware/installer/images/esp32-s3-stephanelec-16p.jpg"/>
4438

45-
* Leds Per Pin: the number of LEDs connected to one pin
39+
* Leds Per Pin: the number of LEDs connected to each pin
4640
* Pins Are Columns: are the LEDs on a pin a row of the effect (width is 1 (or 2) x ledsPerPin). If not set the LEDs are a column (height is 1 (or 2) x ledsPerPin)
4741
* Mirrored Pins: If set it is assumed that LEDs are connected with increasing positions on 8 pins on one side of the board and decreasing positions on the 8 pins of the other side of the board. The resulting size will have a width of 8 and the height (or width) will be 2 * ledsPerPin. If not set, the width will be 16 and the height (or width) = ledsPerPin
4842
* Pins: 47,48,21,38,14,39,13,40,12,41,11,42,10,2,3,1

docs/moonlight/modifiers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The following Modifiers are defined in MoonLight. Some found there origin in WLE
2121
| Circle | ![Circle](https://github.com/user-attachments/assets/c5308217-0bd4-49ad-adf8-f17b7062671f) | | |
2222
| Rotate | ![Rotate](https://github.com/user-attachments/assets/c622a9df-318a-4f83-81c0-f5a5c7bafb7b) | <img width="320" alt="Rotate" src="https://github.com/user-attachments/assets/7273a625-5e14-4814-92e8-8f7f65cfc02e" /> | |
2323
| Checkerboard | ![Checkerboard](https://github.com/user-attachments/assets/54970267-35af-406c-9558-c1f4219a71c0) | <img width="320" alt="Checkerboard" src="https://github.com/user-attachments/assets/66d51dc7-b816-4ca7-b1e3-57b067566516" /> | |
24-
| Pinwheel 🧊 | ![PinWheel](https://github.com/user-attachments/assets/e5dbadbe-eeb1-41e5-b197-ec4bd5366aea) | <img width="320" alt="PinWheel" src="https://github.com/user-attachments/assets/46585cea-d301-4221-9af2-65f8054543da" /> | Projects 1D/2D effects onto 2D/3D layouts in a pinwheel pattern. **Swirl**: bend the pinwheel, **Rotation Symmetry**: rotational symmetry of the pattern, **Petals** Virtual width, **Ztwist** twist the pattern along the z-axis. Height: distance from center to corner |
25-
| RippleYZ 🧊 | ![RippleYZ](https://github.com/user-attachments/assets/0918efac-6367-420f-b0e3-d796d9551953) | <img width="320" alt="RippleYZ" src="https://github.com/user-attachments/assets/90ecf22c-c4c1-4ee9-8096-fd5613fbb1a7" /> | 1D/2D effect will be rippled to 2D/3D (🚨). Shrink: shrinks the original size towards Y and Z, towardsY: copies X into Y, towardsZ: copies XY into Z |
24+
| Pinwheel 🧊 | ![PinWheel](https://github.com/user-attachments/assets/e5dbadbe-eeb1-41e5-b197-ec4bd5366aea) | <img width="320" alt="PinWheel" src="https://github.com/user-attachments/assets/46585cea-d301-4221-9af2-65f8054543da" /> | Projects 1D/2D effects onto 2D/3D layouts in a pinwheel pattern.<br>**Swirl**: bend the pinwheel<br>**Rotation Symmetry**: rotational symmetry of the pattern<br>**Petals** Virtual width<br>**Ztwist** twist the pattern along the z-axis<br>Height: distance from center to corner |
25+
| RippleYZ 🧊 | ![RippleYZ](https://github.com/user-attachments/assets/0918efac-6367-420f-b0e3-d796d9551953) | <img width="320" alt="RippleYZ" src="https://github.com/user-attachments/assets/90ecf22c-c4c1-4ee9-8096-fd5613fbb1a7" /> | 1D/2D effect will be rippled to 2D/3D (🚨)<br>Shrink: shrinks the original size towards Y and Z, towardsY: copies X into Y, towardsZ: copies XY into Z |
2626

2727
🚨: some effects already do this theirselves e.g. FreqMatrix runs on 1D but copies to 2D and 3D if size allows.

0 commit comments

Comments
 (0)