iobroker.al-ko 0.2.14 → 0.3.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Hubert <hubert.zechner@posteo.at>
+Copyright (c) 2019
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,5 @@
 ![Logo](admin/al-ko.png)
+
 # ioBroker.al-ko
 
 [![NPM version](https://img.shields.io/npm/v/iobroker.al-ko.svg)](https://www.npmjs.com/package/iobroker.al-ko)
@@ -6,153 +7,73 @@
 ![Number of Installations](https://iobroker.live/badges/al-ko-installed.svg)
 ![Current version in stable repository](https://iobroker.live/badges/al-ko-stable.svg)
 
-[![NPM](https://nodei.co/npm/iobroker.al-ko.png?downloads=true)](https://nodei.co/npm/iobroker.al-ko/)
-
-**Tests:** ![Test and Release](https://github.com/zechnerhubert/ioBroker.al-ko/workflows/Test%20and%20Release/badge.svg)
-
----
+![NPM](https://nodei.co/npm/iobroker.al-ko.png?downloads=true)
 
-## ioBroker.al-ko
+## Overview
 
-Adapter zur Kommunikation mit **AL-KO Robolinho** und weiteren AL-KO Gartengeräten.
+The ioBroker.al-ko adapter integrates **AL-KO Robolinho robotic lawnmowers** and other AL-KO smart garden devices into ioBroker using the official **AL-KO Cloud API**, including real-time updates via WebSocket.
 
-Adapter for communication with **AL-KO Robolinho** and other AL-KO garden tools.
+This adapter is a **community project** and is **not affiliated with or supported by AL-KO**.
 
 ---
 
-## Funktionsumfang / Features
+## Features
 
-- Verbindung mit der offiziellen **AL-KO Cloud API**
-- Automatisches Anlegen aller relevanten States
-- Alle schreibbaren States werden berücksichtigt (Whitelist)
-- Änderungen an States werden per API zurück in die Cloud gepusht
-- Gerätestatus wird automatisch und in Echtzeit über **WebSocket** aktualisiert
-- Authentifizierung via Benutzername / Passwort und API-Client-Daten
+- Connects to the official AL-KO Cloud API
+- Automatically creates all readable states
+- Writable states controlled through a whitelist
+- Sends state changes back to AL-KO (`desired` state API)
+- Real-time updates via WebSocket
+- Supports multiple devices
+- Works with the newest ioBroker admin/jsonConfig format
 
 ---
 
-## Konfiguration
-
-Um den Adapter zu nutzen, benötigen Sie API-Zugangsdaten von AL-KO.  
-Diese können Sie hier beantragen:  
-👉 [AL-KO IoT API Zugang](https://alko-garden.at/iot-api-zugang-anfordern/)
+## Requirements
 
-Im Admin müssen folgende Daten hinterlegt werden:
-- **Username** (AL-KO Konto)
-- **Password**
-- **Client ID**
-- **Client Secret**
+You need AL-KO API credentials, which can be requested here:
 
----
+➡ https://alko-garden.at/iot-api-zugang-anfordern/
 
-## DISCLAIMER
+Adapter settings in Admin:
 
-Dieser Adapter steht **in keinem Zusammenhang mit der Firma AL-KO**.  
-Es handelt sich um ein Community-Projekt, und AL-KO bietet **keinen Support** dafür an.
+- Username (AL-KO account)
+- Password
+- Client ID
+- Client Secret
 
 ---
 
-## Changelog
-
-### 0.2.14 (2025-11-01)
-
-**Deutsch:**
-- Entwicklungs-Tooling aktualisiert:
-  - `@alcalzone/release-script` auf ^5.0.0 (Releases nur vom Default-Branch; Node.js ≥ 18 erforderlich)
-  - `@alcalzone/release-script-plugin-iobroker` auf ^4.0.0 (ESM, Node.js ≥ 18)
-  - `@alcalzone/release-script-plugin-license` auf ^4.0.0 (ESM, Node.js ≥ 18)
-  - ESLint 9, TypeScript auf ^5.9.3, Prettier 3
-- Keine funktionalen Änderungen am Adaptercode
-
-**English:**
-- Development tooling updated:
-  - `@alcalzone/release-script` to ^5.0.0 (releases only from default branch; requires Node.js ≥ 18)
-  - `@alcalzone/release-script-plugin-iobroker` to ^4.0.0 (ESM, Node.js ≥ 18)
-  - `@alcalzone/release-script-plugin-license` to ^4.0.0 (ESM, Node.js ≥ 18)
-  - ESLint 9, TypeScript bumped to ^5.9.3, Prettier 3
-- No functional changes to adapter code
-
-### 0.2.13 (2025-10-29)
-
-**Deutsch:**
-- JSON-Syntaxfehler in `io-package.json` behoben, der den Adapter-Check blockiert hat (Folgefehler „adminUI“).
-- VS-Code-Schemahinweis für `admin/jsonConfig.json` aktualisiert.
-- `size`-Attribute in `jsonConfig` erneut geprüft/validiert.
-- Keine funktionalen Änderungen.
-
-**English:**
-- Fixed a JSON syntax error in `io-package.json` that blocked adapter-check (follow-up “adminUI” errors).
-- Updated VS Code JSON schema hint for `admin/jsonConfig.json`.
-- Re-validated `size` attributes in `jsonConfig`.
-- No functional changes.
-
-### 0.2.12 (2025-10-29)
-
-**Deutsch:**
-- Admin-UI: Offizielle jsonConfig-Schema-URL korrigiert (`.vscode/settings.json`)
-- Fehlende responsive `size`-Attribute in `admin/jsonConfig.json` ergänzt
-- Mindestanforderungen angehoben: `js-controller >= 6.0.11`, `admin >= 7.6.17`
-- Keine funktionalen Änderungen
-
-**English:**
-- Admin UI: Fixed official jsonConfig schema URL (`.vscode/settings.json`)
-- Added missing responsive `size` attributes in `admin/jsonConfig.json`
-- Raised minimum requirements: `js-controller >= 6.0.11`, `admin >= 7.6.17`
-- No functional changes
+## Disclaimer
 
-### 0.2.11 (2025-10-28)
+This adapter is **not** affiliated with or supported by AL-KO.  
+Do **not** contact AL-KO customer service regarding this project.
 
-**Deutsch:**
-* Kleinere Code-Korrekturen und Optimierungen vorgenommen  
-* Keine funktionalen Änderungen – Stabilität und Wartbarkeit verbessert  
+---
 
-**English:**
-* Minor code corrections and optimizations  
-* No functional changes – improved stability and maintainability
+## Latest Changes
 
-### 0.2.10 (2025-10-28)
+### **0.2.16 (unreleased / development)**
 
-**Deutsch:**
-- Adapter-Kategorie angepasst: Typ von 'hardware' auf 'garden' geändert.
-- Keine funktionalen Änderungen für Anwender
+- Improved instance handling and object hierarchy
+- Better separation of writable and non-writable states
+- Added axios global timeout
+- Introduced adapter-safe timers (`this.setTimeout`, `this.setInterval`)
+- Many internal improvements and preparations for future patches
 
-**English:** 
-- Changed adapter type from 'hardware' to 'garden' for proper categorization in ioBroker Admin and repositories.
-- No functional changes for end users  
+### **0.2.15 (2025-11-02)**
 
-### 0.2.9 (2025-10-28)
+- Cleaned up admin/jsonConfig structure for adapter-check
+- Added missing `size` attributes
+- Added `.commitinfo` to `.gitignore`
+- No functional changes
 
-**Deutsch:**  
-- Wartungsupdate: npm-Abhängigkeitskonflikte (`sinon-chai` vs. `chai`) behoben  
-- ESLint-Konfiguration auf Version 9 mit `@iobroker/eslint-config` v2.2.0 aktualisiert  
-- CI-Stabilität auf GitHub Actions verbessert  
-- Keine funktionalen Änderungen für Anwender
+➡ **Full changelog here:**  
+**[CHANGELOG.md](./CHANGELOG.md)**
 
-**English:**  
-- Maintenance update: resolved npm dependency conflicts (`sinon-chai` vs `chai`)  
-- Updated ESLint setup to v9 + `@iobroker/eslint-config` v2.2.0  
-- Improved GitHub Actions CI stability  
-- No functional changes for end users  
+---
 
 ## License
-MIT License
-
-Copyright (c) 2025 Hubert <hubertiob@posteo.at>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+This project is released under the **MIT License**.  
+See the included **LICENSE** file for full details.

package/admin/i18n/de/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Adaptereinstellungen für al-ko",
-	"option1": "Option1",
-	"option2": "Option2"
-}
+  "al-ko adapter settings": "Adaptereinstellungen für al-ko",
+  "option1": "Option1",
+  "option2": "Option2"
+}

package/admin/i18n/en/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Adapter settings for al-ko",
-	"option1": "option1",
-	"option2": "option2"
-}
+  "al-ko adapter settings": "Adapter settings for al-ko",
+  "option1": "option1",
+  "option2": "option2"
+}

package/admin/i18n/es/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Ajustes del adaptador para al-ko",
-	"option1": "Opción1",
-	"option2": "opción 2"
-}
+  "al-ko adapter settings": "Ajustes del adaptador para al-ko",
+  "option1": "Opción1",
+  "option2": "opción 2"
+}

package/admin/i18n/fr/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Paramètres d'adaptateur pour al-ko",
-	"option1": "option1",
-	"option2": "Option2"
-}
+  "al-ko adapter settings": "Paramètres d'adaptateur pour al-ko",
+  "option1": "option1",
+  "option2": "Option2"
+}

package/admin/i18n/it/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Impostazioni dell'adattatore per al-ko",
-	"option1": "opzione1",
-	"option2": "opzione2"
-}
+  "al-ko adapter settings": "Impostazioni dell'adattatore per al-ko",
+  "option1": "opzione1",
+  "option2": "opzione2"
+}

package/admin/i18n/nl/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Adapterinstellingen voor al-ko",
-	"option1": "Option1",
-	"option2": "Optie2"
-}
+  "al-ko adapter settings": "Adapterinstellingen voor al-ko",
+  "option1": "Option1",
+  "option2": "Optie2"
+}

package/admin/i18n/pl/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Ustawienia adaptera dla al-ko",
-	"option1": "opcja 1",
-	"option2": "opcja2"
-}
+  "al-ko adapter settings": "Ustawienia adaptera dla al-ko",
+  "option1": "opcja 1",
+  "option2": "opcja2"
+}

package/admin/i18n/pt/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Configurações do adaptador para al-ko",
-	"option1": "opção1",
-	"option2": "opção2"
-}
+  "al-ko adapter settings": "Configurações do adaptador para al-ko",
+  "option1": "opção1",
+  "option2": "opção2"
+}

package/admin/i18n/ru/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Настройки адаптера для al-ko",
-	"option1": "вариант1",
-	"option2": "вариант2"
-}
+  "al-ko adapter settings": "Настройки адаптера для al-ko",
+  "option1": "вариант1",
+  "option2": "вариант2"
+}

package/admin/i18n/uk/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "Налаштування адаптера для al-ko",
-	"option1": "Варіант1",
-	"option2": "Варіант2"
-}
+  "al-ko adapter settings": "Налаштування адаптера для al-ko",
+  "option1": "Варіант1",
+  "option2": "Варіант2"
+}

package/admin/i18n/zh-cn/translations.json

@@ -1,5 +1,5 @@
 {
-	"al-ko adapter settings": "al-ko的适配器设置",
-	"option1": "选项1",
-	"option2": "选项2"
-}
+  "al-ko adapter settings": "al-ko的适配器设置",
+  "option1": "选项1",
+  "option2": "选项2"
+}

package/admin/jsonConfig.json

@@ -1,51 +1,48 @@
 {
-  "$schema": "https://raw.githubusercontent.com/ioBroker/ioBroker.admin/master/packages/jsonConfig/schemas/jsonConfig.json",
-  "type": "tabs",
+  "type": "panel",
+  "label": {
+    "en": "General",
+    "de": "Allgemein",
+    "ru": "Общие",
+    "pt": "Geral",
+    "nl": "Algemeen",
+    "fr": "Général",
+    "it": "Generale",
+    "es": "General",
+    "pl": "Ogólne",
+    "uk": "Загальні",
+    "zh-cn": "常规"
+  },
   "items": {
-    "general": {
-      "type": "panel",
+    "username": {
+      "type": "text",
+      "label": { "en": "Username", "de": "Benutzername" },
+      "placeholder": "Enter your AL-KO account username",
+      "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
+    },
+    "password": {
+      "type": "password",
+      "label": { "en": "Password", "de": "Passwort" },
+      "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
+    },
+    "clientId": {
+      "type": "text",
+      "label": { "en": "Client ID", "de": "Client-ID" },
+      "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
+    },
+    "clientSecret": {
+      "type": "password",
+      "label": { "en": "Client Secret", "de": "Client-Secret" },
+      "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
+    },
+    "wsDebug": {
+      "type": "checkbox",
       "label": {
-        "en": "General",
-        "de": "Allgemein",
-        "ru": "Общие",
-        "pt": "Geral",
-        "nl": "Algemeen",
-        "fr": "Général",
-        "it": "Generale",
-        "es": "General",
-        "pl": "Ogólne",
-        "uk": "Загальні",
-        "zh-cn": "常规"
+        "en": "Enable WebSocket message logging",
+        "de": "WebSocket-Nachrichten protokollieren"
       },
-      "items": {
-        "username": {
-          "type": "text",
-          "label": { "en": "Username", "de": "Benutzername" },
-          "placeholder": "Enter your AL-KO account username",
-          "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
-        },
-        "password": {
-          "type": "password",
-          "label": { "en": "Password", "de": "Passwort" },
-          "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
-        },
-        "clientId": {
-          "type": "text",
-          "label": { "en": "Client ID", "de": "Client-ID" },
-          "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
-        },
-        "clientSecret": {
-          "type": "password",
-          "label": { "en": "Client Secret", "de": "Client-Secret" },
-          "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
-        },
-        "wsDebug": {
-          "type": "checkbox",
-          "label": { "en": "Enable WebSocket message logging", "de": "WebSocket-Nachrichten protokollieren" },
-          "default": false,
-          "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
-        }
-      }
+      "default": false,
+      "size": { "xs": 12, "sm": 6, "md": 6, "lg": 4, "xl": 4 }
     }
   }
 }

package/docs/de/README.md

@@ -0,0 +1,68 @@
+# ioBroker.al-ko – Deutsche Dokumentation
+
+![Logo](../../admin/al-ko-128.png)
+
+## Überblick
+
+Der ioBroker.al-ko Adapter integriert **AL-KO Robolinho Rasenroboter** und weitere AL-KO Smart-Garden-Geräte in ioBroker.  
+Die Kommunikation erfolgt über die **offizielle AL-KO Cloud API**, inklusive Echtzeit-Updates per WebSocket.
+
+---
+
+## Funktionen
+
+- Verbindung zur offiziellen AL-KO Cloud API
+- Automatische Erstellung aller lesbaren Zustände
+- Schreibbare Zustände über Whitelist steuerbar
+- Änderungen werden per PATCH an AL-KO (`desired` State) übermittelt
+- Echtzeitupdates per WebSocket
+- Unterstützung mehrerer Geräte
+- Kompatibel mit modernem ioBroker Admin / jsonConfig
+
+---
+
+## Voraussetzungen
+
+Für die Nutzung werden AL-KO API-Zugangsdaten benötigt:
+
+Anfordern unter:  
+➡ https://alko-garden.at/iot-api-zugang-anfordern/
+
+Erforderlich:
+
+- Benutzername
+- Passwort
+- Client ID
+- Client Secret
+
+Eintragen unter: **Instanzen → al-ko → Konfiguration**
+
+---
+
+## Haftungsausschluss
+
+Dieser Adapter ist ein **Community-Projekt**.  
+AL-KO bietet **keinen offiziellen Support** hierfür.
+
+---
+
+## Änderungen (Auszug)
+
+### **0.3.0**
+
+Alle Änderungen siehe vollständigen Changelog:  
+➡ [CHANGELOG.md](../../CHANGELOG.md)
+
+Wesentliche Neuerungen:
+
+- Verbesserte Objektstruktur
+- Überarbeitetes Logging
+- Verbesserte ID-Sanitärisierung
+- Globale Timeouts und adapter-sichere Timer
+- Dokumentation überarbeitet
+
+---
+
+## Lizenz
+
+Veröffentlicht unter der **MIT-Lizenz**.

package/docs/en/README.md

@@ -0,0 +1,66 @@
+# ioBroker.al-ko – English Documentation
+
+![Logo](../../admin/al-ko-128.png)
+
+## Overview
+
+The ioBroker.al-ko adapter integrates **AL-KO Robolinho robotic mowers** and other AL-KO smart garden devices into ioBroker.  
+It communicates with the official **AL-KO Cloud API**, including real-time updates via WebSockets.
+
+---
+
+## Features
+
+- Connection to the official AL-KO Cloud API
+- Automatic creation of all readable states
+- Writable states controlled through a whitelist
+- Changes to writable states are propagated back to AL-KO via the `desired` API
+- Real-time updates through WebSocket
+- Supports multiple devices
+- Fully compatible with modern ioBroker admin/jsonConfig
+
+---
+
+## Requirements
+
+To use this adapter, AL-KO API credentials are required.
+
+Request access at:  
+➡ https://alko-garden.at/iot-api-zugang-anfordern/
+
+Required fields:
+
+- Username
+- Password
+- Client ID
+- Client Secret
+
+Enter these values in Admin → Instance Settings.
+
+---
+
+## Disclaimer
+
+This adapter is **not** affiliated with or supported by AL-KO.  
+It is a **community-developed project**.
+
+---
+
+## Changes (Summary)
+
+### **0.3.0**
+
+See full changelog here:  
+➡ [CHANGELOG.md](../../CHANGELOG.md)
+
+Key updates:
+
+- Internal cleanup and consistency improvements
+- Improved logging, ID sanitizing and timers
+- Documentation restructured
+
+---
+
+## License
+
+Released under the **MIT License**.