homebridge-tasmota-control 0.4.4 → 0.4.5

package/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.5] - (10.08.2022)
+## Changes
+- fix report wrong device state [#4](https://github.com/grzegorz914/homebridge-tasmota-control/issues/4)
+- code and logs refactor
+- add additional check configured host in config
+- update config schema
+
 ## [0.4.4] - (23.07.2022)
 ## Changes
 - refactor information service

package/README.md

@@ -1,12 +1,14 @@
 <p align="center">
-  <a href="https://github.com/grzegorz914/homebridge-tasmota-control"><img src="https://raw.githubusercontent.com/grzegorz914/homebridge-tasmota-control/master/homebridge-tasmota-control.png" width="640"></a>
+  <a href="https://github.com/grzegorz914/homebridge-tasmota-control"><img src="https://raw.githubusercontent.com/grzegorz914/homebridge-tasmota-control/main/homebridge-tasmota-control.png" width="640"></a>
 </p>
 
 <span align="center">
 
 # Homebridge Tasmota Control
 [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
-[![npm](https://badgen.net/npm/dt/homebridge-tasmota-control?color=purple)](https://www.npmjs.com/package/homebridge-tasmota-control) [![npm](https://badgen.net/npm/v/homebridge-tasmota-control?color=purple)](https://www.npmjs.com/package/homebridge-tasmota-control)
+[![npm](https://badgen.net/npm/dt/homebridge-tasmota-control?color=purple)](https://www.npmjs.com/package/homebridge-tasmota-control) 
+[![npm](https://badgen.net/npm/v/homebridge-tasmota-control?color=purple)](https://www.npmjs.com/package/homebridge-tasmota-control)
+[![npm](https://img.shields.io/npm/v/homebridge-tasmota-control/beta.svg?style=flat-square)](https://www.npmjs.com/package/homebridge-tasmota-control)
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/grzegorz914/homebridge-tasmota-control.svg)](https://github.com/grzegorz914/homebridge-tasmota-control/pulls)
 [![GitHub issues](https://img.shields.io/github/issues/grzegorz914/homebridge-tasmota-control.svg)](https://github.com/grzegorz914/homebridge-tasmota-control/issues)
 
@@ -23,17 +25,19 @@ Homebridge plugin for Tasmota flashed devices.
 
 ## Note
 * Right now only switch/outlets devices are supported.
-* Tested with latest Tasmota 10.1.0
+* Tested with Tasmota 10.1.0 and above
 
 ## Troubleshooting
 * If for some reason the device is not displayed in HomeKit app try this procedure:
-   * Go to `./homebridge/persist`.
+   * Go to `./homebridge/persist` or `/var/lib/homebridge/persist` for RPI.
    * Remove `AccessoryInfo.xxx` file which contain Your device data: `{"displayName":"Tasmota"}`.
    * Next remove `IdentifierCashe.xxx` file with same name as `AccessoryInfo.xxx`.
    * Restart Homebridge and try add it to the Home app again.
 
-## Configuration
-Install and use [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x/wiki) plugin to configure this plugin (Highly Recommended). The sample configuration can be edited and used manually as an alternative. See the `sample-config.json` file in this repository for an example or copy the example below into your config.json file, making the apporpriate changes before saving it. Be sure to always make a backup copy of your config.json file before making any changes to it.
+### Configuration
+* Run this plugin as a child bridge (Highly Recommended).
+* Install and use [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x/wiki) to configure this plugin (Highly Recommended). 
+* The sample configuration can be edited and used manually as an alternative. See the `sample-config.json` file in this repository for an example or copy the example below into your config.json file, making the apporpriate changes before saving it. Be sure to always make a backup copy of your config.json file before making any changes to it.
 
 <p align="left">
   <a href="https://github.com/grzegorz914/homebridge-tasmota-control"><img src="https://raw.githubusercontent.com/grzegorz914/homebridge-tasmota-control/master/graphics/ustawienia.png" width="840"></a>
@@ -67,16 +71,16 @@ Install and use [Homebridge Config UI X](https://github.com/oznu/homebridge-conf
   }
 ```
 
-## Adding to HomeKit
+### Adding to HomeKit
 Each accessory needs to be manually paired. 
 1. Open the Home <img src='https://user-images.githubusercontent.com/3979615/78010622-4ea1d380-738e-11ea-8a17-e6a465eeec35.png' width='16.42px'> app on your device. 
-2. Tap the <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' width='16.42px'>. 
-3. Tap *Add Accessory*, and select *I Don't Have a Code or Cannot Scan* or *More Options*. 
-4. Select Your accessory. 
-5. Enter the Homebridge PIN or scan the QR code, this can be found in Homebridge UI or Homebridge logs.
+2. Tap the Home tab, then tap <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' width='16.42px'>. 
+3. Tap *Add Accessory*, and select *I Don't Have a Code, Cannot Scan* or *More options*. 
+4. Select Your accessory and press add anyway. 
+5. Enter the PIN or scan the QR code, this can be found in Homebridge UI or Homebridge logs.
 6. Complete the accessory setup.
 
-## [What's New](https://github.com/grzegorz914/homebridge-tasmota-control/blob/master/CHANGELOG.md).
+## [What's New](https://github.com/grzegorz914/homebridge-tasmota-control/main/master/CHANGELOG.md).
 
 ## Development
 * Pull request and help in development highly appreciated.

package/config.schema.json

@@ -2,7 +2,7 @@
   "pluginAlias": "tasmotaControl",
   "pluginType": "platform",
   "singular": true,
-  "headerDisplay": "This plugin works with Tasmota flashed devices and are exposed to HomeKit as separate accessories and each needs to be manually paired.\n\n1. Open the Home <img src='https://user-images.githubusercontent.com/3979615/78010622-4ea1d380-738e-11ea-8a17-e6a465eeec35.png' height='16.42px'> app on your device.\n2. Tap the <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' height='16.42px'>.\n3. Tap *Add Accessory*, and select *I Don't Have a Code or Cannot Scan* or *More Options*.\n4. Select Your accessory.\n5. Enter the Homebridge PIN or scan the QR code, this can be found in Homebridge UI or Homebridge logs.\n6. Complete the accessory setup.",
+  "headerDisplay": "This plugin works with deevices flashed with Tasmota firmware. Devices are exposed to HomeKit as separate accessories and each needs to be manually paired.\n\n1. Open the Home <img src='https://user-images.githubusercontent.com/3979615/78010622-4ea1d380-738e-11ea-8a17-e6a465eeec35.png' height='16.42px'> app on your device.\n2. Tap the <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' height='16.42px'>.\n3. Tap *Add Accessory*, and select *I Don't Have a Code or Cannot Scan* or *More Options*.\n4. Select Your accessory and press add anyway.\n5. Enter the PIN or scan the QR code, this can be found in Homebridge UI or Homebridge logs.\n6. Complete the accessory setup.",
 	"footerDisplay": "For documentation please see [GitHub repository](https://github.com/grzegorz914/homebridge-tasmota-control).",
   "schema": {
     "type": "object",

package/index.js

@@ -33,9 +33,10 @@ class tasmotaPlatform {
   constructor(log, config, api) {
     // only load if configured
     if (!config || !Array.isArray(config.devices)) {
-      log('No configuration found for %s', PLUGIN_NAME);
+      log(`No configuration found for ${deviceName}.`, PLUGIN_NAME);
       return;
     }
+
     this.log = log;
     this.api = api;
     this.devices = config.devices || [];
@@ -45,8 +46,8 @@ class tasmotaPlatform {
       this.log.debug('didFinishLaunching');
       for (let i = 0; i < this.devices.length; i++) {
         const device = this.devices[i];
-        if (!device.name) {
-          this.log.warn('Device Name Missing');
+        if (!device.name || !device.host) {
+          this.log.warn('Device name or host missing!');
         } else {
           new tasmotaDevice(this.log, device, this.api);
         }
@@ -88,8 +89,6 @@ class tasmotaDevice {
 
     //setup variables
     this.channelsCount = 0;
-    this.checkDeviceInfo = true;
-    this.checkDeviceState = false;
     this.startPrepareAccessory = true;
 
     this.prefDir = path.join(api.user.storagePath(), 'tasmota');
@@ -106,27 +105,32 @@ class tasmotaDevice {
       fs.mkdirSync(this.prefDir);
     }
 
-    //Check device state
-    setInterval(function () {
-      if (this.checkDeviceInfo) {
-        this.getDeviceInfo();
-      } else {
-        this.updateDeviceState();
-      }
-    }.bind(this), this.refreshInterval * 1000);
+    this.getDeviceInfo();
+  }
+
+  reconnect() {
+    setTimeout(() => {
+      this.getDeviceInfo();
+    }, 15000);
+  }
+
+  updateDeviceState() {
+    setTimeout(() => {
+      this.checkDeviceState();
+    }, this.refreshInterval * 1000);
   }
 
   async getDeviceInfo() {
-    this.log.debug('Device: %s %s, requesting Device Info.', this.host, this.name);
+    this.log.debug(`Device: ${this.host} ${this.name}, requesting info.`);
     try {
-      const response = await this.axiosInstance(API_COMMANDS.Status);
-      const debug = this.enableDebugMode ? this.log('Device: %s %s, debug response: %s', this.host, this.name, JSON.stringify(response.data, null, 2)) : false;
+      const deviceInfo = await this.axiosInstance(API_COMMANDS.Status);
+      const debug = this.enableDebugMode ? this.log(`Device: ${this.host} ${this.name}, debug device info: ${JSON.stringify(deviceInfo.data, null, 2)}`) : false;
 
-      const deviceName = response.data.Status.DeviceName;
-      const modelName = response.data.StatusFWR.Hardware;
-      const addressMac = response.data.StatusNET.Mac;
-      const firmwareRevision = response.data.StatusFWR.Version;
-      const channelsCount = response.data.Status.FriendlyName.length;
+      const deviceName = deviceInfo.data.Status.DeviceName;
+      const modelName = deviceInfo.data.StatusFWR.Hardware;
+      const addressMac = deviceInfo.data.StatusNET.Mac;
+      const firmwareRevision = deviceInfo.data.StatusFWR.Version;
+      const channelsCount = deviceInfo.data.Status.FriendlyName.length;
 
       this.log(`----- ${deviceName} -----`);
       this.log(`Manufacturer: ${this.manufacturer}`);
@@ -134,45 +138,49 @@ class tasmotaDevice {
       this.log(`Serialnr: ${addressMac}`);
       this.log(`Firmware: ${firmwareRevision}`);
       this.log(`Channels: ${channelsCount}`);
-      this.log('----------------------------------');
+      this.log(`----------------------------------`);
 
       this.modelName = modelName;
       this.serialNumber = addressMac;
       this.firmwareRevision = firmwareRevision;
       this.channelsCount = channelsCount;
 
-      this.checkDeviceInfo = (channelsCount == 0);
+      this.checkDeviceState();
     } catch (error) {
-      this.log.error('Device: %s %s, Device Info eror: %s, state: Offline, trying to reconnect', this.host, this.name, error);
+      this.log.error(`Device: ${this.host} ${this.name}, check info error: ${error}, trying to reconnect in 15s.`);
+      this.reconnect();
     }
   }
 
-  async updateDeviceState() {
-    this.log.debug('Device: %s %s, requesting Device state.', this.host, this.name);
+  async checkDeviceState() {
+    this.log.debug(`Device: ${this.host} ${this.name}, requesting state.`, this.host, this.name);
     try {
-      const response = await this.axiosInstance(API_COMMANDS.PowerStatus);
-      const debug = this.enableDebugMode ? this.log('Device: %s %s, debug response: %s', this.host, this.name, JSON.stringify(response.data, null, 2)) : false;
+      const channelsCount = this.channelsCount;
+      const deviceState = await this.axiosInstance(API_COMMANDS.PowerStatus);
+      const debug = this.enableDebugMode ? this.log(`Device: ${this.host} ${this.name}, debug state: ${JSON.stringify(deviceState.data, null, 2)}`) : false;
 
       this.powerState = new Array();
-      for (let i = 0; i < this.channelsCount; i++) {
-        const channel = this.channelsCount == 1 ? 'POWER' : 'POWER' + (i + 1);
-        const powerState = (response.data[channel] == 'ON');
+      for (let i = 0; i < channelsCount; i++) {
+        const channel = channelsCount == 1 ? 'POWER' || 'POWER1' : 'POWER' + (i + 1);
+        const powerState = (deviceState.data[channel] == 'ON');
+
         if (this.tasmotaServices) {
           this.tasmotaServices[i]
             .updateCharacteristic(Characteristic.On, powerState)
         }
+
         this.powerState.push(powerState);
       }
-      this.checkDeviceState = true;
+
+      this.updateDeviceState();
 
       //start prepare accessory
-      if (this.startPrepareAccessory) {
+      if (this.startPrepareAccessory && this.serialNumber) {
         this.prepareAccessory();
       }
     } catch (error) {
-      this.log.error('Device: %s %s, update Device state error: %s, state: Offline', this.host, this.name, error);
-      this.checkDeviceState = false;
-      this.checkDeviceInfo = true;
+      this.log.error(`Device: ${this.host} ${this.name}, check state error: ${error}, trying again.`);
+      this.updateDeviceState();
     }
   }
 
@@ -200,23 +208,24 @@ class tasmotaDevice {
     //Prepare service 
     this.log.debug('prepareTasmotaService');
     this.tasmotaServices = new Array();
-    for (let i = 0; i < this.channelsCount; i++) {
+    const channelsCount = this.channelsCount;
+    for (let i = 0; i < channelsCount; i++) {
       const tasmotaService = new Service.Outlet(accessoryName, `tasmotaService${[i]}`);
       tasmotaService.getCharacteristic(Characteristic.On)
         .onGet(async () => {
           const state = this.powerState[i];
-          const logInfo = this.disableLogInfo ? false : this.log('Device: %s %s, get state: %s', this.host, accessoryName, state ? 'ON' : 'OFF');
+          const logInfo = this.disableLogInfo ? false : this.log(`Device: ${this.host} ${accessoryName}, state: ${state ? 'ON' : 'OFF'}`);
           return state;
         })
         .onSet(async (state) => {
-          const powerOn = this.channelsCount == 1 ? API_COMMANDS.Power + API_COMMANDS.On : API_COMMANDS.Power + (i + 1) + API_COMMANDS.On;
-          const powerOff = this.channelsCount == 1 ? API_COMMANDS.Power + API_COMMANDS.Off : API_COMMANDS.Power + (i + 1) + API_COMMANDS.Off;
+          const powerOn = (channelsCount == 1) ? API_COMMANDS.Power + API_COMMANDS.On : API_COMMANDS.Power + (i + 1) + API_COMMANDS.On;
+          const powerOff = (channelsCount == 1) ? API_COMMANDS.Power + API_COMMANDS.Off : API_COMMANDS.Power + (i + 1) + API_COMMANDS.Off;
           state = state ? powerOn : powerOff;
           try {
             await this.axiosInstance(state);
-            const logInfo = this.disableLogInfo ? false : this.log('Device: %s %s, set state: %s', this.host, accessoryName, state ? 'ON' : 'OFF');
+            const logInfo = this.disableLogInfo ? false : this.log(`Device: ${this.host} ${accessoryName}, set state: ${state ? 'ON' : 'OFF'}`);
           } catch (error) {
-            this.log.error('Device: %s %s, set state: %s', this.host, this.name, error);
+            this.log.error(`Device: ${this.host} ${accessoryName}, set state error: ${error}`);
           }
         });
       this.tasmotaServices.push(tasmotaService);
@@ -224,7 +233,7 @@ class tasmotaDevice {
     }
 
     this.startPrepareAccessory = false;
-    this.log.debug('Device: %s %s, publishExternalAccessories.', this.host, accessoryName);
+    this.log.debug(`Device: ${this.host} ${accessoryName}, publish as external accessory.`);
     this.api.publishExternalAccessories(PLUGIN_NAME, [accessory]);
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Tasmota Control",
   "name": "homebridge-tasmota-control",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "description": "Homebridge plugin (https://github.com/homebridge/homebridge) to control Tasmota flashed devices.",
   "license": "MIT",
   "author": "grzegorz914",