@homebridge-plugins/homebridge-tado 8.2.0 → 8.3.0-beta.0

package/config.schema.json

@@ -563,6 +563,11 @@
         "title": "Skip Authentication",
         "type": "boolean",
         "description": "Optional: Skip authentication for tado api."
+      },
+      "skipFakeGatoHistory": {
+        "title": "Skip FakeGato History Service",
+        "type": "boolean",
+        "description": "Optional: Skip creation of FakeGato history service."
       }
     }
   },
@@ -571,6 +576,7 @@
     "debug",
     "tadoApiUrl",
     "skipAuth",
+    "skipFakeGatoHistory",
     {
       "key": "homes",
       "type": "array",

package/homebridge-ui/public/js/main.js

@@ -134,6 +134,7 @@ async function createCustomSchema(home) {
     debug: pluginConfig[0].debug,
     tadoApiUrl: pluginConfig[0].tadoApiUrl,
     skipAuth: pluginConfig[0].skipAuth,
+    skipFakeGatoHistory: pluginConfig[0].skipFakeGatoHistory,
     homes: home
   });
 
@@ -143,6 +144,7 @@ async function createCustomSchema(home) {
     pluginConfig[0].debug = config.debug;
     pluginConfig[0].tadoApiUrl = config.tadoApiUrl;
     pluginConfig[0].skipAuth = config.skipAuth;
+    pluginConfig[0].skipFakeGatoHistory = config.skipFakeGatoHistory;
     pluginConfig[0].homes = pluginConfig[0].homes.map(myHome => {
       if (myHome.name === config.homes.name) {
         myHome = config.homes;
@@ -285,6 +287,7 @@ async function removeDeviceFromConfig(name) {
         delete pluginConfig[0].debug;
         delete pluginConfig[0].tadoApiUrl;
         delete pluginConfig[0].skipAuth;
+        delete pluginConfig[0].skipFakeGatoHistory;
       }
 
       await homebridge.updatePluginConfig(pluginConfig);

package/homebridge-ui/public/js/schema.js

@@ -555,6 +555,11 @@ const schema = {
       'title': 'Skip Authentication',
       'type': 'boolean',
       'description': 'Optional: Skip authentication for tado api.'
+    },
+    'skipFakeGatoHistory': {
+      'title': 'Skip FakeGato History Service',
+      'type': 'boolean',
+      'description': 'Optional: Skip creation of FakeGato history service.'
     }
   },
   'layout': [
@@ -562,6 +567,7 @@ const schema = {
     'debug',
     'tadoApiUrl',
     'skipAuth',
+    'skipFakeGatoHistory',
     'homes.name',
     'homes.polling',
     'homes.temperatureUnit',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homebridge-plugins/homebridge-tado",
-  "version": "8.2.0",
+  "version": "8.3.0-beta.0",
   "description": "Homebridge plugin for controlling tado° devices.",
   "main": "index.js",
   "scripts": {
@@ -51,4 +51,4 @@
     "globals": "^16.4.0",
     "prettier": "^3.6.2"
   }
-}
+}

package/src/accessories/contact.js

@@ -86,11 +86,11 @@ export default class ContactAccessory {
         .updateValue(this.accessory.context.timesOpened);
     });
 
-    this.historyService = new this.FakeGatoHistoryService('door', this.accessory, {
+    this.historyService = this.FakeGatoHistoryService ? new this.FakeGatoHistoryService('door', this.accessory, {
       storage: 'fs',
       path: this.api.user.storagePath(),
       disableTimer: true,
-    });
+    }) : undefined;
 
     await timeout(250); //wait for historyService to load
 
@@ -101,19 +101,18 @@ export default class ContactAccessory {
         this.deviceHandler.changedStates.bind(this, this.accessory, this.historyService, this.accessory.displayName)
       );
 
-    this.refreshHistory(service);
+    if (!this.refreshHistoryHandlerRegistered) {
+      this.deviceHandler.refreshHistoryHandlers.push(() => this.refreshHistory(service));
+      this.refreshHistoryHandlerRegistered = true;
+    }
   }
 
   refreshHistory(service) {
     let state = service.getCharacteristic(this.api.hap.Characteristic.ContactSensorState).value;
 
-    this.historyService.addEntry({
+    if (this.historyService) this.historyService.addEntry({
       time: moment().unix(),
       status: state ? 1 : 0,
     });
-
-    setTimeout(() => {
-      this.refreshHistory(service);
-    }, 10 * 60 * 1000);
   }
 }

package/src/accessories/heatercooler.js

@@ -248,11 +248,11 @@ export default class HeaterCoolerAccessory {
     if (service.testCharacteristic(this.api.hap.Characteristic.RotationSpeed))
       service.removeCharacteristic(service.getCharacteristic(this.api.hap.Characteristic.RotationSpeed));
 
-    this.historyService = new this.FakeGatoHistoryService('thermo', this.accessory, {
+    this.historyService = this.FakeGatoHistoryService ? new this.FakeGatoHistoryService('thermo', this.accessory, {
       storage: 'fs',
       path: this.api.user.storagePath(),
       disableTimer: true,
-    });
+    }) : undefined;
 
     await timeout(250); //wait for historyService to load
 
@@ -324,7 +324,10 @@ export default class HeaterCoolerAccessory {
         this.deviceHandler.changedStates.bind(this, this.accessory, this.historyService, this.accessory.displayName)
       );
 
-    this.refreshHistory(service);
+    if (!this.refreshHistoryHandlerRegistered) {
+      this.deviceHandler.refreshHistoryHandlers.push(() => this.refreshHistory(service));
+      this.refreshHistoryHandlerRegistered = true;
+    }
   }
 
   refreshHistory(service) {
@@ -338,15 +341,11 @@ export default class HeaterCoolerAccessory {
         : 0;
 
     //Thermo
-    this.historyService.addEntry({
+    if (this.historyService) this.historyService.addEntry({
       time: moment().unix(),
       currentTemp: currentTemp,
       setTemp: targetTemp,
       valvePosition: valvePos,
     });
-
-    setTimeout(() => {
-      this.refreshHistory(service);
-    }, 10 * 60 * 1000);
   }
 }

package/src/accessories/humidity.js

@@ -50,11 +50,11 @@ export default class HumidityAccessory {
       }
     }
 
-    this.historyService = new this.FakeGatoHistoryService('room', this.accessory, {
+    this.historyService = this.FakeGatoHistoryService ? new this.FakeGatoHistoryService('room', this.accessory, {
       storage: 'fs',
       path: this.api.user.storagePath(),
       disableTimer: true,
-    });
+    }) : undefined;
 
     await timeout(250); //wait for historyService to load
 
@@ -65,21 +65,20 @@ export default class HumidityAccessory {
         this.deviceHandler.changedStates.bind(this, this.accessory, this.historyService, this.accessory.displayName)
       );
 
-    this.refreshHistory(service);
+    if (!this.refreshHistoryHandlerRegistered) {
+      this.deviceHandler.refreshHistoryHandlers.push(() => this.refreshHistory(service));
+      this.refreshHistoryHandlerRegistered = true;
+    }
   }
 
   refreshHistory(service) {
     let state = service.getCharacteristic(this.api.hap.Characteristic.CurrentRelativeHumidity).value;
 
-    this.historyService.addEntry({
+    if (this.historyService) this.historyService.addEntry({
       time: moment().unix(),
       temp: 0,
       humidity: state,
       ppm: 0,
     });
-
-    setTimeout(() => {
-      this.refreshHistory(service);
-    }, 10 * 60 * 1000);
   }
 }

package/src/accessories/motion.js

@@ -41,11 +41,11 @@ export default class MotionAccessory {
     if (!service.testCharacteristic(this.api.hap.Characteristic.LastActivation))
       service.addCharacteristic(this.api.hap.Characteristic.LastActivation);
 
-    this.historyService = new this.FakeGatoHistoryService('motion', this.accessory, {
+    this.historyService = this.FakeGatoHistoryService ? new this.FakeGatoHistoryService('motion', this.accessory, {
       storage: 'fs',
       path: this.api.user.storagePath(),
       disableTimer: true,
-    });
+    }) : undefined;
 
     await timeout(250); //wait for historyService to load
 
@@ -56,19 +56,18 @@ export default class MotionAccessory {
         this.deviceHandler.changedStates.bind(this, this.accessory, this.historyService, this.accessory.displayName)
       );
 
-    this.refreshHistory(service);
+    if (!this.refreshHistoryHandlerRegistered) {
+      this.deviceHandler.refreshHistoryHandlers.push(() => this.refreshHistory(service));
+      this.refreshHistoryHandlerRegistered = true;
+    }
   }
 
-  async refreshHistory(service) {
+  refreshHistory(service) {
     let state = service.getCharacteristic(this.api.hap.Characteristic.MotionDetected).value;
 
-    this.historyService.addEntry({
+    if (this.historyService) this.historyService.addEntry({
       time: moment().unix(),
       status: state ? 1 : 0,
     });
-
-    setTimeout(() => {
-      this.refreshHistory(service);
-    }, 10 * 60 * 1000);
   }
 }

package/src/accessories/temperature.js

@@ -55,11 +55,11 @@ export default class TemperatureAccessory {
       maxValue: 100,
     });
 
-    this.historyService = new this.FakeGatoHistoryService('room', this.accessory, {
+    this.historyService = this.FakeGatoHistoryService ? new this.FakeGatoHistoryService('room', this.accessory, {
       storage: 'fs',
       path: this.api.user.storagePath(),
       disableTimer: true,
-    });
+    }) : undefined;
 
     await timeout(250); //wait for historyService to load
 
@@ -70,21 +70,20 @@ export default class TemperatureAccessory {
         this.deviceHandler.changedStates.bind(this, this.accessory, this.historyService, this.accessory.displayName)
       );
 
-    this.refreshHistory(service);
+    if (!this.refreshHistoryHandlerRegistered) {
+      this.deviceHandler.refreshHistoryHandlers.push(() => this.refreshHistory(service));
+      this.refreshHistoryHandlerRegistered = true;
+    }
   }
 
   refreshHistory(service) {
     let state = service.getCharacteristic(this.api.hap.Characteristic.CurrentTemperature).value;
 
-    this.historyService.addEntry({
+    if (this.historyService) this.historyService.addEntry({
       time: moment().unix(),
       temp: state,
       humidity: 0,
       ppm: 0,
     });
-
-    setTimeout(() => {
-      this.refreshHistory(service);
-    }, 10 * 60 * 1000);
   }
 }

package/src/accessories/thermostat.js

@@ -180,11 +180,11 @@ export default class ThermostatAccessory {
     if (!service.testCharacteristic(this.api.hap.Characteristic.ValvePosition))
       service.addCharacteristic(this.api.hap.Characteristic.ValvePosition);
 
-    this.historyService = new this.FakeGatoHistoryService('thermo', this.accessory, {
+    this.historyService = this.FakeGatoHistoryService ? new this.FakeGatoHistoryService('thermo', this.accessory, {
       storage: 'fs',
       path: this.api.user.storagePath(),
       disableTimer: true,
-    });
+    }) : undefined;
 
     await timeout(250); //wait for historyService to load
 
@@ -254,7 +254,10 @@ export default class ThermostatAccessory {
         this.deviceHandler.changedStates.bind(this, this.accessory, this.historyService, this.accessory.displayName)
       );
 
-    this.refreshHistory(service);
+    if (!this.refreshHistoryHandlerRegistered) {
+      this.deviceHandler.refreshHistoryHandlers.push(() => this.refreshHistory(service));
+      this.refreshHistoryHandlerRegistered = true;
+    }
   }
 
   refreshHistory(service) {
@@ -268,16 +271,12 @@ export default class ThermostatAccessory {
         ? Math.round(targetTemp - currentTemp >= 5 ? 100 : (targetTemp - currentTemp) * 20)
         : 0;
 
-    this.historyService.addEntry({
+    if (this.historyService) this.historyService.addEntry({
       time: moment().unix(),
       currentTemp: currentTemp,
       setTemp: targetTemp,
       valvePosition: valvePos,
     });
-
-    setTimeout(() => {
-      this.refreshHistory(service);
-    }, 10 * 60 * 1000);
   }
 
   async changeUnit(service, value) {

package/src/helper/handler.js

@@ -1,12 +1,17 @@
 import Logger from '../helper/logger.js';
 import moment from 'moment';
+import { writeFile } from 'fs/promises';
+import { join } from "path";
 
 var settingState = false;
 var delayTimer = {};
 
 const timeout = (ms) => new Promise((res) => setTimeout(res, ms));
+const aRefreshHistoryHandlers = [];
 
 export default (api, accessories, config, tado, telegram) => {
+  const storagePath = api.user.storagePath();
+
   async function setStates(accessory, accs, target, value) {
     accessories = accs.filter((acc) => acc && acc.context.config.homeName === config.homeName);
 
@@ -567,7 +572,7 @@ export default (api, accessories, config, tado, telegram) => {
               ? Math.round(targetTemp - currentTemp >= 5 ? 100 : (targetTemp - currentTemp) * 20)
               : 0;
 
-          historyService.addEntry({
+          if (historyService) historyService.addEntry({
             time: moment().unix(),
             currentTemp: currentTemp,
             setTemp: targetTemp,
@@ -595,7 +600,7 @@ export default (api, accessories, config, tado, telegram) => {
               ? Math.round(targetTemp - currentTemp >= 5 ? 100 : (targetTemp - currentTemp) * 20)
               : 0;
 
-          historyService.addEntry({
+          if (historyService) historyService.addEntry({
             time: moment().unix(),
             currentTemp: currentTemp,
             setTemp: targetTemp,
@@ -636,7 +641,7 @@ export default (api, accessories, config, tado, telegram) => {
               .updateValue(openDuration);
           }
 
-          historyService.addEntry({ time: moment().unix(), status: value.newValue ? 1 : 0 });
+          if (historyService) historyService.addEntry({ time: moment().unix(), status: value.newValue ? 1 : 0 });
 
           let dest = value.newValue ? 'opened' : 'closed';
 
@@ -658,7 +663,7 @@ export default (api, accessories, config, tado, telegram) => {
               .getCharacteristic(api.hap.Characteristic.LastActivation)
               .updateValue(lastActivation);
 
-            historyService.addEntry({ time: moment().unix(), status: value.newValue ? 1 : 0 });
+            if (historyService) historyService.addEntry({ time: moment().unix(), status: value.newValue ? 1 : 0 });
           }
 
           let dest;
@@ -679,13 +684,13 @@ export default (api, accessories, config, tado, telegram) => {
 
         case 'zone-temperature':
         case 'weather-temperature': {
-          historyService.addEntry({ time: moment().unix(), temp: value.newValue, humidity: 0, ppm: 0 });
+          if (historyService) historyService.addEntry({ time: moment().unix(), temp: value.newValue, humidity: 0, ppm: 0 });
 
           break;
         }
 
         case 'zone-humidity': {
-          historyService.addEntry({ time: moment().unix(), temp: 0, humidity: value.newValue, ppm: 0 });
+          if (historyService) historyService.addEntry({ time: moment().unix(), temp: 0, humidity: value.newValue, ppm: 0 });
 
           break;
         }
@@ -697,7 +702,32 @@ export default (api, accessories, config, tado, telegram) => {
     }
   }
 
+  async function refreshHistory(homeId, zoneStates) {
+    try {
+      const data = {};
+      data.counterData = await tado.getCounterData();
+      await writeFile(join(storagePath, "tado-counter.json"), JSON.stringify(data, null, 2), "utf-8");
+    } catch (error) {
+      Logger.error(`Error while updating tado counter file: ${error.message || error}`);
+    }
+    try {
+      const data = {};
+      data.zoneStates = zoneStates ?? {};
+      await writeFile(join(storagePath, `tado-states-${homeId}.json`), JSON.stringify(data, null, 2), "utf-8");
+    } catch (error) {
+      Logger.error(`Error while updating tado states file for home id ${homeId}: ${error.message || error}`);
+    }
+    try {
+      for (const fnRefreshHistory of aRefreshHistoryHandlers) {
+        fnRefreshHistory();
+      }
+    } catch (error) {
+      Logger.error(`Error while refreshing history: ${error.message || error}`);
+    }
+  }
+
   async function getStates() {
+    let zoneStates = {};
     try {
       //ME
       if (!config.homeId) await updateMe();
@@ -706,7 +736,7 @@ export default (api, accessories, config, tado, telegram) => {
       if (!config.temperatureUnit) await updateHome();
 
       //Zones
-      if (config.zones.length) await updateZones();
+      if (config.zones.length) zoneStates = await updateZones();
 
       //MobileDevices
       if (config.presence.length) await updateMobileDevices();
@@ -725,10 +755,23 @@ export default (api, accessories, config, tado, telegram) => {
     } catch (err) {
       errorHandler(err);
     } finally {
+      refreshHistory(config.homeId, zoneStates);
       setTimeout(() => {
         getStates();
       }, Math.max(config.polling, 300) * 1000);
     }
+
+    //log tado api counter every hour
+    async function logCounter() {
+      try {
+        const iCounter = (await tado.getCounterData()).counter;
+        Logger.info(`Tado API counter: ${iCounter.toLocaleString('en-US')}`);
+      } catch (error) {
+        Logger.warn(`Failed to get Tado API counter: ${error.message || error}`);
+      }
+    }
+    void logCounter();
+    setInterval(logCounter, 60 * 60 * 1000);
   }
 
   async function updateMe() {
@@ -773,6 +816,7 @@ export default (api, accessories, config, tado, telegram) => {
   }
 
   async function updateZones(idToUpdate) {
+    let zoneStates = {};
     if (!settingState || idToUpdate !== undefined) {
       Logger.debug('Polling Zones...', config.homeName);
 
@@ -823,7 +867,6 @@ export default (api, accessories, config, tado, telegram) => {
         });
       }
 
-      let zoneStates = {};
       let zonesToUpdate = [];
       if (idToUpdate !== undefined) {
         zoneStates[idToUpdate] = await tado.getZoneState(config.homeId, idToUpdate);
@@ -1233,6 +1276,7 @@ export default (api, accessories, config, tado, telegram) => {
         });
       }
     }
+    return zoneStates = {};
   }
 
   async function updateMobileDevices() {
@@ -1513,5 +1557,6 @@ export default (api, accessories, config, tado, telegram) => {
     getStates: getStates,
     setStates: setStates,
     changedStates: changedStates,
+    refreshHistoryHandlers: aRefreshHistoryHandlers
   };
 };

package/src/platform.js

@@ -41,7 +41,7 @@ class TadoPlatform {
     Logger.init(log, config.debug);
     CustomTypes.registerWith(api.hap);
     EveTypes.registerWith(api.hap);
-    FakeGatoHistoryService = fakeGatoHistory(api);
+    FakeGatoHistoryService = config.skipFakeGatoHistory ? undefined : fakeGatoHistory(api);
 
     this.api = api;
     this.accessories = [];

package/src/tado/tado-api.js

@@ -1,7 +1,7 @@
 import Logger from '../helper/logger.js';
 import got from 'got';
 import path from 'path';
-import fs from 'fs/promises';
+import fs, { access, readFile } from 'fs/promises';
 
 const tado_url = "https://my.tado.com";
 const tado_auth_url = "https://login.tado.com/oauth2";
@@ -12,6 +12,7 @@ export default class Tado {
     this.tadoApiUrl = tadoApiUrl || tado_url;
     this.customTadoApiUrlActive = !!tadoApiUrl;
     this.skipAuth = skipAuth?.toString() === "true";
+    this.storagePath = storagePath;
     this.name = name;
     const usesExternalTokenFile = config.username?.toLowerCase().endsWith(".json");
     this._tadoExternalTokenFilePath = usesExternalTokenFile ? config.username : undefined;
@@ -24,13 +25,59 @@ export default class Tado {
       return (hash >>> 0).toString(36).padStart(7, '0');
     };
     this.username = usesExternalTokenFile ? undefined : config.username;
-    this._tadoInternalTokenFilePath = usesExternalTokenFile ? undefined : path.join(storagePath, `.tado-token-${fnSimpleHash(config.username)}.json`);
+    this._tadoInternalTokenFilePath = usesExternalTokenFile ? undefined : path.join(this.storagePath, `.tado-token-${fnSimpleHash(config.username)}.json`);
     this._tadoApiClientId = tado_client_id;
     this._tadoTokenPromise = undefined;
     this._tadoAuthenticationCallback = undefined;
+    this._counterInitPromise = this._initCounter();
     Logger.debug("API successfull initialized", this.name);
   }
 
+  async _initCounter() {
+    let counterData;
+    try {
+      const sFilePath = path.join(this.storagePath, `tado-counter.json`);
+      await access(sFilePath);
+      const sData = (await readFile(sFilePath, "utf-8"));
+      counterData = JSON.parse(sData)?.counterData;
+    } catch (_err) {
+      //no counter data => ignore
+    }
+    this._counter = counterData?.counter ?? 0;
+    this._counterTimestamp = counterData?.counterTimestamp ?? new Date().toISOString();
+    this._checkCounterMidnightReset();
+  }
+
+  _checkCounterMidnightReset() {
+    const timezone = "Europe/Berlin";
+    const now = new Date();
+    const last = new Date(this._counterTimestamp || 0);
+    const formatDate = (date) => date.toLocaleDateString("en-US", { timeZone: timezone });
+    if (formatDate(now) !== formatDate(last)) {
+      this._counter = 0;
+      this._counterTimestamp = new Date().toISOString();
+    }
+  }
+
+  async _increaseCounter() {
+    try {
+      await this._counterInitPromise;
+      this._checkCounterMidnightReset();
+      this._counter++;
+      this._counterTimestamp = new Date().toISOString();
+    } catch (error) {
+      Logger.warn(`Failed to increase tado api counter: ${error.message || error}`);
+    }
+  }
+
+  async getCounterData() {
+    await this._counterInitPromise;
+    return {
+      counter: this._counter,
+      counterTimestamp: this._counterTimestamp
+    };
+  }
+
   async getToken() {
     if (!this._tadoTokenPromise) {
       this._tadoTokenPromise = this._getToken().finally(() => {
@@ -95,6 +142,7 @@ export default class Tado {
         },
         responseType: "json"
       });
+      await this._increaseCounter();
       const { access_token, refresh_token } = response.body;
       if (!access_token || !refresh_token) throw new Error("Empty access/refresh token.");
       await fs.writeFile(this._tadoInternalTokenFilePath, JSON.stringify({ access_token, refresh_token }));
@@ -114,6 +162,7 @@ export default class Tado {
       },
       responseType: "json"
     });
+    await this._increaseCounter();
     const { device_code, verification_uri_complete } = authResponse.body;
     if (!device_code) throw new Error("Failed to retrieve device code.");
     Logger.info(`Open the following URL in your browser, click "submit" and log in to your tado° account "${this.username}": ${verification_uri_complete}`);
@@ -131,6 +180,7 @@ export default class Tado {
           },
           responseType: "json"
         });
+        await this._increaseCounter();
       } catch (_error) {
         //authentication still pending -> response code 400
       }
@@ -211,6 +261,7 @@ export default class Tado {
 
     try {
       const response = await got(tadoLink + path, config);
+      await this._increaseCounter();
       return response.body;
     } catch (error) {
       Logger.error(`API Request [${method} ${path}] - FAILED: ${error.message}`, this.name);