node-red-contrib-hoymiles-home 0.1.1
Node-RED nodes for Hoymiles S-Miles Home API – live power data watch
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:
{
"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
npm install node-red-contrib-hoymiles-home
Or via the Node-RED palette manager: search for hoymiles-home.
Quick start
- Add a hoymiles-watch node to your flow
- Open it and create a new Hoymiles Credentials config node
- Enter your S-Miles Home e-mail and password
- Enter your Station ID
- 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.
# 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.
# 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:
npm install node-red-contrib-hoymiles-home@dev
License
MIT © Robin Lenz
