homebridge-bose-soundtouch 1.8.0

package/.eslintrc.json

@@ -0,0 +1,26 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "sourceType": "module"
+  },
+  "rules": {
+    "quotes": ["warn", "single"],
+    "indent": ["warn", 2, { "SwitchCase": 1 }],
+    "semi": ["error", "always"],
+    "comma-dangle": ["warn", "always-multiline"],
+    "dot-notation": "off",
+    "eqeqeq": "warn",
+    "curly": ["warn", "all"],
+    "brace-style": ["warn"],
+    "prefer-arrow-callback": ["warn"],
+    "max-len": ["warn", 140],
+    "no-console": ["warn"],
+    "@typescript-eslint/no-non-null-assertion": "off"
+  }
+}

package/README.md

@@ -0,0 +1,195 @@
+# Homebridge Bose SoundTouch
+
+Ein Homebridge Plugin zur Steuerung von Bose SoundTouch Lautsprechern via Apple HomeKit.
+
+## Features
+
+- **Automatische Erkennung** - Findet SoundTouch-Geräte automatisch im Netzwerk via mDNS
+- **Lautstärkesteuerung** - Regeln der Lautstärke über HomeKit
+- **Wiedergabesteuerung** - Play, Pause, Stop, Nächster/Vorheriger Track
+- **Presets/Favoriten** - Schnellzugriff auf gespeicherte Sender als Schalter
+- **Stummschaltung** - Mute-Funktion
+- **Echtzeit-Updates** - WebSocket-Verbindung für sofortige Statusänderungen
+- **Multi-Room** - Unterstützung für mehrere Geräte
+
+## Installation
+
+### Über Homebridge UI
+
+1. Suche nach `homebridge-bose-soundtouch` in der Plugin-Suche
+2. Klicke auf "Installieren"
+
+### Manuell via npm
+
+```bash
+npm install -g homebridge-bose-soundtouch
+```
+
+### Aus dem Quellcode
+
+```bash
+cd homebridge-bose-soundtouch
+npm install
+npm run build
+npm link
+```
+
+## Konfiguration
+
+### Minimale Konfiguration (Auto-Discovery)
+
+```json
+{
+  "platforms": [
+    {
+      "platform": "BoseSoundTouch",
+      "name": "Bose SoundTouch"
+    }
+  ]
+}
+```
+
+### Vollständige Konfiguration
+
+```json
+{
+  "platforms": [
+    {
+      "platform": "BoseSoundTouch",
+      "name": "Bose SoundTouch",
+      "autoDiscover": true,
+      "discoveryTimeout": 10000,
+      "enableSmartSpeaker": true,
+      "volumeAsLightbulb": false,
+      "enablePresets": true,
+      "devices": [
+        {
+          "name": "Wohnzimmer Speaker",
+          "host": "192.168.1.100",
+          "room": "Wohnzimmer"
+        },
+        {
+          "name": "Schlafzimmer Speaker",
+          "host": "192.168.1.101",
+          "room": "Schlafzimmer"
+        }
+      ]
+    }
+  ]
+}
+```
+
+### Konfigurationsoptionen
+
+| Option | Typ | Standard | Beschreibung |
+|--------|-----|----------|--------------|
+| `platform` | string | **Pflicht** | Muss `"BoseSoundTouch"` sein |
+| `name` | string | **Pflicht** | Name der Plattform |
+| `autoDiscover` | boolean | `true` | Automatische Geräteerkennung |
+| `discoveryTimeout` | number | `10000` | Timeout für Discovery in ms |
+| `enableSmartSpeaker` | boolean | `true` | SmartSpeaker-Service aktivieren |
+| `volumeAsLightbulb` | boolean | `false` | Lautstärke als Lampe darstellen (besserer Slider) |
+| `enablePresets` | boolean | `true` | Preset-Schalter aktivieren |
+| `devices` | array | `[]` | Manuell konfigurierte Geräte |
+
+### Geräte-Konfiguration
+
+| Option | Typ | Beschreibung |
+|--------|-----|--------------|
+| `name` | string | Anzeigename des Geräts |
+| `host` | string | IP-Adresse des SoundTouch-Geräts |
+| `room` | string | Raum-Zuordnung (optional) |
+
+## HomeKit-Funktionen
+
+### Speaker Service
+- **Mute** - Stummschaltung ein/aus
+- **Volume** - Lautstärke (0-100%)
+
+### Smart Speaker Service (optional)
+- **CurrentMediaState** - Aktueller Status (Play/Pause/Stop)
+- **TargetMediaState** - Wiedergabe steuern
+- **Volume** - Lautstärke
+- **Mute** - Stummschaltung
+
+### Lightbulb Service (optional)
+- **On** - Mute/Unmute
+- **Brightness** - Lautstärke als Slider
+
+### Preset Switches
+- Schalter für jeden gespeicherten Preset (1-6)
+- Momentary-Verhalten (schaltet automatisch aus)
+
+## Unterstützte Geräte
+
+Dieses Plugin funktioniert mit allen Bose SoundTouch-Geräten:
+- SoundTouch 10
+- SoundTouch 20
+- SoundTouch 30
+- SoundTouch 300
+- SoundTouch Portable
+- SoundTouch SA-5 Amplifier
+- Wave SoundTouch
+
+**Hinweis:** Neuere Bose-Geräte (Home Speaker 500, 700, etc.) werden NICHT unterstützt, da sie eine andere API verwenden.
+
+## API-Funktionen
+
+Das Plugin nutzt die vollständige [Bose SoundTouch Web API](https://assets.bosecreative.com/m/496577402d128874/original/SoundTouch-Web-API.pdf):
+
+- `/info` - Geräteinformationen
+- `/now_playing` - Aktuelle Wiedergabe
+- `/volume` - Lautstärke get/set
+- `/key` - Tastendrücke (Play, Pause, etc.)
+- `/presets` - Gespeicherte Favoriten
+- `/sources` - Verfügbare Quellen
+- `/bass` - Bass-Einstellungen
+- `/getZone` / `/setZone` - Multi-Room-Zonen
+- WebSocket auf Port 8080 für Echtzeit-Updates
+
+## Troubleshooting
+
+### Gerät wird nicht gefunden
+
+1. Stelle sicher, dass das SoundTouch-Gerät eingeschaltet ist
+2. Prüfe, ob sich das Gerät im gleichen Netzwerk befindet
+3. Versuche, die IP-Adresse manuell in der Konfiguration anzugeben
+4. Teste die Verbindung: `curl http://IP_ADRESSE:8090/info`
+
+### Keine Steuerung möglich
+
+1. Prüfe die Homebridge-Logs auf Fehler
+2. Starte Homebridge neu
+3. Entferne das Gerät aus HomeKit und füge es erneut hinzu
+
+### WebSocket-Verbindung fehlerhaft
+
+Der WebSocket verbindet sich automatisch erneut. Falls Echtzeit-Updates nicht funktionieren, prüfe ob Port 8080 erreichbar ist.
+
+## Entwicklung
+
+```bash
+# Clone und installieren
+git clone https://github.com/daniel/homebridge-bose-soundtouch.git
+cd homebridge-bose-soundtouch
+npm install
+
+# Build
+npm run build
+
+# Watch mode für Entwicklung
+npm run watch
+
+# Linting
+npm run lint
+```
+
+## Lizenz
+
+MIT
+
+## Credits
+
+- [Bose SoundTouch Web API](https://assets.bosecreative.com/m/496577402d128874/original/SoundTouch-Web-API.pdf)
+- [libsoundtouch](https://github.com/CharlesBlonde/libsoundtouch) - Inspiration für API-Implementierung
+- [bosesoundtouchapi](https://github.com/thlucas1/bosesoundtouchapi) - Referenz für WebSocket-Events

package/config.schema.json

@@ -0,0 +1,247 @@
+{
+  "pluginAlias": "BoseSoundTouch",
+  "pluginType": "platform",
+  "singular": true,
+  "customUi": true,
+  "headerDisplay": "Homebridge Plugin für Bose SoundTouch Lautsprecher - Mit Custom Radio & Streaming Stationen.",
+  "footerDisplay": "Weitere Informationen: [GitHub](https://github.com/Dress13/homebridge-bose-soundtouch)",
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "default": "Bose SoundTouch",
+        "required": true
+      },
+      "autoDiscover": {
+        "title": "Automatische Erkennung",
+        "type": "boolean",
+        "default": true,
+        "description": "SoundTouch-Geräte automatisch im Netzwerk finden"
+      },
+      "discoveryTimeout": {
+        "title": "Discovery Timeout (ms)",
+        "type": "integer",
+        "default": 10000,
+        "minimum": 1000,
+        "maximum": 60000,
+        "description": "Timeout für die automatische Geräteerkennung"
+      },
+      "devices": {
+        "title": "Geräte",
+        "description": "Geräte werden automatisch erkannt. Hier kannst du pro Gerät Icon und Presets konfigurieren.",
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "host": {
+              "title": "IP-Adresse",
+              "type": "string",
+              "required": true,
+              "format": "ipv4",
+              "description": "IP-Adresse des SoundTouch-Geräts"
+            },
+            "name": {
+              "title": "Name",
+              "type": "string",
+              "description": "Anzeigename (optional, wird automatisch vom Gerät gelesen)"
+            },
+            "room": {
+              "title": "Raum",
+              "type": "string",
+              "description": "Raum-Zuordnung (optional)"
+            },
+            "deviceIcon": {
+              "title": "Geräte-Icon",
+              "type": "integer",
+              "default": 26,
+              "oneOf": [
+                { "title": "Speaker (Lautsprecher)", "enum": [26] },
+                { "title": "Audio Receiver", "enum": [34] },
+                { "title": "Television (TV)", "enum": [31] },
+                { "title": "TV Set Top Box", "enum": [35] },
+                { "title": "TV Streaming Stick", "enum": [36] },
+                { "title": "AirPlay Speaker", "enum": [38] },
+                { "title": "HomePod", "enum": [39] },
+                { "title": "Airport", "enum": [27] }
+              ],
+              "description": "Icon für dieses Gerät in der Home App"
+            },
+            "presets": {
+              "title": "Preset-Belegung",
+              "description": "Belege die 6 Preset-Tasten mit eigenen Sendern",
+              "type": "array",
+              "maxItems": 6,
+              "items": {
+                "type": "object",
+                "properties": {
+                  "slot": {
+                    "title": "Preset-Taste",
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 6,
+                    "required": true,
+                    "description": "Welche Preset-Taste (1-6)"
+                  },
+                  "name": {
+                    "title": "Name",
+                    "type": "string",
+                    "required": true,
+                    "description": "Anzeigename in HomeKit"
+                  },
+                  "type": {
+                    "title": "Typ",
+                    "type": "string",
+                    "required": true,
+                    "default": "radio",
+                    "oneOf": [
+                      { "title": "Internet Radio (HTTP Stream)", "enum": ["radio"] },
+                      { "title": "Spotify", "enum": ["spotify"] },
+                      { "title": "Amazon Music", "enum": ["amazon"] },
+                      { "title": "Deezer", "enum": ["deezer"] },
+                      { "title": "TuneIn", "enum": ["tunein"] }
+                    ],
+                    "description": "Art der Quelle"
+                  },
+                  "url": {
+                    "title": "Stream URL",
+                    "type": "string",
+                    "description": "HTTP Stream URL für Radio"
+                  },
+                  "spotifyUri": {
+                    "title": "Spotify URI",
+                    "type": "string",
+                    "description": "Spotify URI (z.B. spotify:playlist:37i9dQZF1DXcBWIGoYBM5M)"
+                  },
+                  "contentId": {
+                    "title": "Content ID",
+                    "type": "string",
+                    "description": "Content ID für TuneIn, Amazon oder Deezer"
+                  },
+                  "sourceAccount": {
+                    "title": "Account",
+                    "type": "string",
+                    "description": "Account-Identifier für Spotify/Amazon/Deezer"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "layout": [
+    "name",
+    {
+      "type": "fieldset",
+      "title": "Automatische Erkennung",
+      "description": "Geräte werden beim Start automatisch im Netzwerk gefunden. Du kannst sie dann hier konfigurieren.",
+      "items": [
+        "autoDiscover",
+        "discoveryTimeout"
+      ]
+    },
+    {
+      "type": "fieldset",
+      "title": "Geräte-Konfiguration",
+      "description": "Füge hier deine SoundTouch-Geräte hinzu (IP-Adresse). Pro Gerät kannst du das Icon und die Preset-Tasten individuell konfigurieren.",
+      "expandable": true,
+      "expanded": true,
+      "items": [
+        {
+          "key": "devices",
+          "type": "array",
+          "buttonText": "Gerät hinzufügen",
+          "items": [
+            {
+              "type": "div",
+              "displayFlex": true,
+              "items": [
+                {
+                  "key": "devices[].host",
+                  "flex": "1 1 150px"
+                },
+                {
+                  "key": "devices[].name",
+                  "flex": "1 1 150px"
+                }
+              ]
+            },
+            {
+              "type": "div",
+              "displayFlex": true,
+              "items": [
+                {
+                  "key": "devices[].room",
+                  "flex": "1 1 150px"
+                },
+                {
+                  "key": "devices[].deviceIcon",
+                  "flex": "1 1 150px"
+                }
+              ]
+            },
+            {
+              "type": "fieldset",
+              "title": "Preset-Tasten belegen",
+              "expandable": true,
+              "items": [
+                {
+                  "key": "devices[].presets",
+                  "type": "array",
+                  "buttonText": "Preset hinzufügen",
+                  "items": [
+                    {
+                      "type": "div",
+                      "displayFlex": true,
+                      "items": [
+                        {
+                          "key": "devices[].presets[].slot",
+                          "flex": "0 0 80px"
+                        },
+                        {
+                          "key": "devices[].presets[].name",
+                          "flex": "1 1 150px"
+                        },
+                        {
+                          "key": "devices[].presets[].type",
+                          "flex": "1 1 150px"
+                        }
+                      ]
+                    },
+                    {
+                      "key": "devices[].presets[].url",
+                      "condition": {
+                        "functionBody": "try { return model.devices[arrayIndices[0]].presets[arrayIndices[1]].type === 'radio'; } catch(e) { return false; }"
+                      }
+                    },
+                    {
+                      "key": "devices[].presets[].spotifyUri",
+                      "condition": {
+                        "functionBody": "try { return model.devices[arrayIndices[0]].presets[arrayIndices[1]].type === 'spotify'; } catch(e) { return false; }"
+                      }
+                    },
+                    {
+                      "key": "devices[].presets[].contentId",
+                      "condition": {
+                        "functionBody": "try { return ['tunein', 'amazon', 'deezer'].includes(model.devices[arrayIndices[0]].presets[arrayIndices[1]].type); } catch(e) { return false; }"
+                      }
+                    },
+                    {
+                      "key": "devices[].presets[].sourceAccount",
+                      "condition": {
+                        "functionBody": "try { return ['spotify', 'amazon', 'deezer'].includes(model.devices[arrayIndices[0]].presets[arrayIndices[1]].type); } catch(e) { return false; }"
+                      }
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/dist/discovery.d.ts

@@ -0,0 +1,20 @@
+export interface DiscoveredDevice {
+    name: string;
+    host: string;
+    port: number;
+    mac?: string;
+}
+export declare class SoundTouchDiscovery {
+    private bonjour;
+    private browser;
+    private devices;
+    private onDeviceFound?;
+    private onDeviceLost?;
+    constructor();
+    start(onDeviceFound?: (device: DiscoveredDevice) => void, onDeviceLost?: (device: DiscoveredDevice) => void): void;
+    stop(): void;
+    private handleServiceUp;
+    private handleServiceDown;
+    getDevices(): DiscoveredDevice[];
+    discoverOnce(timeout?: number): Promise<DiscoveredDevice[]>;
+}

package/dist/discovery.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SoundTouchDiscovery = void 0;
+const bonjour_service_1 = __importDefault(require("bonjour-service"));
+class SoundTouchDiscovery {
+    bonjour;
+    browser = null;
+    devices = new Map();
+    onDeviceFound;
+    onDeviceLost;
+    constructor() {
+        this.bonjour = new bonjour_service_1.default();
+    }
+    start(onDeviceFound, onDeviceLost) {
+        this.onDeviceFound = onDeviceFound;
+        this.onDeviceLost = onDeviceLost;
+        // SoundTouch devices advertise via mDNS as _soundtouch._tcp
+        this.browser = this.bonjour.find({ type: 'soundtouch' }, (service) => {
+            this.handleServiceUp(service);
+        });
+        this.browser.on('down', (service) => {
+            this.handleServiceDown(service);
+        });
+    }
+    stop() {
+        if (this.browser) {
+            this.browser.stop();
+            this.browser = null;
+        }
+        this.bonjour.destroy();
+    }
+    handleServiceUp(service) {
+        if (!service.addresses || service.addresses.length === 0) {
+            return;
+        }
+        // Prefer IPv4 address
+        const host = service.addresses.find((addr) => !addr.includes(':')) || service.addresses[0];
+        const device = {
+            name: service.name,
+            host: host,
+            port: service.port || 8090,
+            mac: service.txt?.['MAC'],
+        };
+        const key = `${device.host}:${device.port}`;
+        if (!this.devices.has(key)) {
+            this.devices.set(key, device);
+            this.onDeviceFound?.(device);
+        }
+    }
+    handleServiceDown(service) {
+        const addresses = service.addresses || [];
+        for (const addr of addresses) {
+            const key = `${addr}:${service.port || 8090}`;
+            const device = this.devices.get(key);
+            if (device) {
+                this.devices.delete(key);
+                this.onDeviceLost?.(device);
+            }
+        }
+    }
+    getDevices() {
+        return Array.from(this.devices.values());
+    }
+    async discoverOnce(timeout = 5000) {
+        return new Promise((resolve) => {
+            const devices = [];
+            const browser = this.bonjour.find({ type: 'soundtouch' }, (service) => {
+                if (!service.addresses || service.addresses.length === 0) {
+                    return;
+                }
+                const host = service.addresses.find((addr) => !addr.includes(':')) || service.addresses[0];
+                const device = {
+                    name: service.name,
+                    host: host,
+                    port: service.port || 8090,
+                    mac: service.txt?.['MAC'],
+                };
+                const exists = devices.some((d) => d.host === device.host && d.port === device.port);
+                if (!exists) {
+                    devices.push(device);
+                }
+            });
+            setTimeout(() => {
+                browser.stop();
+                resolve(devices);
+            }, timeout);
+        });
+    }
+}
+exports.SoundTouchDiscovery = SoundTouchDiscovery;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { API } from 'homebridge';
+/**
+ * This method registers the platform with Homebridge
+ */
+declare const _default: (api: API) => void;
+export = _default;

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+const settings_1 = require("./settings");
+const platform_1 = require("./platform");
+module.exports = (api) => {
+    api.registerPlatform(settings_1.PLATFORM_NAME, platform_1.SoundTouchPlatform);
+};

package/dist/platform.d.ts

@@ -0,0 +1,43 @@
+import { API, DynamicPlatformPlugin, Logger, PlatformAccessory, PlatformConfig, Service, Characteristic } from 'homebridge';
+import { SoundTouchAccessory } from './soundtouchAccessory';
+export interface PresetConfig {
+    slot: number;
+    name: string;
+    type: 'radio' | 'spotify' | 'amazon' | 'deezer' | 'tunein';
+    url?: string;
+    spotifyUri?: string;
+    contentId?: string;
+    sourceAccount?: string;
+}
+export interface DeviceConfig {
+    name?: string;
+    host: string;
+    room?: string;
+    deviceIcon?: number;
+    presets?: PresetConfig[];
+}
+export interface SoundTouchPlatformConfig extends PlatformConfig {
+    devices?: DeviceConfig[];
+    autoDiscover?: boolean;
+    discoveryTimeout?: number;
+}
+export declare class SoundTouchPlatform implements DynamicPlatformPlugin {
+    readonly log: Logger;
+    readonly config: SoundTouchPlatformConfig;
+    readonly api: API;
+    readonly Service: typeof Service;
+    readonly Characteristic: typeof Characteristic;
+    readonly accessories: PlatformAccessory[];
+    private readonly soundTouchAccessories;
+    private readonly externalAccessories;
+    private discovery?;
+    constructor(log: Logger, config: SoundTouchPlatformConfig, api: API);
+    configureAccessory(accessory: PlatformAccessory): void;
+    private discoverDevices;
+    private registerDevice;
+    private cleanup;
+    getAllAccessories(): SoundTouchAccessory[];
+    getAccessoryByHost(host: string): SoundTouchAccessory | undefined;
+    getAccessoryByName(name: string): SoundTouchAccessory | undefined;
+    getDeviceConfig(host: string): DeviceConfig | undefined;
+}