node-red-contrib-hoymiles-home 0.1.1-dev.0 → 0.1.2

package/README.md

@@ -0,0 +1,115 @@
+# node-red-contrib-hoymiles-home
+
+Node-RED nodes for the **Hoymiles S-Miles Home API** — continuously polls live power data and emits a message for every new reading.
+
+## Nodes
+
+### `hoymiles-config` (config node)
+
+Manages authentication against the Hoymiles cloud. Enter your S-Miles Home **e-mail** and **password** — the node performs the same two-step login as the S-Miles Home app (pre-inspection → Argon2ID or MD5·SHA256 password encoding → token) and shares the session with all connected watch nodes.
+
+### `hoymiles-watch` (input node)
+
+Continuously polls live power data for a station and emits one message per reading.
+
+**Configuration:**
+
+| Field | Description |
+|---|---|
+| Credentials | Select a `hoymiles-config` node |
+| Station ID | Numeric station ID (`sid`) — find it in the S-Miles Home app or via the Hoymiles API |
+| Interval (s) | Poll interval in seconds. Leave empty to use the `dly` value from each server response (recommended — mirrors the S-Miles Home app) |
+
+**Output `msg.payload`:**
+
+```json
+{
+  "pv":   210,
+  "load": 340,
+  "grid": 130,
+  "bat":  0
+}
+```
+
+| Field | Description |
+|---|---|
+| `pv` | Solar generation (W) |
+| `load` | Consumption (W) |
+| `grid` | Grid exchange (W) — negative = feed-in |
+| `bat` | Battery power (W) — negative = charging |
+
+**Additional message properties:**
+
+| Property | Value |
+|---|---|
+| `msg.topic` | `hoymiles/watch/{sid}` |
+| `msg.sid` | Station ID |
+
+**Status indicators:**
+
+| Colour | Text | Meaning |
+|---|---|---|
+| Yellow | authenticating… | Login in progress |
+| Yellow | connecting… | Fetching live URI |
+| Green | watching sid=… | Polling normally |
+| Yellow | reconnecting… | Refreshing expired URI |
+| Red | auth failed | Login failed — check credentials |
+| Red | connect error | Initial connection failed |
+| Grey | stopped | Node stopped / redeployed |
+
+## Installation
+
+```bash
+npm install node-red-contrib-hoymiles-home
+```
+
+Or via the Node-RED palette manager: search for **hoymiles-home**.
+
+## Quick start
+
+1. Add a **hoymiles-watch** node to your flow
+2. Open it and create a new **Hoymiles Credentials** config node
+3. Enter your S-Miles Home **e-mail** and **password**
+4. Enter your **Station ID**
+5. Connect a **debug** node and click **Deploy**
+
+## Local development with Docker
+
+A Docker Compose setup is included for testing nodes without a full Node-RED installation.
+
+```bash
+# First start — builds the image and initialises the data volume
+docker compose up --build
+
+# After changing node code — restart is enough (nodes are bind-mounted)
+docker compose restart
+
+# After changing package.json or adding dependencies — rebuild
+docker compose up --build
+```
+
+Open **http://localhost:1880** — the **Hoymiles Test** flow is pre-loaded.
+
+## Releasing
+
+Versions are published to npm automatically via GitHub Actions when a tag is pushed.
+
+```bash
+# Stable release
+npm version minor   # or patch / major
+git push --follow-tags
+
+# Dev release (published with npm tag "dev", not "latest")
+npm version prerelease --preid=dev
+git push --follow-tags
+```
+
+Install a dev release:
+
+```bash
+npm install node-red-contrib-hoymiles-home@dev
+```
+
+## License
+
+MIT © Robin Lenz

package/nodes/hoymiles-config/hoymiles-config.js

@@ -129,16 +129,24 @@ module.exports = function (RED) {
             return;
         }
 
-        // loginReady resolves (never rejects) once the login attempt finishes.
-        // Dependents await this, then check node.client for success/failure.
-        node._loginReady = loginWithCredentials(email, password)
-            .then(token => {
-                node.client = new HoymilesClient(token);
-                node.log(`Logged in as ${email}`);
-            })
-            .catch(err => {
-                node.error(`Login failed: ${err.message}`);
-            });
+        // doLogin resolves (never rejects) and updates node.client on success.
+        function doLogin(label = 'Login') {
+            const p = loginWithCredentials(email, password)
+                .then(token => {
+                    node.client = new HoymilesClient(token);
+                    node.log(`${label} successful for ${email}`);
+                })
+                .catch(err => {
+                    node.error(`${label} failed: ${err.message}`);
+                });
+            node._loginReady = p;
+            return p;
+        }
+
+        // relogin() can be called by watch nodes when the token has expired.
+        node.relogin = () => doLogin('Re-login');
+
+        doLogin();
     }
 
     RED.nodes.registerType('hoymiles-config', HoymilesConfigNode, {

package/nodes/hoymiles-watch/hoymiles-watch.js

@@ -1,7 +1,5 @@
-const { APIError } = require('../hoymiles-config/hoymiles-config');
-
-const MIN_INTERVAL_MS   = 1000;
-const DEFAULT_DELAY_MS  = 5000;
+const MIN_INTERVAL_MS    = 1000;
+const DEFAULT_DELAY_MS   = 5000;
 const URI_RETRY_DELAY_MS = 3000;
 
 function sleep(ms) {
@@ -53,7 +51,17 @@ module.exports = function (RED) {
             currentTimer = null;
         }
 
-        async function watchLoop(client) {
+        // Re-authenticates via the config node and returns the fresh client.
+        async function reauth() {
+            node.status({ fill: 'yellow', shape: 'ring', text: 're-authenticating…' });
+            await configNode.relogin();
+            return configNode.client;
+        }
+
+        async function watchLoop() {
+            // client is mutable so re-auth can swap it in during the loop
+            let client = configNode.client;
+
             node.status({ fill: 'yellow', shape: 'ring', text: 'connecting…' });
 
             let uri, data;
@@ -79,15 +87,32 @@ module.exports = function (RED) {
                 try {
                     data = await fetchLive(client, uri);
 
-                    // No "flow" field → URI has expired, refresh
+                    // No "flow" field → URI expired, get a fresh one
                     if (!data || !('flow' in data)) {
-                        uri  = await getLiveUri(client);
-                        data = await fetchLive(client, uri);
+                        try {
+                            uri  = await getLiveUri(client);
+                            data = await fetchLive(client, uri);
+                        } catch (uriErr) {
+                            // URI fetch failed → token likely expired, re-authenticate
+                            node.warn(`URI refresh failed (${uriErr.message}) — re-authenticating`);
+                            const fresh = await reauth();
+                            if (fresh) {
+                                client = fresh;
+                                uri    = await getLiveUri(client);
+                                data   = await fetchLive(client, uri);
+                            }
+                        }
                     }
                 } catch (err) {
-                    node.warn(`Poll error: ${err.message} — refreshing URI`);
-                    node.status({ fill: 'yellow', shape: 'ring', text: 'reconnecting…' });
-                    try { uri = await getLiveUri(client); } catch (_) { /* ignore */ }
+                    node.warn(`Poll error: ${err.message} — re-authenticating`);
+                    node.status({ fill: 'yellow', shape: 'ring', text: 're-authenticating…' });
+                    try {
+                        const fresh = await reauth();
+                        if (fresh) {
+                            client = fresh;
+                            uri    = await getLiveUri(client);
+                        }
+                    } catch (_) { /* will retry next iteration */ }
                     await sleep(URI_RETRY_DELAY_MS);
                     node.status({ fill: 'green', shape: 'dot', text: `watching sid=${sid}` });
                 }
@@ -103,7 +128,6 @@ module.exports = function (RED) {
         }
 
         async function start() {
-            // Wait for the config node to finish logging in
             if (configNode._loginReady) {
                 node.status({ fill: 'yellow', shape: 'ring', text: 'authenticating…' });
                 await configNode._loginReady;
@@ -111,11 +135,11 @@ module.exports = function (RED) {
 
             if (!configNode.client) {
                 node.status({ fill: 'red', shape: 'ring', text: 'auth failed' });
-                return; // error already logged by the config node
+                return;
             }
 
             running = true;
-            await watchLoop(configNode.client);
+            await watchLoop();
         }
 
         node.on('close', (done) => { stop(); done(); });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-hoymiles-home",
-  "version": "0.1.1-dev.0",
+  "version": "0.1.2",
   "description": "Node-RED nodes for Hoymiles S-Miles Home API – live power data watch",
   "author": "Robin Lenz <pinguin45@web.de>",
   "license": "MIT",