Skip to content

Commit

Permalink
add SecuritySystem accessory
Browse files Browse the repository at this point in the history
  • Loading branch information
@ccutrer
ccutrer committed Feb 27, 2019
1 parent 207fd4d commit 2a53ea8
Show file tree
Hide file tree
Showing 5 changed files with 267 additions and 24 deletions.
112 changes: 92 additions & 20 deletions addons/io/org.openhab.io.homekit/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,26 +75,29 @@ Complex accessories require a tag on a Group indicating the accessory type, as w

A full list of supported accessory types can be found in the table below.

| Tag | Child tag | Supported items | Description |
|-------------------- |---------------------------- |----------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Lighting | | Switch, Dimmer, Color | A lightbulb, switchable, dimmable or rgb |
| Switchable | | Switch, Dimmer, Color | An accessory that can be turned off and on. While similar to a lightbulb, this will be presented differently in the Siri grammar and iOS apps |
| ContactSensor | | Contact | An accessory with on/off state that can be viewed in HomeKit but not changed such as a contact sensor for a door or window |
| CurrentTemperature | | Number | An accessory that provides a single read-only temperature value. The units default to celsius but can be overridden globally using the useFahrenheitTemperature global property |
| CurrentHumidity | | Number | An accessory that provides a single read-only value indicating the relative humidity. |
| Thermostat | | Group | A thermostat requires all child tags defined below |
| | TargetTemperature | Number | A target temperature that will engage the thermostat's heating and cooling actions as necessary, depending on the heatingCoolingMode |
| | homekit:CurrentTemperature | Number | The current temperature, same as above |
| | homekit:TargetHeatingCoolingMode | String | Item used to set and get the current target mode of the device: OFF, AUTO, HEAT, COOL. The string's value must match those defined in the `thermostat*Mode` |
| | homekit:CurrentHeatingCoolingMode | String | (Optional) Item used to read the current state of the device: OFF, HEATING, COOLING. The string's value must match those defined in the `thermostat*State` properties. |
| LeakSensor | | Switch, ContactSensor | Leak sensor. ON / OPEN state means flood detected. |
| MotionSensor | | Switch, ContactSensor | Motion sensor. ON / OPEN state means motion detected. |
| OccupancySensor | | Switch, ContactSensor | Occupancy sensor. ON / OPEN state means occupancy detected. |
| Valve | | Switch | Simple open/close valve. Assumes liquid is flowing when valve is open. |
| WindowCovering | | Rollershutter | Simple window covering with support for setting target position / current position support. |
| SmokeSensor | | Switch, ContactSensor | Smoke detector. ON / OPEN state means smokes detected. |
| CarbonMonoxideSensor | | Switch, ContactSensor | CO detector. ON / OPEN state means smoke detected (it currently appears that Home.app on iOS doesn't distinguish between a smoke and CO detector). |
| Fan | | Switch, Dimmer | Fan with or without speed control. |
| Tag | Child tag | Supported items | Description |
|-------------------- |---------------------------- |----------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Lighting | | Switch, Dimmer, Color | A lightbulb, switchable, dimmable or rgb |
| Switchable | | Switch, Dimmer, Color | An accessory that can be turned off and on. While similar to a lightbulb, this will be presented differently in the Siri grammar and iOS apps |
| ContactSensor | | Contact | An accessory with on/off state that can be viewed in HomeKit but not changed such as a contact sensor for a door or window |
| CurrentTemperature | | Number | An accessory that provides a single read-only temperature value. The units default to celsius but can be overridden globally using the useFahrenheitTemperature global property |
| CurrentHumidity | | Number | An accessory that provides a single read-only value indicating the relative humidity. |
| Thermostat | | Group | A thermostat requires all child tags defined below |
| | TargetTemperature | Number | A target temperature that will engage the thermostat's heating and cooling actions as necessary, depending on the heatingCoolingMode |
| | homekit:CurrentTemperature | Number | The current temperature, same as above |
| | homekit:TargetHeatingCoolingMode | String | Item used to set and get the current target mode of the device: OFF, AUTO, HEAT, COOL. The string's value must match those defined in the `thermostat*Mode` |
| | homekit:CurrentHeatingCoolingMode | String | (Optional) Item used to read the current state of the device: OFF, HEATING, COOLING. The string's value must match those defined in the `thermostat*State` properties. |
| LeakSensor | | Switch, ContactSensor | Leak sensor. ON / OPEN state means flood detected. |
| MotionSensor | | Switch, ContactSensor | Motion sensor. ON / OPEN state means motion detected. |
| OccupancySensor | | Switch, ContactSensor | Occupancy sensor. ON / OPEN state means occupancy detected. |
| Valve | | Switch | Simple open/close valve. Assumes liquid is flowing when valve is open. |
| WindowCovering | | Rollershutter | Simple window covering with support for setting target position / current position support. |
| SmokeSensor | | Switch, ContactSensor | Smoke detector. ON / OPEN state means smokes detected. |
| CarbonMonoxideSensor | | Switch, ContactSensor | CO detector. ON / OPEN state means smoke detected (it currently appears that Home.app on iOS doesn't distinguish between a smoke and CO detector). |
| Fan | | Switch, Dimmer | Fan with or without speed control. |
| SecuritySystem | | Group | A security system requires both child tags defined below |
| | homekit:CurrentSecuritySystemState | String | The current state of the security system. STAY_ARM / AWAY_ARM / NIGHT_ARM / DISARMED / TRIGGERED |
| | homekit:TargetSecuritySystemState | String | The requested state of the security system. STAY_ARM / AWAY_ARM / NIGHT_ARM / DISARM. While the requested state is not DISARM, and the current state is DISARMED, HomeKit will display "Arming...", for example during an exit delay. |


See the sample below for example items:
Expand All @@ -118,6 +121,10 @@ Rollershutter MasterWindow_Blinds "Master Window Blinds" [ "WindowCovering" ]
Dimmer FamilyRoomFan "Family Room Fan" <fan> [ "Fan" ]
Switch BathroomFan "Bathroom Fan" <fan> [ "Fan" ]
Group gAlarm "Security System" [ "SecuritySystem" ]
String Alarm_CurrentState (gAlarm) [ "homekit:CurrentSecuritySystemState" ]
String Alarm_TargetState (gAlarm) [ "homekit:TargetSecuritySystemState" ]
```

## Common Problems
Expand Down Expand Up @@ -168,3 +175,68 @@ openhab> log:set TRACE com.beowulfe.hap
openhab> log:tail com.beowulfe.hap
```

## Full Security System Example

This example associates a DSC Alarm with HomeKit. Proxy items are created for HomeKit, since the commands don't map exactly, and rules are used to
maintain them. Additionally, `NIGHT_ARM` isn't supported, so it's automatically mapped to `STAY_ARM`.

```alarm.items
Number Alarm_Mode "Arm Mode" <lock> { channel="dscalarm:partition:46c52f35:partition1:partition_arm_mode" }
Switch Alarm_Armed "Armed Status" <lock> { channel="dscalarm:partition:46c52f35:partition1:partition_armed" }
Switch Alarm_InAlarm "In Alarm" <lock> { channel="dscalarm:partition:46c52f35:partition1:partition_in_alarm" }
Group gAlarm "Security System" [ "SecuritySystem" ]
String Alarm_CurrentState (gAlarm) [ "homekit:CurrentSecuritySystemState" ]
String Alarm_TargetState (gAlarm) [ "homekit:TargetSecuritySystemState" ]
```

```alarm.rules
rule "HomeKit Support"
when
Item Alarm_TargetState changed
then
if (Alarm_TargetState.state == 'DISARM') {
Alarm_Mode.sendCommand(0)
} else if (Alarm_TargetState.state == "AWAY_ARM") {
Alarm_Mode.sendCommand(1)
} else if (Alarm_TargetState.state == "STAY_ARM") {
Alarm_Mode.sendCommand(2)
} else if (Alarm_TargetState.state == "NIGHT_ARM") {
Alarm_TargetState.postUpdate("STAY_ARM")
}
end
rule "HomeKit Support"
when
Item Alarm_Mode changed
then
if (Alarm_Mode.state == 0) {
Alarm_TargetState.postUpdate("DISARM")
} else if (Alarm_Mode.state == 1) {
Alarm_TargetState.postUpdate("AWAY_ARM")
} else {
Alarm_TargetState.postUpdate("STAY_ARM")
}
end
rule "HomeKit Support"
when
Item Alarm_Armed changed or
Item Alarm_InAlarm changed
then
if (Alarm_InAlarm.state == ON) {
Alarm_CurrentState.postUpdate("TRIGGERED")
} else if (Alarm_Armed.state == ON) {
if (Alarm_Mode.state == 1) {
Alarm_CurrentState.postUpdate("AWAY_ARM")
Alarm_TargetState.postUpdate("AWAY_ARM")
} else {
Alarm_CurrentState.postUpdate("STAY_ARM")
Alarm_TargetState.postUpdate("STAY_ARM")
}
} else {
Alarm_CurrentState.postUpdate("DISARMED")
Alarm_TargetState.postUpdate("DISARM")
}
end
```
1 change: 1 addition & 0 deletions ...penhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/HomekitAccessoryType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public enum HomekitAccessoryType {
SMOKE_SENSOR("SmokeSensor"),
CARBON_MONOXIDE_SENSOR("CarbonMonoxideSensor"),
FAN("Fan"),
SECURITY_SYSTEM("SecuritySystem"),
@Deprecated()
BLINDS("Blinds");

Expand Down
4 changes: 3 additions & 1 deletion ...b.io.homekit/src/main/java/org/openhab/io/homekit/internal/HomekitCharacteristicType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ public enum HomekitCharacteristicType {
@Deprecated()
OLD_TARGET_HEATING_COOLING_MODE("homekit:HeatingCoolingMode"),
TARGET_HEATING_COOLING_MODE("homekit:TargetHeatingCoolingMode"),
CURRENT_HEATING_COOLING_STATE("homekit:CurrentHeatingCoolingMode");
CURRENT_HEATING_COOLING_STATE("homekit:CurrentHeatingCoolingMode"),
CURRENT_SECURITY_SYSTEM_STATE("homekit:CurrentSecuritySystemState"),
TARGET_SECURITY_SYSTEM_STATE("homekit:TargetSecuritySystemState");

private static final Map<String, HomekitCharacteristicType> TAG_MAP = new HashMap<>();

Expand Down
7 changes: 4 additions & 3 deletions ...it/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitAccessoryFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@ public static HomekitAccessory create(HomekitTaggedItem taggedItem, ItemRegistry
.orElseThrow(() -> new Exception("Fan accessory group should have a fan in it"));

return new HomekitFanImpl(fanAccessory, itemRegistry, updater);
case SECURITY_SYSTEM:
return new HomekitSecuritySystemImpl(taggedItem, itemRegistry, updater,
getCharacteristicItems(taggedItem));
}

throw new IllegalArgumentException("Unknown homekit type: " + taggedItem.getAccessoryType());
Expand All @@ -134,14 +137,12 @@ public static HomekitAccessory create(HomekitTaggedItem taggedItem, ItemRegistry
/**
* Given an accessory group, return the item in the group tagged as an accessory.
*
* @param taggedItem The group item containing our item, or, the accessory item.
* @param taggedItem The group item containing our item, or, the accessory item.
* @param accessoryType The accessory type for which we're looking
* @return
*/
private static Optional<HomekitTaggedItem> getPrimaryAccessory(HomekitTaggedItem taggedItem,
HomekitAccessoryType accessoryType, ItemRegistry itemRegistry) {
logger.info("{} isGroup? {}", taggedItem.getName(), taggedItem.isGroup(),
taggedItem.isMemberOfAccessoryGroup());
if (taggedItem.isGroup()) {
GroupItem groupItem = (GroupItem) taggedItem.getItem();
return groupItem.getMembers().stream().filter(item -> item.hasTag(accessoryType.getTag())).findFirst()
Expand Down
Loading

0 comments on commit 2a53ea8

Please sign in to comment.