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

package/README.md

@@ -92,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:
 
@@ -104,6 +105,7 @@ The Zones JSON Mapper supports:
 - `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`.
 
@@ -127,6 +129,7 @@ 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`

package/examples/README.md

@@ -22,8 +22,8 @@ Notes:
 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)
 
@@ -31,7 +31,8 @@ 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)
 
@@ -40,3 +41,79 @@ 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-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",
@@ -115,7 +126,7 @@
     "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,
@@ -124,6 +135,24 @@
     "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",
     "type": "ui_button",

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

@@ -11,7 +11,7 @@
     "type": "comment",
     "z": "c0a4b6d3e5f70819",
     "name": "Requires @flowfuse/node-red-dashboard",
-    "info": "Install `@flowfuse/node-red-dashboard` (Dashboard 2.0), then import this flow.\n\nDashboard V2 URLs (default):\n- Panel:    http://<node-red-host>:1880/dashboard/panel\n- Controls: http://<node-red-host>:1880/dashboard/controls\n- Sensors:  http://<node-red-host>:1880/dashboard/sensors\n- Zones:    http://<node-red-host>:1880/dashboard/zones\n- Status:   http://<node-red-host>:1880/dashboard/status\n\nNotes:\n- If you changed the Dashboard path in the `ui-base` config, adjust `/dashboard` accordingly.\n- The embedded Alarm Panel is served from Node-RED *admin* endpoints (`/alarm-ultimate/alarm-panel`).",
+    "info": "Install `@flowfuse/node-red-dashboard` (Dashboard 2.0), then import this flow.\n\nDashboard V2 URLs (default):\n- Panel:    http://<node-red-host>:1880/dashboard/panel\n- Controls: http://<node-red-host>:1880/dashboard/controls\n- Sensors:  http://<node-red-host>:1880/dashboard/sensors\n- Zones:    http://<node-red-host>:1880/dashboard/zones\n- Log:      http://<node-red-host>:1880/dashboard/log\n- Status:   http://<node-red-host>:1880/dashboard/status\n\nNotes:\n- If you changed the Dashboard path in the `ui-base` config, adjust `/dashboard` accordingly.\n- The embedded Alarm Panel is served from Node-RED *admin* endpoints (`/alarm-ultimate/alarm-panel`).",
     "x": 290,
     "y": 60,
     "wires": []
@@ -100,6 +100,28 @@
       []
     ]
   },
+  {
+    "id": "2d3e4f5061728394",
+    "type": "ui-template",
+    "z": "c0a4b6d3e5f70819",
+    "group": "5c6d7e8f901a2b3c",
+    "name": "Log (embed)",
+    "order": 1,
+    "width": 12,
+    "height": 14,
+    "head": "",
+    "format": "<template>\n  <iframe :src=\"panelUrl\" style=\"width:100%; height:560px; border:0; border-radius:10px;\"></iframe>\n</template>\n\n<script>\nexport default {\n  data () {\n    return {\n      panelUrl: ''\n    }\n  },\n  mounted () {\n    const alarmNodeId = 'a2b3c4d5e6f70819'\n    const setupUrl = new URL('../_setup', window.location.href)\n\n    fetch(setupUrl)\n      .then(r => r.json())\n      .then(setup => {\n        const httpAdminRoot = setup?.RED?.httpAdminRoot ?? '/'\n        const root = httpAdminRoot.endsWith('/') ? httpAdminRoot : `${httpAdminRoot}/`\n        this.panelUrl = `${root}alarm-ultimate/alarm-panel?embed=1&view=log&id=${encodeURIComponent(alarmNodeId)}`\n      })\n      .catch(() => {\n        const relative = `../alarm-ultimate/alarm-panel?embed=1&view=log&id=${encodeURIComponent(alarmNodeId)}`\n        this.panelUrl = new URL(relative, window.location.href).toString()\n      })\n  }\n}\n</script>\n",
+    "storeOutMessages": true,
+    "passthru": true,
+    "resendOnRefresh": true,
+    "templateScope": "local",
+    "className": "",
+    "x": 1090,
+    "y": 200,
+    "wires": [
+      []
+    ]
+  },
   {
     "id": "b4c5d6e7f8091a2b",
     "type": "function",
@@ -653,6 +675,42 @@
     "visible": true,
     "disabled": false
   },
+  {
+    "id": "f5060718293b4c5d",
+    "type": "ui-page",
+    "name": "Log",
+    "ui": "c4d5e6f708192a3b",
+    "path": "/log",
+    "icon": "format-list-text",
+    "layout": "grid",
+    "theme": "b3c4d5e6f708192a",
+    "breakpoints": [
+      {
+        "name": "Default",
+        "px": 0,
+        "cols": 12
+      },
+      {
+        "name": "Tablet",
+        "px": 576,
+        "cols": 12
+      },
+      {
+        "name": "Small Desktop",
+        "px": 768,
+        "cols": 12
+      },
+      {
+        "name": "Desktop",
+        "px": 1024,
+        "cols": 12
+      }
+    ],
+    "order": 5,
+    "className": "",
+    "visible": true,
+    "disabled": false
+  },
   {
     "id": "d3e4f5060718293a",
     "type": "ui-page",
@@ -684,7 +742,7 @@
         "cols": 12
       }
     ],
-    "order": 5,
+    "order": 6,
     "className": "",
     "visible": true,
     "disabled": false
@@ -758,5 +816,19 @@
     "visible": true,
     "disabled": false,
     "groupType": "default"
+  },
+  {
+    "id": "5c6d7e8f901a2b3c",
+    "type": "ui-group",
+    "name": "Log",
+    "page": "f5060718293b4c5d",
+    "width": 12,
+    "height": 1,
+    "order": 1,
+    "showTitle": true,
+    "className": "",
+    "visible": true,
+    "disabled": false,
+    "groupType": "default"
   }
 ]

package/examples/alarm-ultimate-dashboard.json

@@ -11,7 +11,7 @@
     "type": "comment",
     "z": "a9f3e19b2b7c4d01",
     "name": "Requires node-red-dashboard",
-    "info": "Installa `node-red-dashboard`, poi importa questo flow.\n\nSe hai cambiato `httpAdminRoot`, modifica l'URL dell'iframe nel nodo ui_template.",
+    "info": "Installa `node-red-dashboard`, poi importa questo flow.\n\nL'iframe usa un URL *relativo* che esce da `/ui` (`../alarm-ultimate/...`) così funziona anche con un path prefix (es. Home Assistant Ingress).\nPuoi usare anche `view=log` per mostrare il registro eventi all'utente.",
     "x": 200,
     "y": 60,
     "wires": []
@@ -35,6 +35,17 @@
     "collapse": false,
     "className": ""
   },
+  {
+    "id": "1e2d3c4b5a697801",
+    "type": "ui_group",
+    "name": "Log",
+    "tab": "f1c9d0f3d9b8a001",
+    "order": 2,
+    "disp": true,
+    "width": "12",
+    "collapse": false,
+    "className": ""
+  },
   {
     "id": "a1b2c3d4e5f6a7b8",
     "type": "AlarmSystemUltimate",
@@ -87,7 +98,7 @@
     "order": 1,
     "width": "12",
     "height": "18",
-    "format": "<iframe src=\"/alarm-ultimate/alarm-panel?embed=1&id=a1b2c3d4e5f6a7b8\" style=\"width:100%; height:720px; border:0; border-radius:10px;\"></iframe>",
+    "format": "<iframe src=\"../alarm-ultimate/alarm-panel?embed=1&id=a1b2c3d4e5f6a7b8\" style=\"width:100%; height:720px; border:0; border-radius:10px;\"></iframe>",
     "storeOutMessages": false,
     "fwdInMessages": false,
     "resendOnRefresh": true,
@@ -95,5 +106,23 @@
     "className": "",
     "x": 520,
     "y": 160
+  },
+  {
+    "id": "2f1e0d3c4b5a6978",
+    "type": "ui_template",
+    "z": "a9f3e19b2b7c4d01",
+    "group": "1e2d3c4b5a697801",
+    "name": "Alarm Log (embed)",
+    "order": 1,
+    "width": "12",
+    "height": "10",
+    "format": "<iframe src=\"../alarm-ultimate/alarm-panel?embed=1&view=log&id=a1b2c3d4e5f6a7b8\" style=\"width:100%; height:420px; border:0; border-radius:10px;\"></iframe>",
+    "storeOutMessages": false,
+    "fwdInMessages": false,
+    "resendOnRefresh": true,
+    "templateScope": "local",
+    "className": "",
+    "x": 520,
+    "y": 220
   }
 ]