Add SafeMode and show in SystemStatus and StatusBar

Author: ewowi

docs/moonbase/module/editor.md

@@ -11,12 +11,13 @@ Ultimately the nodes will be displayed in a graphical interface where nodes are
 
 Typically a node will define a layout (🚥), or an effect (🔥), or a modifier (💎) or a supporting process (☸️) but can also combine these tasks (experimental at the moment). To avoid duplication it's in most cases recommended to keep them seperated so an effect can run on multiple layouts and a modifier can modify any effect. 
 
-* **Layout** 🚥: a layout defines what lights are connected to MoonLight. Currently only one layout node is supported defining all the lights (But might change in the future). It defines the coordinates of all lights (addLight) and assigns lights to the GPIO pins of the ESP32 (addPin) and how many channels each light has (normal LEDs 3: Red, Green and Blue). 
+* **Layout** 🚥: a layout defines what lights are connected to MoonLight. It defines the coordinates of all lights (addLight) and assigns lights to the GPIO pins of the ESP32 (addPin) and how many channels each light has (normal LEDs 3: Red, Green and Blue). 
     * The **coordinates** of each light are defined in a 3D coordinate space where each coordinate range between 1 and 255. Currently a strip until 255 leds is supported, a panel until 128x96 LEDS and a cube max 20x20x20. 
         * Coordinates needs to be specified in the order the lights are wired so MoonLight knows which light is first, which is second etc.
         * If a 1D strip is longer, you can address more leds by pretending it is a 2D fixture, e.g. 32x32 to address a strip of 1024 LEDs. 
         * In the future we might look at redefining Coord3D where width is 12 bytes, height is 7 bytes and depth is 5 bytes allowing for max 4096 x 128 x 32 ...
     * Currently **pins** are by default driven by FastLED.show. FastLED needs all LEDs specifications be defined at compile time, e.g. LED type, color order, etc. Normally also the pin(s) need to be defined beforehand but all pins are predefined in the code to avoid this (at a cost of larger firmware). As we want to be able to define all LED specs in the UI instead of during compile, we need to see how / if this can be done.
+    * 🆕 **Multiple layout nodes** can be defined which will execute one after the other
     * In the future, instead of pins, also **IP addresses and universes** can be specified to support sending lights data to ArtNet devices - e.g. [Pknight Artnet DMX 512](https://s.click.aliexpress.com/e/_ExQK8Dc) to control DMX lights or [ArtNet LED controller](https://s.click.aliexpress.com/e/_Ex9uaOk) to control LED strips or panels over local network. Currently this is handled by [Module ArtNet](https://moonmodules.org/MoonLight/moonbase/module/artnet/).
     * Alternatively Moonlight supports 2 other drivers: [Physical Driver](https://github.com/hpwit/I2SClocklessLedDriver) and [Virtual Driver](https://github.com/ewowi/I2SClocklessVirtualLedDriver). Firmware ending with PD or VD will have this enabled. Code has been included but not tested yet (tested in StarLight), this is planned for June/July. 
         * The physical driver is an alternative to the FastLED driver and does not need LED specifications defined at compile time, all can be controlled via UI. 

docs/moonlight/general.md

@@ -0,0 +1,15 @@
+# General
+
+## Functional
+
+* **Safe Mode**: MoonBase will jump into safe mode after a crash, see [System Status](https://moonmodules.org/MoonLight/system/status/). In safe mode, MoonLight will disable the following features:
+    * Add more then 1024 lights
+    * Execute a live script
+
+    This list is dynamic and will change over time if crash reasons change.
+
+## Technical
+
+### Server
+
+### UI

docs/system/status.md

@@ -4,15 +4,16 @@
 
 ## Functional
 
-* <img width="30" src="https://github.com/user-attachments/assets/b0e8af99-ed76-422a-8bd1-bfbd9e0f4c44"/> Performance: loops per second: nr of times main loop is executed
+* 🌙 **Performance**: loops per second: nr of times main loop is executed
+* 🌙 **Safe Mode** 🆕: After a crash, the device will start in Safe Mode disabling possible causes of crashes. See also [MoonLight](https://moonmodules.org/MoonLight/moonlight/general/). In case of safe mode, the statusbar will show a shield: 🛡️. Try to find the reason of the crash and correct and restart the device. If no crash, it will go out of safe mode.
 
-* Sleep: Device is set in low power mode.
-* Restart: The device will restart
-* Factory reset: all settings will be removed.
+* **Sleep**: Device is set in low power mode.
+* **Restart**: The device will restart
+* **Factory reset**: all settings will be removed.
 
 ## Technical
 
-* <img width="30" src="https://github.com/user-attachments/assets/b0e8af99-ed76-422a-8bd1-bfbd9e0f4c44"/> Reordered info from dynamic to static
+* 🌙 Reordered info from dynamic to static
 
 ### Server
 

interface/src/lib/stores/telemetry.ts

@@ -7,7 +7,8 @@ let telemetry_data = {
 	rssi: {
 		rssi: 0,
 		ssid: '',
-		disconnected: true
+		disconnected: true,
+		safeMode: false // 🌙 safeMode Indicates if the system is in safe mode
 	},
 	battery: {
 		soc: 100,
@@ -29,12 +30,12 @@ function createTelemetry() {
 			if (!isNaN(Number(data.rssi))) {
 				update((telemetry_data) => ({
 					...telemetry_data,
-					rssi: { rssi: Number(data.rssi), ssid: data.ssid, disconnected: false }
+					rssi: { rssi: Number(data.rssi), ssid: data.ssid, disconnected: false, safeMode: data.safeMode } // 🌙 safeMode
 				}));
 			} else {
 				update((telemetry_data) => ({
 					...telemetry_data,
-					rssi: { rssi: 0, ssid: data.ssid, disconnected: true }
+					rssi: { rssi: 0, ssid: data.ssid, disconnected: true, safeMode: data.safeMode } // 🌙 safeMode
 				}));
 			}
 		},

interface/src/lib/types/models.ts

@@ -100,6 +100,7 @@ export type Analytics = {
 export type RSSI = {
 	rssi: number;
 	ssid: string;
+	safeMode: boolean; // 🌙 safeMode Indicates if the system is in safe mode
 };
 
 export type Battery = {
@@ -127,6 +128,7 @@ export type StaticSystemInformation = {
 	flash_chip_size: number;
 	flash_chip_speed: number;
 	cpu_reset_reason: string;
+	safeMode: boolean; // 🌙 safeMode Indicates if the system is in safe mode
 };
 
 export type SystemInformation = Analytics & StaticSystemInformation;

interface/src/routes/statusbar.svelte

@@ -44,11 +44,17 @@
 		<label for="main-menu" class="btn btn-ghost btn-circle btn-sm drawer-button lg:hidden"
 			><Hamburger class="h-6 w-auto" /></label
 		>
-		<span class="px-2 text-xl font-bold lg:text-2xl">{page.data.instances.instanceName}</span>
+		<span class="px-2 text-xl font-bold lg:text-2xl">{page.data.instances.instanceName}</span> <!-- 🌙 -->
 	</div>
 	<div class="indicator flex-none">
 		<UpdateIndicator />
 	</div>
+	<!-- 🌙 safeMode -->
+	<div class="indicator flex-none">
+		{#if $telemetry.rssi.safeMode}
+			🛡️
+		{/if}
+	</div>
 	<div class="flex-none">
 		{#if $telemetry.rssi.disconnected}
 			<WiFiOff class="h-7 w-7" />

interface/src/routes/system/status/SystemStatus.svelte

@@ -160,7 +160,7 @@
 	{/snippet}
 	{#snippet title()}
 		<span >System Status</span>
-		<div class="absolute right-5"><a href="https://{page.data.github.split("/")[0]}.github.io/{page.data.github.split("/")[1]}{page.url.pathname}" target="_blank" title="Documentation"><Help  class="lex-shrink-0 mr-2 h-6 w-6 self-end" /></a></div>
+		<div class="absolute right-5"><a href="https://{page.data.github.split("/")[0]}.github.io/{page.data.github.split("/")[1]}{page.url.pathname}" target="_blank" title="Documentation"><Help  class="lex-shrink-0 mr-2 h-6 w-6 self-end" /></a></div> <!-- 🌙 link to docs -->
 	{/snippet}
 
 	<div class="w-full overflow-x-auto">
@@ -287,6 +287,18 @@
 					</div>
 				</div>
 
+				<div class="rounded-box bg-base-100 flex items-center space-x-3 px-4 py-2">
+					<div class="mask mask-hexagon bg-primary h-auto w-10 flex-none">
+						<Power class="text-primary-content h-auto w-full scale-75" />
+					</div>
+					<div>
+						<div class="font-bold">Safe mode</div>
+						<div class="text-sm opacity-75">
+							{systemInformation.safeMode}
+						</div>
+					</div>
+				</div>
+
 				<div class="rounded-box bg-base-100 flex items-center space-x-3 px-4 py-2">
 					<div class="mask mask-hexagon bg-primary h-auto w-10 flex-none">
 						<Sketch class="text-primary-content h-auto w-full scale-75" />

lib/framework/ESP32SvelteKit.cpp

@@ -15,6 +15,7 @@
 #include <ESP32SvelteKit.h>
 
 std::vector<std::function<void()>> runInLoopTask; // 🌙 see .h
+bool safeModeMB = false; // 🌙 see .h
 
 ESP32SvelteKit::ESP32SvelteKit(PsychicHttpServer *server, unsigned int numberEndpoints) : _server(server),
                                                                                           _numberEndpoints(numberEndpoints),

lib/framework/ESP32SvelteKit.h

@@ -85,6 +85,7 @@ enum class ConnectionStatus
 };
 
 extern std::vector<std::function<void()>> runInLoopTask; // 🌙 functions to be called in main loopTask (to avoid https to run out of stack space)
+extern bool safeModeMB; // 🌙 true when the ESP32 is in safe mode, false when it is not
 
 class ESP32SvelteKit
 {

lib/framework/SystemStatus.cpp

@@ -13,6 +13,9 @@
  **/
 
 #include <SystemStatus.h>
+
+#include <ESP32SvelteKit.h> // 🌙 safeMode
+
 #include <esp32-hal.h>
 
 #if CONFIG_IDF_TARGET_ESP32 // ESP32/PICO-D4
@@ -164,6 +167,7 @@ esp_err_t SystemStatus::systemStatus(PsychicRequest *request)
     root["core_temp"] = temperatureRead();
     root["cpu_reset_reason"] = verbosePrintResetReason(esp_reset_reason());
     root["uptime"] = millis() / 1000;
+    root["safeMode"] = safeModeMB; // 🌙 safeMode
 
     return response.send();
 }