homebridge-tasmota-control 1.4.0-beta.9 → 1.4.1-beta.1

package/CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Changes
 
 - added support for iFan, solved [#24](https://github.com/grzegorz914/homebridge-tasmota-control/issues/24)
+- full code refactor
 - config schema updated
 - redme updated
 - cleanup

package/index.js

@@ -1,6 +1,11 @@
 import { join } from 'path';
 import { mkdirSync, existsSync, writeFileSync } from 'fs';
-import TasmotaDevice from './src/tasmotadevice.js';
+import DeviceInfo from './src/deviceinfo.js';
+import MiElHvac from './src/mielhvac.js';
+import Switches from './src/switches.js';
+import Lights from './src/lights.js';
+import Fans from './src/fans.js';
+import Sensors from './src/sensors.js';
 import ImpulseGenerator from './src/impulsegenerator.js';
 import { PluginName, PlatformName } from './src/constants.js';
 
@@ -39,6 +44,12 @@ class tasmotaPlatform {
         }
 
         //log config
+        const url = `http://${host}/cm?cmnd=`;
+        const auth = device.auth || false;
+        const user = device.user || '';
+        const passwd = device.passwd || '';
+        const loadNameFromDevice = device.loadNameFromDevice || false;
+        const refreshInterval = device.refreshInterval * 1000 || 5000;
         const enableDebugMode = device.enableDebugMode || false;
         const disableLogDeviceInfo = device.disableLogDeviceInfo || false;
         const disableLogInfo = device.disableLogInfo || false;
@@ -46,55 +57,19 @@ class tasmotaPlatform {
         const disableLogWarn = device.disableLogWarn || false;
         const disableLogError = device.disableLogError || false;
         const debug = enableDebugMode ? log.info(`Device: ${host} ${deviceName}, debug: Did finish launching.`) : false;
-        const config = {
+        const newConfig = {
           ...device,
           user: 'removed',
           passwd: 'removed'
         };
-        const debug1 = !enableDebugMode ? false : log.info(`Device: ${host} ${deviceName}, Config: ${JSON.stringify(config, null, 2)}.`);
+        const debug1 = !enableDebugMode ? false : log.info(`Device: ${host} ${deviceName}, Config: ${JSON.stringify(newConfig, null, 2)}.`);
 
-        //check files exists, if not then create it
-        const postFix = device.host.split('.').join('');
-        const defaultHeatingSetTemperatureFile = `${prefDir}/defaultHeatingSetTemperature_${postFix}`;
-        const defaultCoolingSetTemperatureFile = `${prefDir}/defaultCoolingSetTemperature_${postFix}`;
-
-        try {
-          const files = [
-            defaultHeatingSetTemperatureFile,
-            defaultCoolingSetTemperatureFile
-          ];
-
-          files.forEach((file, index) => {
-            if (!existsSync(file)) {
-              const data = ['20', '23'][index]
-              writeFileSync(file, data);
-            }
-          });
-        } catch (error) {
-          log.error(`Device: ${host} ${deviceName}, Prepare files error: ${error}`);
-          return;
-        }
-
-        //tasmota device
         try {
-          const miElHvac = device.miElHvac ?? {};
-          const tasmotaDevice = new TasmotaDevice(api, device, miElHvac, defaultHeatingSetTemperatureFile, defaultCoolingSetTemperatureFile);
-          tasmotaDevice.on('publishAccessory', (accessory) => {
-            api.publishExternalAccessories(PluginName, [accessory]);
-            const emitLog = disableLogSuccess ? false : log.success(`Device: ${host} ${deviceName}, Published as external accessory.`);
+          //get device info
+          const deviceInfo = new DeviceInfo(url, auth, user, passwd, deviceName, loadNameFromDevice, enableDebugMode, refreshInterval);
+          deviceInfo.on('debug', (debug) => {
+            const emitLog = !enableDebugMode ? false : log.info(`Device: ${host} ${deviceName}, debug: ${debug}.`);
           })
-            .on('devInfo', (devInfo) => {
-              const emitLog = disableLogDeviceInfo ? false : log.info(devInfo);
-            })
-            .on('success', (success) => {
-              const emitLog = disableLogSuccess ? false : log.success(`Device: ${host} ${deviceName}, ${success}.`);
-            })
-            .on('info', (info) => {
-              const emitLog = disableLogInfo ? false : log.info(`Device: ${host} ${deviceName}, ${info}.`);
-            })
-            .on('debug', (debug) => {
-              const emitLog = !enableDebugMode ? false : log.info(`Device: ${host} ${deviceName}, debug: ${debug}.`);
-            })
             .on('warn', (warn) => {
               const emitLog = disableLogWarn ? false : log.warn(`Device: ${host} ${deviceName}, ${warn}.`);
             })
@@ -102,24 +77,98 @@ class tasmotaPlatform {
               const emitLog = disableLogError ? false : log.error(`Device: ${host} ${deviceName}, ${error}.`);
             });
 
-          //create impulse generator
-          const impulseGenerator = new ImpulseGenerator();
-          impulseGenerator.on('start', async () => {
-            try {
-              const startDone = await tasmotaDevice.start();
-              const stopImpulseGenerator = startDone ? await impulseGenerator.stop() : false;
-
-              //start impulse generator 
-              const startImpulseGenerator = stopImpulseGenerator ? await tasmotaDevice.startImpulseGenerator() : false
-            } catch (error) {
-              const emitLog = disableLogError ? false : log.error(`Device: ${host} ${deviceName}, ${error}, trying again.`);
+          const info = await deviceInfo.getInfo();
+          if (!info.serialNumber) {
+            log.warn(`Device: ${host} ${deviceName}, serial not found.`);
+            return;
+          }
+
+          for (const type of info.deviceTypes) {
+            let deviceType;
+            switch (type) {
+              case 0://mielhvac
+                //check files exists, if not then create it
+                try {
+                  const postFix = device.host.split('.').join('');
+                  info.defaultHeatingSetTemperatureFile = `${prefDir}/defaultHeatingSetTemperature_${postFix}`;
+                  info.defaultCoolingSetTemperatureFile = `${prefDir}/defaultCoolingSetTemperature_${postFix}`;
+                  const files = [
+                    info.defaultHeatingSetTemperatureFile,
+                    info.defaultCoolingSetTemperatureFile
+                  ];
+
+                  files.forEach((file, index) => {
+                    if (!existsSync(file)) {
+                      const data = ['20', '23'][index]
+                      writeFileSync(file, data);
+                    }
+                  });
+                } catch (error) {
+                  log.error(`Device: ${host} ${deviceName}, Prepare files error: ${error}`);
+                  return;
+                }
+
+                deviceType = new MiElHvac(api, device, info, refreshInterval);
+                break;
+              case 1: //switches
+                deviceType = new Switches(api, device, info, refreshInterval);
+                break;
+              case 2: //lights
+                deviceType = new Lights(api, device, info, refreshInterval);
+                break;
+              case 3: //fans
+                deviceType = new Fans(api, device, info, refreshInterval);
+                break;
+              case 4: //sensors
+                deviceType = new Sensors(api, device, info, refreshInterval);
+                break;
+              default:
+                const emitLog = disableLogWarn ? false : log.warn(`Device: ${host} ${deviceName}, unknown device: ${info.deviceType}.`);
+                return;
             }
-          }).on('state', (state) => {
-            const emitLog = !enableDebugMode ? false : state ? log.info(`Device: ${host} ${deviceName}, Start impulse generator started.`) : log.info(`Device: ${host} ${deviceName}, Start impulse generator stopped.`);
-          });
 
-          //start impulse generator
-          await impulseGenerator.start([{ name: 'start', sampling: 45000 }]);
+            deviceType.on('publishAccessory', (accessory) => {
+              api.publishExternalAccessories(PluginName, [accessory]);
+              const emitLog = disableLogSuccess ? false : log.success(`Device: ${host} ${deviceName}, Published as external accessory.`);
+            })
+              .on('devInfo', (devInfo) => {
+                const emitLog = disableLogDeviceInfo ? false : log.info(devInfo);
+              })
+              .on('success', (success) => {
+                const emitLog = disableLogSuccess ? false : log.success(`Device: ${host} ${deviceName}, ${success}.`);
+              })
+              .on('info', (info) => {
+                const emitLog = disableLogInfo ? false : log.info(`Device: ${host} ${deviceName}, ${info}.`);
+              })
+              .on('debug', (debug) => {
+                const emitLog = !enableDebugMode ? false : log.info(`Device: ${host} ${deviceName}, debug: ${debug}.`);
+              })
+              .on('warn', (warn) => {
+                const emitLog = disableLogWarn ? false : log.warn(`Device: ${host} ${deviceName}, ${warn}.`);
+              })
+              .on('error', (error) => {
+                const emitLog = disableLogError ? false : log.error(`Device: ${host} ${deviceName}, ${error}.`);
+              });
+
+            //create impulse generator
+            const impulseGenerator = new ImpulseGenerator();
+            impulseGenerator.on('start', async () => {
+              try {
+                const startDone = await deviceType.start();
+                const stopImpulseGenerator = startDone ? await impulseGenerator.stop() : false;
+
+                //start impulse generator 
+                const startImpulseGenerator = stopImpulseGenerator ? await deviceType.startImpulseGenerator() : false
+              } catch (error) {
+                const emitLog = disableLogError ? false : log.error(`Device: ${host} ${deviceName}, ${error}, trying again.`);
+              }
+            }).on('state', (state) => {
+              const emitLog = !enableDebugMode ? false : state ? log.info(`Device: ${host} ${deviceName}, Start impulse generator started.`) : log.info(`Device: ${host} ${deviceName}, Start impulse generator stopped.`);
+            });
+
+            //start impulse generator
+            await impulseGenerator.start([{ name: 'start', sampling: 45000 }]);
+          }
         } catch (error) {
           const emitLog = disableLogError ? false : log.error(`Device: ${host} ${deviceName}, Did finish launching error: ${error}.`);
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Tasmota Control",
   "name": "homebridge-tasmota-control",
-  "version": "1.4.0-beta.9",
+  "version": "1.4.1-beta.1",
   "description": "Homebridge plugin to control Tasmota flashed devices.",
   "license": "MIT",
   "author": "grzegorz914",

package/src/constants.js

@@ -229,8 +229,7 @@ export const SensorKeys = [
     "TC74",
     "VEML7700",
     "PIR",
-    "ENERGY",
-    "MiElHVAC"
+    "ENERGY"
 ];
 
 export const SensorPropertiesKeys = [

package/src/deviceinfo.js

@@ -0,0 +1,84 @@
+import axios from 'axios';
+import EventEmitter from 'events';
+import { ApiCommands, LightKeys, SensorKeys } from './constants.js';
+
+class DeviceInfo extends EventEmitter {
+    constructor(url, auth, user, passwd, deviceName, loadNameFromDevice, enableDebugMode, refreshInterval) {
+        super();
+        this.name = deviceName
+        this.loadNameFromDevice = loadNameFromDevice;
+        this.enableDebugMode = enableDebugMode;
+
+        //axios instance
+        this.axiosInstance = axios.create({
+            method: 'GET',
+            baseURL: url,
+            timeout: refreshInterval > 10000 ? 10000 : refreshInterval,
+            withCredentials: auth,
+            auth: {
+                username: user,
+                password: passwd
+            }
+        });
+
+    }
+
+    async getInfo() {
+        const debug = this.enableDebugMode ? this.emit('debug', `Requesting info`) : false;
+        try {
+            const deviceInfoData = await this.axiosInstance(ApiCommands.Status);
+            const deviceInfo = deviceInfoData.data ?? {};
+            const debug = this.enableDebugMode ? this.emit('debug', `Info: ${JSON.stringify(deviceInfo, null, 2)}`) : false;
+            await new Promise(resolve => setTimeout(resolve, 250));
+
+            //status
+            const friendlyNames = [];
+            const status = deviceInfo.Status ?? {};
+            const deviceName = this.loadNameFromDevice ? status.DeviceName ?? 'Unknown' : this.name;
+            const friendlyName = status.FriendlyName ?? [];
+            const relaysName = Array.isArray(friendlyName) ? friendlyName : [friendlyName];
+            for (const relayName of relaysName) {
+                const name = relayName ?? 'Unknown'
+                friendlyNames.push(name);
+            }
+
+            //status FWR
+            const statusFwr = deviceInfo.StatusFWR ?? {};
+            const firmwareRevision = statusFwr.Version ?? 'Unknown';
+            const modelName = statusFwr.Hardware ?? 'Unknown';
+
+            //status NET
+            const statusNet = deviceInfo.StatusNET ?? {};
+            const addressMac = statusNet.Mac ?? false;
+
+            //status SNS
+            const statusSns = deviceInfo.StatusSNS ?? {};
+            const statusSnsKeys = Object.keys(statusSns);
+
+            //status STS
+            const statusSts = deviceInfo.StatusSTS ?? {};
+            const statusStsKeys = Object.keys(statusSts);
+
+            //device types
+            const types = [];
+            const mielhvac = statusSnsKeys.includes('MiElHVAC') ? types.push(0) : false;
+            const lights = statusStsKeys.some(key => LightKeys.includes(key)) ? types.push(2) : false;
+            const fans = statusStsKeys.includes('FanSpeed') ? types.push(3) : false;
+            const sensors = statusSnsKeys.some(key => SensorKeys.includes(key)) ? types.push(4) : false;
+            const switches = !mielhvac && !lights && !fans && !sensors ? types.push(1) : false
+            const obj = {
+                deviceTypes: types,
+                deviceName: deviceName,
+                friendlyNames: friendlyNames,
+                modelName: modelName,
+                serialNumber: addressMac,
+                firmwareRevision: firmwareRevision,
+                relaysCount: friendlyNames.length
+            };
+            return obj;
+        } catch (error) {
+            throw new Error(`Check info error: ${error}`);
+        }
+    }
+}
+export default DeviceInfo;