iobroker.device-watcher 2.0.0 → 2.0.1

package/README.md

@@ -8,7 +8,7 @@
 [![GitHub license](https://img.shields.io/github/license/ciddi89/ioBroker.device-watcher)](https://github.com/ciddi89/ioBroker.device-watcher/blob/main/LICENSE)
 ![GitHub repo size](https://img.shields.io/github/repo-size/ciddi89/ioBroker.device-watcher)
 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/ciddi89/ioBroker.device-watcher)
-![GitHub commits since tagged version (branch)](https://img.shields.io/github/commits-since/ciddi89/ioBroker.device-watcher/v2.0.0)
+![GitHub commits since tagged version (branch)](https://img.shields.io/github/commits-since/ciddi89/ioBroker.device-watcher/v2.0.1)
 ![GitHub last commit](https://img.shields.io/github/last-commit/ciddi89/ioBroker.device-watcher)
 ![GitHub issues](https://img.shields.io/github/issues/ciddi89/ioBroker.device-watcher)
 
@@ -98,7 +98,6 @@ If you found a bug or you have an improvement suggestion, feel free to open an i
 ![list3.png](admin/images/list3.png)
 
 ## To-Do
-- make blacklist more user-friendly
 - clean up the code
 - add support for reaction on state-changes
 - send offline text only from the device that goes offline
@@ -108,6 +107,11 @@ If you found a bug or you have an improvement suggestion, feel free to open an i
     Placeholder for the next version (at the beginning of the line):
     ### **WORK IN PROGRESS**
 -->
+### 2.0.1 (2022-11-02)
+- If the device is offline, set signal strength to '0%'
+- If the device is offline, set battery to ' - '
+- repair some small issues in the lists
+
 ### 2.0.0 (2022-11-01)
 - added Lupusec, HS100 adapter, Zigbee2MQTT and MaxCube
 - changed name of Homematic to HM-RPC

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "device-watcher",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "news": {
+      "2.0.1": {
+        "en": "If the device is offline, set signal strength to '0%'\nIf the device is offline, set battery to ' - '\nrepair some small issues in the lists",
+        "de": "Ist das Gerät offline, setzen Sie Signalstärke auf 0%\nWenn das Gerät offline ist, setzen Sie Batterie auf ' - '\neinige kleine probleme in den listen reparieren",
+        "ru": "Если устройство оффлайн, установите силу сигнала до 0%\nЕсли устройство оффлайн, установите аккумулятор в ' - '\nотремонтировать некоторые небольшие проблемы в списках",
+        "pt": "Se o dispositivo estiver offline, defina a força do sinal para 0%\nSe o dispositivo estiver offline, configure a bateria para ' - '\nreparar alguns pequenos problemas nas listas",
+        "nl": "Als het apparaat offline is, zet een signaalstilstand op 0%\nAls het apparaat offline is, zet dan batterij op '\nrepareer wat kleine kwesties in de lijst",
+        "fr": "Si l'appareil est hors ligne, définir la résistance du signal à 0%\nSi l'appareil est hors ligne, régler la batterie à ' - '\nréparer quelques petits problèmes dans les listes",
+        "it": "Se il dispositivo è offline, impostare la forza del segnale a 0%\nSe il dispositivo è offline, impostare la batteria a ' - '\nriparare alcuni piccoli problemi nelle liste",
+        "es": "Si el dispositivo está fuera de línea, establece la fuerza de señal al 0%\nSi el dispositivo está fuera de línea, establece la batería a ' - '\nreparar algunas pequeñas cuestiones en las listas",
+        "pl": "Jeśli urządzenie jest offline, ustawia siłę sygnału do 0%\nJeśli urządzenie jest wycinane, ustawiono baterię do '- '\nwyremontowano drobne problemy w listach",
+        "uk": "Якщо пристрій вимкнено, встановлюється міцність сигналу на 0%\nЯкщо пристрій вимкнено, встановіть акумулятор до ' - '\nремонт деяких невеликих питань у переліках",
+        "zh-cn": "如果装置落空,信号强度达到0%\n如果装置不线,便将电池到该地。\n在名单中修理一些小型问题"
+      },
       "2.0.0": {
         "en": "added Lupusec, HS100 adapter, Zigbee2MQTT and MaxCube\nchanged name of Homematic to HM-RPC\nmade a completly makeover of the blacklist\nclean up the code and shorten some",
         "de": "lupusec, HS100 Adapter, Zigbee2MQTT und MaxCube\ngeänderter Name von Homematic zu HM-RPC\naus einem kompletten makeover der blacklist\nden code reinigen und einige verkürzen",
@@ -75,18 +88,6 @@
         "es": "muchos cambios de código, comentarios y manejo de errores",
         "pl": "wiele zmian kodu, komentarzy i obsługi błędów",
         "zh-cn": "守则、评论和错误处理的许多变化"
-      },
-      "0.2.3": {
-        "en": "many changes of code, comments and error handling",
-        "de": "viele änderungen von code, kommentaren und fehlerbehandlung",
-        "ru": "много изменений кода, комментариев и обработки ошибок",
-        "pt": "muitas mudanças de código, comentários e manipulação de erros",
-        "nl": "veel veranderingen van code, commentaar en fouten",
-        "fr": "de nombreux changements de code, de commentaires et de traitement des erreurs",
-        "it": "molte modifiche di codice, commenti e gestione degli errori",
-        "es": "muchos cambios de código, comentarios y manejo de errores",
-        "pl": "wiele zmian kodu, komentarzy i obsługi błędów",
-        "zh-cn": "守则、评论和错误处理的许多变化"
       }
     },
     "titleLang": {

package/main.js

@@ -538,39 +538,31 @@ class DeviceWatcher extends utils.Adapter {
 	 */
 	async createData(i) {
 		const devices = await this.getForeignStatesAsync(this.arrDev[i].Selektor);
-		const deviceAdapterName = await this.capitalize(this.arrDev[i].adapter);
+		const adapterID = this.arrDev[i].adapter;
 
-		/*----------  Start of second main loop  ----------*/
+		/*----------  Start of loop  ----------*/
 		for (const [id] of Object.entries(devices)) {
 			if (!isUnloaded) {
 
-
-
+				/*=============================================
+				=              Get device name		          =
+				=============================================*/
 				const deviceName = await this.getDeviceName(id, i);
 
+
+				/*=============================================
+				=            Get path to datapoints	   	      =
+				=============================================*/
 				const currDeviceString = id.slice(0, (id.lastIndexOf('.') + 1) - 1);
 				const shortCurrDeviceString = currDeviceString.slice(0, (currDeviceString.lastIndexOf('.') + 1) - 1);
 
-				// Get battery states
-				const deviceBatteryState = await this.getInitValue(currDeviceString + this.arrDev[i].battery);
-				const shortDeviceBatteryState = await this.getInitValue(shortCurrDeviceString + this.arrDev[i].battery);
-				const shortDeviceBatteryState2 = await this.getInitValue(shortCurrDeviceString + this.arrDev[i].battery2);
-
-
-				//this.devices[deviceName] = currDeviceString + this.arrDev[i].reach;
-
-				/*for (const [value] of Object.entries(this.devices)) {
-						this.log.warn(`${value}`);
-						this.subscribeForeignStatesAsync(value);
-					}*/
-				//this.subscribeForeignStatesAsync(currDeviceString + this.arrDev[i].reach);
-				// <--- END TEST
-
-				// Get link quality
+				/*=============================================
+				=            Get signal strength              =
+				=============================================*/
 				let deviceQualityState;
 				let linkQuality;
 
-				switch (this.arrDev[i].adapter) {
+				switch (adapterID) {
 					case 'mihomeVacuum':
 						deviceQualityState = await this.getForeignStateAsync(shortCurrDeviceString + this.arrDev[i].rssiState);
 						break;
@@ -593,7 +585,7 @@ class DeviceWatcher extends utils.Adapter {
 							if (this.config.trueState) {
 								linkQuality = deviceQualityState.val;
 							} else {
-								switch (this.arrDev[i].adapter) {
+								switch (adapterID) {
 									case 'roomba':
 									case 'sonoff':
 										linkQuality = deviceQualityState.val + '%'; // If quality state is already an percent value
@@ -618,7 +610,7 @@ class DeviceWatcher extends utils.Adapter {
 							break;
 
 						case 'string':
-							switch (this.arrDev[i].adapter) {
+							switch (adapterID) {
 								case 'netatmo':
 									// for Netatmo devices
 									linkQuality = deviceQualityState.val;
@@ -633,10 +625,96 @@ class DeviceWatcher extends utils.Adapter {
 					linkQuality = ' - ';
 				}
 
-				// When was the last contact to the device?
+				/*=============================================
+				=         	    Get battery data       	      =
+				=============================================*/
+				let batteryHealth;
+				let lowBatIndicator;
+
+				// Get battery states
+				const deviceBatteryState = await this.getInitValue(currDeviceString + this.arrDev[i].battery);
+				const shortDeviceBatteryState = await this.getInitValue(shortCurrDeviceString + this.arrDev[i].battery);
+				const shortDeviceBatteryState2 = await this.getInitValue(shortCurrDeviceString + this.arrDev[i].battery2);
+
+				// Get low bat states
+				let deviceLowBatState = await this.getInitValue(currDeviceString + this.arrDev[i].isLowBat);
+				if (deviceLowBatState === undefined) {
+					deviceLowBatState = await this.getInitValue(currDeviceString + this.arrDev[i].isLowBat2);
+				}
+
+				if ((!deviceBatteryState) && (!shortDeviceBatteryState) && (!shortDeviceBatteryState2)) {
+					if (deviceLowBatState !== undefined) {
+						switch (this.arrDev[i].isLowBat || this.arrDev[i].isLowBat2) {
+							case 'none':
+								batteryHealth = ' - ';
+								break;
+							default:
+								if ((deviceLowBatState === false) || (deviceLowBatState === 'NORMAL') || (deviceLowBatState === 1)) {
+									batteryHealth = 'ok';
+								} else {
+									batteryHealth = 'low';
+								}
+								break;
+						}
+					} else {
+						batteryHealth = ' - ';
+					}
+				} else {
+					switch (adapterID) {
+						case 'hmrpc':
+							if (deviceBatteryState === 0) {
+								batteryHealth = ' - ';
+							} else {
+								batteryHealth = deviceBatteryState + 'V';
+							}
+							break;
+
+						case 'hue-extended':
+							if (shortDeviceBatteryState) {
+								batteryHealth = shortDeviceBatteryState + '%';
+							}
+							break;
+						case 'mihomeVacuum':
+							if (shortDeviceBatteryState) {
+								batteryHealth = shortDeviceBatteryState + '%';
+							} else if (shortDeviceBatteryState2) {
+								batteryHealth = shortDeviceBatteryState2 + '%';
+							}
+							break;
+						default:
+							batteryHealth = (deviceBatteryState) + '%';
+					}
+				}
+
+				/*=============================================
+				=            Set Lowbat indicator             =
+				=============================================*/
+				switch (adapterID) {
+					case 'hmrpc': // there are differnt low bat states between hm and hmIp devices
+						if (deviceLowBatState) {
+							lowBatIndicator = true;
+						}
+						break;
+					case 'tado': // there is an string as indicator
+						if (deviceLowBatState != 'NORMAL') {
+							lowBatIndicator = true;
+						}
+						break;
+
+					default: // for all other devices with low bat states
+						if ((deviceLowBatState === true) || (deviceLowBatState === 0)) {
+							lowBatIndicator = true;
+						} else if (deviceBatteryState && (deviceBatteryState < this.config.minWarnBatterie)) { // if the battery state is under the set limit
+							lowBatIndicator = true;
+						}
+				}
+
+				/*=============================================
+				=          Get last contact of device         =
+				=============================================*/
 				let lastContactString;
-				let deviceState = 'Online';
 				let lastDeviceUnreachStateChange;
+				let deviceState = 'Online';
 
 				const deviceMainSelector = await this.getForeignStateAsync(id);
 				const deviceStateSelector = await this.getForeignStateAsync(shortCurrDeviceString + this.arrDev[i].stateValue); // for hmrpc devices
@@ -682,7 +760,7 @@ class DeviceWatcher extends utils.Adapter {
 
 							default:
 								//State changed
-								if  (this.arrDev[i].adapter === 'hmrpc') {
+								if  (adapterID === 'hmrpc') {
 									if (linkQuality != ' - ') {
 										if (deviceUnreachState) {
 											await getLastStateChange();
@@ -718,7 +796,6 @@ class DeviceWatcher extends utils.Adapter {
 											await getLastContactOfState();
 										}
 									}
-
 								} else {
 									if (!deviceUnreachState) {
 										await getLastStateChange();
@@ -729,8 +806,9 @@ class DeviceWatcher extends utils.Adapter {
 								}
 						}
 
-						const adapterID = this.arrDev[i].adapter;
-
+						/*=============================================
+						=            Set Online Status             =
+						=============================================*/
 						switch (adapterID) {
 							case 'hmrpc':
 							case 'hmiP':
@@ -738,28 +816,39 @@ class DeviceWatcher extends utils.Adapter {
 								if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 									if (deviceUnreachState) {
 										deviceState = 'Offline'; //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								} else if ((this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID])) {
 									deviceState = 'Offline'; //set online state to offline
+									linkQuality = '0%'; // set linkQuality to nothing
+									batteryHealth = ' - '; // set batteryhelth to nothing
 								}
 								break;
 							case 'ping':
 								if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 									if (!deviceUnreachState) {
 										deviceState = 'Offline'; //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								} else if ((this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID]) && (!deviceUnreachState)) {
 									deviceState = 'Offline'; //set online state to offline
+									linkQuality = '0%'; // set linkQuality to nothing
+									batteryHealth = ' - '; // set batteryhelth to nothing
 								}
 								break;
 							case 'unifi':
 								if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 									if (deviceUnreachState === 0) {
 										deviceState = 'Offline'; //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								} else if ((this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID])) {
 									deviceState = 'Offline'; //set online state to offline
-
+									linkQuality = '0%'; // set linkQuality to nothing
+									batteryHealth = ' - '; // set batteryhelth to nothing
 								}
 								break;
 							case 'shelly':
@@ -767,18 +856,26 @@ class DeviceWatcher extends utils.Adapter {
 								if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 									if (!deviceUnreachState) {
 										deviceState = 'Offline'; //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								} else if ((!deviceUnreachState) && (typeof lastDeviceUnreachStateChange !== 'undefined') && (this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID])) {
 									deviceState = 'Offline'; //set online state to offline
+									linkQuality = '0%'; // set linkQuality to nothing
+									batteryHealth = ' - '; // set batteryhelth to nothing
 								}
 								break;
 							case 'mihomeVacuum':
 								if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 									if (!shortDeviceUnreachState) {
 										deviceState = 'Offline'; //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								} else if ((this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID])) {
 									deviceState = 'Offline'; //set online state to offline
+									linkQuality = '0%'; // set linkQuality to nothing
+									batteryHealth = ' - '; // set batteryhelth to nothing
 								}
 								break;
 							case 'miHome':
@@ -786,17 +883,25 @@ class DeviceWatcher extends utils.Adapter {
 									if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 										if (!deviceUnreachState) {
 											deviceState = 'Offline'; //set online state to offline
+											linkQuality = '0%'; // set linkQuality to nothing
+											batteryHealth = ' - '; // set batteryhelth to nothing
 										}
 									} else if ((this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID])) {
 										deviceState = 'Offline'; //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								} else {
 									if (this.config.mihomeMaxMinutes === -1) {
 										if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 											deviceState = 'Offline'; //set online state to offline
+											linkQuality = '0%'; // set linkQuality to nothing
+											batteryHealth = ' - '; // set batteryhelth to nothing
 										}
 									} else if ((this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID])) {
 										deviceState = 'Offline'; //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								}
 								break;
@@ -804,9 +909,13 @@ class DeviceWatcher extends utils.Adapter {
 								if ((this.maxMinutes !== undefined) && (this.maxMinutes[adapterID] === -1)) {
 									if (!deviceUnreachState) {
 										deviceState = 'Offline';  //set online state to offline
+										linkQuality = '0%'; // set linkQuality to nothing
+										batteryHealth = ' - '; // set batteryhelth to nothing
 									}
 								} else if ((this.maxMinutes !== undefined) && (lastContact > this.maxMinutes[adapterID])) {
 									deviceState = 'Offline'; //set online state to offline
+									linkQuality = '0%'; // set linkQuality to nothing
+									batteryHealth = ' - '; // set batteryhelth to nothing
 								}
 								break;
 						}
@@ -815,85 +924,18 @@ class DeviceWatcher extends utils.Adapter {
 					}
 				}
 
-				// Get battery states
-				let batteryHealth;
-				let lowBatIndicator;
-				let deviceLowBatState = await this.getInitValue(currDeviceString + this.arrDev[i].isLowBat);
-				if (deviceLowBatState === undefined) {
-					deviceLowBatState = await this.getInitValue(currDeviceString + this.arrDev[i].isLowBat2);
-				}
+				/*=============================================
+				=          		  Fill Raw Lists          	  =
+				=============================================*/
 
-				if ((!deviceBatteryState) && (!shortDeviceBatteryState) && (!shortDeviceBatteryState2)) {
-					if (deviceLowBatState !== undefined) {
-						switch (this.arrDev[i].isLowBat || this.arrDev[i].isLowBat2) {
-							case 'none':
-								batteryHealth = ' - ';
-								break;
-							default:
-								if ((deviceLowBatState === false) || (deviceLowBatState === 'NORMAL') || (deviceLowBatState === 1)) {
-									batteryHealth = 'ok';
-								} else {
-									batteryHealth = 'low';
-								}
-								break;
-						}
-					} else {
-						batteryHealth = ' - ';
-					}
-				} else {
-					switch (this.arrDev[i].adapter) {
-						case 'hmrpc':
-							if (deviceBatteryState === 0) {
-								batteryHealth = ' - ';
-							} else {
-								batteryHealth = deviceBatteryState + 'V';
-							}
-							break;
-
-						case 'hue-extended':
-							if (shortDeviceBatteryState) {
-								batteryHealth = shortDeviceBatteryState + '%';
-							}
-							break;
-						case 'mihomeVacuum':
-							if (shortDeviceBatteryState) {
-								batteryHealth = shortDeviceBatteryState + '%';
-							} else if (shortDeviceBatteryState2) {
-								batteryHealth = shortDeviceBatteryState2 + '%';
-							}
-							break;
-						default:
-							batteryHealth = (deviceBatteryState) + '%';
-					}
-				}
-
-				// fill list with low battery devices
-				switch (this.arrDev[i].adapter) {
-					case 'hmrpc': // there are differnt low bat states between hm and hmIp devices
-						if (deviceLowBatState) {
-							lowBatIndicator = true;
-						}
-						break;
-					case 'tado': // there is an string as indicator
-						if (deviceLowBatState != 'NORMAL') {
-							lowBatIndicator = true;
-						}
-						break;
-
-					default: // for all other devices with low bat states
-						if ((deviceLowBatState === true) || (deviceLowBatState === 0)) {
-							lowBatIndicator = true;
-						} else if (deviceBatteryState && (deviceBatteryState < this.config.minWarnBatterie)) { // if the battery state is under the set limit
-							lowBatIndicator = true;
-						}
-				}
-				if (this.listOnlyBattery) {   // Add only devices with battery in the list
+				/* Add only devices with battery in the rawlist */
+				if (this.listOnlyBattery) {
 					if (deviceBatteryState || shortDeviceBatteryState) {
 						this.listAllDevicesRaw.push(
 							{
 								'Path': id,
 								'Device': deviceName,
-								'Adapter': deviceAdapterName,
+								'Adapter': await this.capitalize(adapterID),
 								'Battery': batteryHealth,
 								'LowBat': lowBatIndicator,
 								'Signal strength': linkQuality,
@@ -902,12 +944,13 @@ class DeviceWatcher extends utils.Adapter {
 							}
 						);
 					}
-				} else { // Add all devices
+				} else {
+					/* Add all devices */
 					this.listAllDevicesRaw.push(
 						{
 							'Path': id,
 							'Device': deviceName,
-							'Adapter': deviceAdapterName,
+							'Adapter': await this.capitalize(adapterID),
 							'Battery': batteryHealth,
 							'LowBat': lowBatIndicator,
 							'Signal strength': linkQuality,
@@ -917,7 +960,8 @@ class DeviceWatcher extends utils.Adapter {
 					);
 				}
 			} else {
-				return; // cancel run if unloaded was called.
+				/* cancel run if unloaded was called. */
+				return;
 			}
 		} // <-- end of loop
 		await this.createLists();
@@ -932,6 +976,8 @@ class DeviceWatcher extends utils.Adapter {
 		// create Data for each Adapter in own lists
 		this.log.debug(`Function started: ${this.createDataForEachAdapter.name}`);
 
+		await this.resetVars(); // reset the arrays and counts
+
 		try {
 			for (let i = 0; i < this.arrDev.length; i++) {
 
@@ -939,8 +985,8 @@ class DeviceWatcher extends utils.Adapter {
 					await this.createData(i);
 				}
 			}
+
 			await this.writeDatapoints(adptName); // fill the datapoints
-			await this.resetVars(); // reset the arrays and counts
 
 		} catch (error) {
 			this.errorReporting('[createDataForEachAdapter]', error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.device-watcher",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Watchdog for devices",
   "author": {
     "name": "Christian Behrends",