node-red-contrib-alarm-ultimate 0.1.0

package/nodes/AlarmUltimateSiren.html

@@ -0,0 +1,94 @@
+<script type="text/javascript">
+  RED.nodes.registerType("AlarmUltimateSiren", {
+    category: "Alarm Ultimate",
+    color: "#ffb3b3",
+    defaults: {
+      name: { value: "" },
+      alarmId: { value: "", required: true },
+      topic: { value: "" },
+      outputInitialState: { value: true },
+    },
+    inputs: 0,
+    outputs: 1,
+    icon: "font-awesome/fa-bell",
+    label: function () {
+      return this.name || "Alarm Siren";
+    },
+    paletteLabel: function () {
+      return "Alarm Siren";
+    },
+    oneditprepare: function () {
+      const alarmSelect = $("#node-input-alarmId");
+      const httpAdminRoot = (RED.settings && RED.settings.httpAdminRoot) || "/";
+      const root = httpAdminRoot.endsWith("/") ? httpAdminRoot : `${httpAdminRoot}/`;
+      const url = `${root}alarm-ultimate/alarm/nodes`;
+      const panelButton = $("#node-input-alarm-panel");
+
+      panelButton.off("click").on("click", (evt) => {
+        evt.preventDefault();
+        const alarmId = alarmSelect.val() || this.alarmId || "";
+        const idPart = alarmId ? `?id=${encodeURIComponent(alarmId)}` : "";
+        window.open(
+          `${root}alarm-ultimate/alarm-panel${idPart}`,
+          "_blank",
+          "noopener,noreferrer",
+        );
+      });
+
+      try {
+        $.getJSON(url)
+          .done((data) => {
+            const nodes = Array.isArray(data && data.nodes) ? data.nodes : [];
+            alarmSelect.empty();
+            alarmSelect.append($("<option></option>").attr("value", "").text("-- select --"));
+            nodes.forEach((n) => {
+              const label = n.name ? `${n.name} (${n.id})` : n.id;
+              alarmSelect.append($("<option></option>").attr("value", n.id).text(label));
+            });
+            if (this.alarmId) alarmSelect.val(this.alarmId);
+          })
+          .fail(() => {});
+      } catch (err) {}
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="AlarmUltimateSiren">
+  <div class="form-row">
+    <label>&nbsp;</label>
+    <button type="button" class="red-ui-button" id="node-input-alarm-panel">
+      <i class="fa fa-keyboard-o"></i> Panel
+    </button>
+  </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>
+
+  <div class="form-row">
+    <label for="node-input-alarmId"><i class="fa fa-link"></i> Alarm node</label>
+    <select id="node-input-alarmId" style="width: 70%"></select>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-topic"><i class="fa fa-tag"></i> Topic</label>
+    <input type="text" id="node-input-topic" placeholder="(default: &lt;controlTopic&gt;/sirenState)" />
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-outputInitialState"><i class="fa fa-bolt"></i> Emit on deploy</label>
+    <input type="checkbox" id="node-input-outputInitialState" style="width:auto; margin-top:7px;" />
+  </div>
+</script>
+
+<script type="text/markdown" data-help-name="AlarmUltimateSiren">
+Emits the siren state from a selected **Alarm System Ultimate** node.
+
+- `msg.payload`: `true` when the siren is on, otherwise `false`
+- `msg.reason`: `manual|timeout|arm|disarm|...`
+
+Notes:
+
+- Use the **Panel** button to open the Alarm Panel preselected on the chosen Alarm node.
+</script>

package/nodes/AlarmUltimateSiren.js

@@ -0,0 +1,83 @@
+'use strict';
+
+const helpers = require('./lib/node-helpers.js');
+const { alarmInstances, alarmEmitter } = require('./lib/alarm-registry.js');
+
+module.exports = function (RED) {
+  function AlarmUltimateSiren(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    const timerBag = helpers.createTimerBag(node);
+    const setNodeStatus = helpers.createStatus(node);
+
+    const alarmId = String(config.alarmId || '').trim();
+    const configuredTopic = typeof config.topic === 'string' ? config.topic.trim() : '';
+    const outputInitialState = config.outputInitialState !== false;
+
+    let lastActive = null;
+
+    function buildTopic(controlTopic) {
+      if (configuredTopic) return configuredTopic;
+      const base = typeof controlTopic === 'string' && controlTopic.trim().length > 0 ? controlTopic.trim() : 'alarm';
+      return `${base}/sirenState`;
+    }
+
+    function emitSiren(active, evt, reason) {
+      if (typeof active !== 'boolean') return;
+      if (lastActive === active && reason !== 'init') return;
+      lastActive = active;
+
+      const msg = {
+        topic: buildTopic(evt && evt.controlTopic),
+        payload: active,
+        alarmId: evt ? evt.alarmId : alarmId,
+        name: evt ? evt.name || '' : '',
+        reason: evt && evt.reason ? evt.reason : reason,
+        ts: evt && evt.ts ? evt.ts : Date.now(),
+      };
+      node.send(msg);
+    }
+
+    function emitCurrent(reason) {
+      if (!alarmId) {
+        setNodeStatus({ fill: 'red', shape: 'ring', text: 'Missing alarmId' });
+        return;
+      }
+      const api = alarmInstances.get(alarmId);
+      if (!api) {
+        setNodeStatus({ fill: 'yellow', shape: 'ring', text: 'Waiting for alarm node' });
+        return;
+      }
+      const ui = api.getState && typeof api.getState === 'function' ? api.getState() : null;
+      const state = ui && ui.state ? ui.state : null;
+      const active = state ? Boolean(state.sirenActive) : null;
+      setNodeStatus({ fill: 'green', shape: 'dot', text: `Connected (${active ? 'on' : 'off'})` });
+      emitSiren(active, { alarmId, controlTopic: ui.controlTopic, name: ui.name }, reason);
+    }
+
+    function onSirenState(evt) {
+      if (!evt || evt.alarmId !== alarmId) return;
+      emitSiren(Boolean(evt.active), evt, 'siren_state');
+    }
+
+    alarmEmitter.on('siren_state', onSirenState);
+    node.on('close', () => {
+      alarmEmitter.off('siren_state', onSirenState);
+    });
+
+    if (outputInitialState) {
+      timerBag.setTimeout(() => emitCurrent('init'), 0);
+      timerBag.setInterval(() => {
+        if (lastActive === null) {
+          emitCurrent('init_retry');
+        }
+      }, 1000);
+    } else {
+      setNodeStatus({ fill: 'grey', shape: 'ring', text: 'Ready' });
+    }
+  }
+
+  RED.nodes.registerType('AlarmUltimateSiren', AlarmUltimateSiren);
+};
+

package/nodes/AlarmUltimateState.html

@@ -0,0 +1,95 @@
+<script type="text/javascript">
+  RED.nodes.registerType("AlarmUltimateState", {
+    category: "Alarm Ultimate",
+    color: "#ffb3b3",
+    defaults: {
+      name: { value: "" },
+      alarmId: { value: "", required: true },
+      topic: { value: "" },
+      outputInitialState: { value: true },
+    },
+    inputs: 0,
+    outputs: 1,
+    icon: "font-awesome/fa-shield",
+    label: function () {
+      return this.name || "Alarm State";
+    },
+    paletteLabel: function () {
+      return "Alarm State";
+    },
+    oneditprepare: function () {
+      const alarmSelect = $("#node-input-alarmId");
+      const httpAdminRoot = (RED.settings && RED.settings.httpAdminRoot) || "/";
+      const root = httpAdminRoot.endsWith("/") ? httpAdminRoot : `${httpAdminRoot}/`;
+      const url = `${root}alarm-ultimate/alarm/nodes`;
+      const panelButton = $("#node-input-alarm-panel");
+
+      panelButton.off("click").on("click", (evt) => {
+        evt.preventDefault();
+        const alarmId = alarmSelect.val() || this.alarmId || "";
+        const idPart = alarmId ? `?id=${encodeURIComponent(alarmId)}` : "";
+        window.open(
+          `${root}alarm-ultimate/alarm-panel${idPart}`,
+          "_blank",
+          "noopener,noreferrer",
+        );
+      });
+
+      try {
+        $.getJSON(url)
+          .done((data) => {
+            const nodes = Array.isArray(data && data.nodes) ? data.nodes : [];
+            alarmSelect.empty();
+            alarmSelect.append($("<option></option>").attr("value", "").text("-- select --"));
+            nodes.forEach((n) => {
+              const label = n.name ? `${n.name} (${n.id})` : n.id;
+              alarmSelect.append($("<option></option>").attr("value", n.id).text(label));
+            });
+            if (this.alarmId) alarmSelect.val(this.alarmId);
+          })
+          .fail(() => {});
+      } catch (err) {}
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="AlarmUltimateState">
+  <div class="form-row">
+    <label>&nbsp;</label>
+    <button type="button" class="red-ui-button" id="node-input-alarm-panel">
+      <i class="fa fa-keyboard-o"></i> Panel
+    </button>
+  </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>
+
+  <div class="form-row">
+    <label for="node-input-alarmId"><i class="fa fa-link"></i> Alarm node</label>
+    <select id="node-input-alarmId" style="width: 70%"></select>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-topic"><i class="fa fa-tag"></i> Topic</label>
+    <input type="text" id="node-input-topic" placeholder="(default: &lt;controlTopic&gt;/state)" />
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-outputInitialState"><i class="fa fa-bolt"></i> Emit on deploy</label>
+    <input type="checkbox" id="node-input-outputInitialState" style="width:auto; margin-top:7px;" />
+  </div>
+</script>
+
+<script type="text/markdown" data-help-name="AlarmUltimateState">
+Emits the alarm arming state from a selected **Alarm System Ultimate** node.
+
+- `msg.payload`: `armed` or `disarmed`
+- `msg.topic`: configurable (default: `controlTopic + "/state"`)
+- `msg.alarmId`, `msg.name`
+
+Notes:
+
+- Use the **Panel** button to open the Alarm Panel preselected on the chosen Alarm node.
+</script>

package/nodes/AlarmUltimateState.js

@@ -0,0 +1,87 @@
+'use strict';
+
+const helpers = require('./lib/node-helpers.js');
+const { alarmInstances, alarmEmitter } = require('./lib/alarm-registry.js');
+
+module.exports = function (RED) {
+  function AlarmUltimateState(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    const timerBag = helpers.createTimerBag(node);
+    const setNodeStatus = helpers.createStatus(node);
+
+    const alarmId = String(config.alarmId || '').trim();
+    const configuredTopic = typeof config.topic === 'string' ? config.topic.trim() : '';
+    const outputInitialState = config.outputInitialState !== false;
+
+    let lastMode = null;
+
+    function buildTopic(controlTopic) {
+      if (configuredTopic) return configuredTopic;
+      const base = typeof controlTopic === 'string' && controlTopic.trim().length > 0 ? controlTopic.trim() : 'alarm';
+      return `${base}/state`;
+    }
+
+    function emitMode(mode, api, reason) {
+      if (mode !== 'armed' && mode !== 'disarmed') {
+        return;
+      }
+      if (lastMode === mode && reason !== 'init') {
+        return;
+      }
+      lastMode = mode;
+
+      const msg = {
+        topic: buildTopic(api && api.controlTopic),
+        payload: mode,
+        alarmId: api ? api.id : alarmId,
+        name: api ? api.name || '' : '',
+        reason,
+      };
+      node.send(msg);
+    }
+
+    function emitCurrent(reason) {
+      if (!alarmId) {
+        setNodeStatus({ fill: 'red', shape: 'ring', text: 'Missing alarmId' });
+        return;
+      }
+      const api = alarmInstances.get(alarmId);
+      if (!api) {
+        setNodeStatus({ fill: 'yellow', shape: 'ring', text: 'Waiting for alarm node' });
+        return;
+      }
+      const state = api.getState && typeof api.getState === 'function' ? api.getState() : null;
+      const mode = state && state.state ? state.state.mode : null;
+      setNodeStatus({ fill: 'green', shape: 'dot', text: `Connected (${mode || 'unknown'})` });
+      emitMode(mode, api, reason);
+    }
+
+    function onAlarmEvent(evt) {
+      if (!evt || evt.alarmId !== alarmId) return;
+      if (evt.event === 'armed' || evt.event === 'disarmed' || evt.event === 'reset') {
+        emitMode(evt.state && evt.state.mode, evt, evt.event);
+      }
+    }
+
+    alarmEmitter.on('event', onAlarmEvent);
+    node.on('close', () => {
+      alarmEmitter.off('event', onAlarmEvent);
+    });
+
+    if (outputInitialState) {
+      timerBag.setTimeout(() => emitCurrent('init'), 0);
+      timerBag.setInterval(() => {
+        if (lastMode === null) {
+          emitCurrent('init_retry');
+        }
+      }, 1000);
+    } else {
+      setNodeStatus({ fill: 'grey', shape: 'ring', text: 'Ready' });
+    }
+  }
+
+  RED.nodes.registerType('AlarmUltimateState', AlarmUltimateState);
+};
+

package/nodes/AlarmUltimateZone.html

@@ -0,0 +1,130 @@
+<script type="text/javascript">
+  RED.nodes.registerType("AlarmUltimateZone", {
+    category: "Alarm Ultimate",
+    color: "#ffb3b3",
+    defaults: {
+      name: { value: "" },
+      alarmId: { value: "", required: true },
+      zoneId: { value: "", required: true },
+      topic: { value: "" },
+      outputInitialState: { value: true },
+    },
+    inputs: 0,
+    outputs: 1,
+    icon: "font-awesome/fa-bullseye",
+    label: function () {
+      return this.name || "Alarm Zone";
+    },
+    paletteLabel: function () {
+      return "Alarm Zone";
+    },
+    oneditprepare: function () {
+      const alarmSelect = $("#node-input-alarmId");
+      const zoneSelect = $("#node-input-zoneId");
+      const httpAdminRoot = (RED.settings && RED.settings.httpAdminRoot) || "/";
+      const root = httpAdminRoot.endsWith("/") ? httpAdminRoot : `${httpAdminRoot}/`;
+      const panelButton = $("#node-input-alarm-panel");
+
+      function apiUrl(path) {
+        return `${root}${path.replace(/^\//, "")}`;
+      }
+
+      panelButton.off("click").on("click", (evt) => {
+        evt.preventDefault();
+        const alarmId = alarmSelect.val() || this.alarmId || "";
+        const idPart = alarmId ? `?id=${encodeURIComponent(alarmId)}` : "";
+        window.open(
+          `${root}alarm-ultimate/alarm-panel${idPart}`,
+          "_blank",
+          "noopener,noreferrer",
+        );
+      });
+
+      function loadAlarms() {
+        return $.getJSON(apiUrl("alarm-ultimate/alarm/nodes"))
+          .done((data) => {
+            const nodes = Array.isArray(data && data.nodes) ? data.nodes : [];
+            alarmSelect.empty();
+            alarmSelect.append($("<option></option>").attr("value", "").text("-- select --"));
+            nodes.forEach((n) => {
+              const label = n.name ? `${n.name} (${n.id})` : n.id;
+              alarmSelect.append($("<option></option>").attr("value", n.id).text(label));
+            });
+            if (this.alarmId) alarmSelect.val(this.alarmId);
+          })
+          .fail(() => {});
+      }
+
+      function loadZones(alarmId) {
+        zoneSelect.empty();
+        zoneSelect.append($("<option></option>").attr("value", "").text("-- select alarm first --"));
+        if (!alarmId) return;
+        $.getJSON(apiUrl(`alarm-ultimate/alarm/${encodeURIComponent(alarmId)}/state`))
+          .done((data) => {
+            const zones = Array.isArray(data && data.zones) ? data.zones : [];
+            zoneSelect.empty();
+            zoneSelect.append($("<option></option>").attr("value", "").text("-- select --"));
+            zones.forEach((z) => {
+              const label = z.name ? `${z.name} (${z.id})` : z.id;
+              zoneSelect.append($("<option></option>").attr("value", z.id).text(label));
+            });
+            if (this.zoneId) zoneSelect.val(this.zoneId);
+          })
+          .fail(() => {});
+      }
+
+      alarmSelect.on("change", () => loadZones(alarmSelect.val()));
+
+      try {
+        loadAlarms.call(this).always(() => loadZones.call(this, this.alarmId));
+      } catch (err) {}
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="AlarmUltimateZone">
+  <div class="form-row">
+    <label>&nbsp;</label>
+    <button type="button" class="red-ui-button" id="node-input-alarm-panel">
+      <i class="fa fa-keyboard-o"></i> Panel
+    </button>
+  </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>
+
+  <div class="form-row">
+    <label for="node-input-alarmId"><i class="fa fa-link"></i> Alarm node</label>
+    <select id="node-input-alarmId" style="width: 70%"></select>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-zoneId"><i class="fa fa-bullseye"></i> Zone</label>
+    <select id="node-input-zoneId" style="width: 70%"></select>
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-topic"><i class="fa fa-tag"></i> Topic</label>
+    <input type="text" id="node-input-topic" placeholder="(default: &lt;controlTopic&gt;/zone/&lt;zoneId&gt;)" />
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-outputInitialState"><i class="fa fa-bolt"></i> Emit on deploy</label>
+    <input type="checkbox" id="node-input-outputInitialState" style="width:auto; margin-top:7px;" />
+  </div>
+</script>
+
+<script type="text/markdown" data-help-name="AlarmUltimateZone">
+Emits the state of a single configured zone from a selected **Alarm System Ultimate** node.
+
+- `msg.payload`: `true` when the zone is open/active, otherwise `false`
+- `msg.zone`: `{ id, name?, type? }`
+- `msg.bypassed`: `true|false`
+
+Notes:
+
+- The zone list is loaded from the selected Alarm node state (`/alarm-ultimate/alarm/:id/state`).
+- Use the **Panel** button to open the Alarm Panel preselected on the chosen Alarm node.
+</script>

package/nodes/AlarmUltimateZone.js

@@ -0,0 +1,91 @@
+'use strict';
+
+const helpers = require('./lib/node-helpers.js');
+const { alarmInstances, alarmEmitter } = require('./lib/alarm-registry.js');
+
+module.exports = function (RED) {
+  function AlarmUltimateZone(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    const timerBag = helpers.createTimerBag(node);
+    const setNodeStatus = helpers.createStatus(node);
+
+    const alarmId = String(config.alarmId || '').trim();
+    const zoneId = String(config.zoneId || '').trim();
+    const configuredTopic = typeof config.topic === 'string' ? config.topic.trim() : '';
+    const outputInitialState = config.outputInitialState !== false;
+
+    let lastOpen = null;
+
+    function buildTopic(controlTopic) {
+      if (configuredTopic) return configuredTopic;
+      const base = typeof controlTopic === 'string' && controlTopic.trim().length > 0 ? controlTopic.trim() : 'alarm';
+      const z = zoneId || 'zone';
+      return `${base}/zone/${z}`;
+    }
+
+    function emitZone(open, evt, reason) {
+      if (typeof open !== 'boolean') return;
+      if (lastOpen === open && reason !== 'init') return;
+      lastOpen = open;
+
+      const msg = {
+        topic: buildTopic(evt && evt.controlTopic),
+        payload: open,
+        alarmId: evt ? evt.alarmId : alarmId,
+        zone: evt && evt.zone ? evt.zone : { id: zoneId || null },
+        bypassed: Boolean(evt && evt.bypassed),
+        ts: evt && evt.ts ? evt.ts : Date.now(),
+        reason,
+      };
+      node.send(msg);
+    }
+
+    function emitCurrent(reason) {
+      if (!alarmId || !zoneId) {
+        setNodeStatus({ fill: 'red', shape: 'ring', text: 'Missing alarmId/zoneId' });
+        return;
+      }
+      const api = alarmInstances.get(alarmId);
+      if (!api) {
+        setNodeStatus({ fill: 'yellow', shape: 'ring', text: 'Waiting for alarm node' });
+        return;
+      }
+      const ui = api.getState && typeof api.getState === 'function' ? api.getState() : null;
+      const zones = ui && Array.isArray(ui.zones) ? ui.zones : [];
+      const selected = zones.find((z) => z && z.id === zoneId);
+      if (!selected) {
+        setNodeStatus({ fill: 'red', shape: 'ring', text: `Unknown zone (${zoneId})` });
+        return;
+      }
+      setNodeStatus({ fill: 'green', shape: 'dot', text: `Connected (${zoneId}: ${selected.open ? 'open' : 'closed'})` });
+      emitZone(Boolean(selected.open), { alarmId, controlTopic: ui.controlTopic, zone: { id: selected.id, name: selected.name, type: selected.type } }, reason);
+    }
+
+    function onZoneState(evt) {
+      if (!evt || evt.alarmId !== alarmId) return;
+      if (!evt.zone || evt.zone.id !== zoneId) return;
+      emitZone(Boolean(evt.open), evt, 'zone_state');
+    }
+
+    alarmEmitter.on('zone_state', onZoneState);
+    node.on('close', () => {
+      alarmEmitter.off('zone_state', onZoneState);
+    });
+
+    if (outputInitialState) {
+      timerBag.setTimeout(() => emitCurrent('init'), 0);
+      timerBag.setInterval(() => {
+        if (lastOpen === null) {
+          emitCurrent('init_retry');
+        }
+      }, 1000);
+    } else {
+      setNodeStatus({ fill: 'grey', shape: 'ring', text: 'Ready' });
+    }
+  }
+
+  RED.nodes.registerType('AlarmUltimateZone', AlarmUltimateZone);
+};
+

package/nodes/lib/alarm-registry.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const { EventEmitter } = require('events');
+
+const alarmInstances = new Map();
+const alarmEmitter = new EventEmitter();
+
+// Allow many listeners (multiple nodes can subscribe).
+alarmEmitter.setMaxListeners(0);
+
+module.exports = {
+  alarmInstances,
+  alarmEmitter,
+};
+