@rfranzoi/scrypted-mqtt-securitysystem 1.0.98 → 1.1.0

package/README.md

@@ -7,7 +7,9 @@ Control and sync alarm panels over MQTT (e.g. Paradox with PAI/PAI-MQTT), expose
 ## Features
 - Arm/Disarm: Disarmed, Home, Away, Night.
 - MQTT topics for current/target state, tamper, and online.
+- Multiple partition support through additional child **SecuritySystem** devices.
 - Optional per‑sensor MQTT bindings (contact/motion/occupancy) with battery, tamper, and online status.
+- Optional per‑sensor **Bypass** switch via MQTT topics.
 - HomeKit: usable through the official Scrypted HomeKit plugin (non-standalone accessory).
 
 ---
@@ -37,6 +39,22 @@ Then in **Scrypted → Manage Plugins → Install
 - **Get Status Tampered (subscribe)**: tamper status.
 - **Get Online (subscribe)**: online/offline indicator of the alarm bridge.
 
+### Partitions
+The main plugin device keeps the legacy single-partition alarm topics above. For panels with multiple
+areas/partitions, use **Add Partition** in Settings to create one child **SecuritySystem** per area.
+
+For example:
+- **Casa**
+  - Set Target: `paradox/control/partitions/Casa`
+  - Get Target: `paradox/states/partitions/Casa/target_state`
+  - Get Current: `paradox/states/partitions/Casa/current_state`
+- **Cantina**
+  - Set Target: `paradox/control/partitions/Cantina`
+  - Get Target: `paradox/states/partitions/Cantina/target_state`
+  - Get Current: `paradox/states/partitions/Cantina/current_state`
+
+Each partition is exposed as a separate Scrypted security system and can be added separately to HomeKit.
+
 ### Publish Options
 - **QoS** / **Retain**
 
@@ -60,6 +78,10 @@ Each sensor has:
   - Motion: `your/zones/hallway/motion`
   - Occupancy: `your/rooms/office/occupied`
   - Optional: `batteryLevel` (0..100), `lowBattery` (boolean), `tamper`, `online`
+- **bypass (optional)**:
+  - **Bypass Control Topic**: publish a bypass command for that zone.
+  - **Bypass State Topic**: subscribe to the actual bypass state.
+  - **Bypass Payload ON/OFF**: defaults to `bypass` / `clear_bypass`.
 
 ### Creating Sensors from the UI
 - Fill the fields for **ID**, **Name**, **Kind**, and desired **Topics**.
@@ -69,6 +91,11 @@ Each sensor has:
 
 > Only the capabilities for which topics are provided will be exposed (e.g., no low‑battery if no related topic is set).
 
+### Bypass Switch (Optional)
+If you configure bypass topics for a sensor, the plugin exposes an extra switch accessory named **`<Zone Name> Bypass`**.
+Turning the switch **On/Off** publishes to the **Bypass Control Topic** with the configured payloads, and the
+**Bypass State Topic** keeps the switch in sync (if provided).
+
 ---
 
 ## HomeKit Notes
@@ -83,6 +110,7 @@ Add this plugin’s device to the HomeKit plugin **(not as a Standalone accessor
 - **Get Current** (subscribe): `alarm/states/partition_1/current_state`
 - **Tamper** (subscribe): `alarm/states/system/tamper`
 - **Online** (subscribe): `alarm/interface/availability` (`online`/`offline`)
+- **Zone Bypass** (optional): publish to `alarm/control/zones/front-door`, state from `alarm/states/zones/front-door/bypassed`
 
 ---
 

package/dist/main.nodejs.js

@@ -34451,12 +34451,99 @@ class BypassMqttSwitch extends sdk_1.ScryptedDeviceBase {
         return this.setPowerState(on);
     }
 }
+class PartitionMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
+    constructor(nativeId, cfg, parent) {
+        super(nativeId);
+        this.cfg = cfg;
+        this.parent = parent;
+        this.securitySystemState = this.securitySystemState || parent.defaultSecuritySystemState();
+        this.online = this.online ?? false;
+    }
+    updateConfig(cfg) {
+        this.cfg = cfg;
+    }
+    handleMqtt(topic, payload) {
+        const raw = payload?.toString() ?? '';
+        const np = normalize(raw);
+        if (topic === this.cfg.topicOnline) {
+            if (truthy(np) || np === 'online') {
+                this.online = true;
+                try {
+                    this.onDeviceEvent(sdk_1.ScryptedInterface.Online, true);
+                }
+                catch { }
+            }
+            else if (falsy(np) || np === 'offline') {
+                this.online = false;
+                try {
+                    this.onDeviceEvent(sdk_1.ScryptedInterface.Online, false);
+                }
+                catch { }
+            }
+            return;
+        }
+        if (topic === this.cfg.topicTamper) {
+            if (truthy(np) || ['tamper', 'intrusion', 'cover'].includes(np)) {
+                const val = ['cover', 'intrusion'].find(x => x === np) || true;
+                this.tampered = val;
+                try {
+                    this.onDeviceEvent(sdk_1.ScryptedInterface.TamperSensor, val);
+                }
+                catch { }
+            }
+            else if (falsy(np)) {
+                this.tampered = false;
+                try {
+                    this.onDeviceEvent(sdk_1.ScryptedInterface.TamperSensor, false);
+                }
+                catch { }
+            }
+            return;
+        }
+        if (topic === this.cfg.topicGetCurrent) {
+            const mode = this.parent.parseIncomingMode(payload);
+            const isAlarm = this.parent.isTriggeredToken(np);
+            const current = this.securitySystemState || this.parent.defaultSecuritySystemState();
+            const newState = {
+                mode: mode ?? current.mode,
+                supportedModes: current.supportedModes ?? this.parent.supportedSecuritySystemModes(),
+                triggered: isAlarm || undefined,
+            };
+            this.securitySystemState = newState;
+            try {
+                this.onDeviceEvent(sdk_1.ScryptedInterface.SecuritySystem, newState);
+            }
+            catch { }
+            if (RUNTIME.logSensors)
+                this.console?.log?.(`[Partition] ${this.cfg.name} current: mode=${newState.mode} triggered=${!!newState.triggered} (${topic}="${raw}")`);
+            return;
+        }
+        if (topic === this.cfg.topicGetTarget) {
+            this.pendingTarget = this.parent.parseIncomingMode(payload);
+            if (RUNTIME.logSensors)
+                this.console?.log?.(`[Partition] ${this.cfg.name} target reported: "${raw}" -> ${this.pendingTarget}`);
+        }
+    }
+    async armSecuritySystem(mode) {
+        const payload = this.parent.getOutgoing(mode);
+        this.console?.log?.('armSecuritySystem', this.cfg.name, mode, '->', payload);
+        this.pendingTarget = mode;
+        this.parent.publishSetTargetTo(this.cfg.topicSetTarget, payload, this.cfg.name);
+    }
+    async disarmSecuritySystem() {
+        const payload = this.parent.getOutgoing(sdk_1.SecuritySystemMode.Disarmed);
+        this.console?.log?.('disarmSecuritySystem', this.cfg.name, '->', payload);
+        this.pendingTarget = sdk_1.SecuritySystemMode.Disarmed;
+        this.parent.publishSetTargetTo(this.cfg.topicSetTarget, payload, this.cfg.name);
+    }
+}
 /** ----------------- Main Plugin ----------------- */
 class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
     constructor() {
         super();
         // device management
         this.sensorsCfg = [];
+        this.partitionsCfg = [];
         this.devices = new Map();
         // load runtime flags
         updateRuntimeFromStorage((k) => this.storage.getItem(k) || '');
@@ -34470,15 +34557,11 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
         // Default state
         this.securitySystemState = this.securitySystemState || {
             mode: sdk_1.SecuritySystemMode.Disarmed,
-            supportedModes: [
-                sdk_1.SecuritySystemMode.Disarmed,
-                sdk_1.SecuritySystemMode.HomeArmed,
-                sdk_1.SecuritySystemMode.AwayArmed,
-                sdk_1.SecuritySystemMode.NightArmed,
-            ],
+            supportedModes: this.supportedSecuritySystemModes(),
         };
         this.online = this.online ?? false;
         // Load configs and announce devices
+        this.loadPartitionsFromStorage();
         this.loadSensorsFromStorage();
         this.discoverDevices().catch(e => this.console.error('discoverDevices error', e));
         // Connect on start
@@ -34518,6 +34601,20 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
     useStrict() {
         return this.storage.getItem('strictParsing') === 'true';
     }
+    supportedSecuritySystemModes() {
+        return [
+            sdk_1.SecuritySystemMode.Disarmed,
+            sdk_1.SecuritySystemMode.HomeArmed,
+            sdk_1.SecuritySystemMode.AwayArmed,
+            sdk_1.SecuritySystemMode.NightArmed,
+        ];
+    }
+    defaultSecuritySystemState() {
+        return {
+            mode: sdk_1.SecuritySystemMode.Disarmed,
+            supportedModes: this.supportedSecuritySystemModes(),
+        };
+    }
     parseIncomingMode(payload) {
         const np = normalize(payload?.toString?.() ?? String(payload ?? ''));
         if (!this.useStrict())
@@ -34560,6 +34657,14 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
             this.console.error('saveSensorsToStorage error', e);
         }
     }
+    savePartitionsToStorage() {
+        try {
+            this.storage.setItem('partitionsJson', JSON.stringify(this.partitionsCfg));
+        }
+        catch (e) {
+            this.console.error('savePartitionsToStorage error', e);
+        }
+    }
     /** ---- Settings UI ---- */
     async getSettings() {
         const out = [
@@ -34592,6 +34697,12 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
             { group: 'Logging', key: 'logSensors', title: 'Log sensor state changes', type: 'boolean', value: this.storage.getItem('logSensors') === 'true' },
             { group: 'Logging', key: 'logMqttAll', title: 'Log ALL MQTT messages', type: 'boolean', value: this.storage.getItem('logMqttAll') === 'true', description: 'Warning: this will be very verbose.' },
         ];
+        // ---- UI Add Partition ----
+        out.push({ group: 'Add Partition', key: 'newPartition.id', title: 'New Partition ID', placeholder: 'casa', value: this.storage.getItem('newPartition.id') || '' }, { group: 'Add Partition', key: 'newPartition.name', title: 'Name', placeholder: 'Casa', value: this.storage.getItem('newPartition.name') || '' }, { group: 'Add Partition', key: 'newPartition.topicSetTarget', title: 'Set Target State (publish)', placeholder: 'paradox/control/partitions/Casa', value: this.storage.getItem('newPartition.topicSetTarget') || '' }, { group: 'Add Partition', key: 'newPartition.topicGetTarget', title: 'Get Target State (subscribe)', placeholder: 'paradox/states/partitions/Casa/target_state', value: this.storage.getItem('newPartition.topicGetTarget') || '' }, { group: 'Add Partition', key: 'newPartition.topicGetCurrent', title: 'Get Current State (subscribe)', placeholder: 'paradox/states/partitions/Casa/current_state', value: this.storage.getItem('newPartition.topicGetCurrent') || '' }, { group: 'Add Partition', key: 'newPartition.topicTamper', title: 'Get Status Tampered (subscribe)', placeholder: 'paradox/states/system/troubles/zone_tamper_trouble', value: this.storage.getItem('newPartition.topicTamper') || '' }, { group: 'Add Partition', key: 'newPartition.topicOnline', title: 'Get Online (subscribe)', placeholder: 'paradox/interface/availability', value: this.storage.getItem('newPartition.topicOnline') || '' }, { group: 'Add Partition', key: 'newPartition.create', title: 'Create partition', type: 'boolean', description: 'Fill the fields above and toggle this on to create a separate SecuritySystem device.' });
+        for (const cfg of this.partitionsCfg) {
+            const gid = `Partition: ${cfg.name} [${cfg.id}]`;
+            out.push({ group: gid, key: `partition.${cfg.id}.name`, title: 'Name', value: cfg.name }, { group: gid, key: `partition.${cfg.id}.topicSetTarget`, title: 'Set Target State (publish)', value: cfg.topicSetTarget || '', placeholder: `paradox/control/partitions/${cfg.name}` }, { group: gid, key: `partition.${cfg.id}.topicGetTarget`, title: 'Get Target State (subscribe)', value: cfg.topicGetTarget || '', placeholder: `paradox/states/partitions/${cfg.name}/target_state` }, { group: gid, key: `partition.${cfg.id}.topicGetCurrent`, title: 'Get Current State (subscribe)', value: cfg.topicGetCurrent || '', placeholder: `paradox/states/partitions/${cfg.name}/current_state` }, { group: gid, key: `partition.${cfg.id}.topicTamper`, title: 'Get Status Tampered (subscribe)', value: cfg.topicTamper || '' }, { group: gid, key: `partition.${cfg.id}.topicOnline`, title: 'Get Online (subscribe)', value: cfg.topicOnline || '' }, { group: gid, key: `partition.${cfg.id}.remove`, title: 'Remove partition', type: 'boolean' });
+        }
         // ---- UI Add Sensor ----
         out.push({ group: 'Add Sensor', key: 'new.id', title: 'New Sensor ID', placeholder: 'front-door', value: this.storage.getItem('new.id') || '' }, { group: 'Add Sensor', key: 'new.name', title: 'Name', placeholder: 'Front Door', value: this.storage.getItem('new.name') || '' }, { group: 'Add Sensor', key: 'new.kind', title: 'Type', value: this.storage.getItem('new.kind') || 'contact', choices: ['contact', 'motion', 'occupancy'] }, { group: 'Add Sensor', key: 'new.create', title: 'Create sensor', type: 'boolean', description: 'Fill the fields above and toggle this on to create the sensor. After creation, restart this plugin to see the accessory listed below. To show it in HomeKit, restart the HomeKit plugin as well.' });
         // ---- UI for existing sensors ----
@@ -34613,6 +34724,66 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
         this.storage.setItem(key, String(value));
         // update runtime flags every time
         updateRuntimeFromStorage((k) => this.storage.getItem(k) || '');
+        // --- Add Partition workflow ---
+        if (key === 'newPartition.create' && String(value) === 'true') {
+            const id = (this.storage.getItem('newPartition.id') || '').trim();
+            const name = (this.storage.getItem('newPartition.name') || '').trim() || id;
+            if (!id) {
+                this.console.warn('Create partition: missing id');
+                return;
+            }
+            if (this.partitionsCfg.find(p => p.id === id)) {
+                this.console.warn('Create partition: id already exists');
+                return;
+            }
+            this.partitionsCfg.push({
+                id,
+                name,
+                topicSetTarget: (this.storage.getItem('newPartition.topicSetTarget') || '').trim(),
+                topicGetTarget: (this.storage.getItem('newPartition.topicGetTarget') || '').trim(),
+                topicGetCurrent: (this.storage.getItem('newPartition.topicGetCurrent') || '').trim(),
+                topicTamper: (this.storage.getItem('newPartition.topicTamper') || '').trim(),
+                topicOnline: (this.storage.getItem('newPartition.topicOnline') || '').trim(),
+            });
+            this.savePartitionsToStorage();
+            for (const k of ['id', 'name', 'topicSetTarget', 'topicGetTarget', 'topicGetCurrent', 'topicTamper', 'topicOnline', 'create'])
+                this.storage.removeItem(`newPartition.${k}`);
+            await this.discoverDevices();
+            await this.connectMqtt(true);
+            return;
+        }
+        // --- Edit/Remove existing partition ---
+        const pm = key.match(/^partition\.([^\.]+)\.(.+)$/);
+        if (pm) {
+            const pid = pm[1];
+            const prop = pm[2];
+            const cfg = this.partitionsCfg.find(p => p.id === pid);
+            if (!cfg) {
+                this.console.warn('putSetting: partition not found', pid);
+                return;
+            }
+            if (prop === 'remove' && String(value) === 'true') {
+                this.partitionsCfg = this.partitionsCfg.filter(p => p.id !== pid);
+                this.savePartitionsToStorage();
+                try {
+                    this.devices.delete(`partition:${pid}`);
+                    deviceManager.onDeviceRemoved?.(`partition:${pid}`);
+                }
+                catch { }
+                this.storage.removeItem(key);
+                await this.discoverDevices();
+                await this.connectMqtt(true);
+                return;
+            }
+            if (prop === 'name')
+                cfg.name = String(value).trim() || cfg.id;
+            else if (prop !== 'id' && prop !== 'remove')
+                cfg[prop] = String(value).trim();
+            this.savePartitionsToStorage();
+            await this.discoverDevices();
+            await this.connectMqtt(true);
+            return;
+        }
         // --- Add Sensor workflow ---
         if (key === 'new.create' && String(value) === 'true') {
             const id = (this.storage.getItem('new.id') || '').trim();
@@ -34697,6 +34868,15 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
         const existing = this.devices.get(nativeId);
         if (existing)
             return existing;
+        if (nativeId.startsWith('partition:')) {
+            const pid = nativeId.substring('partition:'.length);
+            const cfg = this.partitionsCfg.find(p => p.id === pid);
+            if (!cfg)
+                return undefined;
+            const dev = new PartitionMqttSecuritySystem(nativeId, cfg, this);
+            this.devices.set(nativeId, dev);
+            return dev;
+        }
         if (nativeId.startsWith('sensor:')) {
             const sid = nativeId.substring('sensor:'.length);
             const cfg = this.sensorsCfg.find(s => s.id === sid);
@@ -34773,6 +34953,27 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
         }
         this.migrateBypassFromStorage();
     }
+    loadPartitionsFromStorage() {
+        try {
+            const raw = this.storage.getItem('partitionsJson') || '[]';
+            const parsed = JSON.parse(raw);
+            this.partitionsCfg = (Array.isArray(parsed) ? parsed : [])
+                .filter(x => x && x.id && x.name)
+                .map(x => ({
+                id: String(x.id),
+                name: String(x.name),
+                topicSetTarget: String(x.topicSetTarget || '').trim(),
+                topicGetTarget: String(x.topicGetTarget || '').trim(),
+                topicGetCurrent: String(x.topicGetCurrent || '').trim(),
+                topicTamper: String(x.topicTamper || '').trim(),
+                topicOnline: String(x.topicOnline || '').trim(),
+            }));
+        }
+        catch (e) {
+            this.console.error('Invalid partitionsJson:', e);
+            this.partitionsCfg = [];
+        }
+    }
     migrateBypassFromStorage() {
         try {
             const raw = this.storage.getItem('bypassJson') || '[]';
@@ -34832,6 +35033,20 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
     async discoverDevices() {
         // 1) manifest
         const manifests = [];
+        for (const cfg of this.partitionsCfg) {
+            const interfaces = [
+                sdk_1.ScryptedInterface.SecuritySystem,
+                sdk_1.ScryptedInterface.Online,
+            ];
+            if (cfg.topicTamper)
+                interfaces.push(sdk_1.ScryptedInterface.TamperSensor);
+            manifests.push({
+                nativeId: `partition:${cfg.id}`,
+                name: cfg.name,
+                type: sdk_1.ScryptedDeviceType.SecuritySystem,
+                interfaces,
+            });
+        }
         for (const cfg of this.sensorsCfg) {
             const nativeId = `sensor:${cfg.id}`;
             const t = cfg.topics || {};
@@ -34875,6 +35090,17 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
             }
         }
         // 3) instantiate/update
+        for (const cfg of this.partitionsCfg) {
+            const nativeId = `partition:${cfg.id}`;
+            let dev = this.devices.get(nativeId);
+            if (!dev) {
+                dev = new PartitionMqttSecuritySystem(nativeId, cfg, this);
+                this.devices.set(nativeId, dev);
+            }
+            else {
+                dev.updateConfig(cfg);
+            }
+        }
         for (const cfg of this.sensorsCfg) {
             const nativeId = `sensor:${cfg.id}`;
             let dev = this.devices.get(nativeId);
@@ -34957,6 +35183,12 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
             if (v)
                 subs.add(v);
         }
+        // partitions
+        for (const p of this.partitionsCfg) {
+            [p.topicGetTarget, p.topicGetCurrent, p.topicTamper, p.topicOnline]
+                .filter((x) => !!x && String(x).trim().length > 0)
+                .forEach(x => subs.add(String(x)));
+        }
         // sensors
         for (const s of this.sensorsCfg) {
             const t = s.topics || {};
@@ -35020,6 +35252,10 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
                 const np = normalize(p);
                 if (RUNTIME.logMqttAll)
                     this.console.log(`[MQTT] ${topic} -> "${p}"`);
+                for (const dev of this.devices.values()) {
+                    if (dev instanceof PartitionMqttSecuritySystem)
+                        dev.handleMqtt(topic, payload);
+                }
                 // ---- Alarm handling ----
                 if (topic === tOnline) {
                     if (truthy(np) || np === 'online') {
@@ -35086,8 +35322,11 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
                     return;
                 }
                 // ---- Device dispatch ----
-                for (const dev of this.devices.values())
+                for (const dev of this.devices.values()) {
+                    if (dev instanceof PartitionMqttSecuritySystem)
+                        continue;
                     dev.handleMqtt(topic, payload);
+                }
             }
             catch (e) {
                 this.console.error('MQTT message handler error', e);
@@ -35101,19 +35340,22 @@ class ParadoxMqttSecuritySystem extends sdk_1.ScryptedDeviceBase {
         const qos = Math.max(0, Math.min(2, isFinite(qosNum) ? qosNum : 0));
         return { qos, retain };
     }
-    publishSetTarget(payload) {
-        const topic = this.storage.getItem('topicSetTarget');
+    publishSetTargetTo(topic, payload, label = 'Alarm') {
         if (!topic || !this.client) {
-            this.console.warn('topicSetTarget or MQTT not configured.');
-            return;
+            this.console.warn(`${label}: target topic or MQTT not configured.`);
+            return false;
         }
         const { qos, retain } = this.getPublishOptions();
         this.client.publish(topic, payload, { qos, retain }, (err) => {
             if (err)
                 this.console.error('publish error', err);
             else if (RUNTIME.logSensors)
-                this.console.log(`[Alarm] published target "${payload}" to ${topic}`);
+                this.console.log(`[${label}] published target "${payload}" to ${topic}`);
         });
+        return true;
+    }
+    publishSetTarget(payload) {
+        this.publishSetTargetTo(this.storage.getItem('topicSetTarget') || '', payload);
     }
     publishBypass(cfg, payload) {
         const topic = cfg.topics?.control?.trim();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rfranzoi/scrypted-mqtt-securitysystem",
-  "version": "1.0.98",
+  "version": "1.1.0",
   "description": "Scrypted plugin: Paradox Security System via MQTT (PAI/PAI-MQTT style).",
   "license": "MIT",
   "main": "dist/main.nodejs.js",