Merge pull request #114 from pdbjjens/master

Migrate to jsonConfig

Author: pdbjjens

.gitignore

@@ -15,3 +15,7 @@ admin/i18n/*/flat.txt
 
 #ignore .commitinfo created by ioBroker release script
 .commitinfo
+
+
+# ioBroker dev-server
+.dev-server/

.npmignore

@@ -1,45 +1,67 @@
-![Logo](admin/stiebel-isg.png)
 # ioBroker.stiebel-isg
 
+![Logo](admin/stiebel-isg.png)
+
+## ioBroker adapter for STIEBEL ELTRON/Tecalor Internet Service Gateways (ISG)
+
 [![NPM version](https://img.shields.io/npm/v/iobroker.stiebel-isg.svg)](https://www.npmjs.com/package/iobroker.stiebel-isg)
+![Version (stable)](https://iobroker.live/badges/stiebel-isg-stable.svg)
 [![Downloads](https://img.shields.io/npm/dm/iobroker.stiebel-isg.svg)](https://www.npmjs.com/package/iobroker.stiebel-isg)
 ![Number of Installations (latest)](https://iobroker.live/badges/stiebel-isg-installed.svg)
-![Number of Installations (stable)](https://iobroker.live/badges/stiebel-isg-stable.svg)
-[![Dependency Status](https://img.shields.io/david/unltdnetworx/iobroker.stiebel-isg.svg)](https://david-dm.org/unltdnetworx/iobroker.stiebel-isg)
 
-[![NPM](https://nodei.co/npm/iobroker.stiebel-isg.png?downloads=true)](https://nodei.co/npm/iobroker.stiebel-isg/)
+**Tests:** ![Test and Release](https://github.com/iobroker-community-adapters/ioBroker.stiebel-isg/workflows/Test%20and%20Release/badge.svg)
+
+[![NPM](https://nodei.co/npm/iobroker.stiebel-isg.svg?data=d,s)](https://www.npmjs.com/package/iobroker.stiebel-isg)
+
+## Info
+
+This adapter reads values from STIEBEL ELTRON/Tecalor Internet Service Gateways (ISG) web pages and can send commands to control the device.
 
-**Tests:** ![Test and Release](https://github.com/unltdnetworx/ioBroker.stiebel-isg/workflows/Test%20and%20Release/badge.svg)
+**NOTE:** This adapter has been tested with legacy ISG devices only. (ISG Plus and ISG Web). Whether it works with the current ISG Connect device is to be determined yet.
 
-## stiebel-isg adapter for ioBroker
+**NOTE:** This adapter has been transferred to iobroker-community-adapters for maintenance. Only important bug fixes and dependency updates will be released in the future. However PRs with bug fixes or feature enhancements are always welcome.
 
-This adapter is a ment to read values from stiebel-eltron/tecalor internet service gateways (ISG) and control the device.
+**Credits:** This adapter would not have been possible without the great work of Michael Schuster (unltdnetworx) <https://github.com/unltdnetworx>, who created previous releases of this adapter.
 
+## Release Notes
 
-## Steps
+**Caution:** Version 2.0.x includes some Breaking Changes:
 
-1. Install the adpater
-2. Grab the values out of the your stiebel-isg.[x]-object.
+* node.js >= 20, js-controller >= 6.0.11 and admin >= 7.6.17 is required  
+Upgrade your ioBroker to at least this software level, if you want to use this adapter
 
-## Requirements
+* Password encryption in config UI
+If you update this adapter from a previous version instead of a new installation, the adapter may not start, even if your password in your config is correct and has not been changed. To fix this, simply enter the same previous password once more in the config UI and store and close the config UI to restart the adapter. This of course is only neccessary once after the first start after the update.
 
-* stiebel-eltron/tecalor internet service gateway (ISG)
+* The type and/or name of some objects in the object tab has changed
+If you update this adapter from a previous version instead of a new installation, you may possibly find warnings in the ioBroker log or objects and/or names are not updated correctly. To prevent this from happening, the most simple solution is to stop the adapter in the instances tab of ioBroker, completely delete the object tree in the objects tab and then restart the adapter. This of course is only neccessary once after the update and is not required if you do a clean new installation.
 
-## Credits
+## Installation
 
-This adapter would not have been possible without the great work of Michael Schuster (unltdnetworx) <https://github.com/unltdnetworx>, who created previous releases of this adapter.
+1. You need a fully configured and running STIEBEL ELTRON or Tecalor Internet Service Gateway (ISG Web or ISG Plus) in the same network as your ioBroker server.
+2. Install the adapter on your ioBroker server and create an instance
+3. Configure the instance by entering the IP-address or domain name of the ISG and if configured in the ISG, the user name and password.  
+The other settings should be left at their default values unless you know what you are doing.
 
 ## Changelog
 
 <!--
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### **WORK IN PROGRESS**
+
+* (mcm1957) Change: Adapter has been migrated to iobroker-community-adapters organisation
+* (mcm1957) Change: Adapter requires node.js >= 20, js-controller >= 6.0.11 and admin >= 7.6.17 now
+* (mcm1957) Fix: Dependencies have been updated
+* (pdbjjens) Change: remove .npmignore
+* (pdbjjens) Change: migrate adapter configuration to jsonConfig
+
 ### 2.0.0-alpha.1 (2025-10-21)
 
-- (mcm1957) Adapter has been migrated to iobroker-communita-adapters organisation
-- (mcm1957) Adapter requires node.js >= 20, js-controller >= 6.0.11 and admin >= 7.6.17 now
-- (mcm1957) Dependencies have been updated
+* (mcm1957) Adapter has been migrated to iobroker-communita-adapters organisation
+* (mcm1957) Adapter requires node.js >= 20, js-controller >= 6.0.11 and admin >= 7.6.17 now
+* (mcm1957) Dependencies have been updated
 
 ### 1.7.7
 
@@ -57,7 +79,16 @@ This adapter would not have been possible without the great work of Michael Schu
 
 * security enhancements
 
+## Legal Notices
+
+STIEBEL ELTRON, TECALOR, ISG and associated logos are trademarks or registered trademarks of STIEBEL ELTRON GmbH & Co KG  [https://www.stiebel-eltron.com](https://www.stiebel-eltron.com)
+
+All other trademarks are the property of their respective owners.
+
+The authors are in no way endorsed by or affiliated with STIEBEL ELTRON GmbH & Co KG, or any associated subsidiaries, logos or trademarks.
+
 ## License
+
 MIT License
 
 Copyright (c) 2025 iobroker-community-adapters <iobroker-community-adapters@gmx.de>  

README.md

@@ -0,0 +1,43 @@
+{
+    "AUSSENTEMPERATUR": "Außenlufttemperatur",
+    "IP address or domain": "IP-Adresse oder Domäne",
+    "IP address or domain_help": "IP-Adresse oder Domänenname des ISG",
+    "IP address or domain_tips": "Beispiele - IP: 192.168.178.188 oder FQDN: servicewelt.fritz.box",
+    "ISGReboot": "Starten Sie ISG neu",
+    "Main settings": "Haupteinstellungen",
+    "STUFE-TAG": "Lüftungsstufe tagsüber",
+    "URLs": "URLs",
+    "command paths": "Befehlspfade",
+    "command paths_help": "Definieren Sie die Befehlspfade für Einstellungen auf den ISG-Seiten.",
+    "command paths_tips": "Ende der URLs hinter „/?s=\" von ISG-Seiten für Einstellungen, getrennt durch „;“",
+    "enable expert values": "Expertenwerte aktivieren",
+    "enable expert values_help": "Zusätzliche Expertenwerte anzeigen, wenn aktiviert",
+    "enable expert values_tips": "Aktivieren Sie das Lesen/Schreiben von Expertenwerten.",
+    "expert paths": "Expertenpfade",
+    "expert paths_help": "Definieren Sie die Expertenpfade für Expertenwerte auf den ISG-Seiten.",
+    "expert paths_tips": "Ende der URLs hinter „/?s=\" von ISG-Seiten für Expertenwerte, getrennt durch „;“",
+    "info": "Info",
+    "intervall (commands) (s)": "Intervall (Befehle) (s)",
+    "intervall (commands) (s)_help": "Intervall zum Abrufen für Befehle (in Sekunden)",
+    "intervall (s)": "Intervall (s)",
+    "intervall (s)_help": "Intervall für abzurufende Werte (in Sekunden)",
+    "isg password": "Passwort",
+    "isg password_help": "Passwort für das ISG",
+    "isg password_tips": "Beim Passwort muss die Groß-/Kleinschreibung beachtet werden. Lassen Sie es leer, wenn es nicht in ISG festgelegt ist",
+    "no": "NEIN",
+    "settings": "Einstellungen",
+    "start": "Start",
+    "status paths": "Statuspfade",
+    "status paths_help": "Definieren Sie die Statuspfade für den Status auf den ISG-Seiten.",
+    "status paths_tips": "Ende der URLs hinter „/?s=\" von ISG-Seiten für den Status, getrennt durch „;“",
+    "umlauts active": "Umlaute aktiv",
+    "umlauts active_help": "Behandlung von Umlauten aktivieren",
+    "umlauts active_tips": "Umlaute in Objekten aktivieren. Warnung: könnte Probleme im History-Adapter verursachen.",
+    "username": "Benutzername",
+    "username_help": "Benutzername für das ISG",
+    "username_tips": "Beim Benutzernamen muss die Groß-/Kleinschreibung beachtet werden. Lassen Sie das Feld leer, wenn es nicht in ISG festgelegt ist",
+    "value paths": "Wertpfade",
+    "value paths_help": "Definieren Sie die Wertepfade für Werte auf den ISG-Seiten.",
+    "value paths_tips": "Ende der URLs hinter „/?s=\" von ISG-Seiten für Werte, getrennt durch „;“",
+    "yes": "Ja"
+}

admin/admin.d.ts

@@ -0,0 +1,43 @@
+{
+    "Main settings": "Main settings",
+    "URLs": "URLs",
+    "IP address or domain": "IP address or domain",
+    "IP address or domain_help": "IP address or domain name of the ISG",
+    "IP address or domain_tips": "Examples - IP: 192.168.178.188 or FQDN: servicewelt.fritz.box",
+    "username": "Username",
+    "username_help": "Username for the ISG",
+    "username_tips": "Username is case-sensitive, leave empty if not set in ISG",
+    "isg password": "Password",
+    "isg password_help": "Password for the ISG",
+    "isg password_tips": "Password is case-sensitive, leave empty if not set in ISG",
+    "umlauts active": "Umlauts active",
+    "umlauts active_help": "Enable handling of umlauts",
+    "umlauts active_tips": "Activate umlauts in objects. Warning: could cause problems in history-adapter.",
+    "enable expert values": "Enable expert values",
+    "enable expert values_help": "Show additional expert values when enabled",
+    "enable expert values_tips": "Enable reading/writing of expert values.",
+    "intervall (s)": "Interval (s)",
+    "intervall (s)_help": "Interval for values to pull (in seconds)",
+    "intervall (commands) (s)": "Interval (commands) (s)",
+    "intervall (commands) (s)_help": "Interval for commands to pull (in seconds)",
+    "command paths": "Command paths",
+    "command paths_tips": "Ending of URLs behind \"/?s=\" of ISG pages for settings, separated by \";\"",
+    "command paths_help": "Define the command paths for settings on the ISG pages.",
+    "value paths": "Value paths",
+    "value paths_tips": "Ending of URLs behind \"/?s=\" of ISG pages for values, separated by \";\"",
+    "value paths_help": "Define the value paths for values on the ISG pages.",
+    "status paths": "Status paths",
+    "status paths_tips": "Ending of URLs behind \"/?s=\" of ISG pages for status, separated by \";\"",
+    "status paths_help": "Define the status paths for status on the ISG pages.",
+    "expert paths": "Expert paths",
+    "expert paths_tips": "Ending of URLs behind \"/?s=\" of ISG pages for expert values, separated by \";\"",
+    "expert paths_help": "Define the expert paths for expert values on the ISG pages.",
+    "AUSSENTEMPERATUR": "Outside air temperature",
+    "STUFE-TAG": "Ventilation level daytime",
+    "settings": "Settings",
+    "info": "Info",
+    "start": "Start",
+    "yes": "Yes",
+    "no": "No",
+    "ISGReboot": "Reboot ISG"
+}

admin/i18n/de/translations.json

@@ -0,0 +1,43 @@
+{
+    "AUSSENTEMPERATUR": "Temperatura del aire exterior",
+    "IP address or domain": "dirección IP o dominio",
+    "IP address or domain_help": "Dirección IP o nombre de dominio del ISG",
+    "IP address or domain_tips": "Ejemplos: IP: 192.168.178.188 o FQDN: servicewelt.fritz.box",
+    "ISGReboot": "Reiniciar ISG",
+    "Main settings": "Configuraciones principales",
+    "STUFE-TAG": "Nivel de ventilación durante el día",
+    "URLs": "URL",
+    "command paths": "Rutas de comando",
+    "command paths_help": "Defina las rutas de comando para la configuración en las páginas ISG.",
+    "command paths_tips": "Final de las URL detrás de \"/?s=\" de las páginas ISG para configuración, separadas por \";\"",
+    "enable expert values": "Habilitar valores expertos",
+    "enable expert values_help": "Mostrar valores expertos adicionales cuando esté habilitado",
+    "enable expert values_tips": "Habilitar la lectura/escritura de valores expertos.",
+    "expert paths": "Caminos expertos",
+    "expert paths_help": "Defina las rutas de expertos para los valores de expertos en las páginas de ISG.",
+    "expert paths_tips": "Final de las URL detrás de \"/?s=\" de las páginas ISG para valores de expertos, separadas por \";\"",
+    "info": "Información",
+    "intervall (commands) (s)": "Intervalo (comandos) (s)",
+    "intervall (commands) (s)_help": "Intervalo para que se extraigan los comandos (en segundos)",
+    "intervall (s)": "Intervalo(s)",
+    "intervall (s)_help": "Intervalo para que se extraigan los valores (en segundos)",
+    "isg password": "Contraseña",
+    "isg password_help": "Contraseña para el ISG",
+    "isg password_tips": "La contraseña distingue entre mayúsculas y minúsculas, déjela en blanco si no está configurada en ISG",
+    "no": "No",
+    "settings": "Ajustes",
+    "start": "Comenzar",
+    "status paths": "Rutas de estado",
+    "status paths_help": "Defina las rutas de estado para el estado en las páginas ISG.",
+    "status paths_tips": "Final de las URL detrás de \"/?s=\" de las páginas ISG para el estado, separadas por \";\"",
+    "umlauts active": "Diéresis activas",
+    "umlauts active_help": "Habilitar el manejo de diéresis",
+    "umlauts active_tips": "Activar diéresis en objetos. Advertencia: podría causar problemas en el adaptador de historial.",
+    "username": "Nombre de usuario",
+    "username_help": "Nombre de usuario para el ISG",
+    "username_tips": "El nombre de usuario distingue entre mayúsculas y minúsculas, déjelo vacío si no está configurado en ISG",
+    "value paths": "Caminos de valor",
+    "value paths_help": "Defina las rutas de valores para los valores en las páginas ISG.",
+    "value paths_tips": "Final de las URL detrás de \"/?s=\" de las páginas ISG para valores, separadas por \";\"",
+    "yes": "Sí"
+}