iobroker.zeptrion 0.8.5 → 1.0.0

package/README.md

@@ -190,6 +190,13 @@ npm run test:integration   # starts a real js-controller (takes longer)
 
 ## Changelog
 
+### 1.0.0 (2026-07-17)
+- First 1.0 release - the adapter has reached a stable, complete feature set (multicast command bundling, mDNS discovery, hail bulk commands, position estimation, Smartfront support, CSV import, full i18n).
+- FIX: the previous release corrected calibrate/ntp.per roles and the info.connection translation, but ensureState() never updates an object that already exists - so installations updated from an older version kept the old, incorrect objects forever. Added a one-time startup migration that force-corrects exactly those known objects via extendObjectAsync(), without touching anything else (including the adapter's own built-in root info.connection object).
+
+### 0.8.6 (2026-07-17)
+- Corrected object role/type mismatches found by the ioBroker store submission's object structure check: calibrate and ntp.per used role 'value', which strictly requires read=true/write=false and does not fit these intentionally writable states - changed to role 'level'. Also added the missing full i18n translation for info.connection.
+
 ### 0.8.5 (2026-07-16)
 - Enabled automated npm releases via GitHub Actions using npm Trusted Publishing (OIDC) - no more manual publishing, and this and all future tagged releases are automatically signed with npm provenance. No functional/API changes.
 
@@ -212,74 +219,9 @@ npm run test:integration   # starts a real js-controller (takes longer)
 ### 0.8.0
 - Fixed orphaned states remaining after a device is removed/replaced (objects are now cleaned up on start), official Feller zeptrion logo as icon (used with permission)
 
-### 0.7.0 (2026-07-10)
-- Scaling for 20+ devices: parallel setup, poll jitter, duplicate detection
-- Strict startup validation for every configured device row
-- CSV bulk import (dedicated config tab) with row validation and auto-ID
-- FIX: position estimate correctly handled after a stop during an end-position run
-- FIX: adapter timer cleanup (this.clearTimeout), leading zeros in chdes codes are preserved
-
-### 0.6.0 (2026-07-10)
-- Auto-ID from host, device test button (reachability + zeptrion verification + channel count check)
-- Channel object names taken from the device (chdes), new icon, device icons
-
-### 0.5.1 (2026-07-10)
-- CRITICAL FIX: the XML parser skipped the payload because of the XML declaration key - all GET values remained null in 0.5.0
-
-### 0.5.0 (2026-07-07)
-- setPosition: time-based %-approach for shutters (chunked due to the 32s API limit, reference run when position is unknown)
-- tiltOpen/tiltClose: slat tilt pulses (configurable pulse duration)
-- calibrate: set the position estimate without moving
-
-### 0.4.0 (2026-07-07) - Security & quality hardening
-- **Locked factory reset**: `system.factoryDefault` now only works within
-  30s of setting `system.unlock` - a single accidental setState from a
-  script/VIS can no longer wipe the device.
-- **Crash-safe onStateChange**: the entire handler (including the bulk commands) now
-  runs inside centralized error handling - unhandled promise rejections are
-  no longer possible.
-- **Input validation**: channel description (32/32/24/4/4 bytes UTF-8), location (32),
-  NTP URL (32) and NTP interval (0-255) are validated before sending; a clear
-  error message instead of an HTTP 400 from the device. Umlauts are correctly counted as 2 bytes.
-- **Adapter-managed timers** (`this.setTimeout`) used everywhere - automatic cleanup
-  on unload per the ioBroker guidelines.
-- **Connection economy**: as long as the chnotify long-poll is running healthily, the
-  redundant chscan resync now only runs on every 5th poll (goes easier on the
-  weak embedded web servers of the flush-mounted actuators).
-- **chnotify can be disabled** (Expert tab) for environments with connection issues.
-- **New admin UI**: tabs (Devices/Expert), fully EN+DE, input validators
-  (ID pattern, host pattern), tooltips on every column, security notice.
-- Migrated ESLint to flat config (v9), lint runs cleanly; smoke tests for
-  command validation, byte limits, position math and multicast body.
-
-### 0.3.0 (2026-07-07)
-- Channel commands for the same device are automatically bundled within a 50ms window
-  into a single multicast POST to `/zrap/chctrl` instead of being sent sequentially
-  one by one - `control.closeAllShutters` (hail alert) in particular
-  benefits massively from this (one request per device instead of one per channel).
-- Optional time-based shutter position estimate (`posEstimate`) based on a configurable
-  motor travel time, since the hardware itself does not report a position.
-- Optional Smartfront support (`zapi/smartfront/*`): read temperature/brightness/
-  humidity, set LED background color.
-- Role fix: `level.blind` is now applied to the position estimate instead of the
-  raw (usually -1) hardware value.
-
-### 0.2.0 (2026-07-07)
-- Channel states are now primarily updated near real-time via `zrap/chnotify`
-  (long-poll) instead of only via interval polling; `chscan` polling remains as a
-  periodic resync/fallback.
-- An additional safety net (busy window, 5s) prevents a concurrent
-  chscan resync from overwriting a just-sent movement command with a stale value.
-- mDNS discovery handler hardened against exceptions caused by malformed/unrelated
-  network packets (try/catch per service event instead of only around the subscription).
-- New device field "kind" (Shutter/Light/unknown) controls the default object roles
-  (`level.blind`, `button.stop`, `button.open.blind`, `button.close.blind` resp.
-  `level.dimmer`) for better VIS/smart-home integration.
-- Structured `native` metadata (host, channel number, kind) on device/channel objects.
-
-### 0.1.0 (2026-07-07)
-- First version: channel control, channel state/description, device/network info,
-  system commands, location/NTP/date, bulk commands for hail alerts, mDNS discovery.
+### 0.7.0 and older
+
+Older changelog entries can be found in [CHANGELOG_OLD.md](CHANGELOG_OLD.md).
 
 ## License
 

package/io-package.json

@@ -1,8 +1,34 @@
 {
   "common": {
     "name": "zeptrion",
-    "version": "0.8.5",
+    "version": "1.0.0",
     "news": {
+      "1.0.0": {
+        "en": "First 1.0 release. FIX: the previous release corrected calibrate/ntp.per roles and the info.connection translation, but ensureState() never updates an object that already exists - so installations updated from an older version kept the old, incorrect objects forever. Added a one-time startup migration that force-corrects exactly those known objects via extendObjectAsync(), without touching anything else (including the adapter's own built-in root info.connection object). No other functional changes since 0.8.6 - the version bump to 1.0.0 reflects that the adapter has reached a stable, complete feature set (multicast command bundling, mDNS discovery, hail bulk commands, position estimation, Smartfront support, CSV import, full i18n).",
+        "de": "Erstes 1.0-Release. FIX: Das vorherige Release hat die calibrate/ntp.per-Rollen und die info.connection-Übersetzung korrigiert, aber ensureState() aktualisiert nie ein bereits existierendes Objekt - Installationen, die von einer älteren Version aktualisiert haben, behielten die alten, falschen Objekte dauerhaft. Eine einmalige Start-Migration ergänzt, die genau diese bekannten Objekte per extendObjectAsync() zwangskorrigiert, ohne sonst etwas anzufassen (auch nicht das adaptereigene, eingebaute root-info.connection-Objekt). Keine weiteren funktionalen Änderungen seit 0.8.6 - der Sprung auf 1.0.0 spiegelt wider, dass der Adapter einen stabilen, vollständigen Funktionsumfang erreicht hat (Multicast-Befehlsbündelung, mDNS-Discovery, Hagel-Sammelbefehle, Positionsschätzung, Smartfront-Unterstützung, CSV-Import, vollständige i18n).",
+        "ru": "Первый релиз 1.0. ИСПРАВЛЕНИЕ: предыдущий релиз исправил роли calibrate/ntp.per и перевод info.connection, но ensureState() никогда не обновляет уже существующий объект - поэтому установки, обновлённые с более старой версии, навсегда сохраняли старые, неверные объекты. Добавлена одноразовая миграция при запуске, принудительно исправляющая именно эти известные объекты.",
+        "pt": "Primeiro lançamento 1.0. CORREÇÃO: o lançamento anterior corrigiu as funções calibrate/ntp.per e a tradução info.connection, mas ensureState() nunca atualiza um objeto já existente - por isso as instalações atualizadas de uma versão mais antiga mantinham para sempre os objetos antigos incorretos. Adicionada uma migração única no arranque.",
+        "nl": "Eerste 1.0-release. FIX: de vorige release corrigeerde de calibrate/ntp.per-rollen en de info.connection-vertaling, maar ensureState() werkt nooit een reeds bestaand object bij - installaties bijgewerkt vanaf een oudere versie behielden dus permanent de oude, onjuiste objecten. Eenmalige opstartmigratie toegevoegd.",
+        "fr": "Première version 1.0. CORRECTIF : la version précédente a corrigé les rôles calibrate/ntp.per et la traduction info.connection, mais ensureState() ne met jamais à jour un objet déjà existant - les installations mises à jour depuis une version plus ancienne conservaient donc indéfiniment les anciens objets incorrects. Migration unique au démarrage ajoutée.",
+        "it": "Prima versione 1.0. CORREZIONE: la versione precedente ha corretto i ruoli calibrate/ntp.per e la traduzione info.connection, ma ensureState() non aggiorna mai un oggetto già esistente - le installazioni aggiornate da una versione precedente mantenevano quindi per sempre i vecchi oggetti errati. Aggiunta una migrazione una tantum all'avvio.",
+        "es": "Primera versión 1.0. CORRECCIÓN: la versión anterior corrigió los roles calibrate/ntp.per y la traducción de info.connection, pero ensureState() nunca actualiza un objeto ya existente, por lo que las instalaciones actualizadas desde una versión anterior conservaban para siempre los objetos antiguos incorrectos. Se añadió una migración única al inicio.",
+        "pl": "Pierwsze wydanie 1.0. POPRAWKA: poprzednie wydanie naprawiło role calibrate/ntp.per oraz tłumaczenie info.connection, ale ensureState() nigdy nie aktualizuje już istniejącego obiektu - instalacje zaktualizowane ze starszej wersji na stałe zachowywały więc stare, błędne obiekty. Dodano jednorazową migrację przy starcie.",
+        "uk": "Перший реліз 1.0. ВИПРАВЛЕННЯ: попередній реліз виправив ролі calibrate/ntp.per та переклад info.connection, але ensureState() ніколи не оновлює вже існуючий об'єкт - тому інсталяції, оновлені зі старішої версії, назавжди зберігали старі, неправильні об'єкти. Додано одноразову міграцію під час запуску.",
+        "zh-cn": "首个 1.0 版本。修复：上一版本修正了 calibrate/ntp.per 角色和 info.connection 翻译，但 ensureState() 从不更新已存在的对象——因此从旧版本升级的安装会永久保留旧的、不正确的对象。新增了一次性启动迁移来强制修正这些已知对象。"
+      },
+      "0.8.6": {
+        "en": "Corrected object role/type mismatches found by the ioBroker store submission's object structure check: calibrate and ntp.per used role 'value', which strictly requires read=true/write=false and does not fit these intentionally writable states - changed to role 'level'. Also added the missing full i18n translation for info.connection. No functional/API changes - purely metadata (common.role/common.name) corrections.",
+        "de": "Objekt-Rollen-/Typ-Abweichungen behoben, die beim Objektstruktur-Check der ioBroker-Store-Einreichung gefunden wurden: calibrate und ntp.per nutzten die Rolle 'value', die zwingend read=true/write=false erfordert und nicht zu diesen bewusst schreibbaren States passt - auf Rolle 'level' umgestellt. Zusätzlich die fehlende vollständige i18n-Übersetzung für info.connection ergänzt. Keine funktionalen/API-Änderungen - reine Metadaten-Korrekturen (common.role/common.name).",
+        "ru": "Исправлены несоответствия ролей/типов объектов, найденных при проверке структуры объектов для подачи в магазин ioBroker: calibrate и ntp.per использовали роль 'value', которая строго требует read=true/write=false и не подходит для этих намеренно записываемых состояний - изменено на роль 'level'. Также добавлен отсутствующий полный перевод i18n для info.connection.",
+        "pt": "Corrigidas incompatibilidades de função/tipo de objeto encontradas na verificação da estrutura de objetos da submissão à loja ioBroker: calibrate e ntp.per usavam a função 'value', que exige estritamente read=true/write=false e não se adequa a estes estados intencionalmente graváveis - alterado para a função 'level'. Também foi adicionada a tradução i18n completa em falta para info.connection.",
+        "nl": "Object rol/type-mismatches gecorrigeerd die zijn gevonden bij de objectstructuurcontrole van de ioBroker store-inzending: calibrate en ntp.per gebruikten de rol 'value', die strikt read=true/write=false vereist en niet past bij deze bewust schrijfbare states - gewijzigd naar rol 'level'. Ook de ontbrekende volledige i18n-vertaling voor info.connection toegevoegd.",
+        "fr": "Correction des incohérences de rôle/type d'objet détectées lors de la vérification de la structure des objets pour la soumission au store ioBroker : calibrate et ntp.per utilisaient le rôle 'value', qui exige strictement read=true/write=false et ne convient pas à ces états volontairement modifiables - changé en rôle 'level'. La traduction i18n complète manquante pour info.connection a également été ajoutée.",
+        "it": "Corrette le discrepanze di ruolo/tipo degli oggetti riscontrate durante il controllo della struttura degli oggetti per l'invio allo store ioBroker: calibrate e ntp.per utilizzavano il ruolo 'value', che richiede rigorosamente read=true/write=false e non si adatta a questi stati intenzionalmente scrivibili - cambiato in ruolo 'level'. Aggiunta anche la traduzione i18n completa mancante per info.connection.",
+        "es": "Se corrigieron discrepancias de rol/tipo de objeto encontradas en la verificación de estructura de objetos del envío a la tienda ioBroker: calibrate y ntp.per usaban el rol 'value', que requiere estrictamente read=true/write=false y no encaja con estos estados intencionalmente escribibles - cambiado a rol 'level'. También se añadió la traducción i18n completa faltante para info.connection.",
+        "pl": "Naprawiono niezgodności ról/typów obiektów wykryte podczas sprawdzania struktury obiektów zgłoszenia do sklepu ioBroker: calibrate i ntp.per używały roli 'value', która wymaga ściśle read=true/write=false i nie pasuje do tych celowo zapisywalnych stanów - zmieniono na rolę 'level'. Dodano również brakujące pełne tłumaczenie i18n dla info.connection.",
+        "uk": "Виправлено невідповідності ролей/типів об'єктів, знайдені під час перевірки структури об'єктів для подання до магазину ioBroker: calibrate і ntp.per використовували роль 'value', яка суворо вимагає read=true/write=false і не підходить для цих навмисно записуваних станів - змінено на роль 'level'. Також додано відсутній повний переклад i18n для info.connection.",
+        "zh-cn": "修复了在 ioBroker 商店提交的对象结构检查中发现的对象角色/类型不匹配问题：calibrate 和 ntp.per 使用了角色 'value'，该角色严格要求 read=true/write=false，不适合这些故意可写的状态——已更改为角色 'level'。同时还补充了 info.connection 缺失的完整 i18n 翻译。"
+      },
       "0.8.5": {
         "en": "Enabled automated npm releases via GitHub Actions using npm Trusted Publishing (OIDC) - no more manual publishing, and this and all future tagged releases are automatically signed with npm provenance. No functional/API changes.",
         "de": "Automatisierte npm-Releases über GitHub Actions mittels npm Trusted Publishing (OIDC) aktiviert - kein manuelles Veröffentlichen mehr nötig, dieses und alle künftigen getaggten Releases werden automatisch mit npm-Provenance signiert. Keine funktionalen Änderungen/API-Änderungen.",

package/lib/adapter-config.d.ts

@@ -0,0 +1,19 @@
+// This file extends the AdapterConfig type from "@types/iobroker"
+// using the actual properties present in io-package.json
+// in order to provide typings for adapter.config properties
+
+import { native } from '../io-package.json';
+
+type _AdapterConfig = typeof native;
+
+// Augment the globally declared type ioBroker.AdapterConfig
+declare global {
+	namespace ioBroker {
+		interface AdapterConfig extends _AdapterConfig {
+			// Do not enter anything here!
+		}
+	}
+}
+
+// this is required so the above AdapterConfig is found by TypeScript / type checking
+export {};

package/main.js

@@ -120,10 +120,69 @@ class Zeptrion extends utils.Adapter {
 
     // ---------------------------------------------------------------- ready
 
+    // Force-corrects a small set of known-bad object roles/names left over from before this fix.
+    // Only touches an object if it still holds the exact old, known-bad value, so it never
+    // clobbers anything a user might have customized in the meantime. Role fixes are matched by
+    // ID suffix (calibrate/ntp.per are always per-device, unambiguous); the info.connection name
+    // fix is matched by its exact old string value instead of by ID, since the adapter's own
+    // built-in root "info.connection" object (not created by ensureState, must not be touched)
+    // would otherwise be hard to tell apart from the per-device one by ID pattern alone.
+    async migrateObjectRoles() {
+        try {
+            const objects = await this.getAdapterObjectsAsync();
+            let fixedCount = 0;
+            for (const id of Object.keys(objects)) {
+                const obj = objects[id];
+                if (!obj || obj.type !== 'state' || !obj.common) {
+                    continue;
+                }
+                if (/\.calibrate$/.test(id) && obj.common.role === 'value') {
+                    await this.extendObjectAsync(id, { common: { role: 'level' } });
+                    fixedCount++;
+                } else if (/\.ntp\.per$/.test(id) && obj.common.role === 'value') {
+                    await this.extendObjectAsync(id, { common: { role: 'level' } });
+                    fixedCount++;
+                } else if (/\.info\.connection$/.test(id) && obj.common.name === 'Verbindung OK') {
+                    await this.extendObjectAsync(id, {
+                        common: {
+                            name: {
+                                en: 'Connection OK',
+                                de: 'Verbindung OK',
+                                ru: 'Соединение в порядке',
+                                pt: 'Ligação OK',
+                                nl: 'Verbinding OK',
+                                fr: 'Connexion OK',
+                                it: 'Connessione OK',
+                                es: 'Conexión OK',
+                                pl: 'Połączenie OK',
+                                uk: "З'єднання в порядку",
+                                'zh-cn': '连接正常'
+                            }
+                        }
+                    });
+                    fixedCount++;
+                }
+            }
+            if (fixedCount > 0) {
+                this.log.info(`Migration: corrected role/name on ${fixedCount} existing object(s) created by an older version.`);
+            }
+        } catch (e) {
+            // Never let a migration failure block adapter startup.
+            this.log.warn(`Migration of object roles/names failed (non-fatal, adapter will continue starting): ${e}`);
+        }
+    }
+
     async onReady() {
+        // One-time (cheap-and-idempotent-every-startup) fix for role/name mistakes present in
+        // objects created before this fix (see CHANGELOG). ensureState()/setObjectNotExistsAsync()
+        // never touches an object that already exists, so simply updating the adapter does not
+        // correct objects an already-running installation had already created - this actively
+        // force-corrects them via extendObjectAsync() instead.
+        await this.migrateObjectRoles();
+
         await this.setStateAsync('info.connection', { val: false, ack: true });
 
-        const timeout = parseInt(this.config.requestTimeout, 10) || 4000;
+        const timeout = parseInt(String(this.config.requestTimeout), 10) || 4000;
         this.requestTimeout = Math.min(Math.max(timeout, 500), 30000);
 
         const devicesCfg = Array.isArray(this.config.devices) ? this.config.devices : [];
@@ -395,7 +454,22 @@ class Zeptrion extends utils.Adapter {
 
         // --- info ---
         await this.setObjectNotExistsAsync(`${id}.info`, { type: 'channel', common: { name: 'Geräteinformationen' }, native: {} });
-        await this.ensureState(`${id}.info.connection`, { name: 'Verbindung OK', type: 'boolean', role: 'indicator.reachable', read: true, write: false, def: false });
+        await this.ensureState(`${id}.info.connection`, {
+            name: {
+                en: 'Connection OK',
+                de: 'Verbindung OK',
+                ru: 'Соединение в порядке',
+                pt: 'Ligação OK',
+                nl: 'Verbinding OK',
+                fr: 'Connexion OK',
+                it: 'Connessione OK',
+                es: 'Conexión OK',
+                pl: 'Połączenie OK',
+                uk: "З'єднання в порядку",
+                'zh-cn': '连接正常'
+            },
+            type: 'boolean', role: 'indicator.reachable', read: true, write: false, def: false
+        });
         await this.ensureState(`${id}.info.lastError`, { name: 'Letzter Fehler', type: 'string', role: 'text', read: true, write: false, def: '' });
         await this.ensureState(`${id}.info.hw`, { name: 'Hardware-Version', type: 'string', role: 'info.hardware', read: true, write: false });
         await this.ensureState(`${id}.info.sw`, { name: 'Software-Version', type: 'string', role: 'info.firmware', read: true, write: false });
@@ -435,7 +509,7 @@ class Zeptrion extends utils.Adapter {
         // --- ntp (zrap/ntp) ---
         await this.setObjectNotExistsAsync(`${id}.ntp`, { type: 'channel', common: { name: 'NTP' }, native: {} });
         await this.ensureState(`${id}.ntp.url`, { name: 'NTP-Server (URL/IP, max. 32 Zeichen)', type: 'string', role: 'text', read: true, write: true });
-        await this.ensureState(`${id}.ntp.per`, { name: 'Abfrageintervall in Stunden (0=deaktiviert)', type: 'number', role: 'value', read: true, write: true, min: 0, max: 255 });
+        await this.ensureState(`${id}.ntp.per`, { name: 'Abfrageintervall in Stunden (0=deaktiviert)', type: 'number', role: 'level', read: true, write: true, min: 0, max: 255 });
 
         // --- date (zrap/date) ---
         await this.setObjectNotExistsAsync(`${id}.date`, { type: 'channel', common: { name: 'Datum/Zeit' }, native: {} });
@@ -513,7 +587,7 @@ class Zeptrion extends utils.Adapter {
                 });
                 await this.ensureState(`${ch}.calibrate`, {
                     name: 'Schätzung setzen OHNE Fahrt (z.B. nach manueller Bedienung am Wandtaster): aktuellen Ist-Zustand in % eintragen',
-                    type: 'number', role: 'value', min: 0, max: 100, read: false, write: true
+                    type: 'number', role: 'level', min: 0, max: 100, read: false, write: true
                 });
                 await this.extendObjectAsync(`${ch}.tiltOpen`, {
                     type: 'state',
@@ -1519,13 +1593,13 @@ class Zeptrion extends utils.Adapter {
                         id: candidate,
                         name: row.name || row.host,
                         host: row.host,
-                        channels: parseInt(row.channels, 10) || 1,
+                        channels: parseInt(String(row.channels), 10) || 1,
                         kind: row.kind,
-                        travelTimeSec: parseInt(row.travelTimeSec, 10) || 0,
+                        travelTimeSec: parseInt(String(row.travelTimeSec), 10) || 0,
                         travelTimeSecCh: String(row.travelTimeSecCh || '').trim(),
-                        tiltTimeMs: parseInt(row.tiltTimeMs, 10) || 0,
+                        tiltTimeMs: parseInt(String(row.tiltTimeMs), 10) || 0,
                         smartfront: row.smartfront,
-                        pollInterval: parseInt(row.pollInterval, 10) || 30
+                        pollInterval: parseInt(String(row.pollInterval), 10) || 30
                     });
                     existingHosts.add(row.host.toLowerCase());
                     existingIds.add(candidate);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zeptrion",
-  "version": "0.8.5",
+  "version": "1.0.0",
   "description": "ioBroker Adapter für Feller zeptrion / zApp WLAN-Aktoren (WLAN-Nebenstelle 4K, WLAN-Zwischenmodul 2K) über die zrap Webservice API - inkl. Sammelbefehlen für Hagelalarm und mDNS-Discovery",
   "author": {
     "name": "Stefan",
@@ -31,6 +31,7 @@
   "files": [
     "admin/",
     "main.js",
+    "lib/",
     "io-package.json",
     "LICENSE"
   ],
@@ -45,7 +46,9 @@
   },
   "devDependencies": {
     "@iobroker/testing": "^5.3.0",
-    "eslint": "^10.6.0"
+    "eslint": "^10.6.0",
+    "@tsconfig/node22": "^22.0.5",
+    "@types/node": "^22.20.1"
   },
   "scripts": {
     "start": "node main.js",
@@ -55,4 +58,4 @@
     "test:integration": "mocha test/integration.js --exit --timeout 60000",
     "test": "npm run test:package && npm run test:unit"
   }
-}
+}