BetterCorp/BetterFrame
1
0
Fork 0
mirror of https://github.com/BetterCorp/BetterFrame.git synced 2026-05-26 17:56:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
BetterFrame/nodered/README.md

59 lines
2.7 KiB
Markdown
Raw Normal View History

feat: Node-RED custom nodes + dashboard entity type Node-RED nodes (nodered/): - bf-config: shared server URL + admin API key - bf-event-in: filter kiosk events by topic glob - bf-layout-switch: POST display layout-switch - bf-power: kiosk wake/standby - bf-fan: kiosk fan control - bf-cameras: query camera list - Drag-droppable from Node-RED palette Server: - Admin Bearer API key auth on /admin/* (NodeRED can call admin API) - GET /api/admin/cameras for bf-cameras node - Dashboard entity type: - entities.type CHECK adds 'dashboard' - entities.dashboard_id column - shared/nodered-bridge.ts listDashboards() polls /nrdp/flows - Bundle resolves dashboard entity → web cell at /dash/<id> - POST /admin/entities/sync-dashboards mirrors Node-RED tabs - EntitiesPage shows Dashboards section + Sync button - EntityEditPage for dashboard: read-only + "Open in Node-RED" - No create/delete from BF UI — managed in Node-RED - sec-config: noderedUrl on admin-http (was already on api-http)
2026-05-12 23:47:53 +00:00
# @betterframe/nodered-nodes
BetterFrame integration nodes for Node-RED. Drag-and-droppable nodes for the
BetterFrame admin REST API and kiosk event ingest.
## Nodes
feat: restructure Node-RED nodes + server event emission Renames: - bf-config → bf-server-config (config node clarity) - bf-event-in → bf-kiosk-camera-event (specific camera trigger) New trigger nodes (input-only, under "BetterFrame Triggers"): - bf-trigger-display-power, bf-trigger-layout-changed, bf-trigger-kiosk-changed, bf-trigger-camera-changed New flow nodes: - bf-config-get: query state by type (displays/kiosks/cameras/layouts/ entities, or by-id) - bf-config-set: mutate via typed setters (default-layout, enabled, priority, name) Server-side event emission: - shared/strip-secrets.ts: recursive password scrub - New JSON admin endpoints: GET/POST /api/admin/{displays,kiosks, layouts,entities}[/:id] - Coordinator-ws fires kiosk.changed on connect/disconnect/heartbeat - Layout/power/camera routes call nodered.forward() on state change
2026-05-13 00:26:08 +00:00
| Node | Category | Purpose |
feat: Node-RED custom nodes + dashboard entity type Node-RED nodes (nodered/): - bf-config: shared server URL + admin API key - bf-event-in: filter kiosk events by topic glob - bf-layout-switch: POST display layout-switch - bf-power: kiosk wake/standby - bf-fan: kiosk fan control - bf-cameras: query camera list - Drag-droppable from Node-RED palette Server: - Admin Bearer API key auth on /admin/* (NodeRED can call admin API) - GET /api/admin/cameras for bf-cameras node - Dashboard entity type: - entities.type CHECK adds 'dashboard' - entities.dashboard_id column - shared/nodered-bridge.ts listDashboards() polls /nrdp/flows - Bundle resolves dashboard entity → web cell at /dash/<id> - POST /admin/entities/sync-dashboards mirrors Node-RED tabs - EntitiesPage shows Dashboards section + Sync button - EntityEditPage for dashboard: read-only + "Open in Node-RED" - No create/delete from BF UI — managed in Node-RED - sec-config: noderedUrl on admin-http (was already on api-http)
2026-05-12 23:47:53 +00:00
| --- | --- | --- |
feat: restructure Node-RED nodes + server event emission Renames: - bf-config → bf-server-config (config node clarity) - bf-event-in → bf-kiosk-camera-event (specific camera trigger) New trigger nodes (input-only, under "BetterFrame Triggers"): - bf-trigger-display-power, bf-trigger-layout-changed, bf-trigger-kiosk-changed, bf-trigger-camera-changed New flow nodes: - bf-config-get: query state by type (displays/kiosks/cameras/layouts/ entities, or by-id) - bf-config-set: mutate via typed setters (default-layout, enabled, priority, name) Server-side event emission: - shared/strip-secrets.ts: recursive password scrub - New JSON admin endpoints: GET/POST /api/admin/{displays,kiosks, layouts,entities}[/:id] - Coordinator-ws fires kiosk.changed on connect/disconnect/heartbeat - Layout/power/camera routes call nodered.forward() on state change
2026-05-13 00:26:08 +00:00
| `bf-server-config` | config | Shared server URL + admin API key |
| `bf-kiosk-camera-event` | Triggers | Filter incoming kiosk camera events (default `camera.*`) |
| `bf-trigger-display-power` | Triggers | Fires on `display.power.changed` |
| `bf-trigger-layout-changed` | Triggers | Fires on `layout.changed` |
| `bf-trigger-kiosk-changed` | Triggers | Fires on `kiosk.changed` (connect/disconnect/heartbeat) |
| `bf-trigger-camera-changed` | Triggers | Fires on `camera.changed` (created/updated/deleted) |
feat: bf-status (action + trigger) + bf-snapshot (action) nodes - bf-status: query kiosk state by ID via /api/admin/kiosks/:id - bf-trigger-status: dedicated heartbeat-only topic kiosk.status (skips connect/disconnect noise from kiosk.changed) - bf-snapshot: GET /admin/entities/:id/snapshot as Buffer for motion → email/telegram flows - coordinator-ws now forwards both kiosk.changed (event=heartbeat) AND kiosk.status on every status message
2026-05-13 00:29:12 +00:00
| `bf-trigger-status` | Triggers | Fires on `kiosk.status` (heartbeat-only telemetry; optional kiosk_id filter) |
feat: restructure Node-RED nodes + server event emission Renames: - bf-config → bf-server-config (config node clarity) - bf-event-in → bf-kiosk-camera-event (specific camera trigger) New trigger nodes (input-only, under "BetterFrame Triggers"): - bf-trigger-display-power, bf-trigger-layout-changed, bf-trigger-kiosk-changed, bf-trigger-camera-changed New flow nodes: - bf-config-get: query state by type (displays/kiosks/cameras/layouts/ entities, or by-id) - bf-config-set: mutate via typed setters (default-layout, enabled, priority, name) Server-side event emission: - shared/strip-secrets.ts: recursive password scrub - New JSON admin endpoints: GET/POST /api/admin/{displays,kiosks, layouts,entities}[/:id] - Coordinator-ws fires kiosk.changed on connect/disconnect/heartbeat - Layout/power/camera routes call nodered.forward() on state change
2026-05-13 00:26:08 +00:00
| `bf-layout-switch` | BetterFrame | Switch a display's active layout |
| `bf-power` | BetterFrame | Wake / standby a kiosk display |
| `bf-fan` | BetterFrame | Set fan mode (auto/pwm) on a kiosk |
| `bf-cameras` | BetterFrame | Fetch the camera list |
| `bf-config-get` | BetterFrame | Fetch BF state (displays/kiosks/cameras/layouts/entities, by id or full list) |
| `bf-config-set` | BetterFrame | Mutate BF state (default layout, enabled, priority, name) |
feat: bf-status (action + trigger) + bf-snapshot (action) nodes - bf-status: query kiosk state by ID via /api/admin/kiosks/:id - bf-trigger-status: dedicated heartbeat-only topic kiosk.status (skips connect/disconnect noise from kiosk.changed) - bf-snapshot: GET /admin/entities/:id/snapshot as Buffer for motion → email/telegram flows - coordinator-ws now forwards both kiosk.changed (event=heartbeat) AND kiosk.status on every status message
2026-05-13 00:29:12 +00:00
| `bf-status` | BetterFrame | Fetch current kiosk state by ID (telemetry, last_seen_at, etc.) |
| `bf-snapshot` | BetterFrame | Fetch a JPEG snapshot for a camera entity (binary Buffer payload) |
feat: Node-RED custom nodes + dashboard entity type Node-RED nodes (nodered/): - bf-config: shared server URL + admin API key - bf-event-in: filter kiosk events by topic glob - bf-layout-switch: POST display layout-switch - bf-power: kiosk wake/standby - bf-fan: kiosk fan control - bf-cameras: query camera list - Drag-droppable from Node-RED palette Server: - Admin Bearer API key auth on /admin/* (NodeRED can call admin API) - GET /api/admin/cameras for bf-cameras node - Dashboard entity type: - entities.type CHECK adds 'dashboard' - entities.dashboard_id column - shared/nodered-bridge.ts listDashboards() polls /nrdp/flows - Bundle resolves dashboard entity → web cell at /dash/<id> - POST /admin/entities/sync-dashboards mirrors Node-RED tabs - EntitiesPage shows Dashboards section + Sync button - EntityEditPage for dashboard: read-only + "Open in Node-RED" - No create/delete from BF UI — managed in Node-RED - sec-config: noderedUrl on admin-http (was already on api-http)
2026-05-12 23:47:53 +00:00
## Authentication
All action/query nodes use an **admin-scoped API key** created in the
BetterFrame admin UI. The key is sent as `Authorization: Bearer bf-...`.
feat: restructure Node-RED nodes + server event emission Renames: - bf-config → bf-server-config (config node clarity) - bf-event-in → bf-kiosk-camera-event (specific camera trigger) New trigger nodes (input-only, under "BetterFrame Triggers"): - bf-trigger-display-power, bf-trigger-layout-changed, bf-trigger-kiosk-changed, bf-trigger-camera-changed New flow nodes: - bf-config-get: query state by type (displays/kiosks/cameras/layouts/ entities, or by-id) - bf-config-set: mutate via typed setters (default-layout, enabled, priority, name) Server-side event emission: - shared/strip-secrets.ts: recursive password scrub - New JSON admin endpoints: GET/POST /api/admin/{displays,kiosks, layouts,entities}[/:id] - Coordinator-ws fires kiosk.changed on connect/disconnect/heartbeat - Layout/power/camera routes call nodered.forward() on state change
2026-05-13 00:26:08 +00:00
Configure once on a `bf-server-config` node and reference it from the others.
feat: Node-RED custom nodes + dashboard entity type Node-RED nodes (nodered/): - bf-config: shared server URL + admin API key - bf-event-in: filter kiosk events by topic glob - bf-layout-switch: POST display layout-switch - bf-power: kiosk wake/standby - bf-fan: kiosk fan control - bf-cameras: query camera list - Drag-droppable from Node-RED palette Server: - Admin Bearer API key auth on /admin/* (NodeRED can call admin API) - GET /api/admin/cameras for bf-cameras node - Dashboard entity type: - entities.type CHECK adds 'dashboard' - entities.dashboard_id column - shared/nodered-bridge.ts listDashboards() polls /nrdp/flows - Bundle resolves dashboard entity → web cell at /dash/<id> - POST /admin/entities/sync-dashboards mirrors Node-RED tabs - EntitiesPage shows Dashboards section + Sync button - EntityEditPage for dashboard: read-only + "Open in Node-RED" - No create/delete from BF UI — managed in Node-RED - sec-config: noderedUrl on admin-http (was already on api-http)
2026-05-12 23:47:53 +00:00
## Event ingest path
feat: restructure Node-RED nodes + server event emission Renames: - bf-config → bf-server-config (config node clarity) - bf-event-in → bf-kiosk-camera-event (specific camera trigger) New trigger nodes (input-only, under "BetterFrame Triggers"): - bf-trigger-display-power, bf-trigger-layout-changed, bf-trigger-kiosk-changed, bf-trigger-camera-changed New flow nodes: - bf-config-get: query state by type (displays/kiosks/cameras/layouts/ entities, or by-id) - bf-config-set: mutate via typed setters (default-layout, enabled, priority, name) Server-side event emission: - shared/strip-secrets.ts: recursive password scrub - New JSON admin endpoints: GET/POST /api/admin/{displays,kiosks, layouts,entities}[/:id] - Coordinator-ws fires kiosk.changed on connect/disconnect/heartbeat - Layout/power/camera routes call nodered.forward() on state change
2026-05-13 00:26:08 +00:00
Trigger nodes are pure filters — they do not subscribe to the BF server.
feat: Node-RED custom nodes + dashboard entity type Node-RED nodes (nodered/): - bf-config: shared server URL + admin API key - bf-event-in: filter kiosk events by topic glob - bf-layout-switch: POST display layout-switch - bf-power: kiosk wake/standby - bf-fan: kiosk fan control - bf-cameras: query camera list - Drag-droppable from Node-RED palette Server: - Admin Bearer API key auth on /admin/* (NodeRED can call admin API) - GET /api/admin/cameras for bf-cameras node - Dashboard entity type: - entities.type CHECK adds 'dashboard' - entities.dashboard_id column - shared/nodered-bridge.ts listDashboards() polls /nrdp/flows - Bundle resolves dashboard entity → web cell at /dash/<id> - POST /admin/entities/sync-dashboards mirrors Node-RED tabs - EntitiesPage shows Dashboards section + Sync button - EntityEditPage for dashboard: read-only + "Open in Node-RED" - No create/delete from BF UI — managed in Node-RED - sec-config: noderedUrl on admin-http (was already on api-http)
2026-05-12 23:47:53 +00:00
Wire an upstream `http in` node on `/in/kiosk/<topic>` (BetterFrame's
authenticated kiosk-ingest endpoint, surfaced by the Angie proxy with
feat: restructure Node-RED nodes + server event emission Renames: - bf-config → bf-server-config (config node clarity) - bf-event-in → bf-kiosk-camera-event (specific camera trigger) New trigger nodes (input-only, under "BetterFrame Triggers"): - bf-trigger-display-power, bf-trigger-layout-changed, bf-trigger-kiosk-changed, bf-trigger-camera-changed New flow nodes: - bf-config-get: query state by type (displays/kiosks/cameras/layouts/ entities, or by-id) - bf-config-set: mutate via typed setters (default-layout, enabled, priority, name) Server-side event emission: - shared/strip-secrets.ts: recursive password scrub - New JSON admin endpoints: GET/POST /api/admin/{displays,kiosks, layouts,entities}[/:id] - Coordinator-ws fires kiosk.changed on connect/disconnect/heartbeat - Layout/power/camera routes call nodered.forward() on state change
2026-05-13 00:26:08 +00:00
`auth_request` gating) and feed its `msg.payload` into the matching
`bf-trigger-*` node. The server emits these topics from coordinator-ws
(kiosk WS lifecycle) and the admin routes (layout/power/camera mutations).
feat: Node-RED custom nodes + dashboard entity type Node-RED nodes (nodered/): - bf-config: shared server URL + admin API key - bf-event-in: filter kiosk events by topic glob - bf-layout-switch: POST display layout-switch - bf-power: kiosk wake/standby - bf-fan: kiosk fan control - bf-cameras: query camera list - Drag-droppable from Node-RED palette Server: - Admin Bearer API key auth on /admin/* (NodeRED can call admin API) - GET /api/admin/cameras for bf-cameras node - Dashboard entity type: - entities.type CHECK adds 'dashboard' - entities.dashboard_id column - shared/nodered-bridge.ts listDashboards() polls /nrdp/flows - Bundle resolves dashboard entity → web cell at /dash/<id> - POST /admin/entities/sync-dashboards mirrors Node-RED tabs - EntitiesPage shows Dashboards section + Sync button - EntityEditPage for dashboard: read-only + "Open in Node-RED" - No create/delete from BF UI — managed in Node-RED - sec-config: noderedUrl on admin-http (was already on api-http)
2026-05-12 23:47:53 +00:00
## Installation
### Dev (single-host BetterFrame install)
```sh
# Symlink the package into Node-RED's user dir so edits hot-reload.
ln -s "$(pwd)/nodered" ~/.node-red/node_modules/@betterframe/nodered-nodes
# Restart Node-RED.
```
### Docker compose
The compose stack mounts `nodered-data` as `/data`. Either:
- bake the package into the Node-RED image by extending the Dockerfile with
`npm install /repo/nodered`, or
- mount `./nodered` into `/data/node_modules/@betterframe/nodered-nodes` and
restart the container.
Reference in a new issue Copy permalink