You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/development.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,36 +12,36 @@
12
12
13
13
## Create a branch
14
14
15
-
* Want to make changes: fork the repo (see installation)and submit pull requests, see [creating-a-pull-request-from-a-fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork):
15
+
* Want to make changes: fork the repo (see installation)and submit pull requests, see [creating-a-pull-request-from-a-fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork):
16
16
17
-
* Only branch from the main branch! Press Branches, press New Branch, give it a name e.g. background-script and press Create new Branch, click on background-script
17
+
* Only branch from the main branch! Press Branches, press New Branch, give it a name e.g. background-script and press Create new Branch, click on background-script
* interface/src/routes/moonbase for MoonBase and MoonLight (modules)
27
27
* see [Prepare for development](https://moonmodules.org/MoonLight/develop/installation/#prepare-for-development) about nodejs, npm install
28
28
29
-
```
29
+
```markdown
30
30
npm install
31
31
npm run dev
32
32
```
33
33
34
34
* see [Troubleshooting](https://moonmodules.org/MoonLight/develop/installation/#troubleshooting) about WWWData.h
35
35
36
-
### Back End (Server)
36
+
### Back-end (Server)
37
37
38
38
There are 3 levels to add functionality:
39
39
40
40
***Standard ESP32-Sveltekit code**, e.g. Connections, Wifi and System. MoonBase files is also made using standard sveltekit as example but contains a few components used in MoonLight modules. Might be rewriteen as MoonLight Module in the future.
41
-
* lib folder for Sveltekit back end
41
+
* lib folder for Sveltekit vack-end
42
42
* Read the [ESP32 Sveltekit docs](https://moonmodules.org/MoonLight/esp32sveltekit/)
43
43
*[MoonLight Modules](https://moonmodules.org/MoonLight/moonbase/modules/) e.g. Lights Control, Effects, Info, Channels. They are subclasses of Modules.h/cpp and implement setupDefinition, onUpdate and optional loop. New modules need to be defined in main.cpp and added to menu.svelte. All further UI is generated by Module.svelte.
44
-
* src folder for MoonBase and MoonLight back end
44
+
* src folder for MoonBase and MoonLight vack-end
45
45
***MoonLight Nodes**: the easiest and recommended way. See Effects.h, Layouts.h, Modifiers.h and Drivers.h for examples. They match closest WLED usermods. Each node has controls, a setup and a loop and can be switched on and off. For specific purposes hasOnLayout() and hasModifier() can return true.
46
46
* src/MoonLight/nodes
47
47
@@ -50,7 +50,7 @@ There are 3 levels to add functionality:
50
50
* Go to the file(s) you want to change press edit and make the changes.
51
51
* ☑️ and ➡️ to build and or upload
52
52
* Changes made to the UI are not always visible in the browser, clear the browser cache to see latest UI (see [connect to MoonLight](https://moonmodules.org/MoonLight/gettingstarted/installation/#connect-moonlight)).
53
-
* MoonLight uses clang-format for c/c++ code and prettier for Svelte, javascript etc. Format your code before submitting! (rightclick Format Document on each page you change)
53
+
* MoonLight uses clang-format for c/c++ code and prettier for Svelte, javascript etc. Format your code before submitting! (right-click Format Document on each page you change)
54
54
* Press Commit Changes..., enter a commit message and an extended description, Press Commit Changes
55
55
56
56
## Document your changes
@@ -88,7 +88,7 @@ See [Documentation](https://moonmodules.org/MoonLight/develop/documentation/)
88
88
89
89
### UI development server
90
90
91
-
To ease the frontend development you can deploy the back end code on an ESP32 board and pass the websocket and REST API calls through the development server's proxy running on your computer.
91
+
To ease the frontend development you can deploy the vack-end code on an ESP32 board and pass the websocket and REST API calls through the development server's proxy running on your computer.
92
92
93
93
This very much speeds up UI development as no flashing to ESP32 is required to test updated UI. Svaing an UI file is enough to see the results!!!
Copy file name to clipboardExpand all lines: docs/develop/installation.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ Before changing code, test if the current download of MoonLight is running fine.
110
110
111
111
* If you are developing or updating existing MoonLight installations MoonLight might be outdated or not show up correctly in the browser or not even appear. Two reasons
112
112
113
-
* Sometimes the latest frontend code is not generated yet (WWWData.h). This is how to set it right:
113
+
* Sometimes the latest front-end code is not generated yet (WWWData.h). This is how to set it right:
114
114
* Open platformIO new terminal (>_)
115
115
* touch ./interface/src/app.html so the build process will be triggered to create a new WWWData.h
116
116
* build the project (✔) - if nodejs is not installed (yet) you will get errors. See troubleshooting
@@ -106,7 +106,7 @@ This is the current list of supported lights ranging from 3 channels per light (
106
106
* MHBeTopper19x15W-32 🐺: 32 channels moving head
107
107
* MH19x15W-24: 24 channels moving heads
108
108
109
-
Based on the choosen value, the channels per light and the offsets will be set e.g. for GRB: header->channelsPerLight = 3; header->offsetRed = 1; header->offsetGreen = 0; header->offsetBlue = 2;. Drivers should not make this mapping, the code calling drivers should do.
109
+
Based on the chosen value, the channels per light and the offsets will be set e.g. for GRB: header->channelsPerLight = 3; header->offsetRed = 1; header->offsetGreen = 0; header->offsetBlue = 2;. Drivers should not make this mapping, the code calling drivers should do.
110
110
111
111
The RGB and W offsets needs to be re-ordered and brightness corrected from the channel array. Not only Art-Net but also a LEDs driver need to accept channel arrays with more then 4 channels per light. Eg GRB6 is a type of led curtain some of us have, which a Chinese manufacturer screwed up: 6 channels per light but only rgb is used, 3 channels do nothing
Copy file name to clipboardExpand all lines: docs/develop/sveltekit.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ Below lists are ordered in terms of likelyhood to be accepted:
64
64
65
65
## Steps made to make Sveltekit ready for MoonLight
66
66
67
-
This is a checklist, More info on most of the items can be found in the ESP32-Sveltekit specific documentation [ESP32 SvelteKit](https://moonmodules.org/MoonLight/esp32sveltekit/), [Build Tools](https://moonmodules.org/MoonLight/gettingstarted/), [Frontend](https://moonmodules.org/MoonLight/sveltekit/) and [Back End](https://moonmodules.org/MoonLight/statefulservice/)
67
+
This is a checklist, More info on most of the items can be found in the ESP32-Sveltekit specific documentation [ESP32 SvelteKit](https://moonmodules.org/MoonLight/esp32sveltekit/), [Build Tools](https://moonmodules.org/MoonLight/gettingstarted/), [Front-end](https://moonmodules.org/MoonLight/sveltekit/) and [Back-end](https://moonmodules.org/MoonLight/statefulservice/)
Copy file name to clipboardExpand all lines: docs/gettingstarted/overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,4 +22,4 @@ MoonLight documentation (this site) is organised as follows:
22
22
*[Getting Started](https://moonmodules.org/MoonLight/gettingstarted/): Getting started with MoonLight
23
23
*[MoonLight](https://moonmodules.org/MoonLight/moonlight/), [MoonBase](https://moonmodules.org/MoonLight/moonbase/), [Connections](https://moonmodules.org/MoonLight/connections/), [WiFi](https://moonmodules.org/MoonLight/wifi/), [System](https://moonmodules.org/MoonLight/system/status/): Help per module (MoonLight contains links to these pages)
24
24
*[Develop](https://moonmodules.org/MoonLight/develop/): Info on developing for MoonLight
25
-
*[ESP32 Sveltekit](https://moonmodules.org/MoonLight/esp32sveltekit/), [Build Tools](https://moonmodules.org/MoonLight/gettingstarted/), [Front End](https://moonmodules.org/MoonLight/sveltekit/), [Back End](https://moonmodules.org/MoonLight/statefulservice/): Information about the foundation of MoonLight, ESP32-Sveltekit, aimed at developers.
25
+
*[ESP32 Sveltekit](https://moonmodules.org/MoonLight/esp32sveltekit/), [Build Tools](https://moonmodules.org/MoonLight/gettingstarted/), [Front-end](https://moonmodules.org/MoonLight/sveltekit/), [Back-end](https://moonmodules.org/MoonLight/statefulservice/): Information about the foundation of MoonLight, ESP32-Sveltekit, aimed at developers.
| IR Driver 🆕🚧 | <imgwidth="100"src="../../media/moonlight/IRDriver.jpeg"/> || Receive IR commands and [Lights Control](https://moonmodules.org/MoonLight/moonlight/lightscontrol/)|
39
39
40
-
41
-
Virtual LED Driver: Driving max 120! outputs. E.g. 48 panels of 256 LEDs each run at 50-100 FPS using shift registers. Not implemented yet
40
+
* The Parallel LED driver uses different hardware peripherals depending on the MCU type: ESP32-D0: I2S, ESP32-S3: LCD_CAM, ESP32-P4: Parallel IO (ParLIO).
41
+
*Virtual LED Driver: Driving max 120! outputs (E.g. 48 panels of 256 LEDs each run at 50-100 FPS) using shift registers. Integrated within the Parallel LED Driver architecture. Not implemented yet
0 commit comments