Sort accessories in README alphabetically

README.md

@@ -6,19 +6,20 @@ You need to adapt your `config.json` !
 ## Currently supported accessories
 This plugin currently supports the following services (and characteristics):
 
-| Type                                    | Description                                             | 
+| Type                                     | Description                                             | 
-|:----------------------------------------|:--------------------------------------------------------|
+|:-----------------------------------------|:--------------------------------------------------------|
-| ContactSensor                           | Simple contact sensor, for example for windows          |
+| [ContactSensor](#contact-sensor)         | Simple contact sensor, for example for windows          |
-| [Doorbell](#doorbell)                   | Doorbell, sends message to devices on ring              |
+| [Doorbell](#doorbell)                    | Doorbell, sends message to devices on ring              |
-| [Fan](#fan)                             | Simple on/off fan, may be extended in future            |
+| [Fan](#fan)                              | Simple on/off fan, may be extended in future            |
-| [Lightbulb](#lightbulb)                 | Everything, from simple light to dimmable, RGB and RGBW |
+| [Lightbulb](#lightbulb)                  | Everything, from simple light to dimmable, RGB and RGBW |
-| [MotionSensor](#motionsensor)           | Detects and reports motion                              |
+| [MotionSensor](#motion-sensor)           | Detects and reports motion                              |
-| [OccupancySensor](#occupancysensor)     | Detects presence in a room                              |
+| [OccupancySensor](#occupancy-sensor)     | Detects presence in a room                              |
-| [Outlet](#outlet)                       | Simple on/off wall outlet                               |
+| [Outlet](#outlet)                        | Simple on/off wall outlet                               |
-| [TemperatureSensor](#temperaturesensor) | Temperature sensor                                      |
+| [SecuritySystem](#security-system)       | Intrusion alarm system                                  |
-| [Thermostat](#thermostat)               | Thermostat with temperature sensor and heating state    |
+| [Switch](#switch)                        | Simple on/off switch                                    |
-| [Switch](#switch)                       | Simple on/off switch                                    |
+| [TemperatureSensor](#temperature-sensor) | Temperature sensor                                      |
-| [WindowCovering](#windowcovering)       | Window covering (shutters, blinds, ...)                 |
+| [Thermostat](#thermostat)                | Thermostat with temperature sensor and heating state    |
+| [WindowCovering](#window-covering)       | Window covering (shutters, blinds, ...)                 |
 
 Other accessories are being worked on and will be added as soon as ready.
 
@@ -91,6 +92,25 @@ The following characteristics are valid for all accessories:
     "model": "Motion 360 KNX",
 }
 ```
+
+### Contact sensor
+This sensor shows the open / closed state of a contact (door, window, generic ...).
+
+#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
+| Parameter    | Possible values | Mandatory | Description                      |
+|:-------------|:----------------|:----------|:---------------------------------|
+| ContactState | \<item>         | Yes       | SHNG item to monitor for contact |
+
+
+#### Example:
+```json
+{
+    "type": "ContactSensor",
+    "name": "Window kitchen",
+    "ContactState": "EG.Kueche.Fenster"
+}
+```
+
 ### Doorbell
 A doorbell is an accessory that simply sends a message to all devices enrolled in the home that someone rang the doorbell.
 HomeKit displays a message that "This accessory is not currently supported by the Home app.".
@@ -179,6 +199,25 @@ The above optional min and max parameters allow you to specify the neede range f
 }
 ```
 
+### Motion sensor
+This sensor is tripped if it detects motion in a room.
+
+#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
+| Parameter      | Possible values | Mandatory | Description                     |
+|:---------------|:----------------|:----------|:--------------------------------|
+| MotionDetected | \<item>         | Yes       | SHNG item to monitor for motion |
+
+
+#### Example:
+```json
+{
+    "type": "MotionSensor",
+    "name": "Movement hallway",
+    "MotionDetected": "EG.Flur.Bewegung"
+}
+```
+
+
 ### Occupancy sensor
 This sensor is tripped if it detects presence in a room.
 
@@ -199,39 +238,55 @@ This sensor is tripped if it detects presence in a room.
 }
 ```
 
-### Motion sensor
+
-This sensor is tripped if it detects motion in a room.
+### Outlet
+This accessory can monitor and change the on/off state of a wall outlet. The outlet can be generic, a light, a fan, ...
 
 #### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
-| Parameter      | Possible values | Mandatory | Description                     |
+| Parameter | Possible values | Mandatory | Description                          |
-|:---------------|:----------------|:----------|:--------------------------------|
+|:----------|:----------------|:----------|:-------------------------------------|
-| MotionDetected | \<item>         | Yes       | SHNG item to monitor for motion |
+| On        | \<item>         | Yes       | SHNG item to switch outlet on or off |
 
 
 #### Example:
 ```json
 {
-    "type": "OccupancySensor",
+    "type": "Outlet",
-    "name": "Presence bathroom",
+    "name": "Christmas tree",
-    "OccupancyDetected": "EG.Flur.Bewegung"
+    "On": "EG.Esszimmer.Steckdose"
 }
 ```
 
-### Contact sensor
+### Security system
-This sensor shows the open / closed state of a contact (door, window, generic ...).
+This accessory can pilote your intrusion security system. That system can be a physical one operated via SHNG, or a SHNG native logic.
 
 #### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
-| Parameter    | Possible values | Mandatory | Description                      |
+| Parameter    | Possible values | Mandatory | Description                                      |
-|:-------------|:----------------|:----------|:---------------------------------|
+|:-------------|:----------------|:----------|:-------------------------------------------------|
-| ContactState | \<item>         | Yes       | SHNG item to monitor for contact |
+| CurrentState | \<item>         | Yes       | SHNG item to monitor for the current alarm state |
+| TargetState  | \<item>         | Yes       | SHNG item to set or get the target state         |
 
+#### Additional comments
+Valid values for 'CurrentState':
+* STAY_ARM = 0
+* AWAY_ARM = 1
+* NIGHT_ARM = 2
+* DISARMED = 3
+* ALARM_TRIGGERED = 4
+
+Valid values for 'TargetState':
+* STAY_ARM = 0
+* AWAY_ARM = 1
+* NIGHT_ARM = 2
+* DISARMED = 3
 
 #### Example:
 ```json
 {
-    "type": "ContactSensor",
+    "type": "SecuritySystem",
-    "name": "Window kitchen",
+    "name": "Intrusion alarm",
-    "ContactState": "EG.Kueche.Fenster"
+    "currentState": "Technik.Alarmanlage.Status.Ist",
+    "targetState": "Technik.Alarmanlage.Status.Soll"
 }
 ```
 
@@ -253,24 +308,6 @@ This accessory can monitor and change the on/off state of something. It is very
 }
 ```
 
-### Outlet
-This accessory can monitor and change the on/off state of a wall outlet. The outlet can be generic, a light, a fan, ...
-
-#### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 
-| Parameter | Possible values | Mandatory | Description                          |
-|:----------|:----------------|:----------|:-------------------------------------|
-| On        | \<item>         | Yes       | SHNG item to switch outlet on or off |
-
-
-#### Example:
-```json
-{
-    "type": "Outlet",
-    "name": "Christmas tree",
-    "On": "EG.Esszimmer.Steckdose"
-}
-```
-
 ### Temperature sensor
 This sensor show the actual temperature.
 
@@ -313,7 +350,7 @@ CurrentHeatingCoolingState = 0 for OFF, 1 for HEAT and 2 for COOL
 }
 ```
 
-### WindowCovering
+### Window covering
 This accessory type can be used for shutters or blinds. Because the differnce between HomeKit and the controlling technology, for example KNX, can be significant this accessory has a lot of parameters. Luckily most are optional.
 
 #### Characteristics in addition to [common characteristics](#common-accessories-characteristics) 

package.json

@@ -2,15 +2,15 @@
   "private": false,
   "displayName": "SmartHomeNG",
   "name": "homebridge-smarthomeng",
-  "version": "2.0.1",
+  "version": "2.0.3",
-  "description": "A short description about what your plugin does.",
+  "description": "SmartHomeNG plugin for Homebridge",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git://github.com/Foxi352/homebridge-smarthomeng2.git"
+    "url": "git://github.com/Foxi352/homebridge-smarthomeng.git"
   },
   "bugs": {
-    "url": "https://github.com/Foxi352/homebridge-smarthomeng2/issues"
+    "url": "https://github.com/Foxi352/homebridge-smarthomeng/issues"
   },
   "engines": {
     "node": ">=14.18.1",

src/Accessories/SecuritySystem.ts

@@ -0,0 +1,94 @@
+import {
+    AccessoryPlugin,
+    CharacteristicValue,
+    Service,
+    Nullable,
+} from 'homebridge';
+
+import { SmartHomeNGPlatform } from '../platform';
+
+export class SecuritySystem implements AccessoryPlugin {
+    private readonly deviceService: Service;
+    private readonly informationService: Service;
+
+    public name: string;
+    private currentState = this.platform.Characteristic.SecuritySystemCurrentState.DISARMED;
+    private targetState = this.platform.Characteristic.SecuritySystemTargetState.DISARM;
+
+    constructor(private readonly platform: SmartHomeNGPlatform, private readonly accessory) {
+        this.name = accessory.name;
+        this.deviceService = new this.platform.Service.SecuritySystem(accessory.name);
+
+
+        // create handlers for required characteristics
+        this.deviceService.getCharacteristic(this.platform.Characteristic.SecuritySystemCurrentState)
+            .onGet(this.handleSecuritySystemCurrentStateGet.bind(this));
+
+        this.deviceService.getCharacteristic(this.platform.Characteristic.SecuritySystemTargetState)
+            .onGet(this.handleSecuritySystemTargetStateGet.bind(this))
+            .onSet(this.handleSecuritySystemTargetStateSet.bind(this));
+
+        this.informationService =
+            new this.platform.Service.AccessoryInformation()
+                .setCharacteristic(this.platform.Characteristic.Manufacturer, accessory.manufacturer)
+                .setCharacteristic(this.platform.Characteristic.Model, accessory.model)
+                .setCharacteristic(this.platform.Characteristic.SerialNumber, accessory.currentstate);
+
+        this.platform.shng.addMonitor(accessory.currentstate, this.shngCurrentStateCallback.bind(this));
+        this.platform.shng.addMonitor(accessory.targetState, this.shngTargetStateCallback.bind(this));
+        this.platform.log.info('SecuritySystem', accessory.name, 'created!');
+    }
+
+    identify(): void {
+        this.platform.log.info('Identify!');
+    }
+
+    getServices(): Service[] {
+        return [this.informationService, this.deviceService];
+    }
+
+    handleSecuritySystemCurrentStateGet(): Nullable<CharacteristicValue> {
+        this.platform.log.info(
+            'handleSecuritySystemCurrentStateGet:',
+            this.accessory.name, '=',
+            this.currentState,
+        );
+        return this.currentState;
+    }
+
+    handleSecuritySystemTargetStateGet(): Nullable<CharacteristicValue> {
+        this.platform.log.info(
+            'handleSecuritySystemTargetStateGet:', this.accessory.name,
+            'is currently', this.targetState,
+        );
+        return this.targetState;
+    }
+
+    handleSecuritySystemTargetStateSet(value: CharacteristicValue) {
+        this.targetState = value as number;
+        this.platform.log.info('handleSecuritySystemTargetStateSet:', this.accessory.name, 'was set to', this.targetState);
+        this.platform.shng.setItem(this.accessory.targetstate, this.targetState);
+    }
+
+    shngCurrentStateCallback(value: unknown): void {
+        this.platform.log.debug('shngCurrentStateCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        if (typeof value === 'number') {
+            this.currentState = value;
+            this.deviceService.updateCharacteristic(this.platform.Characteristic.SecuritySystemCurrentState, this.currentState);
+        } else {
+            this.platform.log.warn('Unknown type ', typeof value, 'received for', this.accessory.name + ':', value);
+        }
+    }
+
+    shngTargetStateCallback(value: unknown): void {
+        this.platform.log.debug('shngTargetStateCallback:', this.accessory.name, '=', value, '(' + typeof value + ')');
+        if (typeof value === 'number') {
+            this.targetState = value;
+            this.deviceService.updateCharacteristic(this.platform.Characteristic.SecuritySystemTargetState, this.targetState);
+        } else {
+            this.platform.log.warn('Unknown type ', typeof value, 'received for', this.accessory.name + ':', value);
+        }
+    }
+
+}
+

src/platform.ts

@@ -9,8 +9,6 @@ import {
 } from 'homebridge';
 import { SmartHomeNG } from './SmartHomeNG';
 
-import { OccupancySensor } from './Accessories/OccupancySensor';
-import { MotionSensor } from './Accessories/MotionSensor';
 import { Switch } from './Accessories/Switch';
 import { Outlet } from './Accessories/Outlet';
 import { Fan } from './Accessories/Fan';
@@ -20,6 +18,9 @@ import { Thermostat } from './Accessories/Thermostat';
 import { WindowCovering } from './Accessories/WindowCovering';
 import { ContactSensor } from './Accessories/ContactSensor';
 import { Doorbell } from './Accessories/Doorbell';
+import { SecuritySystem } from './Accessories/SecuritySystem';
+import { OccupancySensor } from './Accessories/OccupancySensor';
+import { MotionSensor } from './Accessories/MotionSensor';
 
 function uncapitalizeKeys(obj): Record<string, unknown> {
     function isObject(o: unknown): boolean {
@@ -105,6 +106,11 @@ export class SmartHomeNGPlatform implements StaticPlatformPlugin {
                         devices.push(new Doorbell(this, accessory));
                         break;
 
+                    // Doorbell
+                    case 'securitysystem':
+                        devices.push(new SecuritySystem(this, accessory));
+                        break;
+
                     // Switch
                     case 'switch':
                         devices.push(new Switch(this, accessory));