Merge branch 'board-preset-tuning'

Author: ewowi

docs/develop/development.md

@@ -7,40 +7,41 @@
 * Make changes
 * Document your change
 * Submit a pull request
-* Develop principles: Checklist before submitting a request.
+
+[Standards and Guidelines](https://moonmodules.org/MoonLight/develop/standardsguidelines/). Check before submitting a request!
 
 ## Create a branch
 
-* 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):
+* 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):
 
-    * Press Branches, press New Branch, give it a name e.g. background-script and press Create new Branch, click on background-script
+  * 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
 
-      <img width="90" src="https://github.com/user-attachments/assets/588d0854-bac1-4b70-8931-ba6db4c94248" />
+    <img width="90" src="https://github.com/user-attachments/assets/588d0854-bac1-4b70-8931-ba6db4c94248" />
 
 ## Make changes
 
-### Front End (UI)
+### Front-end (UI)
 
 * interface folder
     * interface/src/routes/moonbase for MoonBase and MoonLight (modules)
 * see [Prepare for development](https://moonmodules.org/MoonLight/develop/installation/#prepare-for-development) about nodejs, npm install
 
-```
+```markdown
 npm install
 npm run dev
 ```
 
 * see [Troubleshooting](https://moonmodules.org/MoonLight/develop/installation/#troubleshooting) about WWWData.h
 
-### Back End (Server)
+### Back-end (Server)
 
 There are 3 levels to add functionality:
 
-* **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.
-  * lib folder for Sveltekit back end
+* **Standard ESP32-Sveltekit code**, e.g. Connections, Wifi and System. MoonBase files are also made using standard SvelteKit as examples but contain a few components used in MoonLight modules. Might be rewritten as a MoonLight Module in the future.
+  * lib folder for Sveltekit back-end
   * Read the [ESP32 Sveltekit docs](https://moonmodules.org/MoonLight/esp32sveltekit/)
 * [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.
-  * src folder for MoonBase and MoonLight back end
+  * src folder for MoonBase and MoonLight back-end
 * **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.
   * src/MoonLight/nodes
 
@@ -49,7 +50,7 @@ There are 3 levels to add functionality:
 * Go to the file(s) you want to change press edit and make the changes. 
 * ☑️ and ➡️ to build and or upload
 * 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)).
-* 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)
+* 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)
 * Press Commit Changes..., enter a commit message and an extended description, Press Commit Changes
 
 ## Document your changes
@@ -66,7 +67,7 @@ See [Documentation](https://moonmodules.org/MoonLight/develop/documentation/)
 
     * The upstream MoonLight repo can now process this PR
 
-## Addtional info
+## Additional info
 
 ### Emoji coding
 
@@ -87,9 +88,9 @@ See [Documentation](https://moonmodules.org/MoonLight/develop/documentation/)
 
 ### UI development server
 
-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.
+To ease the front-end 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.
 
-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!!!
+This very much speeds up UI development, as no flashing to the ESP32 is required to test updated UI. Saving a UI file is enough to see the results.
 
 See [Setup Proxy for Development](https://moonmodules.org/MoonLight/gettingstarted/#setup-proxy-for-development) and [development-server](https://moonmodules.org/MoonLight/gettingstarted/#development-server) how to setup.
 
@@ -123,14 +124,3 @@ There are 3 files to consider when making a ESP32-device definition.
 	boards/BOARD_NAME.csv
 	boards/BOARD_NAME.JSON
 	firmware/BOARD_TYPE_NAME.ini (e.g. esp32dev, esp32-s3), contains different boards
-
-## Develop principles
-
-* One firmware per board containing everything, to keep management of firmware simple - for everybody. 3MB flash space to allow for this.
-* Clang-format and Prettier for unified layout of code (right click format document in VSCode)
-* Part of submitting a change via a pull request is updated documentation. Functionality and documentation should be in one Pull Request 
-* Make minimal changes in upstream (Sveltekit) code, as we need to stay in sync as easy as possible. Add // 🌙 to show a change has been made.
-* The main branch is the source to branch and merge to, no direct code commits to the main branch. As the main branch docs folder is the source for the website, doc changes can be made directly to main. 
-* The dev branch is used for latest updates between releases. Optionally branch from dev if latest updates are needed for a change.
-* The src folder is for all MoonBase and MoonLight Nodes and Modules development. No need for UI changes as that is generated for Nodes and Modules. The lib folder is for upstream (Sveltekit). The interface folder is for UI, mainly Sveltekit and Modules and Nodes generic functions.
-* A pull request should contain compilable code and tested to not crash the system at minimal and support also boards without PSRAM, e.g. ESP32-D0. Code may be work in progress.

docs/develop/drivers.md

@@ -38,7 +38,7 @@ The development environment consists of
 
     <img width="320" src="https://github.com/user-attachments/assets/74928dac-d59b-4489-b97b-759c6d792b77" />
 
-    * The main branch will be checked out per default. To run / test latest developments, switch to the dev branch
+    * The main branch will be checked out per default. Latest development will be done in branches from main, merged back into main when done.
 
 ## Install and setup VSCode
 
@@ -110,7 +110,7 @@ Before changing code, test if the current download of MoonLight is running fine.
 
 * 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
 
-    * Sometimes the latest front end code is not generated yet (WWWData.h). This is how to set it right: 
+    * Sometimes the latest front-end code is not generated yet (WWWData.h). This is how to set it right: 
         * Open platformIO new terminal (>_)
         * touch ./interface/src/app.html so the build process will be triggered to create a new WWWData.h
         * build the project (✔) - if nodejs is not installed (yet) you will get errors. See troubleshooting
@@ -180,7 +180,7 @@ Before changing code, test if the current download of MoonLight is running fine.
 
 ### Install nodejs
 
-nodejs is needed if changes on the frontend (UI) are made (interface folder). On each file change, ☑️ or ➡️ will rebuild the UI using nodejs.
+nodejs is needed if changes on the front-end (UI) are made (interface folder). On each file change, ☑️ or ➡️ will rebuild the UI using nodejs.
 
 * Windows: if nodejs is not on your system you will get this error:
 

docs/develop/installation.md

@@ -38,23 +38,26 @@ ModuleDemo(PsychicHttpServer *server
     * Initialy create the module data
 
 ```cpp
-void setupDefinition(const JsonArray& root) override{
+void setupDefinition(const JsonArray& controls) override{
     JsonObject control; // state.data has one or more properties
-    JsonArray details; // if a control is an array, this is the details of the array
-    JsonArray values; // if a control is a select, this is the values of the select
-
-    control = root.add<JsonObject>(); control["name"] = "hostName"; control["type"] = "text"; control["default"] = "MoonLight";
-    control = root.add<JsonObject>(); control["name"] = "connectionMode"; control["type"] = "select"; control["default"] = "Signal Strength"; values = control["values"].to<JsonArray>();
-    values.add("Offline");
-    values.add("Signal Strength");
-    values.add("Priority");
-
-    control = root.add<JsonObject>(); control["name"] = "savedNetworks"; control["type"] = "rows"; details = control["n"].to<JsonArray>();
+    JsonArray rows; // if a control is an array, this is the rows of the array
+
+    control = addControl(controls, "hostName", "text"); 
+    control["default"] = "MoonLight";
+    control = addControl(controls, "connectionMode", "select"); 
+    control["default"] = "Signal Strength";
+    addControlValue(control, "Offline");
+    addControlValue(control, "Signal Strength");
+    addControlValue(control, "Priority");
+
+    control = addControl(controls, "savedNetworks", "rows"); 
+    rows = control["n"].to<JsonArray>();
     {
-        control = details.add<JsonObject>(); control["name"] = "SSID"; control["type"] = "text"; control["default"] = "ewtr"; control["min"] = 3; control["max"] = 32; 
-        control = details.add<JsonObject>(); control["name"] = "Password"; control["type"] = "password"; control["default"] = "";
+        control = addControl(rows, "SSID", "text", 3, 32); 
+        control["default"] = "ewtr";
+        control = addControl(rows, "Password", "password"); 
+        control["default"] = "";
     }
-
 }
 
 ```