@homebridge-plugins/homebridge-tado 6.0.14

package/homebridge-ui/server.js

@@ -0,0 +1,80 @@
+const { HomebridgePluginUiServer } = require('@homebridge/plugin-ui-utils');
+const { RequestError } = require('@homebridge/plugin-ui-utils');
+
+const TadoApi = require('../src/tado/tado-api.js');
+
+class UiServer extends HomebridgePluginUiServer {
+  constructor () { 
+
+    super();
+
+    this.onRequest('/authenticate', this.authenticate.bind(this));
+    this.onRequest('/exec', this.exec.bind(this));
+    this.onRequest('/reset', this.reset.bind(this));
+    
+    this.tado = false;
+    
+    this.ready();
+  } 
+
+  authenticate(config){
+  
+    this.tado = new TadoApi('Config UI X', { username: config.username, password: config.password });
+    
+    return;
+  
+  }
+  
+  reset(){
+  
+    this.tado = false;
+  
+    return;
+  
+  }
+  
+  async exec(payload){
+  
+    if(this.tado){
+    
+      try {
+      
+        console.log('Executing /' + payload.dest);
+        
+        let value1, value2, value3;
+        
+        if(payload.data){
+          if(typeof payload.data === 'object'){
+            value1 = payload.data[0];
+            value2 = payload.data[1];
+            value3 = payload.data[2];
+          } else {
+            value1 = payload.data;
+          }
+        }
+  
+        const data = await this.tado[payload.dest](value1, value2, value3);
+        
+        return data;
+  
+      } catch(err){
+      
+        console.log(err);
+  
+        throw new RequestError(err.message);
+  
+      }
+      
+    } else {
+  
+      throw new RequestError('API not initialized!');
+  
+    }
+  
+  }
+
+}
+
+(() => {
+  return new UiServer;
+})();

package/index.js

@@ -0,0 +1,14 @@
+/**
+ * v6
+ *
+ * @url https://github.com/homebridge-plugins/homebridge-tado
+ * @author SeydX <seyd55@outlook.de>
+ *
+ **/
+
+'use strict';
+
+module.exports = function (homebridge) {
+  let TadoPlatform = require('./src/platform.js')(homebridge);
+  homebridge.registerPlatform('@homebridge-plugins/homebridge-tado', 'TadoPlatform', TadoPlatform, true);
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@homebridge-plugins/homebridge-tado",
+  "version": "6.0.14",
+  "description": "Homebridge plugin for controlling Tado devices",
+  "main": "index.js",
+  "funding": [
+    {
+      "type": "paypal",
+      "url": "https://paypal.me/seydx"
+    },
+    {
+      "type": "kofi",
+      "url": "https://ko-fi.com/seydx"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/seydx"
+    }
+  ],
+  "scripts": {
+    "lint": "eslint --fix ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/homebridge-plugins/homebridge-tado.git"
+  },
+  "author": "SeydX (https://github.com/homebridge-plugins/homebridge-tado)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/homebridge-plugins/homebridge-tado/issues"
+  },
+  "homepage": "https://github.com/homebridge-plugins/homebridge-tado#readme",
+  "keywords": [
+    "tado",
+    "thermostat",
+    "homebridge",
+    "homebridge-plugin",
+    "plugin",
+    "boiler",
+    "presence",
+    "heat"
+  ],
+  "engines": {
+    "node": ">=12.18.3",
+    "homebridge": "^1.1.6"
+  },
+  "dependencies": {
+    "@homebridge/plugin-ui-utils": "^0.0.19",
+    "fakegato-history": "^0.6.1",
+    "form-data": "^4.0.0",
+    "fs-extra": "^10.0.0",
+    "got": "^11.8.2",
+    "moment": "^2.29.1",
+    "simple-oauth2": "^4.2.0"
+  },
+  "devDependencies": {
+    "@babel/core": "7.14.3",
+    "@babel/eslint-parser": "7.14.4",
+    "@babel/eslint-plugin": "7.13.16",
+    "eslint": "^7.27.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-prettier": "^3.4.0",
+    "prettier": "^2.3.0"
+  }
+}

package/src/accessories/airquality.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const Logger = require('../helper/logger.js');
+
+class AirQualityAccessory {
+  constructor(api, accessory, accessories, tado) {
+    this.api = api;
+    this.accessory = accessory;
+    this.accessories = accessories;
+
+    this.tado = tado;
+
+    this.getService();
+  }
+
+  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+  // Services
+  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+
+  getService() {
+    let service = this.accessory.getService(this.api.hap.Service.AirQualitySensor);
+
+    if (!service) {
+      Logger.info('Adding AirQualitySensor service', this.accessory.displayName);
+      service = this.accessory.addService(
+        this.api.hap.Service.AirQualitySensor,
+        this.accessory.displayName,
+        this.accessory.context.config.subtype
+      );
+    }
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.PM10Density))
+      service.addCharacteristic(this.api.hap.Characteristic.PM10Density);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.PM2_5Density))
+      service.addCharacteristic(this.api.hap.Characteristic.PM2_5Density);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.NitrogenDioxideDensity))
+      service.addCharacteristic(this.api.hap.Characteristic.NitrogenDioxideDensity);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.OzoneDensity))
+      service.addCharacteristic(this.api.hap.Characteristic.OzoneDensity);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.SulphurDioxideDensity))
+      service.addCharacteristic(this.api.hap.Characteristic.SulphurDioxideDensity);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.CarbonMonoxideLevel))
+      service.addCharacteristic(this.api.hap.Characteristic.CarbonMonoxideLevel);
+
+    service.getCharacteristic(this.api.hap.Characteristic.CarbonMonoxideLevel).setProps({
+      minStep: 0.01,
+    });
+  }
+}
+
+module.exports = AirQualityAccessory;

package/src/accessories/contact.js

@@ -0,0 +1,124 @@
+'use strict';
+
+const Logger = require('../helper/logger.js');
+
+const moment = require('moment');
+
+const timeout = (ms) => new Promise((res) => setTimeout(res, ms));
+
+class ContactAccessory {
+  constructor(api, accessory, accessories, tado, deviceHandler, FakeGatoHistoryService) {
+    this.api = api;
+    this.accessory = accessory;
+    this.accessories = accessories;
+    this.FakeGatoHistoryService = FakeGatoHistoryService;
+
+    this.deviceHandler = deviceHandler;
+    this.tado = tado;
+
+    this.getService();
+  }
+
+  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+  // Services
+  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+
+  async getService() {
+    let service = this.accessory.getService(this.api.hap.Service.ContactSensor);
+    let serviceSwitch = this.accessory.getService(this.api.hap.Service.Switch);
+
+    if (serviceSwitch) {
+      Logger.info('Removing Switch service', this.accessory.displayName);
+      this.accessory.removeService(serviceSwitch);
+    }
+
+    if (!service) {
+      Logger.info('Adding ContactSensor service', this.accessory.displayName);
+      service = this.accessory.addService(
+        this.api.hap.Service.ContactSensor,
+        this.accessory.displayName,
+        this.accessory.context.config.subtype
+      );
+    }
+
+    let batteryService = this.accessory.getService(this.api.hap.Service.BatteryService);
+
+    if (!this.accessory.context.config.noBattery && this.accessory.context.config.type === 'HEATING') {
+      if (!batteryService) {
+        Logger.info('Adding Battery service', this.accessory.displayName);
+        batteryService = this.accessory.addService(this.api.hap.Service.BatteryService);
+      }
+      batteryService.setCharacteristic(
+        this.api.hap.Characteristic.ChargingState,
+        this.api.hap.Characteristic.ChargingState.NOT_CHARGEABLE
+      );
+    } else {
+      if (batteryService) {
+        Logger.info('Removing Battery service', this.accessory.displayName);
+        this.accessory.removeService(batteryService);
+      }
+    }
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.LastActivation))
+      service.addCharacteristic(this.api.hap.Characteristic.LastActivation);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.TimesOpened))
+      service.addCharacteristic(this.api.hap.Characteristic.TimesOpened);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.ResetTotal))
+      service.addCharacteristic(this.api.hap.Characteristic.ResetTotal);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.OpenDuration))
+      service.addCharacteristic(this.api.hap.Characteristic.OpenDuration);
+
+    if (!service.testCharacteristic(this.api.hap.Characteristic.ClosedDuration))
+      service.addCharacteristic(this.api.hap.Characteristic.ClosedDuration);
+
+    service.getCharacteristic(this.api.hap.Characteristic.ResetTotal).onSet((value) => {
+      Logger.info(value + ': Resetting FakeGato..', this.accessory.displayName);
+
+      const now = Math.round(new Date().valueOf() / 1000);
+      const epoch = Math.round(new Date('2001-01-01T00:00:00Z').valueOf() / 1000);
+
+      service.getCharacteristic(this.api.hap.Characteristic.ResetTotal).updateValue(now - epoch);
+
+      this.accessory.context.timesOpened = 0;
+
+      service
+        .getCharacteristic(this.api.hap.Characteristic.TimesOpened)
+        .updateValue(this.accessory.context.timesOpened);
+    });
+
+    this.historyService = new this.FakeGatoHistoryService('door', this.accessory, {
+      storage: 'fs',
+      path: this.api.user.storagePath(),
+      disableTimer: true,
+    });
+
+    await timeout(250); //wait for historyService to load
+
+    service
+      .getCharacteristic(this.api.hap.Characteristic.ContactSensorState)
+      .on(
+        'change',
+        this.deviceHandler.changedStates.bind(this, this.accessory, this.historyService, this.accessory.displayName)
+      );
+
+    this.refreshHistory(service);
+  }
+
+  refreshHistory(service) {
+    let state = service.getCharacteristic(this.api.hap.Characteristic.ContactSensorState).value;
+
+    this.historyService.addEntry({
+      time: moment().unix(),
+      status: state ? 1 : 0,
+    });
+
+    setTimeout(() => {
+      this.refreshHistory(service);
+    }, 10 * 60 * 1000);
+  }
+}
+
+module.exports = ContactAccessory;

package/src/accessories/faucet.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const Logger = require('../helper/logger.js');
+
+class FaucetAccessory {
+  constructor(api, accessory, accessories, tado, deviceHandler) {
+    this.api = api;
+    this.accessory = accessory;
+    this.accessories = accessories;
+
+    this.deviceHandler = deviceHandler;
+    this.tado = tado;
+
+    this.getService();
+  }
+
+  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+  // Services
+  //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
+
+  getService() {
+    let service = this.accessory.getService(this.api.hap.Service.Valve);
+    let serviceSwitch = this.accessory.getService(this.api.hap.Service.Switch);
+    let serviceHeaterCooler = this.accessory.getService(this.api.hap.Service.HeaterCooler);
+    let serviceThermostat = this.accessory.getService(this.api.hap.Service.Thermostat);
+
+    if (serviceSwitch) {
+      Logger.info('Removing Switch service', this.accessory.displayName);
+      this.accessory.removeService(serviceSwitch);
+    }
+
+    if (serviceThermostat) {
+      Logger.info('Removing Thermostat service', this.accessory.displayName);
+      this.accessory.removeService(serviceThermostat);
+    }
+
+    if (serviceHeaterCooler) {
+      Logger.info('Removing HeaterCooler service', this.accessory.displayName);
+      this.accessory.removeService(serviceHeaterCooler);
+    }
+
+    if (!service) {
+      Logger.info('Adding Faucet service', this.accessory.displayName);
+      service = this.accessory.addService(
+        this.api.hap.Service.Valve,
+        this.accessory.displayName,
+        this.accessory.context.config.subtype
+      );
+    }
+
+    service
+      .setCharacteristic(this.api.hap.Characteristic.Name, this.accessory.displayName)
+      .setCharacteristic(this.api.hap.Characteristic.IsConfigured, this.api.hap.Characteristic.IsConfigured.CONFIGURED)
+      .setCharacteristic(this.api.hap.Characteristic.StatusFault, this.api.hap.Characteristic.StatusFault.NO_FAULT)
+      .setCharacteristic(this.api.hap.Characteristic.ValveType, this.api.hap.Characteristic.ValveType.WATER_FAUCET);
+
+    service
+      .getCharacteristic(this.api.hap.Characteristic.Active)
+      .onSet(this.deviceHandler.setStates.bind(this, this.accessory, this.accessories, 'State'));
+  }
+}
+
+module.exports = FaucetAccessory;