Skip to content

Commit f9ce2ae

Browse files
committed
Doc changes
1 parent 5e6514e commit f9ce2ae

File tree

5 files changed

+14
-9
lines changed

5 files changed

+14
-9
lines changed

docs/gettingstarted/hardware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Hardware
22

3-
To get started the minimal you need is an esp32-device connected via USB to your computer and a LED-strip or panel connected via 3 wires to the vcc, ground and a supported gpio pin of the esp32 (e.g. Pin 2). An ESP32-S3 is preferred as it has more memory to support large setups and Live Scripts.
3+
To get started the minimal you need is an esp32-device connected via USB to your computer and a LED-strip or panel connected via 3 wires to the vcc, ground and a supported GPIO pin of the esp32 (e.g. Pin 2). An ESP32-S3 is preferred as it has more memory to support large setups and Live Scripts.
44

55
!!! info "ESP32-D0"
66

docs/moonbase/module/drivers.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@
66

77
The Drivers module defines layers and drivers.
88

9-
* Layout 🚥: define a **layout** (e.g. a panel 16x16), of your LEDs or lights. See [Layouts](https://moonmodules.org/MoonLight/layouts/)
10-
* Driver ☸️: A driver sends light data to output, e.g. gpio pins (e.g. FastLED, Virtual and Physical driver) or over the network (e.g. Art-Net) or receives (light) data (e.g. audiosync to run audio reactive effects).
9+
* Layout 🚥: A layout (🚥) defines the positions of the lights to control. See [Layouts](https://moonmodules.org/MoonLight/moonlight/layouts/)
10+
* Driver ☸️: A driver is a link between MoonLight to hardware or the network. Drivers can both input data or output data. Examples:
11+
* LED drivers (FastLED, Physical and Virtual drivers, hub75 panels)
12+
* Light driver (Art-Net / DMX)
13+
* Audio driver
14+
* Sensor drivers (microphone, gyro, MIDI controller)
1115

1216
## Controls
1317

@@ -27,10 +31,10 @@ Want to add a Driver to MoonLight, see [develop](https://moonmodules.org/MoonLig
2731
| Name | Preview | Controls | Remarks
2832
| ---- | ----- | ---- | ---- |
2933
| Physical LED Driver | <img width="100" src="https://github.com/user-attachments/assets/9cbe487e-f330-40a5-8b40-6663c83e5d90"/> | <img width="320" alt="Physical" src="https://github.com/user-attachments/assets/0c6f1543-623a-45bf-98d7-f5ddd072a1c6" /> | Drive multiple LED types, all devices including ESP32-P4(-nano) supported<br>Max Power and Light preset: See below<br>DMA buffer: set higher when LEDs flicker |
30-
| FastLED Driver | <img width="100" src="https://avatars.githubusercontent.com/u/5899270?s=48&v=4"/> | <img width="320" alt="FastLed" src="https://github.com/user-attachments/assets/d5ea1510-9766-4687-895a-b68c82575b8f" /> | Drive WS2812 lights.<br>Max Power: See below |
31-
| ArtNet | <img width="100" src="https://github.com/user-attachments/assets/9c65921c-64e9-4558-b6ef-aed2a163fd88"> | <img width="320" alt="Art-Net" src="https://github.com/user-attachments/assets/1428e990-daf7-43ba-9e50-667d51b456eb" /> | Drive lights over the network. See below |
34+
| FastLED Driver | <img width="100" src="https://avatars.githubusercontent.com/u/5899270?s=48&v=4"/> | <img width="320" alt="FastLed" src="https://github.com/user-attachments/assets/d5ea1510-9766-4687-895a-b68c82575b8f" /> | Most used LED driver. Drive WS2812 lights.<br>Max Power: See below |
35+
| Art-Net | <img width="100" src="https://github.com/user-attachments/assets/9c65921c-64e9-4558-b6ef-aed2a163fd88"> | <img width="320" alt="Art-Net" src="https://github.com/user-attachments/assets/1428e990-daf7-43ba-9e50-667d51b456eb" /> | Drive lights over the network. See below |
3236
| AudioSync | <img width="100" src="https://github.com/user-attachments/assets/bfedf80b-6596-41e7-a563-ba7dd58cc476"/> | No controls | Listens to audio sent over the local network by WLED-AC or WLED-MM and allows audio reactive effects (♪ & ♫) to use audio data (volume and bands (FFT)) |
33-
| Virtual LED Driver | <img width="100" src="https://github.com/user-attachments/assets/98fb5010-7192-44db-a5c9-09602681ee15"/> | <img width="100" src="https://github.com/user-attachments/assets/c81d2f56-00d1-4424-a716-8e3c30e76636"/> | Driving max 120! panels of 256 LEDs each at 100 FPS using shift registers<br>Not implemented yet |
37+
| Virtual LED Driver | <img width="100" src="https://github.com/user-attachments/assets/98fb5010-7192-44db-a5c9-09602681ee15"/> | <img width="100" src="https://github.com/user-attachments/assets/c81d2f56-00d1-4424-a716-8e3c30e76636"/> | Driving max 120! outputs. E.g. 48 panels of 256 LEDs each run at 50-100 FPS using shift registers<br>Not implemented yet |
3438
| HUB75 Driver | <img width="100" src="https://github.com/user-attachments/assets/620f7c41-8078-4024-b2a0-39a7424f9678"/> | <img width="100" src="https://github.com/user-attachments/assets/4d386045-9526-4a5a-aa31-638058b31f32"/> | Drive HUB75 panels<br>Not implemented yet |
3539

3640
### Max Power and Light Preset

docs/moonbase/module/effects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
The Effects module defines Effects and Modifiers. They run in a 'layer'.
88

99
* Effect 🔥: An animation running in a layer, see below for am overview of effects. Effects can run in 1D, 2D or 3D coordinate spaces.
10-
* Modifier 💎: An effect on an effect e.g. mirror, multiply or rotate. See [Modifiers](https://moonmodules.org/MoonLight/modifiers/)
10+
* Modifier 💎: An effect on an effect e.g. mirror, multiply or rotate. See [Modifiers](https://moonmodules.org/MoonLight/moonlight/modifiers/)
1111
* Layer: An area on a (LED) display. Effects and modifier run in this area. Each layer maps a coordinate space to the display
1212

1313
!!! info "One layer"

docs/moonbase/module/inputoutput.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<img width="320" height="441" alt="io11" src="https://github.com/user-attachments/assets/b5452d8e-400c-4a72-a195-d5b7a7764407" />
44
<img width="320" height="77" alt="io22" src="https://github.com/user-attachments/assets/99fd135c-8d36-463b-ae3a-f06119cb8ccb" />
55

6-
Shows info about input / output devices, e.g. gpio pins.
6+
Shows info about input / output devices, e.g. GPIO pins.
77

88
* Per pin:
99
* GPIO = gpio_num;

docs/moonlight/layouts.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Layouts
22

3-
A layout (🚥) defines the coordinates of all lights connected to a MoonLight device and also assign groups of LEDs to esp32 gpio pins.
3+
A layout (🚥) defines the positions of lights connected to a MoonLight device.
44

55
* The **coordinates** of each light are defined in a 3D coordinate space
66
* Coordinates needs to be specified in the order the lights are wired so MoonLight knows which light is first, which is second etc.
77
* For lights in a straight line (1D, e.g. LED strips or a LED bar), specify coordinates as [x,0,0]
88
* For lights in a flat area (2D, e.g. LED matrix), specify coordinates as [x,y,0]
99
* **Multiple layout nodes** can be defined which will be mapped in the order of the layouts
1010
* MoonLight will use the layout definition to generate a **mapping** of the effects to a real world light layout. Most simple example is a panel which has a snake layout. The mapping will create a layer for effects where the snake layout is hidden.
11+
* Layouts also assign groups of LEDs to esp32 GPIO pins.
1112

1213
## Layout 🚥 Nodes
1314

0 commit comments

Comments
 (0)