Merge pull request #642 from pdbjjens/master

Move to JSONconfig UI
iobroker-community-adapters · Jan 24, 2024 · f689e81 · f689e81
2 parents 8396254 + afcd749
commit f689e81
Show file tree

Hide file tree

Showing 23 changed files with 1,054 additions and 1,012 deletions.
diff --git a/.npmignore b/.npmignore
@@ -27,7 +27,7 @@ iobroker.*.tgz
 package-lock.json
 
 # i18n intermediate files
-admin/i18n
+# admin/i18n
 
 # maintenance scripts
 maintenance/**
diff --git a/.releaseconfig.json b/.releaseconfig.json
@@ -1,3 +1,3 @@
 {
-	"plugins": ["iobroker", "license"]
+	"plugins": ["iobroker", "license", "manual-review"]
 }
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Jens-Peter Jensen jjensen@t-online.de
+Copyright (c) 2024 Jens-Peter Jensen jjensen@t-online.de
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -29,28 +29,34 @@ This adapter connects ioBroker to various VBus-based devices using resol-vbus, a
 
 ## Configuration hints
 
-* The default setting for the connection type is VBus/LAN, but it must be explicitly selected even for VBus/LAN, otherwise no connection will be established.
+* The connection device type must be explicitly selected, otherwise no connection will be established.
+* TCP connection port: The default setting 7053 should not be changed
+* Device password: The password which you have set in your connection device (default: vbus)
+* DL3 channel: Only relevant for DL3/DL2Plus - leave at "None" for all other connection devices.  
+(allowed values: 1-6, channel 0 cannot be read out)
+* Update interval: The time between updates of the measured values (default 30s)
 * The correct settings for direct LAN access for VBus/LAN, DL3, DL2, KM2 are:
-  * Connection type: VBus/LAN or KM2 or DL2 or DL3
-  * Connection identifier: IP address (e.g. 192.168.178.188) or FullyQualifiedHostName (e.g. host1.example.com)
-  * VBus password: YourVBusPassword (default: vbus)
-  * Connection port: Default setting 7053 should not be changed
-  * DL3 channel: Only relevant for DL3 (values 1-6, channel 0 can not be read out)
-  * Update interval: Time between updates of the measured values (default 30s)
+  * Connection Device: VBus/LAN or KM2/DL2 or DL3/DL2Plus
+  * Device Address: IP address (e.g. 192.168.178.188) or FullyQualifiedHostName (e.g. myDL2.fritz.box)
 * The correct settings for the DL3, DL2, KM2 access via VBus.net are:
-  * Connection type: DL3 or DL2 or KM2
-  * Connection identifier: vbus.net (or vbus.io) - both without http:// and Via identifier!
-  * Connection port: Default setting 7053 should not be changed
-  * VBus password: YourVBusPassword (default: vbus)
-  * DL3 channel: Only relevant for DL3 (values: 1-6, channel 0 cannot be read out)
-  * Via identifier: YourViaIdentifier (e.g. d1234567890) - without http:// before or .vbus.io behind
-  * Update interval: Time between the update of the measured values (default 30s)
+  * Connection Device: DL3/DL2Plus or DL2/KM2
+  * Device Address: vbus.net (or vbus.io) - both without http:// and Via identifier!  
+  * Via Tag: YourViaIdentifier (e.g. d1234567890) - without http:// before or .vbus.io behind
 
 ## Changelog
 <!--
   Placeholder for the next version (at the beginning of the line):
   ### **WORK IN PROGRESS**
 -->
+
+### **WORK IN PROGRESS**
+
+* (pdbjjens) New: Support ioBroker discovery
+* (pdbjjens) Change: node>=16, js-contoller>=4 and admin>=6 required
+* (pdbjjens) New: Use JSON config UI
+* (pdbjjens) Updated dependencies
+* (pdbjjens) Fix: Set info.connection false when reconnecting
+
 ### 0.2.5 (2023-03-14)
 
 * (pdbjjens) Updated dependencies
@@ -89,7 +95,7 @@ The authors are in no way endorsed by or affiliated with RESOL GmbH, or any asso
 
 MIT License
 
-Copyright (c) 2023 Jens-Peter Jensen <jjensen@t-online.de>
+Copyright (c) 2024 Jens-Peter Jensen <jjensen@t-online.de>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/admin/i18n/de/translations.json b/admin/i18n/de/translations.json
@@ -1,29 +1,37 @@
 {
-    "Connection Device": "Verbindungsgerät",
-    "Connection Identifier": "Verbindungskennung",
-    "Connection Port": "Verbindungs-Port",
-    "DL2/KM2": "DL2 / KM2",
-    "DL3": "DL3",
-    "DL3 Channel": "DL3-Kanal",
-    "DL3 Channel 0": "DL3-Kanal 0",
-    "DL3 Channel 1": "DL3-Kanal 1",
-    "DL3 Channel 2": "DL3-Kanal 2",
-    "DL3 Channel 3": "DL3-Kanal 3",
-    "DL3 Channel 4": "DL3-Kanal 4",
-    "DL3 Channel 5": "DL3-Kanal 5",
-    "DL3 Channel 6": "DL3-Kanal 6",
-    "Default: 7053": "Standard: 7053",
-    "Default: vbus": "Standard: vbus",
-    "Force Adapter Reinitialization": "Reinitialisierung des Adapters erzwingen",
-    "Host address (IP or FQDN) for local LAN and for VBus.net or Serial Port Id for VBus/USB access": "Hostadresse (IP oder FQDN) für lokales LAN und für VBus.net oder serielle Port-ID für VBus/USB-Zugriff",
-    "If Force Adapter Reinitialization is set, the adapter restarts with new configuration immediately on save": "Wenn Adapter Reinitialization gesetzt ist, wird der Adapter sofort nach dem Speichern mit einer neuen Konfiguration neu gestartet",
-    "Required for DL3 only": "Nur für DL3 erforderlich",
-    "Required only for VBus.net access via DLx/KMx": "Nur für den VBus.net-Zugriff über DLx / KMx erforderlich",
-    "Select VBus Connection Device Type": "Wählen Sie den VBus-Verbindungsgerätetyp (VBus/LAN, DL3 usw.).",
-    "Serial/LANGW": "Seriell/LANGW",
-    "VBus Interval": "VBus-Aktualisierungsintervall (in Sekunden)",
-    "VBus Password": "VBus Passwort",
+    "DL3 Channel 0": "DL3 Kanal 0",
+    "DL3 Channel 1": "DL3 Kanal 1",
+    "DL3 Channel 2": "DL3 Kanal 2",
+    "DL3 Channel 3": "DL3 Kanal 3",
+    "DL3 Channel 4": "DL3 Kanal 4",
+    "DL3 Channel 5": "DL3 Kanal 5",
+    "DL3 Channel 6": "DL3 Kanal 6",
+    "Lbl_ConnectionDevice": "Verbindungsgerät",
+    "Desc_ConnectionDevice": "Wählen Sie den Verbindungsgerätetyp für die Verbindung mit Ihrem Resol-Controller aus.",
+    "Ttip_ConnectionDevice": "Beispiele: VBus/USB, VBus/LAN, KM2, DL2, DL3",
+    "Lbl_ConnectionPort": "TCP-Verbindungsport",
+    "Desc_ConnectionPort": "TCP-Port Ihres Verbindungsgeräts",
+    "Ttip_ConnectionPort": "Standard: 7053",
+    "Lbl_DL3Channel": "DL3-Kanal",
+    "Desc_DL3Channel": "Wählen Sie den DL3/DL2Plus-Kanal – belassen Sie ihn bei „Keiner“, wenn Sie keinen DL3 oder DL2Plus verwenden.",
+    "Ttip_DL3Channel": "DL3/DL2Plus-Kanal 0 wird nicht unterstützt",
+    "Lbl_DeviceAddress": "Geräteadresse",
+    "Desc_DeviceAddress": "Hostadresse (IP oder FQDN) für LAN und VBus.net oder Port-ID für Seriell/USB-Port.",
+    "Ttip_DeviceAddress": "Beispiele: IP: 192.168.178.188 FQDN: myDL2.fritz.box VBus.net: d0123456789.vbus.net oder myDL2.vbus.io SerialPort-ID: /dev/ttyUSB0 oder COM5",
+    "Lbl_DevicePassword": "Gerätepasswort",
+    "Desc_DevicePassword": "Passwort Ihres Verbindungsgeräts.",
+    "Ttip_DevicePassword": "Standard: vbus",
+    "Lbl_Pollintervall": "Updateintervall",
+    "Desc_Pollintervall": "Aktualisierungsintervall in Sekunden.",
+    "Ttip_Pollintervall": "30-Sekunden-Schritte, mindestens 30 Sekunden, höchstens 300 Sekunden",
+    "Lbl_Via-tag": "Via-Tag",
+    "Desc_Via-tag": "Nur für VBus.net-Zugriff über KM2/DLx erforderlich.",
+    "Ttip_Via-tag": "Beispiel: d0123456789",
+    "none": "Keiner",
     "VBus/LAN": "VBus/LAN",
+    "KM2/DL2": "KM2/DL2",
+    "DL3/DL2Plus": "DL3/DL2Plus",
     "VBus/USB": "VBus/USB",
-    "Via tag": "Via-Kennung"
+    "Serial-to-LAN Gateway": "Seriell-zu-LAN-Gateway",
+    "Basic settings": "Grundeinstellungen"
 }
diff --git a/admin/i18n/en/translations.json b/admin/i18n/en/translations.json
@@ -1,29 +1,37 @@
 {
-    "Connection Device": "Connection Device",
-    "Connection Identifier": "Connection Identifier",
-    "Connection Port": "Connection Port",
-    "DL2/KM2": "DL2 / KM2",
-    "DL3": "DL3",
-    "DL3 Channel": "DL3 Channel",
     "DL3 Channel 0": "DL3 Channel 0",
     "DL3 Channel 1": "DL3 Channel 1",
     "DL3 Channel 2": "DL3 Channel 2",
     "DL3 Channel 3": "DL3 Channel 3",
     "DL3 Channel 4": "DL3 Channel 4",
     "DL3 Channel 5": "DL3 Channel 5",
     "DL3 Channel 6": "DL3 Channel 6",
-    "Default: 7053": "Default: 7053",
-    "Default: vbus": "Default: vbus",
-    "Force Adapter Reinitialization": "Force Adapter Reinitialization",
-    "Host address (IP or FQDN) for local LAN and for VBus.net or Serial Port Id for VBus/USB access": "Host address (IP or FQDN) for local LAN and for VBus.net or Serial Port Id for VBus/USB access",
-    "If Force Adapter Reinitialization is set, the adapter restarts with new configuration immediately on save": "If Force Adapter Reinitialization is set, the adapter restarts with new configuration immediately on save",
-    "Required for DL3 only": "Required for DL3 only",
-    "Required only for VBus.net access via DLx/KMx": "Required only for VBus.net access via DLx / KMx",
-    "Select VBus Connection Device Type": "Select VBus Connection Device Type (VBus/LAN, DL3 etc.)",
-    "Serial/LANGW": "Serial/LANGW",
-    "VBus Interval": "VBus Update Interval (in seconds)",
-    "VBus Password": "VBus Password",
+    "Lbl_ConnectionDevice": "Connection Device",
+    "Desc_ConnectionDevice": "Select the connection device type to connect to your Resol controller.",
+    "Ttip_ConnectionDevice": "Examples: VBus/USB, VBus/LAN, KM2, DL2, DL3",
+    "Lbl_ConnectionPort": "TCP Connection Port",
+    "Desc_ConnectionPort": "TCP port of your connection device",
+    "Ttip_ConnectionPort": "Default: 7053",
+    "Lbl_DL3Channel": "DL3 Channel",
+    "Desc_DL3Channel": "Select DL3/DL2Plus channel - Leave at \"None\" if you do not use a DL3 or DL2Plus.",
+    "Ttip_DL3Channel": "DL3/DL2Plus channel 0 is not supported",
+    "Lbl_DeviceAddress": "Device Address",
+    "Desc_DeviceAddress": "Host address (IP or FQDN) for LAN and VBus.net or Port-ID for Serial/USB-Port.",
+    "Ttip_DeviceAddress": "Examples: IP: 192.168.178.188 FQDN: myDL2.fritz.box VBus.net: d0123456789.vbus.net or myDL2.vbus.io SerialPort-ID: /dev/ttyUSB0 or COM5",
+    "Lbl_DevicePassword": "Device Password",
+    "Desc_DevicePassword": "Password of your connection device.",
+    "Ttip_DevicePassword": "Default: vbus",
+    "Lbl_Pollintervall": "Update Interval",
+    "Desc_Pollintervall": "Update interval in seconds.",
+    "Ttip_Pollintervall": "30 second steps, minimum 30s, maximum 300s",
+    "Lbl_Via-tag": "Via-Tag",
+    "Desc_Via-tag": "Required only for VBus.net access via KM2/DLx.",
+    "Ttip_Via-tag": "Example: d0123456789",
+    "none": "None",
     "VBus/LAN": "VBus/LAN",
+    "KM2/DL2": "KM2/DL2",
+    "DL3/DL2Plus": "DL3/DL2Plus",
     "VBus/USB": "VBus/USB",
-    "Via tag": "Via tag"
-}
+    "Serial-to-LAN Gateway": "Serial-to-LAN Gateway",
+    "Basic settings": "Basic settings"
+}
diff --git a/admin/i18n/es/translations.json b/admin/i18n/es/translations.json
@@ -1,29 +1,37 @@
 {
-    "Connection Device": "Dispositivo de conexión",
-    "Connection Identifier": "Identificador de conexión",
-    "Connection Port": "Puerto de conexión",
-    "DL2/KM2": "DL2 / KM2",
-    "DL3": "DL3",
-    "DL3 Channel": "Canal DL3",
     "DL3 Channel 0": "DL3 Canal 0",
     "DL3 Channel 1": "DL3 Canal 1",
     "DL3 Channel 2": "DL3 Canal 2",
     "DL3 Channel 3": "DL3 Canal 3",
     "DL3 Channel 4": "DL3 Canal 4",
     "DL3 Channel 5": "DL3 Canal 5",
     "DL3 Channel 6": "DL3 Canal 6",
-    "Default: 7053": "Predeterminado: 7053",
-    "Default: vbus": "Predeterminado: vbus",
-    "Force Adapter Reinitialization": "Reinicialización del adaptador de fuerza",
-    "Host address (IP or FQDN) for local LAN and for VBus.net or Serial Port Id for VBus/USB access": "Dirección de host (IP o FQDN) para LAN local y para VBus.net o Id. De puerto serie para acceso VBus/USB",
-    "If Force Adapter Reinitialization is set, the adapter restarts with new configuration immediately on save": "Si se establece Forzar reinicialización del adaptador, el adaptador se reinicia con una nueva configuración inmediatamente al guardar",
-    "Required for DL3 only": "Requerido solo para DL3",
-    "Required only for VBus.net access via DLx/KMx": "Se requiere solo para el acceso a VBus.net a través de DLx / KMx",
-    "Select VBus Connection Device Type": "Seleccione el tipo de dispositivo de conexión VBus (VBus/LAN, DL3, etc.)",
-    "Serial/LANGW": "Serie/LANGW",
-    "VBus Interval": "Intervalo de actualización de VBus (en segundos)",
-    "VBus Password": "Contraseña de VBus",
+    "Lbl_ConnectionDevice": "Dispositivo de conexión",
+    "Desc_ConnectionDevice": "Seleccione el tipo de dispositivo de conexión para conectarse a su controlador Resol.",
+    "Ttip_ConnectionDevice": "Ejemplos: VBus/USB, VBus/LAN, KM2, DL2, DL3",
+    "Lbl_ConnectionPort": "Puerto de conexión TCP",
+    "Desc_ConnectionPort": "Puerto TCP de su dispositivo de conexión",
+    "Ttip_ConnectionPort": "Predeterminado: 7053",
+    "Lbl_DL3Channel": "Canal DL3",
+    "Desc_DL3Channel": "Seleccione el canal DL3/DL2Plus. Déjelo en \"Ninguno\" si no utiliza un DL3 o DL2Plus.",
+    "Ttip_DL3Channel": "El canal 0 DL3/DL2Plus no es compatible",
+    "Lbl_DeviceAddress": "Dirección del dispositivo",
+    "Desc_DeviceAddress": "Dirección de host (IP o FQDN) para LAN y VBus.net o ID de puerto para puerto serie/USB.",
+    "Ttip_DeviceAddress": "Ejemplos: IP: 192.168.178.188 FQDN: myDL2.fritz.box VBus.net: d0123456789.vbus.net o myDL2.vbus.io SerialPort-ID: /dev/ttyUSB0 o COM5",
+    "Lbl_DevicePassword": "Contraseña del dispositivo",
+    "Desc_DevicePassword": "Contraseña de su dispositivo de conexión.",
+    "Ttip_DevicePassword": "Predeterminado: vbus",
+    "Lbl_Pollintervall": "Intervalo de actualización",
+    "Desc_Pollintervall": "Intervalo de actualización en segundos.",
+    "Ttip_Pollintervall": "Pasos de 30 segundos, mínimo 30 segundos, máximo 300 segundos",
+    "Lbl_Via-tag": "Etiqueta vía",
+    "Desc_Via-tag": "Requerido sólo para acceso a VBus.net a través de KM2/DLx.",
+    "Ttip_Via-tag": "Ejemplo: d0123456789",
+    "none": "Ninguno",
     "VBus/LAN": "VBus/LAN",
+    "KM2/DL2": "KM2/DL2",
+    "DL3/DL2Plus": "DL3/DL2Plus",
     "VBus/USB": "VBus/USB",
-    "Via tag": "Vía etiqueta"
+    "Serial-to-LAN Gateway": "Puerta de enlace serie a LAN",
+    "Basic settings": "Ajustes básicos"
 }
diff --git a/admin/i18n/fr/translations.json b/admin/i18n/fr/translations.json
@@ -1,29 +1,37 @@
 {
-    "Connection Device": "Dispositif de connexion",
-    "Connection Identifier": "Identifiant de connexion",
-    "Connection Port": "Port de connexion",
-    "DL2/KM2": "DL2 / KM2",
-    "DL3": "DL3",
-    "DL3 Channel": "Canal DL3",
-    "DL3 Channel 0": "DL3 Channel 0",
-    "DL3 Channel 1": "DL3 Channel 1",
-    "DL3 Channel 2": "DL3 Channel 2",
-    "DL3 Channel 3": "DL3 Channel 3",
-    "DL3 Channel 4": "DL3 Channel 4",
-    "DL3 Channel 5": "DL3 Channel 5",
-    "DL3 Channel 6": "DL3 Channel 6",
-    "Default: 7053": "Par défaut: 7053",
-    "Default: vbus": "Par défaut: vbus",
-    "Force Adapter Reinitialization": "Forcer la réinitialisation de l'adaptateur",
-    "Host address (IP or FQDN) for local LAN and for VBus.net or Serial Port Id for VBus/USB access": "Adresse d'hôte (IP ou FQDN) pour le LAN local et pour VBus.net ou ID de port série pour l'accès VBus/USB",
-    "If Force Adapter Reinitialization is set, the adapter restarts with new configuration immediately on save": "Si Forcer la réinitialisation de l'adaptateur est défini, l'adaptateur redémarre avec la nouvelle configuration immédiatement lors de l'enregistrement",
-    "Required for DL3 only": "Requis pour DL3 uniquement",
-    "Required only for VBus.net access via DLx/KMx": "Requis uniquement pour l'accès à VBus.net via DLx / KMx",
-    "Select VBus Connection Device Type": "Sélectionnez le type de périphérique de connexion VBus (VBus/LAN, DL3, etc.)",
-    "Serial/LANGW": "Série/LANGW",
-    "VBus Interval": "Intervalle de mise à jour VBus (en secondes)",
-    "VBus Password": "Mot de passe VBus",
+    "DL3 Channel 0": "DL3 Canal 0",
+    "DL3 Channel 1": "DL3 Canal 1",
+    "DL3 Channel 2": "DL3 Canal 2",
+    "DL3 Channel 3": "DL3 Canal 3",
+    "DL3 Channel 4": "DL3 Canal 4",
+    "DL3 Channel 5": "DL3 Canal 5",
+    "DL3 Channel 6": "DL3 Canal 6",
+    "Lbl_ConnectionDevice": "Dispositif de connexion",
+    "Desc_ConnectionDevice": "Sélectionnez le type de périphérique de connexion à connecter à votre contrôleur Resol.",
+    "Ttip_ConnectionDevice": "Exemples : VBus/USB, VBus/LAN, KM2, DL2, DL3",
+    "Lbl_ConnectionPort": "Port de connexion TCP",
+    "Desc_ConnectionPort": "Port TCP de votre périphérique de connexion",
+    "Ttip_ConnectionPort": "Par défaut : 7053",
+    "Lbl_DL3Channel": "Canal DL3",
+    "Desc_DL3Channel": "Sélectionnez le canal DL3/DL2Plus - Laissez sur « Aucun » si vous n'utilisez pas de canal DL3 ou DL2Plus.",
+    "Ttip_DL3Channel": "Le canal 0 du DL3/DL2Plus n'est pas pris en charge",
+    "Lbl_DeviceAddress": "Adresse de l'appareil",
+    "Desc_DeviceAddress": "Adresse hôte (IP ou FQDN) pour LAN et VBus.net ou ID de port pour port série/USB.",
+    "Ttip_DeviceAddress": "Exemples : IP : 192.168.178.188 FQDN : myDL2.fritz.box VBus.net : d0123456789.vbus.net ou myDL2.vbus.io SerialPort-ID : /dev/ttyUSB0 ou COM5",
+    "Lbl_DevicePassword": "Mot de passe de l'appareil",
+    "Desc_DevicePassword": "Mot de passe de votre appareil de connexion.",
+    "Ttip_DevicePassword": "Par défaut : vbus",
+    "Lbl_Pollintervall": "Intervalle de mise à jour",
+    "Desc_Pollintervall": "Intervalle de mise à jour en secondes.",
+    "Ttip_Pollintervall": "Pas de 30 secondes, minimum 30 s, maximum 300 s",
+    "Lbl_Via-tag": "Via-Tag",
+    "Desc_Via-tag": "Requis uniquement pour l'accès à VBus.net via KM2/DLx.",
+    "Ttip_Via-tag": "Exemple : d0123456789",
+    "none": "Aucun",
     "VBus/LAN": "VBus/LAN",
+    "KM2/DL2": "KM2/DL2",
+    "DL3/DL2Plus": "DL3/DL2Plus",
     "VBus/USB": "VBus/USB",
-    "Via tag": "Via tag"
+    "Serial-to-LAN Gateway": "Passerelle série vers LAN",
+    "Basic settings": "Paramètres de base"
 }