homebridge-tasmota-control 0.4.6 → 0.4.10

package/CHANGELOG.md

@@ -4,6 +4,15 @@ 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.10] - (23.08.2022)
+## Changes
+- added possibility to display log device info on every restart
+- config schema updated
+
+## [0.4.7] - (23.08.2022)
+## Changes
+- added display channel name instead device name
+
 ## [0.4.6] - (12.08.2022)
 ## Changes
 - finally fixed report wrong device state [#4](https://github.com/grzegorz914/homebridge-tasmota-control/issues/4)

package/README.md

@@ -29,7 +29,7 @@ Homebridge plugin for Tasmota flashed devices.
 
 ## Troubleshooting
 * If for some reason the device is not displayed in HomeKit app try this procedure:
-   * Go to `./homebridge/persist` or `/var/lib/homebridge/persist` for RPI.
+   * Go to `./homebridge/persist` macOS 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.
@@ -52,6 +52,7 @@ Homebridge plugin for Tasmota flashed devices.
 | `passwd` | Here set the authorization *Password*. |
 | `enableDebugMode` | This enable deep log in homebridge console. |
 | `disableLogInfo` | This disable log info, all values and state will not be displayed in Homebridge log console. |
+| `disableLogDeviceInfo` | If enabled, add ability to disable log device info by every connections device to the network. |
 
 ```json
 {
@@ -65,20 +66,21 @@ Homebridge plugin for Tasmota flashed devices.
         "passwd": "password",
         "refreshInterval": 5,
         "disableLogInfo": false,
-        "enableDebugMode": false,
+        "disableLogDeviceInfo": false,
+        "enableDebugMode": false
       }
     ]
   }
 ```
 
 ### 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 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.
+* Each accessory needs to be manually paired. 
+  * 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. 
+  * Tap the Home tab, then tap <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' width='16.42px'>. 
+  * Tap *Add Accessory*, and select *I Don't Have a Code, Cannot Scan* or *More options*. 
+  * Select Your accessory and press add anyway. 
+  * Enter the PIN or scan the QR code, this can be found in Homebridge UI or Homebridge logs.
+  * Complete the accessory setup.
 
 ## [What's New](https://github.com/grzegorz914/homebridge-tasmota-control/main/master/CHANGELOG.md).
 

package/config.schema.json

@@ -3,7 +3,7 @@
   "pluginType": "platform",
   "singular": true,
   "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).",
+  "footerDisplay": "For documentation please see [GitHub repository](https://github.com/grzegorz914/homebridge-tasmota-control).",
   "schema": {
     "type": "object",
     "properties": {
@@ -20,7 +20,7 @@
               "required": true
             },
             "host": {
-              "title": "IP Address",
+              "title": "IP address",
               "type": "string",
               "default": "192.168.1.61",
               "required": true,
@@ -53,7 +53,7 @@
               "required": true
             },
             "enableDebugMode": {
-              "title": "Enable Debug Mode",
+              "title": "Enable debug mode",
               "type": "boolean",
               "default": false,
               "description": "This enable debug mode.",
@@ -65,46 +65,56 @@
               "default": false,
               "description": "This disable log info, all values and state will not be displayed in Homebridge log console.",
               "required": false
+            },
+            "disableLogDeviceInfo": {
+              "title": "Disable log device info",
+              "type": "boolean",
+              "default": false,
+              "description": "This disable log device info by every connections device to the network.",
+              "required": false
             }
           }
         }
       }
     }
   },
-  "layout": [{
-    "key": "devices",
-    "type": "tabarray",
-    "title": "{{ value.name || 'new device' }}",
-    "items": [
-      "devices[].name",
-      "devices[].host",
-      "devices[].auth",
-      {
-        "key": "devices[]",
-        "type": "section",
-        "title": "Authorization",
-        "expandable": true,
-        "expanded": false,
-        "items": [
-          "devices[].user",
-          "devices[].passwd"
-        ],
-        "condition": {
-          "functionBody": "return model.devices[arrayIndices].auth === true;"
+  "layout": [
+    {
+      "key": "devices",
+      "type": "tabarray",
+      "title": "{{ value.name || 'new device' }}",
+      "items": [
+        "devices[].name",
+        "devices[].host",
+        "devices[].auth",
+        {
+          "key": "devices[]",
+          "type": "section",
+          "title": "Authorization",
+          "expandable": true,
+          "expanded": false,
+          "items": [
+            "devices[].user",
+            "devices[].passwd"
+          ],
+          "condition": {
+            "functionBody": "return model.devices[arrayIndices].auth === true;"
+          }
+        },
+        {
+          "key": "devices[]",
+          "type": "section",
+          "title": "Advanced Settings",
+          "expandable": true,
+          "expanded": false,
+          "items": [
+            "devices[].enableDebugMode",
+            "devices[].disableLogInfo",
+            "devices[].disableLogDeviceInfo",
+            "devices[].refreshInterval"
+          ]
         }
-      },
-      {
-        "key": "devices[]",
-        "type": "section",
-        "title": "Advanced Settings",
-        "expandable": true,
-        "expanded": false,
-        "items": [
-          "devices[].enableDebugMode",
-          "devices[].disableLogInfo",
-          "devices[].refreshInterval"
-        ]
-      }
-    ]
-  }]
+      ]
+    }
+  ]
 }

package/index.js

@@ -33,13 +33,13 @@ class tasmotaPlatform {
   constructor(log, config, api) {
     // only load if configured
     if (!config || !Array.isArray(config.devices)) {
-      log(`No configuration found for ${deviceName}.`, PLUGIN_NAME);
+      log(`No configuration found for ${PLUGIN_NAME}.`);
       return;
     };
 
     this.log = log;
     this.api = api;
-    this.devices = config.devices || [];
+    this.devices = config.devices;
     this.accessories = [];
 
     this.api.on('didFinishLaunching', () => {
@@ -80,6 +80,7 @@ class tasmotaDevice {
     this.refreshInterval = config.refreshInterval || 5;
     this.enableDebugMode = config.enableDebugMode || false;
     this.disableLogInfo = config.disableLogInfo || false;
+    this.disableLogDeviceInfo = config.disableLogDeviceInfo || false;
 
     //get Device info
     this.manufacturer = 'Tasmota';
@@ -127,23 +128,27 @@ class tasmotaDevice {
       const debug = this.enableDebugMode ? this.log(`Device: ${this.host} ${this.name}, debug device info: ${JSON.stringify(deviceInfo.data, null, 2)}`) : false;
 
       const deviceName = deviceInfo.data.Status.DeviceName;
+      const friendlyName = Array.isArray(deviceInfo.data.Status.FriendlyName) ? deviceInfo.data.Status.FriendlyName : [];
+      const friendlyNameCount = friendlyName.length;
       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}`);
-      this.log(`Hardware: ${modelName}`);
-      this.log(`Serialnr: ${addressMac}`);
-      this.log(`Firmware: ${firmwareRevision}`);
-      this.log(`Channels: ${channelsCount}`);
-      this.log(`----------------------------------`);
+      if (!this.disableLogDeviceInfo) {
+        this.log(`----- ${this.name} -----`);
+        this.log(`Manufacturer: ${this.manufacturer}`);
+        this.log(`Hardware: ${modelName}`);
+        this.log(`Serialnr: ${addressMac}`);
+        this.log(`Firmware: ${firmwareRevision}`);
+        this.log(`Channels: ${friendlyNameCount}`);
+        this.log(`----------------------------------`);
+      };
 
       this.modelName = modelName;
       this.serialNumber = addressMac;
       this.firmwareRevision = firmwareRevision;
-      this.channelsCount = channelsCount;
+      this.friendlyName = friendlyName;
+      this.channelsCount = friendlyNameCount;
 
       this.checkDeviceState();
     } catch (error) {
@@ -155,22 +160,26 @@ class tasmotaDevice {
   async checkDeviceState() {
     this.log.debug(`Device: ${this.host} ${this.name}, requesting state.`, this.host, this.name);
     try {
+      const friendlyName = this.friendlyName;
       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();
+      this.names = new Array();
       for (let i = 0; i < channelsCount; i++) {
         const power = channelsCount == 1 ? 'POWER' : 'POWER' + (i + 1);
         const power1 = channelsCount == 1 ? 'POWER1' : 'POWER' + (i + 1);
         const powerState = (deviceState.data[power] != undefined) ? (deviceState.data[power] == 'ON') : (deviceState.data[power1] == 'ON');
+        const name = friendlyName[i];
+
+        this.powerState.push(powerState);
+        this.names.push(name);
 
         if (this.tasmotaServices) {
           this.tasmotaServices[i]
             .updateCharacteristic(Characteristic.On, powerState);
         };
-
-        this.powerState.push(powerState);
       };
 
       this.updateDeviceState();
@@ -209,13 +218,16 @@ class tasmotaDevice {
     //Prepare service 
     this.log.debug('prepareTasmotaService');
     this.tasmotaServices = new Array();
-    const channelsCount = this.channelsCount;
+    const channelsName = this.names;
+    const channelsCount = this.channelsCount;;
     for (let i = 0; i < channelsCount; i++) {
-      const tasmotaService = new Service.Outlet(accessoryName, `tasmotaService${[i]}`);
+      const serviceName = (channelsCount > 1) ? `${accessoryName} ${channelsName[i]}` : accessoryName;
+      const logName = (channelsCount > 1) ? `${accessoryName}, channel: ${channelsName[i]}` : `${accessoryName}`
+      const tasmotaService = new Service.Outlet(serviceName, `tasmotaService${[i]}`);
       tasmotaService.getCharacteristic(Characteristic.On)
         .onGet(async () => {
           const state = this.powerState[i];
-          const logInfo = this.disableLogInfo ? false : this.log(`Device: ${this.host} ${accessoryName}, state: ${state ? 'ON' : 'OFF'}`);
+          const logInfo = this.disableLogInfo ? false : this.log(`Device: ${this.host} ${logName}, state: ${state ? 'ON' : 'OFF'}`);
           return state;
         })
         .onSet(async (state) => {
@@ -224,9 +236,9 @@ class tasmotaDevice {
           state = state ? powerOn : powerOff;
           try {
             await this.axiosInstance(state);
-            const logInfo = this.disableLogInfo ? false : this.log(`Device: ${this.host} ${accessoryName}, set state: ${state ? 'ON' : 'OFF'}`);
+            const logInfo = this.disableLogInfo ? false : this.log(`Device: ${this.host} ${logName}, set state: ${state ? 'ON' : 'OFF'}`);
           } catch (error) {
-            this.log.error(`Device: ${this.host} ${accessoryName}, set state error: ${error}`);
+            this.log.error(`Device: ${this.host} ${logName}, set state error: ${error}`);
           }
         });
       this.tasmotaServices.push(tasmotaService);

package/package.json

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