node-red-contrib-dmx-for-ha 0.4.1 → 0.4.4

package/README.md

@@ -270,6 +270,127 @@ Set to `0` to make all un-timed commands instant.
 
 ---
 
+## Context store — finding your files
+
+This is one of the most common questions with Node-RED on Home Assistant. The context store files are **not** where you expect them.
+
+### Where are the files?
+
+The NR add-on runs in its own Docker container with an isolated config directory. This is **separate** from the main HA config you see via Samba.
+
+| What you see | Actual path on host |
+|---|---|
+| Samba `\\{haip}\config\` | HA config — flows, automations etc. |
+| NR add-on config | `/addon_configs/a0d7b954_nodered/` |
+| Context store files | `/addon_configs/a0d7b954_nodered/nodeRED/context_stores/context/` |
+
+The NR add-on config directory is **not accessible via Samba** — this trips everyone up.
+
+### How to find your context files
+
+Use the **Studio Code Server** add-on (VS Code in HA):
+
+1. Install Studio Code Server from the add-on store if not already installed
+2. Open it: Settings → Add-ons → Studio Code Server → Open Web UI
+3. Open a terminal: Terminal → New Terminal
+4. Run:
+
+```bash
+find / -name "*.json" -path "*context*" 2>/dev/null | grep -v proc
+```
+
+You should see something like:
+```
+/addon_configs/a0d7b954_nodered/nodeRED/context_stores/context/7e2467f26a0693a0/dd6582b967f0314a.json
+/addon_configs/a0d7b954_nodered/nodeRED/context_stores/context/7e2467f26a0693a0/75b10249fcbfd224.json
+...
+```
+
+One `.json` file per node, named by node ID.
+
+### Reading a context file
+
+```bash
+cat "/addon_configs/a0d7b954_nodered/nodeRED/context_stores/context/{flowId}/{nodeId}.json"
+```
+
+A healthy file looks like:
+```json
+{
+    "state": "ON",
+    "brightness": 255,
+    "red": 255,
+    "green": 255,
+    "blue": 255,
+    "white": 255,
+    "warmWhite": 0
+}
+```
+
+### Important: NR adds a `/context/` subfolder
+
+When you set `dir` in your context store config, NR automatically appends `/context/` to it. So:
+
+```javascript
+// You set:
+config: { dir: '/config/nodeRED/context_stores' }
+
+// NR actually writes to:
+// /config/nodeRED/context_stores/context/
+```
+
+### Recommended config.js settings
+
+```javascript
+contextStorage: {
+    memory:      { module: 'memory' },
+    disk_values: { 
+        module: 'localfilesystem', 
+        config: { 
+            dir: '/config/nodeRED/context_stores',
+            flushInterval: 5   // Write to disk every 5 seconds (default is 30)
+        } 
+    },
+    disk_meta:   { 
+        module: 'localfilesystem', 
+        config: { 
+            dir: '/config/nodeRED/context_stores',
+            flushInterval: 5
+        } 
+    },
+    default:     { module: 'memory' },
+},
+```
+
+**Important:** Use an **absolute path** starting with `/config/`. A relative path will silently resolve to the wrong location and nothing will be saved.
+
+`flushInterval: 5` means NR writes to disk every 5 seconds instead of the default 30. This reduces the window of data loss on unexpected shutdown — after turning a light on, wait 5 seconds before restarting.
+
+### Verifying context store is working
+
+After saving a state and waiting 5+ seconds, check your files appeared:
+
+```bash
+ls "/addon_configs/a0d7b954_nodered/nodeRED/context_stores/context/"
+```
+
+If the directory is empty or doesn't exist — check your `config.js` path is absolute and restart NR.
+
+### NR startup log confirmation
+
+On every startup NR logs which context stores loaded:
+
+```
+Context store  : 'memory'      [module=memory]
+Context store  : 'disk_values' [module=localfilesystem]
+Context store  : 'disk_meta'   [module=localfilesystem]
+Context store  : 'default'     [module=memory]
+```
+
+If `disk_values` shows `[module=memory]` — your config.js change didn't take effect.
+
+---
+
 ## Troubleshooting
 
 **Nodes don't appear in palette** — Restart Node-RED. Check log for errors.

package/nodes/ha-mqtt-dmx-group.js

@@ -290,7 +290,7 @@ module.exports = function (RED) {
                 catch(e) { node.warn(`${groupId} — failed to parse HA command`); return; }
 
                 saveGroupState(payload);
-                pubState({ state: payload.state, color_mode: S.colorMode, brightness: payload.brightness });
+                pubState({ state: payload.state, color_mode: S.colorMode, brightness: payload.brightness, color: payload.color });
                 forwardToChildren(payload, null);
                 const _lbl = payload.effect ? `effect:${payload.effect}` : `${payload.state}`;
                 groupStatus(payload.state, `${groupId} → ${_lbl}`);
@@ -318,7 +318,8 @@ module.exports = function (RED) {
         function handleDeviceRemove(incomingTrace) {
             if (diskTimer) { clearTimeout(diskTimer); diskTimer = null; }
             // No flush needed on remove — state is cleared below
-            ctxSet('state', null); ctxSet('state', null, 'disk_values');
+            // Keep disk state on remove — state survives remove/add cycles
+            ctxSet('state', null); // RAM only
             pub(cfgTopic, '', true);
             broker.unsubscribe(cmdTopic, node.id);
             forwardToChildren({ device: 'remove' }, incomingTrace);
@@ -337,7 +338,7 @@ module.exports = function (RED) {
                 // Forward payload deeper
                 if (msg.payload) {
                     saveGroupState(msg.payload);
-                    pubState({ state: msg.payload.state, color_mode: S.colorMode, brightness: msg.payload.brightness });
+                    pubState({ state: msg.payload.state, color_mode: S.colorMode, brightness: msg.payload.brightness, color: msg.payload.color });
                     forwardToChildren(msg.payload, msg.dmx_trace);
                     groupStatus(msg.payload.state, `${groupId} → cascade:${msg.payload.state}`);
                 }
@@ -354,7 +355,7 @@ module.exports = function (RED) {
                     }
                 } else if (msg.payload && msg.payload.state != null) {
                     saveGroupState(msg.payload);
-                    pubState({ state: msg.payload.state, color_mode: S.colorMode, brightness: msg.payload.brightness });
+                    pubState({ state: msg.payload.state, color_mode: S.colorMode, brightness: msg.payload.brightness, color: msg.payload.color });
                     forwardToChildren(msg.payload, null);
                     groupStatus(msg.payload.state, `${groupId} → ${msg.payload.state}`);
                 } else {

package/nodes/ha-mqtt-dmx.js

@@ -670,7 +670,11 @@ module.exports = function (RED) {
                     sendDmxChannels(buildColorChannels(0, r, g, b, w, ww));
                 }
                 pubState({ state, color_mode: S.colorMode, brightness, color: { r, g, b, w, ww } });
-                setStatus('yellow', 'ring', `${fixtureId} ready — awaiting HA`);
+                if (state === 'ON') {
+                    setStatus('green', 'dot', `${fixtureId} ON  bright:${brightness}`);
+                } else {
+                    setStatus('grey', 'ring', `${fixtureId} OFF`);
+                }
                 node.log(`${fixtureId} recovery — state:${state}`);
             }, 2000);
         }
@@ -693,8 +697,10 @@ module.exports = function (RED) {
                     ctxSet('warmWhite',ww,'disk_values');
                 }
             }
+            // Keep disk state on remove — state survives remove/add cycles
+            // Only clear RAM so recovery on re-add reads last known disk state
             ['state','brightness','red','green','blue','white','warmWhite'].forEach(function (k) {
-                ctxSet(k, null); ctxSet(k, null, 'disk_values');
+                ctxSet(k, null);
             });
             pub(cfgTopic, '', true);
             broker.unsubscribe(cmdTopic, node.id);

package/nodes/ha-mqtt-relay.js

@@ -323,7 +323,11 @@ module.exports = function (RED) {
                 const state = recall('state', 'state_disk', S.defaultState);
                 pubRelay(state === 'ON' ? 1 : 0);
                 pubState(state);
-                setStatus('yellow', 'ring', `${fixtureId} ready — awaiting HA`);
+                if (state === 'ON') {
+                    setStatus('green', 'dot', `${fixtureId} ON`);
+                } else {
+                    setStatus('grey', 'ring', `${fixtureId} OFF`);
+                }
                 node.log(`${fixtureId} recovery — state:${state}`);
             }, 2000);
         }
@@ -332,7 +336,8 @@ module.exports = function (RED) {
         function handleDeviceRemove() {
             stopEffect();
             if (diskTimer) { clearTimeout(diskTimer); diskTimer = null; }
-            ctxSet('state', null); ctxSet('state', null, 'disk_values');
+            // Keep disk state on remove — state survives remove/add cycles
+            ctxSet('state', null); // RAM only
             pub(cfgTopic, '', true);
             broker.unsubscribe(cmdTopic, node.id);
             setStatus('red', 'ring', `${fixtureId} removed`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-dmx-for-ha",
-  "version": "0.4.1",
+  "version": "0.4.4",
   "description": "DMX lighting control for Home Assistant via Node-RED and MQTT. Place a node, fill in the settings, deploy. Full HA device registry integration with RGBW/RGBWW/CCT/brightness colour modes, transitions, effects, and group control.",
   "keywords": [
     "node-red",