iobroker.esphome 0.3.1 → 0.3.2

package/CHANGELOG_OLD.md

@@ -1,4 +1,9 @@
 # Older changes
+## 0.2.2 (2021-06-24)
+* (DutchmanNL) [!!! Breaking !!!] Make YAML file persistent, backup your configuration before updating ! solves [#57](https://github.com/DrozmotiX/ioBroker.esphome/issues/57)
+* (DutchmanNL) Update ESPHome Dashboard to 1.18.0, requires  Python >=3.7 (and ensure <4.0!)
+* (DutchmanNL) Bugfix : Reconnect to devices without autodiscovery / MDNS-Broadcast in network, solves [#66](https://github.com/DrozmotiX/ioBroker.esphome/issues/66)
+
 ## 0.2.1-1 (2021-03-30)
 * (DutchmanNL) add cover component
 * (DutchmanNL) add transitionLength for lights

package/README.md

@@ -112,6 +112,10 @@ If you like my work, please consider a personal donation
     ### __WORK IN PROGRESS__
     * (DutchmanNL) 
 -->
+### 0.3.2 (2023-11-01)
+* (DutchmanNL) Improved error handling if devices are not reachable/disconnected
+* (DutchmanNL) Bugfix: Allow control of brightness and color for light component, fixes #173
+
 ### 0.3.1 (2023-10-31)
 * (DutchmanNL) Bugfix: Show online state of ESP Device correctly, Fixes #106
 
@@ -131,11 +135,6 @@ If you like my work, please consider a personal donation
 * (Jey-Cee) Bugfix : Light component state not changed [#74](https://github.com/DrozmotiX/ioBroker.esphome/issues/74)
 * (DutchmanNL) Update compatibility to version 1.19.4 of ESPHome Dashboard
 
-### 0.2.2 (2021-06-24)
-* (DutchmanNL) [!!! Breaking !!!] Make YAML file persistent, backup your configuration before updating ! solves [#57](https://github.com/DrozmotiX/ioBroker.esphome/issues/57)
-* (DutchmanNL) Update ESPHome Dashboard to 1.18.0, requires  Python >=3.7 (and ensure <4.0!)
-* (DutchmanNL) Bugfix : Reconnect to devices without autodiscovery / MDNS-Broadcast in network, solves [#66](https://github.com/DrozmotiX/ioBroker.esphome/issues/66)
-
 ## License
 MIT License
 

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "esphome",
-    "version": "0.3.1",
+    "version": "0.3.2",
     "news": {
+      "0.3.2": {
+        "en": "Improved error handling if devices are not reachable/disconnected\nBugfix: Allow control of brightness and color for light component, fixes #173",
+        "de": "Verbesserte Fehlerbehandlung, wenn Geräte nicht erreichbar/vernetzt sind\nBugfix: Erlauben Sie die Kontrolle von Helligkeit und Farbe für die Lichtkomponente, fixiert #173",
+        "ru": "Улучшена обработка ошибок, если устройства не доступны / отключены\nBugfix: Разрешить контроль яркости и цвета для легкой составляющей, исправляет #173",
+        "pt": "Melhor manuseio de erros se os dispositivos não forem acessíveis/desconectados\nBugfix: Permitir controle de brilho e cor para componente de luz, correções #173",
+        "nl": "Improviserende fouten als de apparatuur niet bereikbaar is\nBugfix: Controle van helderheid en kleur voor lichtcomonent, reparatie #173",
+        "fr": "Amélioration de la manipulation des erreurs si les dispositifs ne sont pas accessibles/déconnectés\nBugfix: Permettre le contrôle de la luminosité et de la couleur pour le composant de lumière, corrige #173",
+        "it": "Miglioramento della gestione degli errori se i dispositivi non sono raggiungibili/disconnessi\nBugfix: Consentire il controllo di luminosità e colore per componenti leggeri, correzioni #173",
+        "es": "Mejor manejo de errores si los dispositivos no son accesibles/desconectados\nBugfix: Permitir el control del brillo y el color para el componente de luz, fija #173",
+        "pl": "Poprawiona obsługa błędów, jeśli urządzenia nie są dosyć dopasowalne i rozproszone\nBugfix: Allow kontrola jasności i koloru dla komponentów świetlnych naprawia numer #173",
+        "uk": "Поліпшення обробки помилок, якщо пристрої не досягаються / відключені\nПомилки: Дозволяє контролювати яскравість і колір для легкого компонента, закріплює #173",
+        "zh-cn": "如果装置无法达到/无联系,改进错误处理\nBugfix: 允许控制光明和颜色,确定第173号行动。"
+      },
       "0.3.1": {
         "en": "Bugfix: Show online state of ESP Device correctly, Fixes #106",
         "de": "Bugfix: Online-Zustand von ESP Device korrekt anzeigen, Fixes #106",
@@ -76,18 +89,6 @@
         "es": "agregar componente de portada\nagregar transiciónLength para luces",
         "pl": "dodaj komponent okładki\ndodaj długość przejścia dla świateł",
         "zh-cn": "添加封面组件\n为灯光添加transitionLength"
-      },
-      "0.2.1-0": {
-        "en": "Logging improved, solves [#48](https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nName of states changed, solves [#49](https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "de": "Protokollierung verbessert, löst [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nName der Staaten geändert, löst [# 49] (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "ru": "Ведение журнала улучшено, решает [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nНазвание состояний изменено, решает [# 49] (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "pt": "Logging melhorado, resolve [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nNome dos estados alterados, resolve [# 49] (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "nl": "Logboekregistratie verbeterd, lost op [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nNaam van staten gewijzigd, lost [# 49] op (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "fr": "Journalisation améliorée, résout [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nLe nom des états a changé, résout [# 49] (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "it": "Registrazione migliorata, risolve [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nIl nome degli stati è cambiato, risolve [# 49] (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "es": "Registro mejorado, resuelve [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nNombre de los estados cambiado, resuelve [# 49] (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "pl": "Logowanie poprawione, rozwiązuje [# 48] (https://github.com/DrozmotiX/ioBroker.esphome/issues/48)\nZmiana nazwy stanów, rozwiązuje [# 49] (https://github.com/DrozmotiX/ioBroker.esphome/issues/49)",
-        "zh-cn": "日志记录得到改进，解决了[＃48]（https://github.com/DrozmotiX/ioBroker.esphome/issues/48）\n状态名称更改，解决[＃49]（https://github.com/DrozmotiX/ioBroker.esphome/issues/49）"
       }
     },
     "title": "Control ESPHome managed devices",

package/main.js

@@ -71,7 +71,7 @@ class Esphome extends utils.Adapter {
 			}
 
 		} catch (e) {
-			this.log.error(`Connection issue ${e}`);
+			this.log.error(`[Adapter start] Fatal error occurred ${e}`);
 		}
 	}
 
@@ -154,11 +154,7 @@ class Esphome extends utils.Adapter {
 
 			// Get basic data of known devices and start reading data
 			for (const i in knownDevices) {
-				this.deviceInfo[knownDevices[i].native.ip] = {
-					ip: knownDevices[i].native.ip,
-					passWord: this.decrypt(knownDevices[i].native.passWord),
-				};
-				this.connectDevices(knownDevices[i].native.ip, this.deviceInfo[knownDevices[i].native.ip].passWord);
+				this.connectDevices(knownDevices[i].native.ip, this.decrypt(knownDevices[i].native.passWord));
 			}
 		} catch (e) {
 			this.sendSentry(`[tryKnownDevices] ${e}`);
@@ -176,12 +172,7 @@ class Esphome extends utils.Adapter {
 				try {
 					this.log.debug(`Discovery message ${JSON.stringify(message)}`);
 					if (this.deviceInfo[message.address] == null) {
-						this.log.info(`[AutoDiscovery] New ESPHome device found at IP ${message.address}`);
-						// Store new Device information to device array in memory
-						this.deviceInfo[message.address] = {
-							ip: message.address,
-							passWord: apiPass
-						};
+						this.log.info(`[AutoDiscovery] New ESPHome device found at IP ${message.address}, trying to initialize`);
 						this.connectDevices(`${message.address}`, `${apiPass}`);
 					}
 				} catch (e) {
@@ -206,7 +197,7 @@ class Esphome extends utils.Adapter {
 			// Prepare connection attributes
 			client[host] = new Client({
 				host: host,
-				password: pass,
+				password: apiPass,
 				clientInfo: `${this.host}`,
 				clearSession: true,
 				initializeDeviceInfo: true,
@@ -223,6 +214,16 @@ class Esphome extends utils.Adapter {
 			// Connection listener
 			client[host].on('connected', async () => {
 				try {
+					// Clear any existing memory information for this device
+					delete this.deviceInfo[host];
+
+					// Reserve basic memory information for this device
+					this.deviceInfo[host] = {
+						connected : true,
+						connectionError : false,
+						initialized: false,
+						ip : host
+					};
 					this.log.info(`ESPHome client ${host} connected`);
 					// Clear possible present warn messages for device from previous connection
 					delete warnMessages[host];
@@ -231,13 +232,31 @@ class Esphome extends utils.Adapter {
 				}
 			});
 
-			client[host].on('disconnected', () => {
+			client[host].on('disconnected', () => 	{
 				try {
 					if (this.deviceInfo[host].deviceName != null) {
 						this.setState(`${this.deviceInfo[host].deviceName}.info._online`, {val: false, ack: true});
-						this.log.warn(`ESPHome  client  ${this.deviceInfo[host].deviceInfo.name} disconnected`);
+
+						// Cache relevant data before clearing memory space of device
+						const cacheDeviceInformation = {
+							deviceName: this.deviceInfo[host].deviceName,
+							deviceInfoName: this.deviceInfo[host].deviceInfoName,
+						};
+
+						// Clear any existing memory information for this device
+						delete this.deviceInfo[host];
+
+						// Reserve basic memory information for this device
+						this.deviceInfo[host] = {
+							connected : false,
+							connectionError : true,
+							deviceName : cacheDeviceInformation.deviceName,
+							deviceInfoName : cacheDeviceInformation.deviceInfoName,
+							ip : host
+						};
+						this.log.warn(`ESPHome client ${this.deviceInfo[host].deviceInfoName} | ${this.deviceInfo[host].deviceName} | on ${host} disconnected`);
 					} else {
-						this.log.warn(`ESPHome  client  ${host} disconnected`);
+						this.log.warn(`ESPHome client ${host} disconnected`);
 					}
 				} catch (e) {
 					this.log.debug(`ESPHome disconnect error : ${e}`);
@@ -245,20 +264,17 @@ class Esphome extends utils.Adapter {
 			});
 
 			client[host].on('initialized', () => {
-				this.log.info(`ESPHome  client ${this.deviceInfo[host].deviceInfo.name} on ip ${host} initialized`);
-			});
-
-			client[host].on('logs', (/** @type {object} */ messageObj) => {
-				this.log.debug(`ESPHome client log : ${JSON.stringify(messageObj)}`);
+				this.log.info(`ESPHome  client ${this.deviceInfo[host].deviceInfoName} on ip ${host} initialized`);
+				this.deviceInfo[host].initialized = true;
 			});
 
 			// Log message listener
 			client[host].connection.on('message', (/** @type {object} */ message) => {
-				this.log.debug(`${host} client log ${message}`);
+				this.log.debug(`[ESPHome Device Message] ${host} client log ${message}`);
 			});
 
 			client[host].connection.on('data', (/** @type {object} */ data) => {
-				this.log.debug(`${host} client data ${data}`);
+				this.log.debug(`[ESPHome Device Data] ${host} client data ${data}`);
 			});
 
 			// Handle device information when connected or information updated
@@ -275,10 +291,11 @@ class Esphome extends utils.Adapter {
 						deviceInfo: deviceInfo,
 						deviceName: deviceName,
 						deviceInfoName: deviceInfo.name,
-						passWord: pass,
+						passWord: apiPass,
 					};
 
-					// Store MAC & IP relation
+					// Store MAC & IP relation, delete possible existing entry before
+					delete this.deviceStateRelation[deviceName];
 					this.deviceStateRelation[deviceName] = {'ip': host};
 
 					this.log.debug(`DeviceInfo ${this.deviceInfo[host].deviceInfo.name}: ${JSON.stringify(this.deviceInfo)}`);
@@ -297,7 +314,7 @@ class Esphome extends utils.Adapter {
 							name: this.deviceInfo[host].deviceInfoName,
 							mac: deviceInfo.macAddress,
 							deviceName: deviceName,
-							passWord: this.encrypt(pass),
+							passWord: this.encrypt(apiPass),
 						},
 					});
 
@@ -390,7 +407,7 @@ class Esphome extends utils.Adapter {
 					await client[host].connection.subscribeStatesService();
 					this.log.debug(`[DeviceInfoData] ${this.deviceInfo[host].deviceInfo.name} ${JSON.stringify(this.deviceInfo[host])}`);
 
-					// Listen to state changes an write values to states (create state if not yet exists)
+					// Listen to state changes and write values to states (create state if not yet exists)
 					entity.on(`state`, async (/** @type {object} */ state) => {
 						this.log.debug(`StateData: ${JSON.stringify(state)}`);
 						try {
@@ -483,23 +500,46 @@ class Esphome extends utils.Adapter {
 			// Connection data handler
 			client[host].on('error', (error) => {
 				try {
+
+					// Reserve memory space for connection error if not already exist
+					if (!this.deviceInfo[host]){
+						this.deviceInfo[host] = {
+							ip : host,
+							connectError : false,
+							connected : false
+						};
+					}
+
 					let optimisedError = error.message;
 					// Optimise error messages
-					if (error.message.includes('EHOSTUNREACH')) {
-						optimisedError = `Client ${this.deviceInfo[host].ip} not reachable !`;
-						if (!warnMessages[host].connectError) {
+					if (error.code === 'ETIMEDOUT') {
+						optimisedError = `Client ${host} not reachable !`;
+						if (!this.deviceInfo[host].connectError) {
 							this.log.error(optimisedError);
-							warnMessages[host].connectError = true;
+							this.deviceInfo[host].connectError = true;
 						}
 					} else if (error.message.includes('Invalid password')) {
 						optimisedError = `Client ${host} incorrect password !`;
-						this.log.error(optimisedError);
+						if (!this.deviceInfo[host].connectError) {
+							this.log.error(optimisedError);
+							this.deviceInfo[host].connectError = true;
+						}
 					} else if (error.message.includes('ECONNRESET')) {
-						optimisedError = `Client ${this.deviceInfo[host].ip} Connection Lost, will reconnect automatically when device is available!`;
-						this.log.warn(optimisedError);
+						optimisedError = `Client ${host} Connection Lost, will reconnect automatically when device is available!`;
+						if (!this.deviceInfo[host].connectError) {
+							this.log.warn(optimisedError);
+							this.deviceInfo[host].connectError = true;
+						}
 					} else if (error.message.includes('timeout')) {
-						optimisedError = `Client ${host} Timeout, connection Lost, will reconnect automatically when device is available!`;
+						optimisedError = `Client ${host} Timeout, will reconnect automatically when device is available!`;
+						if (!this.deviceInfo[host].connectError) {
+							this.log.warn(optimisedError);
+							this.deviceInfo[host].connectError = true;
+						}
+					}  else if (error.message.includes('ECONNREFUSED')) {
+						optimisedError = `Client ${host} not yet ready to connect, will try again!`;
 						this.log.warn(optimisedError);
+
 					} else if (error.message.includes('write after end')) {
 						// Ignore error
 					} else {
@@ -527,10 +567,6 @@ class Esphome extends utils.Adapter {
 			// connect to socket
 			try {
 				this.log.debug(`trying to connect to ${host}`);
-				// Reserve memory for warn messages
-				warnMessages[host] = {
-					connectError: false
-				};
 				client[host].connect();
 			} catch (e) {
 				this.log.error(`Client ${host} connect error ${e}`);
@@ -992,8 +1028,8 @@ class Esphome extends utils.Adapter {
 					} else {
 						this.log.info(`Valid IP address received`);
 						this.messageResponse[obj.message['device-ip']] = obj;
-						const pass = this.decrypt(obj.message['device-pass']);
-						await this.connectDevices(obj.message['device-ip'], pass);
+						// const pass = this.decrypt(obj.message['device-pass']);
+						await this.connectDevices(obj.message['device-ip'], apiPass);
 					}
 					break;
 			}
@@ -1126,18 +1162,18 @@ class Esphome extends utils.Adapter {
 						state: this.deviceInfo[deviceIP][device[4]].states.state,
 						transitionLength: this.deviceInfo[deviceIP][device[4]].states.transitionLength
 					};
-					if (this.deviceInfo[deviceIP][device[4]].config.supportsBrightness === true) {
+					if (this.deviceInfo[deviceIP][device[4]].config.legacySupportsBrightness === true) {
 						data.brightness = this.deviceInfo[deviceIP][device[4]].states.brightness;
 					}
-					if (this.deviceInfo[deviceIP][device[4]].config.supportsRgb === true) {
+					if (this.deviceInfo[deviceIP][device[4]].config.legacySupportsRgb === true) {
 						data.red = this.deviceInfo[deviceIP][device[4]].states.red;
 						data.green = this.deviceInfo[deviceIP][device[4]].states.green;
 						data.blue = this.deviceInfo[deviceIP][device[4]].states.blue;
 					}
-					if (this.deviceInfo[deviceIP][device[4]].config.supportsWhiteValue === true) {
+					if (this.deviceInfo[deviceIP][device[4]].config.legacySupportsWhiteValue === true) {
 						data.white = this.deviceInfo[deviceIP][device[4]].states.white;
 					}
-					if (this.deviceInfo[deviceIP][device[4]].config.supportsColorTemperature === true) {
+					if (this.deviceInfo[deviceIP][device[4]].config.legacySupportsColorTemperature === true) {
 						data.colorTemperature = this.deviceInfo[deviceIP][device[4]].states.colorTemperature;
 					}
 					const effect = this.deviceInfo[deviceIP][device[4]].states.effect;
@@ -1197,7 +1233,6 @@ class Esphome extends utils.Adapter {
 			this.log.error(`[resetOnlineState] ${e}`);
 		}
 	}
-
 }
 
 if (require.main !== module) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.esphome",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Control your ESP8266/ESP32 with simple yet powerful configuration files created and managed by ESPHome",
   "author": {
     "name": "DutchmanNL",
@@ -28,6 +28,8 @@
     "@alcalzone/release-script-plugin-iobroker": "^3.6.0",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
     "@alcalzone/release-script-plugin-manual-review": "^3.5.9",
+    "@iobroker/adapter-dev": "^1.2.0",
+    "@iobroker/dev-server": "^0.6.0",
     "@iobroker/testing": "^4.1.0",
     "@types/chai": "^4.3.6",
     "@types/chai-as-promised": "^7.1.6",
@@ -52,6 +54,7 @@
   "main": "main.js",
   "scripts": {
     "release": "release-script",
+    "dev-server": "dev-server",
     "test:js": "mocha --config test/mocharc.custom.json \"{!(node_modules|test)/**/*.test.js,*.test.js,test/**/test!(PackageFiles|Startup).js}\"",
     "test:package": "mocha test/package --exit",
     "test:unit": "mocha test/unit --exit",