Skip to content

Commit 1f48a3e

Browse files
committed
Docs changes
1 parent 4ac6de8 commit 1f48a3e

File tree

4 files changed

+13
-4
lines changed

4 files changed

+13
-4
lines changed

docs/moonbase/module/animations.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,18 @@
99
* driverOn: sends LED output to ESP32 gpio pins.
1010
* Switch off to see the effect framerate in System Status/Metrics
1111
* Switch on to see the effect framerate throttled by a LED driver in System Status/Metrics (800KHz, 256 leds, 24 bits is 130 fps theoretically - 120 practically)
12+
* Pin: Currently only 2 and 16 supported
1213
* Nodes: One or more processes, can be fixture definitions, mappings, effects, projections. Currently all nodes are effects.
1314
* Nodes can have arguments
1415
* Scrips: Running Live scripts (WIP)
16+
* If a script file is updated (here or in the [File Manager](https://ewowi.github.io/MoonBase/moonbase/files/)) and the file is part of an active node, it will rerun
1517

1618
<img width="498" alt="Screenshot 2025-03-29 at 14 12 01" src="https://github.com/user-attachments/assets/3a5a3743-c0a4-4456-96cb-f4abd0d01450" />
1719

1820
## Technical
1921

2022
* See [Modules](../modules.md)
23+
* Upon changing a pin, FastLED.addLeds will rerun
2124
* Uses ESPLiveScripts, see compileAndRun. compileAndRun is started when in Nodes a file.sc animation is choosen
2225
* To do: kill running scripts, e.g. when changing effects
2326
* To do: use Nodes arguments as arguments to scripts or hardcoded effects
@@ -32,7 +35,10 @@
3235
* Each node has a type
3336
* Fixture definition: tell where each pixture is in a 1D/2D/3D physical coordinate space (based on StarLight)
3437
* Fixture mapping: change the fixture to a 1D/2D/3D virtual coordinate space
38+
* e.g. if the fixture is a globe, you can map that to 2D using mercator projection mapping
39+
* if the fixture is 200x200 you can map it to 50x50
3540
* Effect: run an effect in (part of) the virtual coordinate space
41+
* or in the physical space if you want to run at highest performance, e.g. a random effect doesn't need to go through mappings
3642
* Modifier: Mirror, rotate, etc, multiple projections allowed (projection in StarLight)
3743
* Driver show: show the result on Leds (using FastLED, hpwit drivers), ArtNet, DDP, ...
3844
* Future situation: Nodes and noodles (2)
@@ -52,4 +58,4 @@
5258

5359
### UI
5460

55-
Generated
61+
Generated by [Module.svelte](https://github.com/ewowi/MoonBase/blob/main/interface/src/routes/custom/module/Module.svelte)

docs/moonbase/module/demo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@
1414

1515
### UI
1616

17-
Generated
17+
Generated by [Module.svelte](https://github.com/ewowi/MoonBase/blob/main/interface/src/routes/custom/module/Module.svelte)

docs/moonbase/module/instances.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,21 @@
44

55
## Functional
66

7+
Sends and receives UDP messages over the network to see which other instances are there (WLED compatible).
8+
79
* Instance name: name of this instance
810
* Instances: Instances found on the network
911
* Click on IP to jump to the instance
1012

1113
## Technical
1214

1315
* See [Modules](../modules.md)
16+
* Statusbar and HTML title display the instance name
1417

1518
### Server
1619

1720
[ModuleInstances.h](https://github.com/ewowi/MoonBase/blob/main/src/custom/ModuleInstances.h)
1821

1922
### UI
2023

21-
Generated
24+
Generated by [Module.svelte](https://github.com/ewowi/MoonBase/blob/main/interface/src/routes/custom/module/Module.svelte)

docs/moonbase/modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A module is a generic building block to create server and UI functionality which
88

99
MoonBase-Modules are inspired by WLED usermods, further developed in StarBase and now in MoonBase (using the ESP32-Sveltekit infrastructure)
1010

11-
See [Demo](module/demo.md) and [Animations](module/animations.md) for examples
11+
See [Demo](module/demo.md), [Instances](module/instances.md) and [Animations](module/animations.md) for examples
1212

1313
Press the ? on any module to go to the documentation.
1414

0 commit comments

Comments
 (0)