homebridge-ismartgate-sensor 1.4.3

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changes
+
+## 1.4.3
+Update
+-  support for homebridge 2.0
+-  updated dependancies
+-  replaced depricated node modules
+-  removed mdns config due to vulnerability

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 codyc1515
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# homebridge-ismartgate
+Forked from [homebridge-ismartgate](https://github.com/codyc1515/homebridge-ismartgate) which is no longer support and  has been archived.
+
+[Homebridge](https://github.com/nfarina/homebridge) plug-in for iSmartGate HomeKit devices to expose their Temperature & Battery services, which would otherwise be hidden.
+
+## Things to know
+* Supports only a single garage door / gate
+* Only exposes the Temperature & Battery services, as the device already has HomeKit support for the Garage Door service. If you need a Garage Door service as well, take a look at the plug-in [homebridge-gogogate2](https://www.npmjs.com/package/homebridge-gogogate2).
+* Only the iSmartGate Gate Lite is supported. While no other devices have been tested, I see no reason that they should not work.
+
+### Legal
+* Licensed under [MIT](LICENSE)
+* This is not an official plug-in and is not affiliated with iSmartGate in any way

package/config.schema.json

@@ -0,0 +1,76 @@
+{
+   "pluginAlias":"iSmartGate",
+   "headerDisplay":null,
+   "pluginType":"accessory",
+   "singular":true,
+   "schema":{
+      "type":"object",
+      "properties":{
+          "name":{
+             "title":"Accessory Name",
+             "type":"string",
+             "format":"string",
+             "default":"iSmartGate Sensor",
+             "description":"The name of your device to show in the Home app",
+             "minLength": 1,
+             "required": true
+          },
+          "username":{
+             "title":"Username",
+             "type":"string",
+             "format":"string",
+             "placeholder":"admin",
+             "description": "Default: admin",
+             "minLength": 1,
+             "required": true
+          },
+         "password":{
+            "title":"Password",
+            "type":"string",
+            "format":"password",
+            "description": "Configured during device setup",
+            "minLength": 1,
+            "required": true
+         },
+         "hostname":{
+            "title":"Hostname or IP address",
+            "type":"string",
+            "format":"string",
+            "default":"ismartgate.local",
+            "description": "Host name or local IP address",
+            "minLength": 1,
+            "required": true
+         }
+      }
+   },
+   "layout":[
+       {
+          "type":"flex",
+          "flex-flow":"row wrap",
+          "items":[
+              {
+                 "key":"name",
+                 "type":"string"
+              }
+          ]
+       },
+      {
+         "type":"flex",
+         "flex-flow":"row wrap",
+         "items":[
+            {
+               "key":"username",
+               "type":"string"
+            },
+            {
+               "key":"password",
+               "type":"password"
+            },
+            {
+               "key":"hostname",
+               "type":"string"
+            }
+         ]
+      }
+   ]
+}

package/index.js

@@ -0,0 +1,212 @@
+let   axios = require("axios")
+      //mdns = require('mdns-js'); ///"mdns-js": "^1.0.3",
+
+var	  API,
+	  Accessory,
+	  Characteristic,
+	  Service;
+
+module.exports = function(homebridge) {
+	API = homebridge;
+    Accessory = homebridge.hap.Accessory;
+    Characteristic = homebridge.hap.Characteristic;
+    Service = homebridge.hap.Service;
+
+    homebridge.registerAccessory("homebridge-ismartgate-sensor", "iSmartGate", iSmartGate);
+};
+
+function iSmartGate(log, config) {
+    this.log = log;
+    this.name = config["name"] || "iSmartGate Temperature";
+    this.username = config["username"];
+    this.password = config["password"];
+    this.hostname = config["hostname"];
+    this.response = null;
+    this.cookie = null
+
+    this.CurrentTemperature = null;
+    this.BatteryLevel = null;
+}
+
+iSmartGate.prototype = {
+
+    identify: function(callback) {
+        this.log.info("identify");
+        callback();
+    },
+
+	getServices: function() {
+
+		// Temperature Sensor service
+		this.TemperatureSensor = new Service.TemperatureSensor(this.name);
+
+		// Battery service
+        this.BatteryService = new Service.Battery(this.name);
+
+		// Accessory Information service
+        this.AccessoryInformation = new Service.AccessoryInformation();
+        this.AccessoryInformation
+            .setCharacteristic(Characteristic.Name, this.name)
+            .setCharacteristic(Characteristic.Manufacturer, "iSmartGate")
+            .setCharacteristic(Characteristic.Model, "Temperature")
+            .setCharacteristic(Characteristic.FirmwareRevision, "1.4.2")
+            .setCharacteristic(Characteristic.SerialNumber, this.username);
+
+/*
+		// Start searching for the iSmartGate using mDNS
+		var browser = mdns.createBrowser("_hap._tcp");
+		browser.on('ready', function() { browser.discover(); });
+		browser.on('update', function(data) {
+			if(data['txt']) {
+				data['txt'].forEach(txt => {
+					txt = txt.split("=");
+					if(txt[0] == "md" && txt[1] == "iSmartGate" && data.addresses[0] != this.hostname) {
+						// Set the new hostname obtained from mDNS
+						this.hostname = data.addresses[0];
+						this.log.info("Found an iSmartGate at", this.hostname);
+
+						// Login to the iSmartGate for the first time and refresh
+						setTimeout(function() {
+							this._login();
+						}.bind(this), 2500);
+					}
+				});
+			}
+		}.bind(this));
+*/
+
+        // Login to the iSmartGate for the first time and refresh
+        setTimeout(function() {
+            this.response=this._login();
+        }.bind(this), 2500);
+
+        setTimeout(function() {
+            this._refresh();
+        }.bind(this), 5000);
+
+		// Set a timer to refresh the data every 10 minutes
+		setInterval(function() {
+			this._refresh();
+		}.bind(this), 600000);
+
+		// Set a timer to refresh the login token every 3 hours
+		setInterval(function() {
+			this.response=this._login();
+		}.bind(this), 10800000);
+
+		// Return the Accessory
+        return [
+			this.AccessoryInformation,
+            this.TemperatureSensor,
+            this.BatteryService
+        ];
+
+    },
+
+	_login: async function() {
+		try {
+			this.log.info('Retrieving token')
+			let response = await axios({
+                withCredentials: true,
+				method: 'post',
+				url: `http://${this.hostname}/index.php`,
+				headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded',
+					'Accept-Encoding': 'gzip,deflate,compress',
+				},
+                data: {
+                    "MIME Type": "application/x-www-form-urlencoded",
+                    "login": this.username,
+                    "pass": this.password,
+                    "send-login": "Sign in"
+                },
+				responseType: 'text'
+			}).catch(err => {
+				this.log.debug(JSON.stringify(err, null, 2))
+				this.log.error('Error signing in and getting token %s', err.message)
+				if (err.response) { this.log.warn(JSON.stringify(err.response.data, null, 2))}
+				return err.response
+			})
+			if (response.status == 200) {
+                this.log.info("Logged into iSmartGate succesfully");
+				this.log.debug('signin response', response.headers)
+                this.cookie=response.headers['set-cookie']
+                return response
+			}
+		} catch (err) { this.log.error('Error retrieving token \n%s', err)}
+	},
+
+    _refresh: async function() {
+		try {
+            this.log.debug("Start refreshing temperature & battery");
+			let response = await axios({
+                withCredentials: true,
+				method: 'get',
+				url: `http://${this.hostname}/isg/temperature.php`,
+                headers: {
+					'Cookie': this.cookie
+				},
+                params: {
+                    door: 1
+                },
+				responseType: 'json'
+			}).catch(err => {
+				this.log.debug(JSON.stringify(err, null, 2))
+				this.log.error('Error fetching temperature & battery %s', err.message)
+				if (err.response) { this.log.warn(JSON.stringify(err.response.data, null, 2))}
+				return err.response
+			})
+			if (response.status == 200 && Array.isArray(response.data)) {
+                this.log.debug("Obtained status.", response.data);
+
+                // Find the CurrentTemperature
+                this.CurrentTemperature = response.data[0] / 1000;
+
+                // Find the BatteryLevel
+                switch (response.data[1]) {
+                    case "full":    this.BatteryLevel = 100;    break;
+                    case "80":      this.BatteryLevel = 80;     break;
+                    case "60":      this.BatteryLevel = 60;     break;
+                    case "40":      this.BatteryLevel = 40;     break;
+                    case "20":      this.BatteryLevel = 20;     break;
+                    case "low":     this.BatteryLevel = 10;     break;
+
+                    default:
+                        this.log.warn("Unexpected BatteryLevel detected.", response.data);
+                        this.BatteryLevel = 0;
+                    break;
+                }
+
+				// Set the Current Temperature
+                this.TemperatureSensor.getCharacteristic(Characteristic.CurrentTemperature).updateValue(this.CurrentTemperature);
+
+                // Set the Battery Level
+                this.BatteryService.setCharacteristic(Characteristic.BatteryLevel, this.BatteryLevel);
+
+                // Set the Status Low Battery
+                if(this.BatteryLevel <= 10) {this.BatteryService.setCharacteristic(Characteristic.StatusLowBattery, Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW);}
+                else {this.BatteryService.setCharacteristic(Characteristic.StatusLowBattery, Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL);}
+                return response
+			}
+            else {
+				if(response.data == "Restricted Access") {this.log.error("Restricted Access", response.data);}
+					else if(response.data == "Login Token Expired") {this.log.error("Login Token Expired", response.data);}
+					else {
+                        this.log.error("Could not connect.", "Check http://" + this.hostname + " to make sure the device is still reachable & no captcha is showing.");
+                        this.log.error(response.data);}
+                    }
+
+		} catch (err) { this.log.error('Error retrieving temperature & battery \n%s', err)}
+    },
+
+    _getValue: function(CharacteristicName, callback) {
+        this.log.debug("GET", CharacteristicName);
+		callback(null);
+    },
+
+    _setValue: function(CharacteristicName, value, callback) {
+        this.log.debug("SET", CharacteristicName, value);
+        callback();
+    }
+
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "homebridge-ismartgate-sensor",
+  "displayName": "ismartgate sensor",
+  "version": "1.4.3",
+  "author": "John Valiquette",
+  "dependencies": {
+    "axios": "^1.7.7"
+  },
+  "deprecated": false,
+  "description": "Homebridge plug-in for iSmartGate HomeKit devices to expose their Temperature & Battery sensor, which would otherwise be hidden.",
+  "engines": {
+    "homebridge": "^1.8.0 || ^2.0.0-beta.0",
+    "node": "^18.20.0 || ^20.17.0 || ^22.9.0"
+  },
+  "keywords": [
+    "homebridge-plugin",
+    "homekit",
+    "ismartgate",
+    "gogogate",
+    "garage",
+    "door",
+    "temperature",
+    "battery"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "homepage": "https://github.com/valiquette/homebridge-ismartgate-sensor/blob/master/README.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/valiquette/homebridge-ismartgate-sensor"
+  },
+  "bugs": {
+    "url": "https://github.com/codyc1515/homebridge-ismartgate/issues"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}