iobroker.heos 1.12.2 → 2.1.0

package/.github/dependabot.yml

@@ -10,9 +10,6 @@ updates:
   assignees:
   - withstu
   versioning-strategy: increase
-  ignore:
-    - dependency-name: "got"
-      update-types: ["version-update:semver-major"]
       
 - package-ecosystem: github-actions
   directory: "/"

package/.github/workflows/test-and-release.yml

@@ -38,7 +38,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node-version: ["14.x", "16.x", "18.x"]
+        node-version: ["16.x", "18.x", "20.x"]
         os: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:

package/README.md

@@ -144,6 +144,17 @@ Alternative you can use the script from Uhula: https://forum.iobroker.net/post/4
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 2.1.0 (2023-08-05)
+* (withstu) replace got with axios
+* (withstu) improve upnp handling
+* (withstu) prevent duplicate connect messages
+
+### 2.0.0 (2023-08-05)
+* (withstu) fix pipelines and remove node 14.x support
+
+### 1.12.3 (2023-08-05)
+* (withstu) update dependencies
+
 ### 1.12.2 (2023-05-13)
 * (withstu) optimize error handling
 

package/io-package.json

@@ -1,8 +1,47 @@
 {
   "common": {
     "name": "heos",
-    "version": "1.12.2",
+    "version": "2.1.0",
     "news": {
+      "2.1.0": {
+        "en": "replace got with axios\nimprove upnp handling\nprevent duplicate connect messages",
+        "de": "ersetzen mit axios\nverbesserte upnp-behandlung\ndoppelte verbindungsnachrichten verhindern",
+        "ru": "заменить получилось с axios\nулучшить работу upnp\nпредотвратить дублирование сообщений подключения",
+        "pt": "substituir adquirido com axios\nmelhorar o manuseio de upnp\nevitar mensagens de conexão duplicadas",
+        "nl": "vertaling:\nverbeter de bovenste hand\nverhinder dubbele berichten",
+        "fr": "remplacer obtenu par axios\naméliorer la manutention des ailes\nempêcher les messages de connexion",
+        "it": "sostituire ottenuto con assios\nmigliorare la gestione della upnp\nimpedire i messaggi di connessione duplicati",
+        "es": "reemplazado por axios\nmejorar el manejo de upnp\nevitar duplicados mensajes de conexión",
+        "pl": "zastępować\npoprawić\nlinkować",
+        "uk": "заміну отримав з аксіосом\nполіпшити процес обробки\nзапобігання дублікатів повідомлень з'єднання",
+        "zh-cn": "改为\n改进处理\n防止信息重复"
+      },
+      "2.0.0": {
+        "en": "fix pipelines and remove node 14.x support",
+        "de": "pipelines fixieren und knoten 14.x-unterstützung entfernen",
+        "ru": "исправить трубопроводы и удалить node 14.x поддержка",
+        "pt": "corrigir pipelines e remover o nó 14.x suporte",
+        "nl": "verwijder node 14.x ondersteuning",
+        "fr": "fixer les pipelines et retirer le support node 14.x",
+        "it": "fissare le tubazioni e rimuovere il supporto nodo 14.x",
+        "es": "arreglar los oleoductos y eliminar el nodo 14.x soporte",
+        "pl": "ustawienie rurociągów i usunięcie węzła 14x",
+        "uk": "кріплення трубопроводів і видалення вузла 14.x",
+        "zh-cn": "f 配件和取消14x的支助"
+      },
+      "1.12.3": {
+        "en": "update dependencies",
+        "de": "aktualisierung der abhängigkeiten",
+        "ru": "обновление зависимостей",
+        "pt": "dependências",
+        "nl": "vertaling:",
+        "fr": "mettre à jour les dépendances",
+        "it": "aggiornamento dipendenze",
+        "es": "dependencias de actualización",
+        "pl": "zależności",
+        "uk": "оновлення залежності",
+        "zh-cn": "a. 最新受扶养人"
+      },
       "1.12.2": {
         "en": "optimize error handling",
         "de": "optimierung der fehlerbehandlung",
@@ -54,45 +93,6 @@
         "pl": "ulepszenie przycisków w przeglądarce",
         "uk": "покращувати відтворення всіх кнопок у функції перегляду",
         "zh-cn": "b. 代管特区改善所有但顿作用"
-      },
-      "1.11.3": {
-        "en": "update some dependencies\nimprove failure handling\nimprove play all button in browse feature",
-        "de": "einige abhängigkeiten aktualisieren\nverbesserung der fehlerbehebung\nverbessern spielen alle taste in der browser-funktion",
-        "ru": "обновить некоторые зависимости\nулучшить обработку сбоев\nулучшить играть все кнопки в функции просмотра",
-        "pt": "atualizar algumas dependências\nmelhorar o manuseio de falhas\nmelhorar jogar todos os botões em procurar recurso",
-        "nl": "vertaling:\nverbeter falen\nverbeter alle knoppen in browse",
-        "fr": "mettre à jour certaines dépendances\naméliorer la manipulation des défaillances\naméliorer jouer tous les boutons dans la fonction de navigation",
-        "it": "aggiornare alcune dipendenze\nmigliorare la gestione dei guasti\nmigliorare giocare tutto il pulsante nella funzione di navigazione",
-        "es": "actualizar algunas dependencias\nmejorar el manejo de fallos\nmejorar el juego de todos los botones en la función de navegación",
-        "pl": "aktualizacja\npolepszenie\nulepszenie przycisków w przeglądarce",
-        "uk": "оновлення деяких залежностей\nполіпшення безпеки\nпокращувати відтворення всіх кнопок у функції перегляду",
-        "zh-cn": "二. 更新一些依赖性\n改进失败\nb. 代管特区改善所有但顿作用"
-      },
-      "1.11.2": {
-        "en": "adopt to new adapter structure",
-        "de": "neue adapterstruktur übernehmen",
-        "ru": "принять к новой структуре адаптера",
-        "pt": "adotar a nova estrutura do adaptador",
-        "nl": "adopteren",
-        "fr": "adopter à la nouvelle structure de l'adaptateur",
-        "it": "adottare per la nuova struttura adattatore",
-        "es": "adoptar a nueva estructura de adaptador",
-        "pl": "zaadoptowanie nowej struktury adapterowej",
-        "uk": "прийняти до нової структури адаптера",
-        "zh-cn": "通过新的适应结构"
-      },
-      "1.11.1": {
-        "en": "fix release",
-        "de": "zurück zur übersicht",
-        "ru": "исправить релиз",
-        "pt": "liberação de correção",
-        "nl": "loslaten",
-        "fr": "correction",
-        "it": "rilascio corretto",
-        "es": "corrección de liberación",
-        "pl": "naprawa",
-        "uk": "фіксувати реліз",
-        "zh-cn": "f 固定释放"
       }
     },
     "title": "HEOS",

package/lib/heos-player.js

@@ -86,7 +86,9 @@ class HeosPlayer {
 		this.heos.initPlayerStatistics(this.ip);
 
 		//Init Upnp
-		this.upnp = new HeosUPnP(this.heos, player.ip);
+		if(this.upnp === undefined) {
+			this.upnp = new HeosUPnP(this.heos, player.ip);
+		}
 
 		//Channel
 		await this.heos.setObjectAsync(this.base_state_path, {
@@ -1355,15 +1357,26 @@ class HeosPlayer {
 	}
 
 	async updateUpnp(){
-		if(this.upnp.getServiceList() && Object.keys(this.upnp.getServiceList()).length === 0){
-			await this.upnp.init();
+		if(this.connected){
+			if(this.upnp.getServiceList() && Object.keys(this.upnp.getServiceList()).length === 0){
+				try{
+					await this.upnp.init();
+				} catch(err){
+					if(err.code != 'ECONNABORTED') {
+						this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
+						this.logWarn('[upnp] failed to init upnp: ' + err, false);
+					} else {
+						this.logDebug('[upnp] failed to init upnp: ' + err, false);
+					}
+				}
+			}
+			this.logDebug('[upnp] Allowed Services: ' + JSON.stringify(this.upnp.getServiceList()));
+			await this.getUpnpRenderingControlState();
+			await this.getUpnpACTState();
+			await this.getUpnpGroupControlState();
+			await this.getUpnpZoneControlState();
+			await this.getUpnpAVTransportState();
 		}
-		this.logDebug('[upnp] Allowed Services: ' + JSON.stringify(this.upnp.getServiceList()));
-		await this.getUpnpRenderingControlState();
-		await this.getUpnpACTState();
-		await this.getUpnpGroupControlState();
-		await this.getUpnpZoneControlState();
-		await this.getUpnpAVTransportState();
 	}
 
 	async getUpnpRenderingControlState(){
@@ -1391,8 +1404,12 @@ class HeosPlayer {
 					}
 				}
 			} catch(err){
-				this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
-				this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				if(err.code != 'ECONNABORTED') {
+					this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
+					this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				} else {
+					this.logDebug('[upnp] get ' + service + ' state failed: ' + err, false);
+				}
 			}
 		} else {
 			this.logDebug('[upnp] get ' + service + ' state is not supported by player ' + this.name + ' (' + this.ip + ')', false);
@@ -1424,8 +1441,12 @@ class HeosPlayer {
 					}
 				}
 			} catch(err){
-				this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
-				this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				if(err.code != 'ECONNABORTED') {
+					this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
+					this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				} else {
+					this.logDebug('[upnp] get ' + service + ' state failed: ' + err, false);
+				}
 			}
 			if(state
 				&& state.DevicePower
@@ -1465,8 +1486,12 @@ class HeosPlayer {
 					}
 				}
 			} catch(err){
-				this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
-				this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				if(err.code != 'ECONNABORTED') {
+					this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
+					this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				} else {
+					this.logDebug('[upnp] get ' + service + ' state failed: ' + err, false);
+				}
 			}
 		} else {
 			this.logDebug('[upnp] get ' + service + ' state is not supported by player ' + this.name + ' (' + this.ip + ')', false);
@@ -1498,8 +1523,12 @@ class HeosPlayer {
 					}
 				}
 			} catch(err){
-				this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
-				this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				if(err.code != 'ECONNABORTED') {
+					this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
+					this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				} else {
+					this.logDebug('[upnp] get ' + service + ' state failed: ' + err, false);
+				}
 			}
 		} else {
 			this.logDebug('[upnp] get ' + service + ' state is not supported by player ' + this.name + ' (' + this.ip + ')', false);
@@ -1531,8 +1560,12 @@ class HeosPlayer {
 					}
 				}
 			} catch(err){
-				this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
-				this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				if(err.code != 'ECONNABORTED') {
+					this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
+					this.logWarn('[upnp] get ' + service + ' state failed: ' + err, false);
+				} else {
+					this.logDebug('[upnp] get ' + service + ' state failed: ' + err, false);
+				}
 			}
 
 			//Track Meta
@@ -1598,8 +1631,12 @@ class HeosPlayer {
 			try{
 				const result = await this.upnp.sendCommand(service, action, data);
 			} catch(err){
-				this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
-				this.logWarn('[upnp] set device power state failed: ' + err, false);
+				if(err.code != 'ECONNABORTED') {
+					this.heos.raiseFailures(this.ip, ERROR_CODES.Upnp);
+					this.logWarn('[upnp] set device power state failed: ' + err, false);
+				} else {
+					this.logDebug('[upnp] set device power state failed: ' + err, false);
+				}
 			}
 		} else {
 			this.logWarn('[upnp] set device power state is not supported by player ' + this.name + ' (' + this.ip + ')', false);

package/lib/heos-upnp.js

@@ -6,14 +6,12 @@
 'use strict';
 
 const { URL } = require('url');
-const got = require('got');
+const axios = require('axios');
 const {decode} = require('html-entities');
 const keyInObject = require('./tools').keyInObject;
 
 const {XMLParser, XMLBuilder} = require('fast-xml-parser');
 
-const USER_AGENT = 'LINUX UPnP/1.0 Denon-Heos/149200';
-
 class HeosUPnP {
 	/**
 	 * @param {string} ip IP address of player
@@ -24,23 +22,20 @@ class HeosUPnP {
 
 		this.ip = ip;
 		this.url = 'http://' + this.ip + ':60006/upnp/desc/aios_device/aios_device.xml';
-
-		this.client = got.extend({
-			headers: {
-			  'user-agent': USER_AGENT
-			}
-		});
 	}
 
 	async init() {
-		this.services = {};
-		const response = await this.client(this.url);
+		const response = await axios({
+			method: 'get',
+			url: this.url,
+			timeout: 30000
+		});
 		const options = {
 			parseTrueNumberOnly: true,
 			processEntities: false
 		};
 		const parser = new XMLParser(options);
-		const device = parser.parse(response.body).root.device;
+		const device = parser.parse(response.data).root.device;
 
 		this.deviceType = device.deviceType;
 		this.friendlyName = device.friendlyName;
@@ -80,17 +75,23 @@ class HeosUPnP {
 			}
 			const id = service.serviceType.split(':')[3];
 
-			const response = await this.client(service.SCPDURL);
-			const options = {
-				parseTrueNumberOnly: true,
-				processEntities: false
-			};
-			const parser = new XMLParser(options);
-			const serviceDefinition = await parser.parse(response.body).scpd;
-			service.actions = await this.parseActions(serviceDefinition);
-
-			services[id] = service;
-			this.services[id] = service;
+			if(!this.hasService(id)){
+				const response = await axios({
+					method: 'get',
+					url: service.SCPDURL,
+					timeout: 30000
+				});
+				const options = {
+					parseTrueNumberOnly: true,
+					processEntities: false
+				};
+				const parser = new XMLParser(options);
+				const serviceDefinition = await parser.parse(response.data).scpd;
+				service.actions = await this.parseActions(serviceDefinition);
+
+				this.services[id] = service;
+			}
+			services[id] = this.getService(id);
 		}
 		return services;
 	}
@@ -186,23 +187,19 @@ class HeosUPnP {
 		}
 		const soapBody = this.getSOAPBody(service, action, data);
 
-		const res = await this.client({
-			throwHttpErrors: false,
+		const response = await axios({
+			method: 'post',
 			url: service.controlURL,
-			method: 'POST',
-			body: soapBody,
 			headers: {
 				'Content-Type': 'text/xml; charset="utf-8"',
 				'Content-Length': soapBody.length,
 				'Connection': 'close',
 				'SOAPACTION': `"${service.serviceType}#${action.name}"`
-			}
+			},
+			data: soapBody,
+			timeout: 30000
 		});
-
-		if (res.statusCode !== 200) {
-			throw Error('soap command ' + action.name + ' failure: ' + res.statusCode);
-		}
-		const result = this.parseSOAPResponse(res.body, action.name, action.argOut);
+		const result = this.parseSOAPResponse(response.data, action.name, action.argOut);
 
 		const options = {
 			parseTrueNumberOnly: true,

package/main.js

@@ -46,7 +46,7 @@ class Heos extends utils.Adapter {
 
 		this.start_players_errors = 0;
 		this.ssdp_retry_counter = 0;
-		this.player_ips = [];
+		this.known_player_ips = [];
 
 		this.ssdp_player_ips = [];
 
@@ -2014,15 +2014,15 @@ class Heos extends utils.Adapter {
 					throw new Error('HEOS responded with invalid data.');
 				} else {
 					if (!(pid in this.players)) {
-						const heosPlayer = new HeosPlayer(this, player);
+						const heosPlayer = this.players[pid] = new HeosPlayer(this, player);
 						// wait until objects are created before connecting, because states shouldn't be set before objects exist
 						await heosPlayer.initMetaData(player);
-						this.players[pid] = heosPlayer;
 						try {
 							await heosPlayer.connect();
 						} catch (err) {
 							this.logDebug("can't connect error: " + err, false);
 							this.logWarn("can't connect player " + player.name + ' (' + player.ip + '). Skip.', false);
+							this.raiseFailures(player.ip, ERROR_CODES.General);
 							playerConnected = false;
 						}
 					} else {
@@ -2039,7 +2039,7 @@ class Heos extends utils.Adapter {
 				if (!connectedPlayers.includes(pid)) {
 					await this.stopPlayer(pid);
 				} else {
-					connectedPlayerIps.push(this.players[pid].ip)
+					connectedPlayerIps.push(this.players[pid].ip);
 				}
 			}
 			for(const ip in this.reboot_time){
@@ -2049,7 +2049,7 @@ class Heos extends utils.Adapter {
 			}
 
 			//Check for players in fail state
-			let playerInFailState = false
+			let playerInFailState = false;
 			for (const id in this.ssdp_player_ips) {
 				const ip = this.ssdp_player_ips[id];
 				if (this.getUptime(ip) >= 5 && !foundPlayerIps.includes(ip)) {
@@ -2071,7 +2071,7 @@ class Heos extends utils.Adapter {
 				}
 			} else {
 				this.getGroups();
-				await this.updatePlayerIPs();
+				await this.updateKnownPlayerIPs();
 			}
 		} catch (err) {
 			this.logError('[startPlayers] ' + err);
@@ -2080,15 +2080,15 @@ class Heos extends utils.Adapter {
 		}
 	}
 
-	async updatePlayerIPs() {
+	async updateKnownPlayerIPs() {
 		const states = await this.getStatesAsync('players.*');
-		this.player_ips = [];
+		this.known_player_ips = [];
 		for (const id in states) {
 			if (states[id] && states[id].val) {
 				const idSplit = id.split('.');
 				const state = idSplit[idSplit.length - 1];
 				if (state == 'ip') {
-					this.player_ips.push(states[id].val);
+					this.known_player_ips.push(states[id].val);
 				}
 			}
 		}
@@ -2256,8 +2256,8 @@ class Heos extends utils.Adapter {
 	rebootAll() {
 		this.logWarn('rebooting all players', false);
 		this.reboot_ips = [];
-		for (let i = 0; i < this.player_ips.length; i++) {
-			this.addRebootIp(this.player_ips[i]);
+		for (let i = 0; i < this.known_player_ips.length; i++) {
+			this.addRebootIp(this.known_player_ips[i]);
 		}
 		this.reboot();
 	}
@@ -2478,7 +2478,7 @@ class Heos extends utils.Adapter {
 			this.state = STATES.Searching;
 
 			//Update Player IPs
-			await this.updatePlayerIPs();
+			await this.updateKnownPlayerIPs();
 			this.updatePreferedPlayerIPs();
 			if (this.reboot_ips.length == 0) {
 				this.silent_log_mode = false;
@@ -2507,7 +2507,7 @@ class Heos extends utils.Adapter {
 						this.ssdp_retry_counter += 1;
 					}
 					this.ssdpLeaderElection();
-					if (this.ssdp_retry_initPlayerStatisticscounter > 10 && this.player_ips.length > 0) {
+					if (this.ssdp_retry_counter > 10 && this.known_player_ips.length > 0) {
 						this.manual_search_mode = true;
 						this.silent_log_mode = true;
 						this.logWarn("can't find any HEOS devices. Try to connect known device IPs and reboot them to exclude device failure...", false);
@@ -2516,6 +2516,7 @@ class Heos extends utils.Adapter {
 						this.logDebug('searching for HEOS devices ...', true);
 						this.ssdp_player_ips = [];
 						this.nodessdp_client.search(this.ssdp_search_target_name);
+						this.getPlayers();
 					}
 				}, this.config.searchInterval);
 			}
@@ -2551,14 +2552,14 @@ class Heos extends utils.Adapter {
 		let ips = [];
 		let minFailures = 999;
 
-		for (let i = 0; i < this.player_ips.length; i++) {
-			const failures = this.getOverallFailures(this.player_ips[i]);
+		for (let i = 0; i < this.known_player_ips.length; i++) {
+			const failures = this.getOverallFailures(this.known_player_ips[i]);
 			if (failures < minFailures) {
 				ips = [];
-				ips.push(this.player_ips[i]);
+				ips.push(this.known_player_ips[i]);
 				minFailures = failures;
 			} else if (failures == minFailures) {
-				ips.push(this.player_ips[i]);
+				ips.push(this.known_player_ips[i]);
 			}
 		}
 		return ips.filter(n => n);
@@ -2730,7 +2731,7 @@ class Heos extends utils.Adapter {
 	}
 
 	raiseFailures(ip, code) {
-		if (ip.length > 0 && this.getUptime(ip) >= 5) {
+		if (ip.length > 0 && (this.state != STATES.Connected || this.getUptime(ip) >= 5)) {
 			if (!(ip in this.failure_counter)) {
 				this.initFailures(ip);
 			}
@@ -2828,7 +2829,7 @@ class Heos extends utils.Adapter {
 	}
 
 	raiseLeaderFailures(ip) {
-		if (ip.length > 0 && this.getUptime(ip) >= 5) {
+		if (ip.length > 0 && (this.state != STATES.Connected || this.getUptime(ip) >= 5)) {
 			if (ip in this.leader_failure_counter) {
 				this.leader_failure_counter[ip] += 1;
 			} else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.heos",
-  "version": "1.12.2",
+  "version": "2.1.0",
   "description": "The adapter lets control HEOS from ioBroker",
   "author": {
     "name": "withstu",
@@ -23,12 +23,12 @@
     "url": "https://github.com/withstu/ioBroker.heos"
   },
   "engines": {
-    "node": ">= 14"
+    "node": ">= 16"
   },
   "dependencies": {
     "@iobroker/adapter-core": "^2.6.8",
-    "fast-xml-parser": "^4.0.15",
-    "got": "^11.8.6",
+    "fast-xml-parser": "^4.2.7",
+    "axios": "^1.4.0",
     "html-entities": "^2.3.3",
     "node-ssdp": "^4.0.1",
     "node-vibrant": "^3.1.6"
@@ -41,20 +41,20 @@
     "@iobroker/adapter-dev": "^1.2.0",
     "@iobroker/testing": "^4.1.0",
     "@tsconfig/node14": "^1.0.3",
-    "@types/chai": "^4.3.4",
+    "@types/chai": "^4.3.5",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.16.3",
+    "@types/node": "^20.4.8",
     "@types/proxyquire": "^1.3.28",
     "@types/sinon": "^10.0.8",
     "@types/sinon-chai": "^3.2.9",
-    "axios": "^1.3.4",
+    "axios": "^1.4.0",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.39.0",
     "mocha": "^10.2.0",
     "proxyquire": "^2.1.3",
-    "sinon": "^15.0.4",
+    "sinon": "^15.2.0",
     "sinon-chai": "^3.7.0",
     "typescript": "~5.0.4"
   },