Skip to content

Commit bce3572

Browse files
ewowiewowi
committed
Documentation updates
1 parent 2bcb66d commit bce3572

File tree

4 files changed

+32
-30
lines changed

4 files changed

+32
-30
lines changed

‎docs/general/customizingsveltekit.md‎

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
### Customize UI and app specific
44

5+
This is a checklist, More info on most of the items can be found in the ESP32-Sveltekit specific documentation [ESP32 SvelteKit](https://ewowi.github.io/MoonBase/esp32sveltekit/), [Build Tools](https://ewowi.github.io/MoonBase/gettingstarted/), [Front end](https://ewowi.github.io/MoonBase/sveltekit/) and [Back End](https://ewowi.github.io/MoonBase/statefulservice/)
6+
57
* {custom} = MoonBase / MoonLight
68

79
* docs/media/
@@ -61,28 +63,3 @@
6163
* change license
6264
* change description
6365
* change webhook
64-
65-
### Other improvements
66-
67-
* Add esp32-s3-devkitc-1-n16r8v and LOLIN_WIFI_FIX in pio.ini (including boards folder)
68-
* Add free_psram, used_psram and psram_size in Analytics (models.ts) and analytics_data (analytics.ts) and show in UI (SystemMetrics.svelte)
69-
* Send psram data only if psramFound (SystemStatus.svelte, AnalyticsService.h, SystemStatus.cpp)
70-
* Add File manager
71-
* Add Monitor
72-
* socket.ts: add else listeners.get("monitor")?.forEach((listener) => listener(new Uint8Array(message.data)));
73-
* EventSocket.cpp: add void EventSocket::emitEvent with char * argument
74-
* Add MoonBase / MoonLight specific functionality (Currently fixtures and effects)
75-
* ESP32SvelteKit.cpp:
76-
* CPU load, loops per second (and main.cpp)
77-
* comment response.addHeader("Cache-Control", "public, immutable, max-age=31536000");
78-
* interface/source/routes/+layout.svelte
79-
* Don't show if captive portal: {#if (!window.location.href.includes("192.168.4.1") && $page.data.features.monitor)}
80-
* interface/source/routes/statusbar.svelte
81-
* show help:
82-
```html
83-
<a href="https://{page.data.github.split("/")[0]}.github.io/{page.data.github.split("/")[1]}{page.url.pathname + addModuleToURL()}" target="_blank">?</a>
84-
```
85-
* main.cpp: esp_log_set_vprintf(my_vprintf); WIP
86-
* ci pio
87-
* run in loopTask to avoid stack size crashes in httpd
88-
* updatedItems (to see what speicifcally has been updated)

‎docs/general/pull-requests.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ Below lists are ordered in terms of likelyhood to be accepted:
3232
## Submitted
3333

3434
* [Refactor System Status and Metrics](https://github.com/theelims/ESP32-sveltekit/pull/78)
35+
* Add free_psram, used_psram and psram_size in Analytics (models.ts) and analytics_data (analytics.ts) and show in UI (SystemMetrics.svelte)
36+
* Send psram data only if psramFound (SystemStatus.svelte, AnalyticsService.h, SystemStatus.cpp)
3537
* [Wifi: Multiple edits bug resolved](https://github.com/theelims/ESP32-sveltekit/pull/81)
3638
* [ESPD_LOGx: replace first argument with TAG and define TAG as 🐼](https://github.com/theelims/ESP32-sveltekit/pull/85)
3739

@@ -40,3 +42,19 @@ Below lists are ordered in terms of likelyhood to be accepted:
4042
* [Expands menu on selected subitem](https://github.com/theelims/ESP32-sveltekit/pull/77)
4143
* [Add file.close in fileHandler handleRequest](https://github.com/theelims/ESP32-sveltekit/pull/73)
4244

45+
### Other improvements
46+
47+
* Add esp32-s3-devkitc-1-n16r8v and LOLIN_WIFI_FIX in pio.ini (including boards folder)
48+
* Add Monitor
49+
* socket.ts: add else listeners.get("monitor")?.forEach((listener) => listener(new Uint8Array(message.data)));
50+
* EventSocket.cpp: add void EventSocket::emitEvent with char * argument
51+
* Add MoonBase / MoonLight specific functionality (Currently fixtures and effects)
52+
* ESP32SvelteKit.cpp:
53+
* CPU load (and main.cpp)
54+
* comment response.addHeader("Cache-Control", "public, immutable, max-age=31536000");
55+
* interface/source/routes/+layout.svelte
56+
* Don't show if captive portal: {#if (!window.location.href.includes("192.168.4.1") && $page.data.features.monitor)}
57+
* main.cpp: esp_log_set_vprintf(my_vprintf); WIP
58+
* ci pio
59+
* run in loopTask to avoid stack size crashes in httpd
60+
* updatedItems (to see what specifically has been updated)

‎docs/moonbase/module/animations.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,10 @@
3535
* Each node has a type
3636
* Fixture definition: tell where each pixture is in a 1D/2D/3D physical coordinate space (based on StarLight)
3737
* Fixture mapping: change the fixture to a 1D/2D/3D virtual coordinate space
38+
* A fixture mapping is for a specific fixture dimension and effect dimension
3839
* e.g. if the fixture is a globe, you can map that to 2D using mercator projection mapping
3940
* if the fixture is 200x200 you can map it to 50x50
41+
* if the fixture is 2D, a 1D effect can be shown as a circle or a bar (as WLED expand1D)
4042
* Effect: run an effect in (part of) the virtual coordinate space
4143
* 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 ✅
4244
* Modifier: Mirror, rotate, etc, multiple projections allowed (projection in StarLight)
@@ -45,10 +47,15 @@
4547
* Replace the nodes table (1) by a graphical view (2)
4648
* Mapping model (3)
4749
* Take the StarLight PhysMap as a start
48-
* 2-bytes to 3-bytes to allow for > 16384 leds
49-
* Mapping table is logical pixels
50-
* ledsP is physical pixels (as in FASTLED)
51-
* 1:0, 1:1, 1:many : each logical pixel can be mapped to no, 1 or many physical pixels)
50+
* Array of arrays. Outer array is virtual pixels, inner array is physical pixels
51+
* e.g. [[],[0],[1,2],[3,4,5],[6,7,8,9]]
52+
* first virtual pixel is not mapped to a physical pixel
53+
* second virtual pixel is mapped to physical pixel 0
54+
* third virtual pixel is mapped to physical pixels 1 and 2
55+
* and so on
56+
* CRGB leds[NUM_LEDS] are physical pixels (as in FASTLED)
57+
* Virtual pixels can be 1D, 2D or 3D. Physical pixels also, in any combination
58+
* Using x + y * sizeX + z * sizeX * sizeY
5259
* Nodes manipulate the mapping model and/or interfere in the effects loop
5360
* Presets/playlist: change (part of) the nodes model
5461

‎mkdocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ nav:
2222
- "System":
2323
- system/status.md
2424
- system/metrics.md
25-
- "ESP32 SveleteKit":
25+
- "ESP32 SvelteKit":
2626
- esp32sveltekit.md
2727
- "Build Tools":
2828
- gettingstarted.md

0 commit comments

Comments
 (0)