homebridge-texecom-full 4.2.5 → 4.2.6-beta.0

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This change log documents all release versions of homebridge-texecom
 
+### 4.2.6-beta.0 (2025-01-21)
+
+- **TWEAK** - House keeping.
+- **FIX** - Added carbonmonoxide and dioxide to config.schema.
 
 ### 4.2.5 (2025-01-03)
 

package/config.schema.json

@@ -64,7 +64,10 @@
                             "type": "string",
                             "enum": [
                                 "contact",
-                                "motion"
+                                "motion",
+                                "smoke",
+                                "carbonmonoxide",
+                                "carbondioxide"
                             ],
                             "title": "Zone Type"
                         },

package/index.js

@@ -77,11 +77,11 @@ TexecomPlatform.prototype = {
                 // Is the zone active?
                 var zone_active = S(zone_data).endsWith('1');
 
-                platform.log.debug("Zone update received for zone " + updated_zone + " active: " + zone_active);
+                platform.log.debug(`Zone update received for zone ${updated_zone} active: ${zone_active}`);
 
                 for (var i = 0; i < zoneCount; i++) {
                     if (zoneAccessories[i].zone_number == updated_zone) {
-                        platform.log.debug("Zone match found, updating zone status in HomeKit to " + zone_active);
+                        platform.log.debug(`Zone match found, updating zone status in HomeKit to ${zone_active}`);
                         zoneAccessories[i].changeHandler(zone_active);
 
                         if (zone_active) {
@@ -92,10 +92,10 @@ TexecomPlatform.prototype = {
 
                                             // Set the security system state to "ALARM_TRIGGERED"
                                             stateValue = Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED;
-                                            platform.log.log("Area " + areaAccessories[a].zone_number + " manual triggered");
+                                            platform.log.log(`Area ${areaAccessories[a].zone_number} manual triggered`);
 
                                             // Log the state change
-                                            platform.log.debug("Area match found, updating area status in HomeKit to " + stateValue);
+                                            platform.log.debug(`Area match found, updating area status in HomeKit to ${stateValue}`);
                                             setByAlarm = true;
                                             areaAccessories[a].changeHandler(stateValue);
 
@@ -103,7 +103,7 @@ TexecomPlatform.prototype = {
                                     });
                                 }
                                 catch (e) {
-                                    console.debug('Error processing zones for area ' + a + '. Please add zones under area.');
+                                    console.debug(`Error processing zones for area ${a} Please add zones under area.`);
                                 }
                             }
                         }
@@ -119,14 +119,16 @@ TexecomPlatform.prototype = {
                 var user = S(data).substring(5, 7);
                 var stateValue;
 
+                let armedByUser = user;
+
                 switch (String(status)) {
                     case "L":
                         stateValue = Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED;
-                        platform.log.log("Area " + updated_area + " triggered");
+                        platform.log.log(`Area ${updated_area} triggered`);
                         break;
                     case "D":
                         stateValue = Characteristic.SecuritySystemCurrentState.DISARMED;
-                        platform.log.log("Area " + updated_area + " disarmed");
+                        platform.log.log(`Area ${updated_area} disarmed by User ${user}`);
                         areas_armed = areas_armed.filter(value => value !== zpad(updated_area, 3));
                         break;
                     case "A":
@@ -137,7 +139,7 @@ TexecomPlatform.prototype = {
 
                         if (user == "17") {
                             stateValue = Characteristic.SecuritySystemCurrentState.AWAY_ARM;
-                            platform.log.log("Area " + updated_area + " armed");
+                            platform.log.log(`Area ${updated_area} armed (away) by User ${user}`);
                         }
                         else if (user == "25" || user == "254") {
                             // Read the target state
@@ -158,16 +160,16 @@ TexecomPlatform.prototype = {
                                     stateValue = Characteristic.SecuritySystemCurrentState.DISARMED;
                                     break;
                                 default:
-                                    platform.log.error("Unknown target state: " + targetState);
+                                    platform.log.error(`Unknown target state: ${targetState}`);
                                     return;
                             }
 
-                            platform.log.log("User 254: Target state is " + targetState + ", updated stateValue is " + stateValue);
+                            platform.log.log(`User ${user}: Target state is ${targetState}, updated stateValue is ${stateValue}`);
 
                         }
                         else {
                             stateValue = Characteristic.SecuritySystemCurrentState.NIGHT_ARM;
-                            platform.log.log("Area " + updated_area + " night armed");
+                            platform.log.log(`Area ${updated_area} armed (night) by User ${user}`);
                         }
 
                         if (stateValue == Characteristic.SecuritySystemCurrentState.AWAY_ARM) {
@@ -184,19 +186,19 @@ TexecomPlatform.prototype = {
                         }
                         break;
                     default:
-                        platform.log.log("Unknown status letter " + status);
+                        platform.log.log(`Unknown status letter ${status}`);
                         return;
                 }
                 for (var i = 0; i < areaCount; i++) {
                     if (areaAccessories[i].zone_number == updated_area) {
-                        platform.log.debug("Area match found, updating area status in HomeKit to " + stateValue);
+                        platform.log.debug(`Area match found, updating area status in HomeKit to ${stateValue}`);
                         setByAlarm = true;
-                        areaAccessories[i].changeHandler(stateValue);
+                        areaAccessories[i].changeHandler(stateValue, armedByUser);
                         break;
                     }
                 }
             } else {
-                platform.log.debug("Unknown string from Texecom: " + S(data));
+                platform.log.debug(`Unknown string from Texecom: ${S(data)}`);
             }
         }
 
@@ -211,7 +213,7 @@ TexecomPlatform.prototype = {
             serialPort.on("open", function () {
                 platform.log.log("Serial port opened");
                 serialPort.on('data', function (data) {
-                    platform.log.debug("Serial data received: " + data);
+                    platform.log.debug(`Serial data received: ${data}`);
                     responseEmitter.emit('data', data);
                     processData(data);
                 });
@@ -228,7 +230,7 @@ TexecomPlatform.prototype = {
             connection.setNoDelay(true);
 
             connection.on('data', function (data) {
-                platform.log.debug("IP data received: " + data);
+                platform.log.debug(`IP data received: ${data}`);
                 responseEmitter.emit('data', data);
                 processData(data);
             });
@@ -283,7 +285,7 @@ function TexecomAccessory(log, config) {
         shasum.update(this.zone_number/* || this.area_number*/);
 
         this.sn = shasum.digest('base64');
-        log.log('Computed SN: ' + this.sn);
+        log.log(`Computed SN: ${this.sn}`);
     }
 }
 
@@ -300,7 +302,7 @@ TexecomAccessory.prototype = {
         informationService
             .setCharacteristic(Characteristic.Name, this.name)
             .setCharacteristic(Characteristic.Manufacturer, "Homebridge")
-            .setCharacteristic(Characteristic.Model, "Texecom " + (this.accessoryType === "zone" ? "Zone" : "Area"))
+            .setCharacteristic(Characteristic.Model, `Texecom ${(this.accessoryType === "zone" ? "Zone" : "Area")}`)
             .setCharacteristic(Characteristic.SerialNumber, this.sn);
 
 
@@ -333,10 +335,18 @@ TexecomAccessory.prototype = {
                         .setValue(newState ? Characteristic.CarbonMonoxideDetected.CO_LEVELS_ABNORMAL : Characteristic.CarbonMonoxideDetected.CO_LEVELS_NORMAL);
                 };
                 break;
+            case "carbondioxide":
+                service = new Service.CarbonDioxideSensor();
+                changeAction = function (newState) {
+                    service.getCharacteristic(Characteristic.CarbonDioxideDetected)
+                        .setValue(newState ? Characteristic.CarbonDioxideDetected.CO_LEVELS_ABNORMAL : Characteristic.CarbonDioxideDetected.CO_LEVELS_NORMAL);
+                };
+                break;
 
             case "securitysystem":
                 service = new Service.SecuritySystem();
-                changeAction = function (newState) {
+
+                changeAction = function (newState, user = "unknown") {
                     var targetState;
                     switch (newState) {
                         case Characteristic.SecuritySystemCurrentState.NIGHT_ARM:
@@ -362,7 +372,7 @@ TexecomAccessory.prototype = {
                         service.getCharacteristic(Characteristic.SecuritySystemTargetState).updateValue(targetState);
                     }
                     service.getCharacteristic(Characteristic.SecuritySystemCurrentState).updateValue(newState);
-                    me.log.debug("Set target state " + targetState + " and current state " + newState + " in response to notification from alarm");
+                    me.log.debug(`Set target state ${targetState} and current state ${newState} in response to notification from alarm`);
                 };
 
                 // we don't know the alarm's state at startup, safer to assume disarmed:
@@ -372,7 +382,7 @@ TexecomAccessory.prototype = {
                 service.getCharacteristic(Characteristic.SecuritySystemTargetState)
                     .on('set', function (value, callback) {
                         if (setByAlarm) {
-                            platform.log.debug("Not sending command to alarm for change to state " + value + " because the state change appears to have come from the alarm itself.");
+                            platform.log.debug(`Not sending command to alarm for change to state ${value} because the state change appears to have come from the alarm itself.`);
                             setByAlarm = false;
                             return;
                         }
@@ -395,9 +405,9 @@ TexecomAccessory.prototype = {
                 break;
         }
 
-        this.changeHandler = function (status) {
+        this.changeHandler = function (status, user = "unknown") {
             var newState = status;
-            platform.log.debug("Dwell = " + this.dwell_time);
+            platform.log.debug(`Dwell = ${this.dwell_time}`);
 
             if (!newState && this.dwell_time > 0) {
                 this.dwell_timer = setTimeout(function () { changeAction(newState); }.bind(this), this.dwell_time);
@@ -408,7 +418,12 @@ TexecomAccessory.prototype = {
                 changeAction(newState);
             }
 
-            platform.log.debug("Changing state with changeHandler to " + newState);
+            if (user == "unknown") {
+                platform.log.debug(`Changing state with changeHandler to ${newState}`);
+            }
+            else {
+                platform.log.debug(`Changing state with changeHandler to ${newState} by User ${user}`);
+            }
 
         }.bind(this);
 
@@ -436,26 +451,26 @@ function areaTargetSecurityStateSet(platform, accessory, service, value, callbac
     switch (value) {
         case Characteristic.SecuritySystemTargetState.NIGHT_ARM:
         case Characteristic.SecuritySystemTargetState.STAY_ARM:
-            command = "Y" + area_number;  // Home
+            command = `Y${area_number}`;  // Home
             break;
         case Characteristic.SecuritySystemTargetState.AWAY_ARM:
-            command = "A" + area_number; // Away arm
+            command = `A${area_number}`; // Away arm
             break;
         case Characteristic.SecuritySystemTargetState.DISARM:
-            command = "D" + area_number; // Disarm
+            command = `D${area_number}`; // Disarm
             break;
         default:
-            this.log.debug("Unknown target state: " + value);
+            this.log.debug(`Unknown target state: ${value}`);
             callback(new Error("Unknown target state"));
             return;
     }
 
-    platform.log.debug("Sending arm/disarm command " + value + " to area " + accessory.zone_number);
+    platform.log.debug(`Sending arm/disarm command ${value} to area ${accessory.zone_number}`);
 
 
 
 
-    writeCommandAndWaitForOK(platform.texecomConnection, "W" + platform.udl)
+    writeCommandAndWaitForOK(platform.texecomConnection, `W${platform.udl}`)
         .then(() => writeCommandAndWaitForOK(platform.texecomConnection, command, 0))
         .then(() => {
             // OK response from alarm is only indication that the target state has been reached
@@ -474,18 +489,18 @@ function areaTargetSecurityStateSet(platform, accessory, service, value, callbac
                     currentState = Characteristic.SecuritySystemCurrentState.DISARMED;
                     break;
                 default:
-                    platform.log.debug("Unknown target alarm state " + value);
+                    platform.log.debug(`Unknown target alarm state ${value}`);
                     callback(new Error("Unknown target state"));
                     return;
             }
-            platform.log.debug("Setting current status of area " + accessory.zone_number + " to " + currentState + " because alarm responded OK");
+            platform.log.debug(`Setting current status of area ${accessory.zone_number} to ${currentState} because alarm responded OK`);
             service.getCharacteristic(Characteristic.SecuritySystemCurrentState)
                 .updateValue(currentState);
             accessory.target_State = currentState;
             callback();
         })
         .catch((err) => {
-            platform.log.debug("Callback with error " + err);
+            platform.log.debug(`Callback with error ${err}`);
             callback(err); // Handle errors
         });
 }
@@ -501,19 +516,19 @@ function writeCommandAndWaitForOK(connection, command, retryCount = 1) {
 
         responseEmitter.on('data', handleData);
 
-        connection.write("\\" + command + "/", function (err) {
+        connection.write(`\\${command}/`, function (err) {
             if (err) {
-                platform.log.debug("Error writing to connection: " + err);
+                platform.log.debug(`Error writing to connection: ${err}`);
                 reject(err);
             } else {
-                platform.log.debug("Command sent: " + command);
+                platform.log.debug(`Command sent: ${command}`);
             }
         });
 
         setTimeout(() => {
             responseEmitter.removeListener('data', handleData);
             if (retryCount > 0) {
-                platform.log.debug("Retrying command due to timeout, retries left: " + retryCount);
+                platform.log.debug(`Retrying command due to timeout, retries left: ${retryCount}`);
                 writeCommandAndWaitForOK(connection, command, retryCount - 1).then(resolve).catch(reject);
             } else {
                 reject(new Error("Timeout after retries"));

package/package.json

@@ -2,7 +2,7 @@
   "displayName": "Homebridge Texecom",
   "name": "homebridge-texecom-full",
   "description": "A plugin for homebridge to integrate Texecom Premier Elite alarm systems into HomeKit",
-  "version": "4.2.5",
+  "version": "4.2.6-beta.0",
   "author": {
     "name": "Chris Posthumus",
     "email": "chris.posthumus@gmail.com"