iobroker.assistant 1.4.3 → 1.4.5

package/build/main.js

@@ -162,6 +162,10 @@ function valuesMatch(actual, expected) {
     }
     return String(actual).trim().toLowerCase() === String(expected).trim().toLowerCase();
 }
+/** Whether an ESPHome entity id can be the last part of an ioBroker id (empty ones came from ESPHome 2026). */
+function isControlId(objectId) {
+    return !!objectId && !/[^\p{Ll}\p{Lu}\p{Nd}_-]/u.test(objectId);
+}
 /**
  * ioBroker role for a measurement, derived from its unit — a `value.temperature` shows up with the right
  * icon and in the right place in vis, where a bare `value` is just a number.
@@ -334,6 +338,8 @@ class Assistant extends adapter_core_1.Adapter {
     satControlsReady = new Map();
     /** Satellites whose `volume` state exists and is subscribed (see updateSatelliteVolume). */
     satVolumeEnsured = new Set();
+    /** ESPHome satellite id → the table address already written to its object (see markEsphomeSatellite). */
+    satEsphomeMarked = new Map();
     /** Native (ioBroker) satellite state-id → sender instance id, so we can push announcements back to it. */
     nativeSatFrom = new Map();
     /** Countdown timers / reminders (roadmap #2); mirrored into `timers.*` states. Null until onReady. */
@@ -588,6 +594,8 @@ class Assistant extends adapter_core_1.Adapter {
     async startEsphome(llmKey) {
         const cfg = this.config;
         const devices = (cfg.esphomeDevices || []).filter(d => d?.ip?.trim());
+        // Rows deleted from the table leave their satellite objects behind otherwise — forever offline in the list.
+        await this.removeStaleEsphomeSatellites(devices).catch(e => this.log.warn(`Could not clean up removed ESPHome satellites: ${e.message}`));
         if (!devices.length) {
             this.log.warn('ESPHome satellites are enabled, but no device is configured.');
             return;
@@ -643,9 +651,12 @@ class Assistant extends adapter_core_1.Adapter {
             mediaHost: (cfg.esphomeMediaHost || '').trim(),
             silenceMs: cfg.esphomeSilenceMs || 0,
             log: this.log,
-            onStatus: (device, room, state) => {
-                this.updateSatelliteState(device, room, state).catch(e => this.log.debug(`satellite state update failed: ${e.message}`));
+            onStatus: (device, room, state, address) => {
+                this.updateSatelliteState(device, room, state)
+                    .then(() => this.markEsphomeSatellite(device, room, address))
+                    .catch(e => this.log.debug(`satellite state update failed: ${e.message}`));
             },
+            encodeAudio: (pcm, sampleRate, target) => this.runFfmpegEncode(pcm, sampleRate, target),
             onWakeWords: (device, room, config) => {
                 this.updateSatelliteWakeWords(device, room, config).catch(e => this.log.debug(`satellite wake word update failed: ${e.message}`));
             },
@@ -1100,6 +1111,93 @@ class Assistant extends adapter_core_1.Adapter {
         this.satDeviceById.set(id, device);
         return id;
     }
+    /**
+     * Note which table row an ESPHome satellite belongs to (`native.esphome` on `satellites.<id>`) and show its
+     * address in the host column. That is what lets {@link removeStaleEsphomeSatellites} remove it once the row is
+     * deleted — the id alone is the room or the device name and says nothing about the configuration.
+     */
+    async markEsphomeSatellite(device, room, address) {
+        const id = await this.ensureSatelliteObjects(device, room);
+        if (this.satEsphomeMarked.get(id) === address) {
+            return;
+        }
+        this.satEsphomeMarked.set(id, address);
+        const obj = await this.getObjectAsync(`satellites.${id}`);
+        if (obj?.native?.esphome !== address) {
+            await this.extendObjectAsync(`satellites.${id}`, { native: { esphome: address } });
+        }
+        await this.setStateAsync(`satellites.${id}.host`, { val: address, ack: true });
+    }
+    /**
+     * Remove the objects of ESPHome satellites whose row was deleted from the table (or whose room changed, which
+     * changes the id). Runs before the devices connect, so nothing is re-created meanwhile.
+     *
+     * A satellite marked by {@link markEsphomeSatellite} is matched by its address. One from an older version
+     * carries no mark; it is recognised by `wakeWords` (only ESPHome satellites have it) and removed only when
+     * every row has a room — otherwise a row without one could be it, under its device name.
+     */
+    async removeStaleEsphomeSatellites(devices) {
+        const expected = new Map(devices.map(d => [(0, esphome_1.esphomeAddress)(d), d.room?.trim() ? this.satelliteStateId('', d.room) : null]));
+        const allHaveRooms = [...expected.values()].every(id => id !== null);
+        const roomIds = new Set([...expected.values()].filter((id) => !!id));
+        const prefix = `${this.namespace}.satellites.`;
+        const view = await this.getObjectViewAsync('system', 'device', {
+            startkey: prefix,
+            endkey: `${prefix}香`,
+        });
+        for (const row of view.rows) {
+            const id = row.id.slice(prefix.length);
+            if (!id || id.includes('.')) {
+                continue;
+            }
+            const address = row.value?.native?.esphome;
+            let reason = '';
+            if (address) {
+                if (!expected.has(address)) {
+                    reason = `${address} is no longer in the ESPHome satellites table`;
+                }
+                else {
+                    const want = expected.get(address);
+                    if (want && want !== id) {
+                        reason = `${address} is now in room ${want}`;
+                    }
+                }
+            }
+            else if (allHaveRooms && !roomIds.has(id) && (await this.getObjectAsync(`satellites.${id}.wakeWords`))) {
+                reason = 'no row of the ESPHome satellites table has this room any more';
+            }
+            if (reason) {
+                this.log.info(`Satellite ${id} removed: ${reason}`);
+                await this.forgetSatellite(id);
+            }
+        }
+    }
+    /** Delete a satellite's objects (Satellites tab). Refused while it is online: it would be re-created at once. */
+    async deleteSatellite(id) {
+        if (!id || /[^\w-]/.test(id)) {
+            throw new Error(`invalid satellite id "${id}"`);
+        }
+        if (!(await this.getObjectAsync(`satellites.${id}`))) {
+            throw new Error(`no satellite ${id}`);
+        }
+        const alive = await this.getStateAsync(`satellites.${id}.alive`);
+        if (alive?.val === true) {
+            throw new Error(`satellite ${id} is online`);
+        }
+        await this.forgetSatellite(id);
+        this.log.info(`Satellite ${id} deleted`);
+    }
+    /** Drop the object tree of one satellite and everything cached about it. */
+    async forgetSatellite(id) {
+        await this.delObjectAsync(`satellites.${id}`, { recursive: true });
+        this.satStatesEnsured.delete(id);
+        this.satWakeWordStatesEnsured.delete(id);
+        this.satVolumeEnsured.delete(id);
+        this.satControlsReady.delete(id);
+        this.satEsphomeMarked.delete(id);
+        this.satDeviceById.delete(id);
+        this.dndById.delete(id);
+    }
     /**
      * Publish a satellite's wake-word configuration and let it be changed from ioBroker.
      *
@@ -1303,6 +1401,10 @@ class Assistant extends adapter_core_1.Adapter {
             native: {},
         });
         for (const entity of entities) {
+            if (!isControlId(entity.objectId)) {
+                this.log.debug(`Satellite ${device}: no usable id for "${entity.name}" (${entity.kind}) — skipped`);
+                continue;
+            }
             const id = `${base}.${entity.objectId}`;
             const name = entity.name || entity.objectId;
             if (entity.kind === 'mediaPlayer') {
@@ -1439,6 +1541,9 @@ class Assistant extends adapter_core_1.Adapter {
     }
     /** Write one entity's current value into its state(s). Always acked — this is the device talking. */
     async writeSatelliteControl(satId, entity) {
+        if (!isControlId(entity.objectId)) {
+            return; // never created (see buildSatelliteControls)
+        }
         const base = `satellites.${satId}.controls.${entity.objectId}`;
         if (entity.kind === 'mediaPlayer') {
             const v = entity.value;
@@ -1904,7 +2009,35 @@ class Assistant extends adapter_core_1.Adapter {
             }
         });
     }
-    /** Invalidate the cached device/room/function listings when a room/function enum changes. */
+    /**
+     * Encode mono 16-bit PCM as MP3 or Opus (Ogg) via ffmpeg — for an ESPHome media player that was built with
+     * nothing but that decoder. FLAC and WAV need no tool and are written in `replyFormat.ts`.
+     */
+    runFfmpegEncode(pcm, sampleRate, target) {
+        return new Promise((resolve, reject) => {
+            // prettier-ignore
+            const input = ['-hide_banner', '-loglevel', 'error', '-f', 's16le', '-ar', String(sampleRate), '-ac', '1', '-i', 'pipe:0'];
+            // prettier-ignore
+            const output = target.codec === 'mp3'
+                ? ['-c:a', 'libmp3lame', '-b:a', '128k', '-f', 'mp3']
+                : ['-c:a', 'libopus', '-b:a', '64k', '-f', 'ogg'];
+            // Opus runs at 48/24/16/12/8 kHz only; anything else would make libopus refuse.
+            const rate = target.codec === 'opus' && ![48000, 24000, 16000, 12000, 8000].includes(target.sampleRate)
+                ? 48000
+                : target.sampleRate;
+            const args = [...input, '-ar', String(rate), '-ac', String(target.channels), ...output, '-'];
+            const proc = (0, node_child_process_1.spawn)('ffmpeg', args);
+            const chunks = [];
+            proc.stdout.on('data', (d) => chunks.push(d));
+            proc.stderr.on('data', (d) => this.log.debug(`ffmpeg: ${String(d).trim()}`));
+            proc.on('error', e => reject(new Error(`ffmpeg failed: ${e.message}`)));
+            proc.on('close', code => code === 0 && chunks.length
+                ? resolve(Buffer.concat(chunks))
+                : reject(new Error(`ffmpeg exited with code ${code}`)));
+            proc.stdin.on('error', () => { }); // ignore EPIPE if ffmpeg exits early
+            proc.stdin.end(pcm);
+        });
+    }
     /** Vendor and key of the cloud LLM: speech of the same vendor (OpenAI, OpenRouter) reuses the key. */
     async speechLlmKey() {
         const provider = this.config.provider || 'openai';
@@ -2509,6 +2642,23 @@ class Assistant extends adapter_core_1.Adapter {
             }
             return;
         }
+        // Satellites tab: forget a satellite that is gone. message = { id } (the state id under `satellites.`).
+        if (obj.command === 'deleteSatellite') {
+            const raw = obj.message?.id;
+            const id = typeof raw === 'string' ? raw : '';
+            let payload;
+            try {
+                await this.deleteSatellite(id);
+                payload = { ok: true };
+            }
+            catch (e) {
+                payload = { error: e.message };
+            }
+            if (obj.callback) {
+                this.sendTo(obj.from, obj.command, payload, obj.callback);
+            }
+            return;
+        }
         // Scripts: silence a ringing timer/alarm.
         if (obj.command === 'stopRinging') {
             const n = this.stopRinging();