node-red-contrib-alarm-ultimate 0.1.1 → 0.1.3

package/README.md

@@ -16,6 +16,7 @@ Alarm System Ultimate nodes + web panel for Node-RED.
 Includes:
 
 - `AlarmSystemUltimate` (BETA): full alarm control panel node (zones, entry/exit delays, bypass, chime, 24h/fire/tamper, siren, event log).
+- `AlarmUltimateInputAdapter`: translates incoming messages into zone messages for `AlarmSystemUltimate` using built-in or user-defined presets.
 - Output-only helper nodes: `AlarmUltimateState`, `AlarmUltimateZone`, `AlarmUltimateSiren`.
 - Web tools: Zones JSON mapper + web Alarm Panel (embeddable in Node-RED Dashboard).
 
@@ -73,6 +74,13 @@ These nodes have no input and emit the current Alarm state (and changes) for one
 - `Alarm Zone` (`AlarmUltimateZone`): `msg.payload = true|false` for a selected zone
 - `Alarm Siren` (`AlarmUltimateSiren`): `msg.payload = true|false` when the siren is on/off
 
+### Input Adapter
+
+`AlarmUltimateInputAdapter` translates incoming messages (from arbitrary sources) into the format expected by the Alarm zones.
+
+- Built-in presets are shipped with the package.
+- A single user preset (custom JavaScript) can be created/edited inside the node and is stored in the node configuration.
+
 ## Web tools
 
 These pages are served via the Node-RED admin HTTP endpoint:
@@ -84,6 +92,7 @@ The Alarm Panel supports:
 
 - Preselect node: `/alarm-ultimate/alarm-panel?id=<alarmNodeId>`
 - Embed mode (for Dashboard iframes): `/alarm-ultimate/alarm-panel?embed=1&id=<alarmNodeId>`
+- Views: `view=keypad`, `view=zones`, `view=log` (e.g. `/alarm-ultimate/alarm-panel?embed=1&view=log&id=<alarmNodeId>`)
 
 The Zones JSON Mapper supports:
 
@@ -95,6 +104,8 @@ The Zones JSON Mapper supports:
 - `examples/alarm-ultimate-basic.json`: ready-to-import flow with `AlarmSystemUltimate`, injects and debug nodes.
 - `examples/alarm-ultimate-dashboard.json`: Node-RED Dashboard example embedding the Alarm Panel in a `ui_template` iframe.
 - `examples/alarm-ultimate-dashboard-controls.json`: Node-RED Dashboard example with the embedded panel plus command buttons (and a small sensor simulator).
+- `examples/alarm-ultimate-dashboard-v2.json`: Dashboard 2.0 example for `@flowfuse/node-red-dashboard` (Alarm Panel + basic controls + status).
+- `examples/alarm-ultimate-home-assistant-alarm-panel.json`: Home Assistant Add-on example (no MQTT) using the HA Alarm Panel card + `AlarmUltimateInputAdapter`.
 
 See `examples/README.md`.
 
@@ -112,11 +123,14 @@ When Node-RED authentication is enabled, the admin endpoints use these permissio
 
 - `AlarmSystemUltimate.read`
 - `AlarmSystemUltimate.write`
+- `AlarmUltimateInputAdapter.read`
 
 HTTP admin endpoints:
 
 - `GET /alarm-ultimate/alarm/nodes`
 - `GET /alarm-ultimate/alarm/:id/state`
+- `GET /alarm-ultimate/alarm/:id/log`
+- `GET /alarm-ultimate/input-adapter/presets`
 - `POST /alarm-ultimate/alarm/:id/command`
 - `GET /alarm-ultimate/alarm-json-mapper`
 - `GET /alarm-ultimate/alarm-panel`

package/examples/README.md

@@ -12,13 +12,18 @@ This flow includes:
 - Inject nodes for arm/disarm, bypass, sensor open/close
 - Output-only nodes (`Alarm State`, `Alarm Zone`, `Alarm Siren`) connected to debug
 
+Notes:
+
+- The old Alarm “Translator” option has been removed. If you need to translate incoming device messages, use the `AlarmUltimateInputAdapter` node.
+- Zones can be edited from the Alarm node editor via the “Manage zones” button (opens the `alarm-json-mapper` tool).
+
 ## Dashboard (node-red-dashboard)
 
 Import `examples/alarm-ultimate-dashboard.json`.
 
 - Requires `node-red-dashboard` installed (`ui_*` nodes).
-- The widget uses an iframe pointing to `"/alarm-ultimate/alarm-panel?embed=1&id=<alarmNodeId>"`.
-- If you changed `httpAdminRoot`, update the iframe URL accordingly (e.g. `"/red/alarm-ultimate/alarm-panel?...`).
+- The widget uses an iframe pointing to `../alarm-ultimate/alarm-panel?embed=1&id=<alarmNodeId>` (escapes the Dashboard path like `/ui`).
+- The embedded panel supports `view=keypad`, `view=zones`, and `view=log`.
 
 ### Dashboard + commands (panel + controls)
 
@@ -26,4 +31,89 @@ Import `examples/alarm-ultimate-dashboard-controls.json`.
 
 - Includes the panel (iframe) + Dashboard buttons for `arm`, `disarm`, `status`, `list_open_zones`, `siren_on/off`, `panic`.
 - Also includes a small “sensor simulator” (buttons that send `true/false` on `sensor/frontdoor` and `sensor/living_pir`).
-- The iframe uses a *relative* URL (`alarm-ultimate/...`) so it works even when Node-RED is served under a path prefix (e.g. Home Assistant Ingress).
+- The iframe uses a _relative_ URL that escapes the Dashboard path (`../alarm-ultimate/...`) so it works even when Node-RED is served under a path prefix (e.g. Home Assistant Ingress).
+- The embedded panel supports `view=keypad`, `view=zones`, and `view=log` (useful to show a user-facing event log).
+
+## Dashboard V2 (FlowFuse / @flowfuse/node-red-dashboard)
+
+Import `examples/alarm-ultimate-dashboard-v2.json`.
+
+- Requires `@flowfuse/node-red-dashboard` installed (`ui-*` nodes).
+- Embeds the Alarm Panel via a Dashboard 2.0 `ui-template` (Vue SFC) iframe.
+- Includes basic command buttons (`arm`, `disarm`, `status`), a small sensor simulator, and two status widgets (`AlarmUltimateState`, `AlarmUltimateSiren` → `ui-text`).
+
+## Home Assistant (Alarm Panel card, no MQTT)
+
+If you run Node-RED as the Home Assistant Add-on and you want to use the standard Home Assistant Alarm Panel card, import:
+
+- `examples/alarm-ultimate-home-assistant-alarm-panel.json`
+
+This example:
+
+- Maps `binary_sensor.*` state changes (`"on"/"off"`) into Alarm zones using `AlarmUltimateInputAdapter` (built-in preset: **Home Assistant on/off**).
+- Receives arm/disarm commands from a Home Assistant Template Alarm Control Panel via the `alarm_ultimate_command` event.
+- Mirrors Alarm events back into Home Assistant by updating `input_select.alarm_ultimate_state`.
+
+### Setup steps
+
+1. **Install prerequisites**
+   - In Home Assistant, ensure the Node-RED Add-on is installed and running.
+   - In Node-RED, ensure `node-red-contrib-home-assistant-websocket` nodes are available.
+
+2. **Create the helper entity in Home Assistant**
+
+   Add this to your `configuration.yaml` (or a `template:`/`input_select:` include), then restart Home Assistant:
+
+   ```yaml
+   input_select:
+     alarm_ultimate_state:
+       name: Alarm Ultimate state
+       options:
+         - disarmed
+         - arming
+         - armed_away
+         - armed_home
+         - pending
+         - triggered
+   ```
+
+3. **Create the Template Alarm Control Panel**
+
+   This exposes an `alarm_control_panel` entity that the standard Home Assistant “Alarm Panel” dashboard card can use.
+
+   ```yaml
+   template:
+     - alarm_control_panel:
+         - name: "Alarm Ultimate"
+           unique_id: alarm_ultimate
+           state: "{{ states('input_select.alarm_ultimate_state') }}"
+           code_format: no_code
+           arm_away:
+             - event: alarm_ultimate_command
+               event_data:
+                 action: arm_away
+           arm_home:
+             - event: alarm_ultimate_command
+               event_data:
+                 action: arm_home
+           disarm:
+             - event: alarm_ultimate_command
+               event_data:
+                 action: disarm
+           trigger:
+             - event: alarm_ultimate_command
+               event_data:
+                 action: trigger
+   ```
+
+4. **Import and configure the Node-RED flow**
+   - Import `examples/alarm-ultimate-home-assistant-alarm-panel.json`.
+   - Open the Home Assistant server config node in the flow and ensure it’s set for the Add-on (default in the example).
+   - Edit the `server-state-changed` node to match your real sensors (replace the example `binary_sensor.*` entity ids).
+   - In the `AlarmSystemUltimate` node, set each zone `topic` to the matching Home Assistant entity id (same strings as above).
+
+5. **Add the Home Assistant dashboard card**
+   - Add the built-in “Alarm panel” card and select the entity `alarm_control_panel.alarm_ultimate`.
+
+Notes:
+- This integration uses a single Alarm “armed” state internally. The example maps `arm_home`/`arm_away` to HA states (`armed_home`/`armed_away`) for the UI by remembering the last requested arm mode.

package/examples/alarm-ultimate-basic.json

@@ -23,7 +23,6 @@
     "name": "Home Alarm",
     "controlTopic": "alarm",
     "payloadPropName": "payload",
-    "translatorConfig": "",
     "persistState": true,
     "requireCodeForArm": false,
     "requireCodeForDisarm": false,

package/examples/alarm-ultimate-dashboard-controls.json

@@ -11,7 +11,7 @@
     "type": "comment",
     "z": "b81f9a4b2f9c1a10",
     "name": "Requires node-red-dashboard",
-    "info": "Install `node-red-dashboard`, then import this flow.\n\nThe iframe uses a *relative* URL so it works even if Node-RED is hosted under a path prefix (eg Home Assistant Ingress).\nIf you changed `httpAdminRoot` / `httpRoot`, adjust the iframe URL accordingly.\n\nTip: Open the panel directly at `alarm-ultimate/alarm-panel?id=<alarmNodeId>` to test outside Dashboard.",
+    "info": "Install `node-red-dashboard`, then import this flow.\n\nThe iframe uses a *relative* URL that escapes the `/ui` path (`../alarm-ultimate/...`), so it works even if Node-RED is hosted under a path prefix (eg Home Assistant Ingress).\nIf you changed `httpAdminRoot` / `httpRoot`, adjust the iframe URL accordingly.\n\nTip: Open the panel directly at `alarm-ultimate/alarm-panel?id=<alarmNodeId>` to test outside Dashboard.",
     "x": 250,
     "y": 60,
     "wires": []
@@ -57,6 +57,17 @@
     "collapse": false,
     "className": ""
   },
+  {
+    "id": "d4c3c4e5f6078893",
+    "type": "ui_group",
+    "name": "Log",
+    "tab": "d9078c5d2b1a4f30",
+    "order": 4,
+    "disp": true,
+    "width": "12",
+    "collapse": false,
+    "className": ""
+  },
   {
     "id": "d0c1b2a3f4e50617",
     "type": "AlarmSystemUltimate",
@@ -64,7 +75,6 @@
     "name": "Home Alarm",
     "controlTopic": "alarm",
     "payloadPropName": "payload",
-    "translatorConfig": "",
     "persistState": true,
     "requireCodeForArm": false,
     "requireCodeForDisarm": false,
@@ -116,12 +126,32 @@
     "order": 1,
     "width": "12",
     "height": "18",
-    "format": "<iframe src=\"alarm-ultimate/alarm-panel?embed=1&id=d0c1b2a3f4e50617\" style=\"width:100%; height:720px; border:0; border-radius:10px;\"></iframe>",
+    "format": "<iframe src=\"../alarm-ultimate/alarm-panel?embed=1&id=d0c1b2a3f4e50617\" style=\"width:100%; height:720px; border:0; border-radius:10px;\"></iframe>",
     "storeOutMessages": false,
     "fwdInMessages": false,
     "resendOnRefresh": true,
     "templateScope": "local",
-    "className": ""
+    "className": "",
+    "x": 520,
+    "y": 180
+  },
+  {
+    "id": "e1f2a3b4c5d60719",
+    "type": "ui_template",
+    "z": "b81f9a4b2f9c1a10",
+    "group": "d4c3c4e5f6078893",
+    "name": "Alarm Log (embed)",
+    "order": 1,
+    "width": "12",
+    "height": "10",
+    "format": "<iframe src=\"../alarm-ultimate/alarm-panel?embed=1&view=log&id=d0c1b2a3f4e50617\" style=\"width:100%; height:420px; border:0; border-radius:10px;\"></iframe>",
+    "storeOutMessages": false,
+    "fwdInMessages": false,
+    "resendOnRefresh": true,
+    "templateScope": "local",
+    "className": "",
+    "x": 520,
+    "y": 240
   },
   {
     "id": "c44ac2b6af1a1e20",