homebridge-texecom-full 4.2.1 → 4.2.5-beta.1

package/.github/FUNDING.yml

@@ -9,4 +9,4 @@ issuehunt: # Replace with a single IssueHunt username
 lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
 polar: # Replace with a single Polar username
 buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+custom: ['https://www.paypal.me/chrisposthumus']

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/CHANGELOG.md

@@ -2,10 +2,24 @@
 
 This change log documents all release versions of homebridge-texecom
 
+### 4.2.3 (2024-10-09)
+
+- **TWEAK** - Trying to get verified by homebridge
+
+### 4.2.2-beta2 (2024-10-09)
+
+- **TWEAK** - Can not install in certain cases. Added post script to check if python is installed.
+- **TEST** - Tested on Homebridge V2
+
+### 4.2.2-beta1 (2024-09-14)
+
+- **TWEAK** - Area triggering reduced to Away Arm only
+            - Not triggering when in Home and evening arm
+
 ### 4.2.1 (2024-09-14)
 
-**FEATURE** - Added arm and disarm for each area
-            - Added zones to each area to be able to trigger an alarm.
+- **FEATURE** - Added arm and disarm for each area
+              - Added zones to each area to be able to trigger an alarm.
 
 ### 1.0.3 (2017-01-28)
 
@@ -23,4 +37,4 @@ This change log documents all release versions of homebridge-texecom
 
 ### 1.0.0 (2017-01-21)
 
-- **FEATURE** - Initial release.
+- **FEATURE** - Initial release.

package/README.md

@@ -1,14 +1,19 @@
+[![npm version](https://badgen.net/npm/v/homebridge-texecom-full/latest)](https://www.npmjs.com/package/homebridge-texecom-full)
+[![npm beta version](https://badgen.net/npm/v/homebridge-texecom-full/beta)](https://www.npmjs.com/package/homebridge-texecom-full)
+[![npm downloads](https://badgen.net/npm/dt/homebridge-texecom-full)](https://www.npmjs.com/package/homebridge-texecom-full)
+[![GitHub last commit](https://badgen.net/github/last-commit/K1LL3R234/homebridge-texecom)](https://github.com/K1LL3R234/homebridge-texecom)
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)[![verified-by-homebridge](https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
 # homebridge-texecom-full
 
 A plugin for [Homebridge](https://github.com/nfarina/homebridge) that creates HomeKit motion, contact, smoke, or carbon monoxide sensors for alarm zones from a Texecom Premier intruder alarm via a serial connection or COM-IP module.
 
 You can receive notifications, which can be set to work only when you're away from home:
 
-![example of notifications](https://github.com/max-christian/homebridge-texecom/blob/master/images/example-notifications.jpg?raw=true)
+![example of notifications](https://github.com/K1LL3R234/homebridge-texecom/blob/master/images/example-notifications.jpg?raw=true)
 
 Another great use is to use the alarm's motion sensors to switch lights on automatically:
 
-![example of automation](https://github.com/max-christian/homebridge-texecom/blob/master/images/example-automation.jpg?raw=true)
+![example of automation](https://github.com/K1LL3R234/homebridge-texecom/blob/master/images/example-automation.jpg?raw=true)
 
 You can also set automations to happen when you arm the alarm and when the alarm goes off.
 
@@ -132,6 +137,8 @@ To configure your COM1 port for the Crestron protocol:
 
 Press "Menu" repeatedly to exit the engineer menu.
 
+**Make sure you program your UDL code in the panel too.**
+
 If connecting to a COM-IP, set up the COM-IP as usual and ensure it is working. Then change the configuration for the port the COM-IP is connected to to Crestron as detailed above. This allows the panel to configure the IP address into the module, then changing to Crestron will allow the panel to input/output the correct commands.
 
 ## Future features

package/config.schema.json

@@ -48,6 +48,7 @@
             },
             "zones": {
                 "type": "array",
+                "title": "Zones",
                 "items": {
                     "type": "object",
                     "properties": {
@@ -83,6 +84,7 @@
             },
             "areas": {
                 "type": "array",
+                "title": "Areas",
                 "items": {
                     "type": "object",
                     "properties": {
@@ -121,6 +123,11 @@
                         "dwell"
                     ]
                 }
+            },
+            "debug":{
+                "type":"boolean",
+                "title":"Debug",
+                "default":false
             }
         },
         "required": true

package/index.js

@@ -17,14 +17,8 @@ const LogUtil = require('./util/logutil');
 var areas_armed = [];  // Creates an empty array, which can later grow dynamically
 
 
-var serialPort;
-var connection;
-
-var service_area;
-
 var setByAlarm = false;
 
-var changed = false;
 
 module.exports = function (homebridge) {
     Accessory = homebridge.platformAccessory;
@@ -129,46 +123,68 @@ TexecomPlatform.prototype = {
                     case "L":
                         stateValue = Characteristic.SecuritySystemCurrentState.ALARM_TRIGGERED;
                         platform.log.log("Area " + updated_area + " triggered");
-                        changed = true;
                         break;
                     case "D":
                         stateValue = Characteristic.SecuritySystemCurrentState.DISARMED;
                         platform.log.log("Area " + updated_area + " disarmed");
-                        changed = true;
-
-                        areas_armed = areas_armed.filter(value => value !== zpad(updated_area,3));
-
+                        areas_armed = areas_armed.filter(value => value !== zpad(updated_area, 3));
                         break;
                     case "A":
                         //user is for my setup
                         //my user 17 is full armed (remote)
+                        //my user on app is 254
                         //all the rest is night armed
 
-                        // Find the index of the first null or undefined value
-                        const index = areas_armed.findIndex(value => value === null || value === undefined);
-
-                        if (index !== -1) {
-                            // Replace the value at that index
-                            areas_armed[index] = zpad(updated_area,3);
-                        } else {
-                            // If no open slot, append to the end
-                            areas_armed.push(zpad(updated_area,3));
-                        }
-
-
                         if (user == "17") {
                             stateValue = Characteristic.SecuritySystemCurrentState.AWAY_ARM;
                             platform.log.log("Area " + updated_area + " armed");
                         }
+                        else if (user == "25" || user == "254") {
+                            // Read the target state
+                            const targetState = areaAccessories[updated_area - 1].target_State;
+
+                            // Map the targetState to the corresponding current state value
+                            switch (targetState) {
+                                case Characteristic.SecuritySystemTargetState.AWAY_ARM:
+                                    stateValue = Characteristic.SecuritySystemCurrentState.AWAY_ARM;
+                                    break;
+                                case Characteristic.SecuritySystemTargetState.STAY_ARM:
+                                    stateValue = Characteristic.SecuritySystemCurrentState.STAY_ARM;
+                                    break;
+                                case Characteristic.SecuritySystemTargetState.NIGHT_ARM:
+                                    stateValue = Characteristic.SecuritySystemCurrentState.NIGHT_ARM;
+                                    break;
+                                case Characteristic.SecuritySystemTargetState.DISARM:
+                                    stateValue = Characteristic.SecuritySystemCurrentState.DISARMED;
+                                    break;
+                                default:
+                                    platform.log.error("Unknown target state: " + targetState);
+                                    return;
+                            }
+
+                            platform.log.log("User 254: Target state is " + targetState + ", updated stateValue is " + stateValue);
+
+                        }
                         else {
                             stateValue = Characteristic.SecuritySystemCurrentState.NIGHT_ARM;
                             platform.log.log("Area " + updated_area + " night armed");
                         }
-                        changed = true;
+
+                        if (stateValue == Characteristic.SecuritySystemCurrentState.AWAY_ARM) {
+                            // Find the index of the first null or undefined value
+                            const index = areas_armed.findIndex(value => value === null || value === undefined);
+
+                            if (index !== -1) {
+                                // Replace the value at that index
+                                areas_armed[index] = zpad(updated_area, 3);
+                            } else {
+                                // If no open slot, append to the end
+                                areas_armed.push(zpad(updated_area, 3));
+                            }
+                        }
                         break;
                     default:
                         platform.log.log("Unknown status letter " + status);
-                        changed = true;
                         return;
                 }
                 for (var i = 0; i < areaCount; i++) {
@@ -244,6 +260,10 @@ function TexecomAccessory(log, config) {
     this.name = config["name"];
     this.zone_type = config["zone_type"] || config["area_type"] || "motion";
     this.dwell_time = config["dwell"] || 0;
+
+    if (config["area_type"] == "securitysystem") {
+        this.target_State = Characteristic.SecuritySystemTargetState.DISARM;
+    }
     try {
         if (Array.isArray(config["zones"])) {
             // If it's an array, apply zpad to each element
@@ -461,6 +481,7 @@ function areaTargetSecurityStateSet(platform, accessory, service, value, callbac
             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) => {
@@ -502,14 +523,7 @@ function writeCommandAndWaitForOK(connection, command, retryCount = 1) {
 }
 
 function is_armed(area_number) {
-    //let isAreaArmed = false;
-
     let isAreaArmed = areas_armed.some(value => value === area_number);
-    /*areas_armed.forEach(function (value) {
-        if (value === area_number) {
-            isAreaArmed = true;
-        }
-    });*/
 
     return isAreaArmed;
 }

package/package.json

@@ -1,12 +1,30 @@
 {
   "displayName": "Homebridge Texecom",
   "name": "homebridge-texecom-full",
-  "description": "A plugin for homebridge (https://github.com/nfarina/homebridge) to integrate Texecom Premier Elite alarm systems into HomeKit",
-  "version": "4.2.1",
+  "description": "A plugin for homebridge to integrate Texecom Premier Elite alarm systems into HomeKit",
+  "version": "4.2.5-beta.1",
+  "author": {
+    "name": "Chris Posthumus",
+    "email": "chris.posthumus@gmail.com"
+  },
+  "homepage": "https://github.com/K1LL3R234/homebridge-texecom",
   "repository": {
     "type": "git",
-    "url": "https://github.com/K1LL3R234/homebridge-texecom"
+    "url": "https://github.com/K1LL3R234/homebridge-texecom.git"
+  },
+  "bugs": {
+    "url": "https://https://github.com/K1LL3R234/homebridge-texecom/issues"
   },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/K1LL3R234"
+    },
+    {
+      "type": "paypal",
+      "url": "https://www.paypal.me/chrisposthumus"
+    }
+  ],
   "license": "MIT",
   "preferGlobal": true,
   "keywords": [
@@ -21,8 +39,9 @@
     "Texecom"
   ],
   "engines": {
-    "node": ">=0.12.0",
-    "homebridge": ">=0.2.5"
+    "homebridge": "^1.6.0 || ^2.0.0-beta.0",
+    "node": "^18.20.4 || ^20.15.1",
+    "python": ">=3.6.0"
   },
   "homebridge": {
     "platforms": [
@@ -30,8 +49,8 @@
     ]
   },
   "dependencies": {
-    "debug": "^2.6.9",
-    "serialport": "^8.0.8",
+    "debug": "^4.2.0",
+    "serialport": "^12.0.0",
     "string": "^3.3.3",
     "zpad": "^0.5.0"
   }

package/util/logutil.js

@@ -34,4 +34,4 @@ class LogUtil {
     }
 }
 
-module.exports = LogUtil;
+module.exports = LogUtil;

package/.vscode/launch.json

@@ -1,23 +0,0 @@
-{
-    /*"configurations": [
-        {
-            "type": "chrome",
-            "name": "localhost:8581",
-            "request": "launch",
-            "program":"${env:APPDATA}\\Roaming\\npm\\node_modules\\homebridge\\bin\\homebridge",
-            "url": "localhost:8581"
-        }
-    ]*/
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Launch Program",
-            "program": "${env:APPDATA}\\npm\\node_modules\\homebridge\\bin\\homebridge",
-            "request": "launch",
-            "skipFiles": [
-                "<node_internals>//**"
-            ],
-            "type":"pwa-node"
-        }
-    ]
-}