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

package/examples/alarm-ultimate-home-assistant-alarm-panel.json

@@ -0,0 +1,335 @@
+[
+  {
+    "id": "b3b0c2c1a9e7d001",
+    "type": "tab",
+    "label": "Alarm Ultimate - Home Assistant (Alarm Panel)",
+    "disabled": false,
+    "info": ""
+  },
+  {
+    "id": "8b2d0e6a71a54e10",
+    "type": "comment",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "Home Assistant integration (no MQTT)",
+    "info": "Requires `node-red-contrib-home-assistant-websocket`.\n\nThis example is designed for Node-RED running as the Home Assistant Add-on.\n\nWhat it does:\n- Takes Home Assistant `binary_sensor.*` state changes (\"on\"/\"off\") and feeds Alarm zones.\n- Receives arm/disarm commands from a Home Assistant Template Alarm Control Panel via an HA event.\n- Mirrors Alarm events back into Home Assistant by updating `input_select.alarm_ultimate_state`.\n\nYou must create in Home Assistant:\n1) An input_select named `input_select.alarm_ultimate_state` with options:\n   - disarmed\n   - arming\n   - armed_away\n   - armed_home\n   - pending\n   - triggered\n2) A Template Alarm Control Panel (example YAML):\n\ntemplate:\n  - alarm_control_panel:\n      - name: \"Alarm Ultimate\"\n        unique_id: alarm_ultimate\n        state: \"{{ states('input_select.alarm_ultimate_state') }}\"\n        code_format: no_code\n        arm_away:\n          - event: alarm_ultimate_command\n            event_data:\n              action: arm_away\n        arm_home:\n          - event: alarm_ultimate_command\n            event_data:\n              action: arm_home\n        disarm:\n          - event: alarm_ultimate_command\n            event_data:\n              action: disarm\n        trigger:\n          - event: alarm_ultimate_command\n            event_data:\n              action: trigger\n\nThen add the standard HA \"Alarm panel\" card and select this entity.\n\nEdit these entities in this flow:\n- binary_sensor.front_door_contact\n- binary_sensor.living_room_motion\n\nAnd edit the Alarm zones topic to match those entity_ids (already set in this example).\n",
+    "x": 330,
+    "y": 60,
+    "wires": []
+  },
+  {
+    "id": "a6c9d8f2b7f24a10",
+    "type": "server",
+    "name": "Home Assistant",
+    "addon": true,
+    "rejectUnauthorizedCerts": true,
+    "ha_boolean": "y|yes|true|on|home|open",
+    "connectionDelay": true,
+    "cacheJson": true,
+    "heartbeat": false,
+    "heartbeatInterval": "30",
+    "areaSelector": "id",
+    "deviceSelector": "id",
+    "entitySelector": "id",
+    "statusSeparator": "at: ",
+    "statusYear": "hidden",
+    "statusMonth": "short",
+    "statusDay": "numeric",
+    "statusHourCycle": "default",
+    "statusTimeFormat": "h:m",
+    "enableGlobalContextStore": false,
+    "version": 5
+  },
+  {
+    "id": "d0c1b2a3f4e50617",
+    "type": "AlarmSystemUltimate",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "Home Alarm",
+    "controlTopic": "alarm",
+    "payloadPropName": "payload",
+    "persistState": true,
+    "requireCodeForArm": false,
+    "requireCodeForDisarm": false,
+    "armCode": "",
+    "duressCode": "",
+    "blockArmOnViolations": true,
+    "exitDelaySeconds": 10,
+    "entryDelaySeconds": 30,
+    "emitOpenZonesDuringArming": false,
+    "openZonesArmingIntervalSeconds": 1,
+    "openZonesRequestTopic": "alarm/listOpenZones",
+    "openZonesRequestIntervalSeconds": 0,
+    "sirenDurationSeconds": 180,
+    "sirenLatchUntilDisarm": false,
+    "sirenTopic": "alarm/siren",
+    "sirenOnPayload": true,
+    "sirenOnPayloadType": "bool",
+    "sirenOffPayload": false,
+    "sirenOffPayloadType": "bool",
+    "emitRestoreEvents": false,
+    "maxLogEntries": 200,
+    "zones": "[\n  {\n    \"id\": \"front_door\",\n    \"name\": \"Front door\",\n    \"topic\": \"binary_sensor.front_door_contact\",\n    \"type\": \"perimeter\",\n    \"entry\": true,\n    \"bypassable\": true,\n    \"chime\": true\n  },\n  {\n    \"id\": \"living_pir\",\n    \"name\": \"Living room motion\",\n    \"topic\": \"binary_sensor.living_room_motion\",\n    \"type\": \"motion\",\n    \"entry\": false,\n    \"bypassable\": true,\n    \"cooldownSeconds\": 10\n  }\n]",
+    "x": 760,
+    "y": 240,
+    "wires": [
+      [
+        "e3e4f5060718293a",
+        "3f50b6a7c1c8b3d10"
+      ],
+      [
+        "3f50b6a7c1c8b3d11"
+      ],
+      [],
+      [],
+      [],
+      [
+        "3f50b6a7c1c8b3d12"
+      ],
+      [],
+      [],
+      []
+    ]
+  },
+  {
+    "id": "c44ac2b6af1a1e2a",
+    "type": "AlarmUltimateInputAdapter",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "HA sensors on/off → boolean",
+    "presetSource": "builtin",
+    "presetId": "home_assistant_on_off",
+    "userCode": "return msg;",
+    "x": 500,
+    "y": 240,
+    "wires": [
+      [
+        "d0c1b2a3f4e50617"
+      ]
+    ]
+  },
+  {
+    "id": "c2b3a4d5e6f70819",
+    "type": "server-state-changed",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "HA binary_sensor.* → Alarm zones",
+    "server": "a6c9d8f2b7f24a10",
+    "version": 6,
+    "outputs": 1,
+    "exposeAsEntityConfig": "",
+    "entities": {
+      "entity": [
+        "binary_sensor.front_door_contact",
+        "binary_sensor.living_room_motion"
+      ],
+      "substring": [],
+      "regex": []
+    },
+    "outputInitially": true,
+    "stateType": "str",
+    "ifState": "",
+    "ifStateType": "str",
+    "ifStateOperator": "is",
+    "outputOnlyOnStateChange": true,
+    "for": "0",
+    "forType": "num",
+    "forUnits": "seconds",
+    "ignorePrevStateNull": false,
+    "ignorePrevStateUnknown": false,
+    "ignorePrevStateUnavailable": false,
+    "ignoreCurrentStateUnknown": false,
+    "ignoreCurrentStateUnavailable": false,
+    "outputProperties": [
+      {
+        "property": "topic",
+        "propertyType": "msg",
+        "value": "triggerId",
+        "valueType": "eventData"
+      },
+      {
+        "property": "payload",
+        "propertyType": "msg",
+        "value": "new_state.state",
+        "valueType": "eventData"
+      }
+    ],
+    "x": 220,
+    "y": 240,
+    "wires": [
+      [
+        "c44ac2b6af1a1e2a"
+      ]
+    ]
+  },
+  {
+    "id": "e1f2a3b4c5d60718",
+    "type": "server-events",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "HA event: alarm_ultimate_command",
+    "server": "a6c9d8f2b7f24a10",
+    "version": 3,
+    "exposeAsEntityConfig": "",
+    "eventType": "alarm_ultimate_command",
+    "eventData": "",
+    "waitForRunning": true,
+    "outputProperties": [
+      {
+        "property": "payload",
+        "propertyType": "msg",
+        "value": "",
+        "valueType": "eventData"
+      }
+    ],
+    "x": 230,
+    "y": 380,
+    "wires": [
+      [
+        "f2a3b4c5d6e70819"
+      ]
+    ]
+  },
+  {
+    "id": "f2a3b4c5d6e70819",
+    "type": "function",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "HA command → Alarm control msg",
+    "func": "const root = msg && typeof msg === \"object\" ? msg : {};\nconst eventData = root.payload && typeof root.payload === \"object\" ? root.payload : {};\nconst ev = eventData.event && typeof eventData.event === \"object\" ? eventData.event : {};\n\nconst action = String(ev.action || ev.command || \"\").trim().toLowerCase();\nconst mode = String(ev.mode || \"\").trim().toLowerCase();\nconst code = typeof ev.code === \"string\" ? ev.code.trim() : \"\";\n\nif (!action) return null;\n\nconst out = { topic: \"alarm\" };\n\nif (action === \"disarm\") {\n  out.command = \"disarm\";\n} else if (action === \"trigger\" || action === \"panic\") {\n  out.command = \"panic\";\n} else if (action.startsWith(\"arm\")) {\n  out.command = \"arm\";\n} else {\n  return null;\n}\n\nif (code) out.code = code;\nif (mode) {\n  // AlarmSystemUltimate maps legacy modes to \"armed\".\n  out.mode = mode;\n}\n\n// Remember last requested arm mode to map HA state on \"armed\" events.\nif (out.command === \"arm\") {\n  const map = {\n    arm_home: \"armed_home\",\n    arm_away: \"armed_away\",\n    arm_night: \"armed_home\",\n    arm: \"armed_away\",\n  };\n  flow.set(\"alarmUltimate:lastArmMode\", map[action] || \"armed_away\");\n}\n\nreturn out;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 520,
+    "y": 380,
+    "wires": [
+      [
+        "d0c1b2a3f4e50617"
+      ]
+    ]
+  },
+  {
+    "id": "e3e4f5060718293a",
+    "type": "function",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "Alarm events → HA alarm state",
+    "func": "const evt = msg && typeof msg.event === \"string\" ? msg.event : \"\";\nlet haState = null;\n\nif (evt === \"disarmed\" || evt === \"reset\") {\n  haState = \"disarmed\";\n} else if (evt === \"arming\") {\n  haState = \"arming\";\n} else if (evt === \"armed\") {\n  haState = flow.get(\"alarmUltimate:lastArmMode\") || \"armed_away\";\n} else if (evt === \"entry_delay\") {\n  haState = \"pending\";\n} else if (evt === \"alarm\") {\n  haState = \"triggered\";\n}\n\nif (!haState) return null;\n\nmsg.haState = haState;\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 520,
+    "y": 500,
+    "wires": [
+      [
+        "a1b2c3d4e5f60718"
+      ]
+    ]
+  },
+  {
+    "id": "a1b2c3d4e5f60718",
+    "type": "api-call-service",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "Set input_select.alarm_ultimate_state",
+    "server": "a6c9d8f2b7f24a10",
+    "version": 5,
+    "debugenabled": false,
+    "domain": "input_select",
+    "service": "select_option",
+    "areaId": [],
+    "deviceId": [],
+    "entityId": [
+      "input_select.alarm_ultimate_state"
+    ],
+    "data": "{\"option\":haState}",
+    "dataType": "jsonata",
+    "mergeContext": "",
+    "mustacheAltTags": false,
+    "outputProperties": [],
+    "queue": "none",
+    "x": 830,
+    "y": 500,
+    "wires": [
+      []
+    ]
+  },
+  {
+    "id": "b0a1c2d3e4f50607",
+    "type": "inject",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "Sync on deploy (status)",
+    "props": [
+      {
+        "p": "topic",
+        "v": "alarm",
+        "vt": "str"
+      },
+      {
+        "p": "command",
+        "v": "status",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": true,
+    "onceDelay": 0.5,
+    "topic": "",
+    "x": 260,
+    "y": 500,
+    "wires": [
+      [
+        "d0c1b2a3f4e50617"
+      ]
+    ]
+  },
+  {
+    "id": "3f50b6a7c1c8b3d10",
+    "type": "debug",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "All events",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 1040,
+    "y": 200,
+    "wires": []
+  },
+  {
+    "id": "3f50b6a7c1c8b3d11",
+    "type": "debug",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "Siren output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 1050,
+    "y": 240,
+    "wires": []
+  },
+  {
+    "id": "3f50b6a7c1c8b3d12",
+    "type": "debug",
+    "z": "b3b0c2c1a9e7d001",
+    "name": "Errors / denied",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 1060,
+    "y": 280,
+    "wires": []
+  }
+]
+

package/nodes/AlarmSystemUltimate.html

@@ -2,15 +2,16 @@
   RED.nodes.registerType("AlarmSystemUltimate", {
     category: "Alarm Ultimate",
     color: "#A8DADC",
-    defaults: {
-      name: { value: "" },
-      controlTopic: { value: "alarm" },
-      payloadPropName: { value: "payload", required: false },
-      persistState: { value: true },
-      requireCodeForArm: { value: false },
-      requireCodeForDisarm: { value: true },
-      armCode: { value: "" },
-      duressCode: { value: "" },
+	    defaults: {
+	      name: { value: "" },
+	      controlTopic: { value: "alarm" },
+	      payloadPropName: { value: "payload", required: false },
+	      persistState: { value: true },
+	      syncTargets: { value: "" },
+	      requireCodeForArm: { value: false },
+	      requireCodeForDisarm: { value: true },
+	      armCode: { value: "" },
+	      duressCode: { value: "" },
 	      blockArmOnViolations: { value: true },
 	      exitDelaySeconds: { value: 30, validate: RED.validators.number() },
 	      entryDelaySeconds: { value: 30, validate: RED.validators.number() },
@@ -55,8 +56,8 @@
     paletteLabel: function () {
       return "Alarm System (BETA)";
 	    },
-		    oneditprepare: function () {
-		      const nodeId = this.id;
+			    oneditprepare: function () {
+			      const nodeId = this.id;
 		      const origin = window.location.origin;
 		      const openerOrigin = origin;
 		      const bc =
@@ -85,10 +86,12 @@
         this.sirenOffPayloadType || "bool",
       );
 
-      const zonesField = $("#node-input-zones");
-      const zonesSummary = $("#node-input-zones-summary");
+	      const zonesField = $("#node-input-zones");
+	      const zonesSummary = $("#node-input-zones-summary");
+	      const syncTargetsField = $("#node-input-syncTargets");
+	      const syncTargetsUi = $("#node-input-syncTargets-ui");
 
-      function parseZonesText(text) {
+	      function parseZonesText(text) {
         const raw = String(text || "").trim();
         if (!raw) return [];
 
@@ -119,9 +122,131 @@
           }
         }
         return zones;
-      }
+	      }
+
+	      function parseSyncTargets(text) {
+	        const raw = String(text || "").trim();
+	        if (!raw) return {};
+	        try {
+	          const parsed = JSON.parse(raw);
+	          return parsed && typeof parsed === "object" && !Array.isArray(parsed) ? parsed : {};
+	        } catch (_err) {
+	          return {};
+	        }
+	      }
+
+	      function normalizeSyncAction(value) {
+	        const v = String(value || "").trim().toLowerCase();
+	        if (v === "arm") return "arm";
+	        if (v === "disarm") return "disarm";
+	        return "leave";
+	      }
 
-      function updateZonesSummary() {
+		      function syncActionLabel(value) {
+		        const v = normalizeSyncAction(value);
+		        if (v === "arm") return "Arm";
+		        if (v === "disarm") return "Disarm";
+		        return "Leave as is";
+		      }
+
+		      function escapeHtml(text) {
+		        return String(text || "")
+		          .replace(/&/g, "&")
+		          .replace(/</g, "&lt;")
+		          .replace(/>/g, "&gt;")
+		          .replace(/"/g, "&quot;")
+		          .replace(/'/g, "&#039;");
+		      }
+
+		      function buildSyncTargetsUi() {
+		        if (!syncTargetsUi || !syncTargetsUi.length) return;
+		        try {
+		          const saved = parseSyncTargets(syncTargetsField.val());
+
+		          // Collect other Alarm nodes in the workspace.
+		          const other = [];
+		          try {
+		            if (RED && RED.nodes && typeof RED.nodes.eachNode === "function") {
+		              RED.nodes.eachNode((n) => {
+		                if (!n) return;
+		                const type = String(n.type || "");
+		                if (type !== "AlarmSystemUltimate") return;
+		                if (n.id === nodeId) return;
+		                other.push({ id: n.id, name: String(n.name || "").trim() });
+		              });
+		            }
+		          } catch (_err) {}
+
+		          other.sort((a, b) => {
+		            const an = (a.name || a.id).toLowerCase();
+		            const bn = (b.name || b.id).toLowerCase();
+		            return an.localeCompare(bn);
+		          });
+
+		          if (other.length === 0) {
+		            syncTargetsUi.html('<span style="color:#777;">No other Alarm nodes found.</span>');
+		            return;
+		          }
+
+		          const table = $('<table style="width:100%; border-collapse:collapse;"></table>');
+		          table.append(
+		            '<thead><tr>' +
+		              '<th style="text-align:left; padding:4px 6px;">Alarm</th>' +
+		              '<th style="text-align:left; padding:4px 6px; width:160px;">On ARM</th>' +
+		              '<th style="text-align:left; padding:4px 6px; width:160px;">On DISARM</th>' +
+		            '</tr></thead>',
+		          );
+
+		          const tbody = $("<tbody></tbody>");
+		          other.forEach((n) => {
+		            const rule = saved[n.id] && typeof saved[n.id] === "object" ? saved[n.id] : {};
+		            const onArm = normalizeSyncAction(rule.onArm);
+		            const onDisarm = normalizeSyncAction(rule.onDisarm);
+
+		            const armSel = $('<select style="width:100%;"></select>');
+		            const disarmSel = $('<select style="width:100%;"></select>');
+		            ["arm", "leave", "disarm"].forEach((v) => {
+		              armSel.append(`<option value="${v}">${syncActionLabel(v)}</option>`);
+		              disarmSel.append(`<option value="${v}">${syncActionLabel(v)}</option>`);
+		            });
+		            armSel.val(onArm);
+		            disarmSel.val(onDisarm);
+
+		            const tr = $("<tr></tr>");
+		            const label = n.name ? `${n.name}` : "(unnamed Alarm)";
+		            tr.append(
+		              `<td style="padding:4px 6px;">${escapeHtml(label)}</td>`,
+		            );
+		            const tdArm = $('<td style="padding:4px 6px;"></td>').append(armSel);
+		            const tdDisarm = $('<td style="padding:4px 6px;"></td>').append(disarmSel);
+		            tr.append(tdArm).append(tdDisarm);
+		            tbody.append(tr);
+
+		            function persist() {
+		              const next = parseSyncTargets(syncTargetsField.val());
+		              next[n.id] = {
+		                onArm: String(armSel.val() || "leave"),
+		                onDisarm: String(disarmSel.val() || "leave"),
+		              };
+		              syncTargetsField.val(JSON.stringify(next));
+		              try {
+		                syncTargetsField.trigger("change");
+		              } catch (_err) {}
+		            }
+
+		            armSel.on("change", persist);
+		            disarmSel.on("change", persist);
+		          });
+		          table.append(tbody);
+		          syncTargetsUi.empty().append(table);
+		        } catch (err) {
+		          syncTargetsUi.html(
+		            `<span style="color:#c00;">Unable to render sync list. Check browser console. (${escapeHtml(err && err.message ? err.message : err)})</span>`,
+		          );
+		        }
+		      }
+
+	      function updateZonesSummary() {
         try {
           const zones = parseZonesText(zonesField.val());
           zonesSummary.text(zones.length ? `${zones.length} zones configured` : "No zones configured");
@@ -216,7 +341,7 @@
 	        }
 	      };
 
-	      window.addEventListener("message", messageListener);
+		      window.addEventListener("message", messageListener);
 	      if (bc) {
 	        bc.addEventListener("message", (ev) => {
 	          const data = ev && ev.data && typeof ev.data === "object" ? ev.data : null;
@@ -227,9 +352,10 @@
 	        });
 	        this._alarmUltimateZonesBroadcast = bc;
 	      }
-	      this._alarmUltimateZonesMessageListener = messageListener;
-	      updateZonesSummary();
-			    },
+		      this._alarmUltimateZonesMessageListener = messageListener;
+		      updateZonesSummary();
+		      setTimeout(() => buildSyncTargetsUi(), 0);
+				    },
 			    oneditsave: function () {
 			      if (this._alarmUltimateZonesMessageListener) {
 			        window.removeEventListener("message", this._alarmUltimateZonesMessageListener);
@@ -317,10 +443,21 @@
     </button>
   </div>
 
-    <div class="form-row">
-	    <label for="node-input-name"
-	        ><i class="icon-tag"></i> Name</label
-	      >
+  <div class="form-row">
+    <label><i class="fa fa-random"></i> Sync other alarms</label>
+    <div style="width: 70%;">
+      <div class="form-tips" style="margin: 0 0 6px 0;">
+        When this Alarm is armed/disarmed, optionally arm/disarm other Alarm nodes in the workspace (codes are forwarded if present).
+      </div>
+      <div id="node-input-syncTargets-ui"></div>
+      <input type="hidden" id="node-input-syncTargets" />
+    </div>
+  </div>
+
+	    <div class="form-row">
+		    <label for="node-input-name"
+		        ><i class="icon-tag"></i> Name</label
+		      >
       <input type="text" id="node-input-name" placeholder="Name" />
     </div>
 
@@ -587,10 +724,11 @@
   | Siren topic                        | Topic used on output 2 to turn the siren on/off (default: `controlTopic + "/siren"`).                                                |
   | Siren ON/OFF payload               | Values emitted on output 2 for siren on/off (typed).                                                                                 |
   | Siren duration (s)                 | Auto stop duration (`0` = latch until disarm).                                                                                       |
-  | Latch siren until disarm           | Forces siren to remain on until disarm (ignores duration).                                                                           |
-  | Emit restore events                | Emits `zone_restore` when a zone returns to false.                                                                                   |
-	  | Event log size                     | Max stored log entries in node context (0 disables log).                                                                             |
-	  | Zones                              | Zone definitions. Use **Manage zones** to edit with the web tool (advanced JSON is available there).                                 |
+	  | Latch siren until disarm           | Forces siren to remain on until disarm (ignores duration).                                                                           |
+	  | Emit restore events                | Emits `zone_restore` when a zone returns to false.                                                                                   |
+		  | Event log size                     | Max stored log entries in node context (0 disables log).                                                                             |
+		  | Sync other alarms                  | Optional: when this node is armed/disarmed, it can arm/disarm other Alarm nodes. The original `msg.code`/`msg.pin` are forwarded.    |
+		  | Zones                              | Zone definitions. Use **Manage zones** to edit with the web tool (advanced JSON is available there).                                 |
 
 	  <br/>