feat: Add basic support for outlets

Author: fox34

.gitignore

@@ -47,3 +47,4 @@ jspm_packages/
 
 # Test configuration
 /test/hbConfig
+/src/discoverDevices.ts

README.md

@@ -22,11 +22,12 @@ This plugin currently focuses on **stability and simplicity** rather than featur
 
 Currently, this plugin supports the following devices and actions within the **FRITZ!** ecosystem:
 
-| Device                                    | Supported actions                                                                               |
-|-------------------------------------------|-------------------------------------------------------------------------------------------------|
-| **Thermostats**<br>(e.g. FRITZ!DECT 301)  | - Power toggle<br>- Change target temperature<br>- Temperature reporting<br>- Recall templates  |
+| Device                                     | Supported actions                                                                               |
+|--------------------------------------------|-------------------------------------------------------------------------------------------------|
+| **Thermostats**<br>(e.g. FRITZ!DECT 301)   | - Temperature reporting<br>- Change target temperature<br>- Recall templates  |
+| **Outlets**<br>(e.g. FRITZ!DECT 200 / 210) | - Power toggle<br>- Temperature reporting                                                    |
 
-> Other FRITZ! SmartHome devices (e.g., plugs or lights) are not yet supported.  
+> Other FRITZ! SmartHome devices (e.g. window sensors or lights) are not yet supported.  
 > Contributions are welcome if you wish to extend functionality.
 > See below for further information.
 
@@ -104,7 +105,6 @@ Some examples of possible devices and features are:
 | **FRITZ!Box**, FRITZ!Repeater             | - Toggle guest WLAN                                                                          |
 | **Buttons**<br>(e.g. FRITZ!DECT 400, 440) | - Temperature and humidity reporting<br>- *Note*: Button presses cannot be detected reliably |
 | **Lights**<br>(e.g. FRITZ!DECT 500)       | - Power toggle<br>- Change brightness / color<br>- Support for adaptive lighting             |
-| **Outlets**<br>(e.g. FRITZ!DECT 200)      | - Power toggle<br>- Temperature reporting                                                    |
 | **Sensors**<br>(e.g. FRITZ!DECT 350)      | - Window state reporting                                                                     |
 
 ---

package.json

@@ -2,7 +2,7 @@
   "name": "homebridge-fritz-light",
   "displayName": "Homebridge FRITZ! Light",
   "type": "module",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Homebridge integration for the FRITZ! ecosystem",
   "author": "fox34",
   "license": "Apache-2.0",

src/accessories/switch.ts

@@ -0,0 +1,45 @@
+import type { CharacteristicValue, PlatformAccessory } from 'homebridge';
+import type { FritzLight } from '../platform.js';
+import { Switch as FritzSwitch } from '../fritzbox/accessories/switch.js';
+import { HomebridgeAccessory } from 'fritz-light';
+
+export class Switch implements HomebridgeAccessory {
+    constructor(platform: FritzLight, accessory: PlatformAccessory, device: FritzSwitch) {
+
+        // Set basic accessory information
+        accessory.getService(platform.Service.AccessoryInformation)!
+            .setCharacteristic(platform.Characteristic.Manufacturer, device.manufacturer)
+            .setCharacteristic(platform.Characteristic.Model, device.productName)
+            .setCharacteristic(platform.Characteristic.SerialNumber, device.ain)
+            .setCharacteristic(platform.Characteristic.FirmwareRevision, device.firmwareVersion)
+        ;
+
+        // Create switch service
+        const switchService = accessory.getService(platform.Service.Switch) || accessory.addService(platform.Service.Switch);
+
+        // Set the service name, this is what is displayed as the default name on the Home app
+        switchService.setCharacteristic(platform.Characteristic.Name, device.name);
+
+        // Implement required characteristics
+        switchService.getCharacteristic(platform.Characteristic.On)
+            .onGet(() => device.on)
+            .onSet(async (value: CharacteristicValue) => {
+                platform.log.info(`Setting target state for ${device.name} to ${value}`);
+                await device.setState(<boolean>value);
+            })
+            .updateValue(device.on)
+        ;
+
+        // Optional: temperature sensor
+        if (device.currentTemperature !== undefined) {
+            const temperatureSensorService = accessory.getService(platform.Service.TemperatureSensor) ||
+                accessory.addService(platform.Service.TemperatureSensor);
+
+            temperatureSensorService.setCharacteristic(platform.Characteristic.Name, `${device.name} Temperature`);
+            temperatureSensorService.getCharacteristic(platform.Characteristic.CurrentTemperature)
+                .onGet(() => <number>device.currentTemperature)
+                .updateValue(<number>device.currentTemperature)
+            ;
+        }
+    }
+}

src/fritzbox/accessories/switch.ts

@@ -0,0 +1,59 @@
+import type { HomebridgeAccessory } from 'fritz-light';
+import type { FritzBox } from '../fritzbox.js';
+import { Switch as HomebridgeSwitch } from '../../accessories/switch.js';
+import type { PlatformAccessory } from 'homebridge';
+import type { FritzLight } from '../../platform.js';
+import { objectsEqualShallow } from '../../utils/utils.js';
+import { FritzAccessory } from '../smarthome.js';
+
+type SwitchState = {
+    name: string;
+    firmwareVersion: string;
+    on: boolean;
+    currentTemperature: number | undefined;
+}
+
+export class Switch implements FritzAccessory {
+    constructor(
+        private fritzbox: FritzBox,
+        public ain: string,
+        public manufacturer: string,
+        public productName: string,
+        private _state: SwitchState,
+    ) {
+    }
+
+    createHomebridgeAccessoryHandler(platform: FritzLight, accessory: PlatformAccessory): HomebridgeAccessory {
+        return new HomebridgeSwitch(platform, accessory, this);
+    }
+
+    set state(state: SwitchState) {
+        // Nothing changed
+        if (objectsEqualShallow(state, this._state)) {
+            return;
+        }
+
+        this._state = state;
+    }
+
+    get name() {
+        return this._state.name;
+    }
+
+    get firmwareVersion() {
+        return this._state.firmwareVersion;
+    }
+
+    get on() {
+        return this._state.on;
+    }
+
+    async setState(on: boolean) {
+        const url = `webservices/homeautoswitch.lua?switchcmd=setswitch${on ? 'on' : 'off'}&ain=${this.ain}`;
+        await this.fritzbox.getAHA(url);
+    }
+
+    get currentTemperature(): number | undefined {
+        return this._state.currentTemperature;
+    }
+}

src/fritzbox/smarthome.ts

@@ -3,12 +3,14 @@ import { HomebridgeAccessory } from 'fritz-light';
 import type { FritzBox } from './fritzbox.js';
 import { XMLClient } from './XMLClient.js';
 import { Template } from './accessories/template.js';
+import { Switch } from './accessories/switch.js';
 import { Thermostat } from './accessories/thermostat.js';
 import { PlatformAccessory, PlatformConfig } from 'homebridge';
 import { FritzLight } from '../platform.js';
 
 // Supported accessory types
 enum AccessoryType {
+    Switch = 'switch',
     Thermostat = 'thermostat', // "hkr" = "Heizkörperregler"
 }
 
@@ -44,7 +46,7 @@ export interface FritzAccessory {
 }
 
 export class SmartHome {
-    private devices: Map<string, FritzAccessory & (Template | Thermostat)> = new Map();
+    private devices: Map<string, FritzAccessory & (Switch | Template | Thermostat)> = new Map();
 
     /**
      * @link https://fritz.support/resources/AHA-HTTP-Interface.pdf
@@ -54,7 +56,7 @@ export class SmartHome {
     /**
      * Get list of currently registered devices, update existing instances
      */
-    public async getDevices(config: PlatformConfig): Promise<(FritzAccessory & (Template | Thermostat))[]> {
+    public async getDevices(config: PlatformConfig): Promise<(FritzAccessory & (Switch | Template | Thermostat))[]> {
         await this.fritzbox.init();
         const sid = await this.fritzbox.getSid();
 
@@ -92,10 +94,16 @@ export class SmartHome {
         ];
     }
 
-    private getDeviceFromApi(device: AHADevice): FritzAccessory & Thermostat {
+    private getDeviceFromApi(device: AHADevice): FritzAccessory & (Switch | Thermostat) {
         // Nothing else implemented yet
-        //switch (this.getDeviceType(device)) { ... }
-        return this.getThermostat(device);
+        switch (this.getDeviceType(device)) {
+        case AccessoryType.Switch:
+            return this.getSwitch(device);
+        case AccessoryType.Thermostat:
+            return this.getThermostat(device);
+        }
+        
+        throw new Error(`Unknown device type: ${this.getDeviceType(device)}`);
     }
 
     private getTemplate(apiTemplate: AHATemplate): Template {
@@ -112,6 +120,33 @@ export class SmartHome {
         }
         return template;
     }
+    
+    private getSwitch(device: AHADevice): Switch {
+        const state = {
+            name: device.name,
+            firmwareVersion: device['@_fwversion'],
+            on: <boolean>(device.switch?.state || device.simpleonoff?.state || false),
+            currentTemperature: device.temperature ? device.temperature.celsius / 10 : undefined,
+        };
+
+        let switchDevice: Switch;
+        if (this.devices.has(device['@_identifier'])) {
+            // Update device state
+            switchDevice = <Switch>this.devices.get(device['@_identifier']);
+            switchDevice.state = state;
+
+        } else {
+            switchDevice = new Switch(
+                this.fritzbox,
+                device['@_identifier'],
+                device['@_manufacturer'],
+                device['@_productname'],
+                state,
+            );
+            this.devices.set(switchDevice.ain, switchDevice);
+        }
+        return switchDevice;
+    }
 
     private getThermostat(device: AHADevice): Thermostat {
         if (!device.hkr) {
@@ -152,6 +187,13 @@ export class SmartHome {
             return AccessoryType.Thermostat;
         }
 
+        if (
+            ((device['@_functionbitmask'] & AHAFunctionBitmask.Outlet) > 0 && device.switch) ||
+            ((device['@_functionbitmask'] & AHAFunctionBitmask.OnOff) > 0 && device.simpleonoff)
+        ) {
+            return AccessoryType.Switch;
+        }
+
         // Not implemented
         return undefined;
     }