iobroker.faikout 0.0.7 → 0.0.8

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Immanuel
+Copyright (c) 2026 Immanuel <github@freitag.online>
 
 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

@@ -65,6 +65,19 @@ module's **Extra** settings makes it report immediately.
 
 ## Changelog
 
+<!--
+	Placeholder for the next version (at the beginning of the line):
+	### **WORK IN PROGRESS**
+-->
+
+### 0.0.8
+- Object structure fixed for the repository check: all datapoint names now in eleven languages
+  (`lib/namen.js`), invalid roles corrected (`info` → `info.name`/`info.address`/`text`,
+  `level.mode.*` → `state`), instance objects translated as well. New test `test/namen.js`.
+- Shared `@iobroker/eslint-config` and `@alcalzone/release-script` adopted, older changelog
+  entries moved to `CHANGELOG_OLD.md`, `.vscode/settings.json` added, contact address in the
+  copyright line.
+
 ### 0.0.7
 - Maintenance release: `@iobroker/adapter-core` 3.4.3 and `@iobroker/testing` 6.2.1, tests also on
   Node.js 26, `testing-action-check` v2, admin translations in the short format
@@ -80,27 +93,7 @@ module's **Extra** settings makes it report immediately.
   `common.main`, fixed responsive column widths, and translated the admin texts into the nine
   remaining languages.
 
-### 0.0.4
-- Fix: the admin rejected the whole configuration with "invalid jsonConfig". `instance` fields
-  do not allow `visible` (their schema sets `additionalProperties: false`); the condition
-  belongs in `hidden`. The configuration is now validated against the official schema.
-
-### 0.0.3
-- Fix: consumption tracking crashed on every meter reading after updating from 0.0.1
-  ("Cannot read properties of undefined") because the stored state predates the day and month
-  buffers. Stored state is merged into a fresh default now.
-- Fix: with no month recorded yet, the month rollover booked the whole meter reading as last
-  month's consumption (3783 kWh instead of the difference).
-- `npm test` only ran the package checks; the unit tests now run with it.
-
-### 0.0.2
-- New VIS widget **Energy history**: bar chart switchable between day, month and year, with
-  cooling and heating shown separately.
-- Consumption now also covers the current and previous month, and keeps three series ready for
-  charting: `stundenJson` (48 hours), `tageJson` (62 days) and `monateJson` (24 months).
-
-### 0.0.1
-- Initial version: own MQTT broker, dynamically created data points, writable controls.
+[Older changelog entries can be found here](CHANGELOG_OLD.md)
 
 ## Trademark and relationship to the hardware project
 
@@ -118,7 +111,7 @@ the protocol prescribes. The hardware project is licensed under the GPL, this ad
 
 MIT License
 
-Copyright (c) 2026 Immanuel
+Copyright (c) 2026 Immanuel <github@freitag.online>
 
 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/io-package.json

@@ -1,7 +1,7 @@
 {
   "common": {
     "name": "faikout",
-    "version": "0.0.7",
+    "version": "0.0.8",
     "titleLang": {
       "en": "Faikout",
       "de": "Faikout",
@@ -68,6 +68,19 @@
       }
     ],
     "news": {
+      "0.0.8": {
+        "en": "Object structure fixed for the repository check: all datapoint names in eleven languages, invalid roles corrected (info, level.mode.*). Shared ESLint config and release script adopted.",
+        "de": "Objektstruktur für die Repository-Prüfung berichtigt: alle Datenpunktnamen in elf Sprachen, ungültige Rollen korrigiert (info, level.mode.*). Gemeinsame ESLint-Konfiguration und Release-Skript übernommen.",
+        "ru": "Структура объектов исправлена для проверки репозитория: все имена точек данных на одиннадцати языках, исправлены недопустимые роли (info, level.mode.*). Внедрены общая конфигурация ESLint и скрипт выпуска.",
+        "pt": "Estrutura de objetos corrigida para a verificação do repositório: todos os nomes de pontos de dados em onze idiomas, funções inválidas corrigidas (info, level.mode.*). Adotada a configuração ESLint partilhada e o script de lançamento.",
+        "nl": "Objectstructuur gecorrigeerd voor de repositorycontrole: alle datapuntnamen in elf talen, ongeldige rollen gecorrigeerd (info, level.mode.*). Gedeelde ESLint-configuratie en releasescript overgenomen.",
+        "fr": "Structure des objets corrigée pour la vérification du dépôt : tous les noms de points de données en onze langues, rôles invalides corrigés (info, level.mode.*). Configuration ESLint partagée et script de publication adoptés.",
+        "it": "Struttura degli oggetti corretta per il controllo del repository: tutti i nomi dei punti dati in undici lingue, ruoli non validi corretti (info, level.mode.*). Adottati la configurazione ESLint condivisa e lo script di rilascio.",
+        "es": "Estructura de objetos corregida para la comprobación del repositorio: todos los nombres de puntos de datos en once idiomas, roles no válidos corregidos (info, level.mode.*). Adoptada la configuración ESLint compartida y el script de publicación.",
+        "pl": "Poprawiono strukturę obiektów na potrzeby kontroli repozytorium: wszystkie nazwy punktów danych w jedenastu językach, poprawiono nieprawidłowe role (info, level.mode.*). Przyjęto wspólną konfigurację ESLint i skrypt wydania.",
+        "uk": "Структуру об'єктів виправлено для перевірки репозиторію: усі назви точок даних одинадцятьма мовами, виправлено недійсні ролі (info, level.mode.*). Запроваджено спільну конфігурацію ESLint і скрипт випуску.",
+        "zh-cn": "为仓库检查修正了对象结构：所有数据点名称提供十一种语言，更正了无效角色（info、level.mode.*）。采用共享 ESLint 配置和发布脚本。"
+      },
       "0.0.7": {
         "en": "Maintenance release: dependencies updated, tests now also run on Node.js 26, admin translations moved to the short file format. Published through GitHub Actions with provenance.",
         "de": "Wartungsversion: Abhängigkeiten aktualisiert, Tests laufen jetzt auch unter Node.js 26, Admin-Übersetzungen ins kurze Dateiformat umgestellt. Veröffentlicht über GitHub Actions mit Provenance.",
@@ -134,7 +147,16 @@
       "common": {
         "name": {
           "en": "Information",
-          "de": "Informationen"
+          "de": "Informationen",
+          "ru": "Информация",
+          "pt": "Informação",
+          "nl": "Informatie",
+          "fr": "Informations",
+          "it": "Informazioni",
+          "es": "Información",
+          "pl": "Informacje",
+          "uk": "Інформація",
+          "zh-cn": "信息"
         }
       },
       "native": {}
@@ -146,7 +168,16 @@
         "role": "indicator.connected",
         "name": {
           "en": "At least one faikout module connected",
-          "de": "Mindestens ein faikout-Modul verbunden"
+          "de": "Mindestens ein faikout-Modul verbunden",
+          "ru": "Подключён хотя бы один модуль faikout",
+          "pt": "Pelo menos um módulo faikout ligado",
+          "nl": "Ten minste één faikout-module verbonden",
+          "fr": "Au moins un module faikout connecté",
+          "it": "Almeno un modulo faikout connesso",
+          "es": "Al menos un módulo faikout conectado",
+          "pl": "Co najmniej jeden moduł faikout połączony",
+          "uk": "Підключено щонайменше один модуль faikout",
+          "zh-cn": "至少已连接一个 faikout 模块"
         },
         "type": "boolean",
         "read": true,

package/lib/broker.js

@@ -12,15 +12,18 @@ const net = require('node:net');
 // aedes 1.x exportiert die Klasse benannt; der Aufruf als Funktion (aedes(...)) faellt weg.
 const { Aedes } = require('aedes');
 
+/**
+ * Der MQTT-Broker, mit dem sich die faikout-Module verbinden.
+ */
 class FaikoutBroker {
     /**
-     * @param {object} opts
+     * @param {object} opts              Einstellungen des Brokers
      * @param {number} opts.port          Port, auf dem gelauscht wird
      * @param {string} [opts.user]        Optionaler Benutzername; leer = keine Anmeldung noetig
      * @param {string} [opts.pass]        Passwort dazu
      * @param {object} opts.log           Logger des Adapters
-     * @param {(topic:string, payload:Buffer)=>void} opts.onMessage
-     * @param {(clientId:string, verbunden:boolean)=>void} [opts.onClient]
+     * @param {(topic:string, payload:Buffer)=>void} opts.onMessage  je eingehender Nachricht
+     * @param {(clientId:string, verbunden:boolean)=>void} [opts.onClient]  bei An- und Abmeldung eines Moduls
      */
     constructor(opts) {
         this.port = opts.port;
@@ -33,6 +36,11 @@ class FaikoutBroker {
         this.server = null;
     }
 
+    /**
+     * Den Broker starten und auf dem eingestellten Port lauschen.
+     *
+     * @returns {Promise<void>} erfuellt, sobald der Port angenommen wird
+     */
     async start() {
         // aedes 1.x wird ueber eine asynchrone Fabrik erzeugt. Ein blosses `new Aedes()`
         // liefert zwar eine Instanz, deren `handle` aber nie antwortet - der Client laeuft
@@ -43,7 +51,9 @@ class FaikoutBroker {
             // Ohne Benutzer bleibt der Broker offen - im eigenen LAN der uebliche Fall, und
             // die faikout-Module koennen ohne Anmeldung senden.
             authenticate: (client, username, password, done) => {
-                if (!this.user) return done(null, true);
+                if (!this.user) {
+                    return done(null, true);
+                }
                 const u = username ? String(username) : '';
                 const p = password ? password.toString() : '';
                 if (u !== this.user || p !== this.pass) {
@@ -70,7 +80,9 @@ class FaikoutBroker {
             });
             this.broker.on('publish', (packet, client) => {
                 // Ohne client sind es die internen $SYS-Nachrichten des Brokers.
-                if (!client || !packet || !packet.topic) return;
+                if (!client || !packet || !packet.topic) {
+                    return;
+                }
                 try {
                     this.onMessage(packet.topic, packet.payload);
                 } catch (e) {
@@ -92,20 +104,35 @@ class FaikoutBroker {
         });
     }
 
-    /** Veroeffentlicht ein Kommando an ein Geraet. */
+    /**
+     * Veroeffentlicht ein Kommando an ein Geraet.
+     *
+     * @param {string} topic   Zieltopic des Moduls
+     * @param {string|Buffer} payload  Nutzlast
+     * @returns {Promise<void>} erfuellt, sobald der Broker die Nachricht angenommen hat
+     */
     publish(topic, payload) {
         return new Promise(resolve => {
-            if (!this.broker) return resolve(false);
+            if (!this.broker) {
+                return resolve(false);
+            }
             this.broker.publish(
                 { topic, payload: Buffer.from(String(payload)), qos: 0, retain: false, cmd: 'publish' },
                 err => {
-                    if (err) this.log.warn(`Senden an "${topic}" fehlgeschlagen: ${err.message}`);
+                    if (err) {
+                        this.log.warn(`Senden an "${topic}" fehlgeschlagen: ${err.message}`);
+                    }
                     resolve(!err);
                 },
             );
         });
     }
 
+    /**
+     * Den Broker beenden und alle Verbindungen schliessen.
+     *
+     * @returns {Promise<void>} erfuellt, wenn der Port wieder frei ist
+     */
     stop() {
         return new Promise(resolve => {
             const fertig = () => {