public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[homekit] Improve documentation (#9683)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach 2021-01-04 22:29:39 +01:00 committed by GitHub
parent 25947bfa9d
commit 944ff33e61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
bundles/org.openhab.io.homekit/README.md
View File

@ -8,6 +8,7 @@ HomeKit organizes your home into "accessories" that are made up of a number of "
Some accessory types require a specific set of characteristics. Some accessory types require a specific set of characteristics.
HomeKit integration supports following accessory types: HomeKit integration supports following accessory types:
- Switchable - Switchable
- Outlet - Outlet
- Lighting (simple, dimmable, color) - Lighting (simple, dimmable, color)
@ -128,7 +129,6 @@ Switch leaksensor "Leak Sensor"
Switch leaksensor_battery "Leak Sensor Battery" (gLeakSensor) {homekit="LeakSensor.BatteryLowStatus"} Switch leaksensor_battery "Leak Sensor Battery" (gLeakSensor) {homekit="LeakSensor.BatteryLowStatus"}
``` ```
You can use openHAB group to manage state of multiple items. (see [Group items](https://www.openhab.org/docs/configuration/items.html#derive-group-state-from-member-items)) You can use openHAB group to manage state of multiple items. (see [Group items](https://www.openhab.org/docs/configuration/items.html#derive-group-state-from-member-items))
In this case, you can assign HomeKit accessory type to the group and to the group items In this case, you can assign HomeKit accessory type to the group and to the group items
Following example defines 3 HomeKit accessories of type Lighting: Following example defines 3 HomeKit accessories of type Lighting:
@ -324,7 +324,6 @@ Switch light2 "Light 2" (gLight) {homekit="Lighting.OnState"}
| | | LockCurrentState | Switch | current states of lock mechanism (OFF=SECURED, ON=UNSECURED) | | | | LockCurrentState | Switch | current states of lock mechanism (OFF=SECURED, ON=UNSECURED) |
| | | LockTargetState | Switch | target states of lock mechanism (OFF=SECURED, ON=UNSECURED) | | | | LockTargetState | Switch | target states of lock mechanism (OFF=SECURED, ON=UNSECURED) |
### Examples ### Examples
See the sample below for example items: See the sample below for example items:
@ -438,6 +437,7 @@ Following modes are supported:
Dimmer dimmer_light_2 "Dimmer Light 2" {homekit="Lighting, Lighting.Brightness" [dimmerMode="filterBrightness100"]} Dimmer dimmer_light_2 "Dimmer Light 2" {homekit="Lighting, Lighting.Brightness" [dimmerMode="filterBrightness100"]}
Dimmer dimmer_light_3 "Dimmer Light 3" {homekit="Lighting, Lighting.Brightness" [dimmerMode="filterOnExceptBrightness100"]} Dimmer dimmer_light_3 "Dimmer Light 3" {homekit="Lighting, Lighting.Brightness" [dimmerMode="filterOnExceptBrightness100"]}
``` ```
### Windows Covering (Blinds) / Window / Door ### Windows Covering (Blinds) / Window / Door
HomeKit Windows Covering, Window and Door accessory types have following mandatory characteristics: HomeKit Windows Covering, Window and Door accessory types have following mandatory characteristics:
@ -462,6 +462,7 @@ openHAB Rollershutter is defined by default as:
- CLOSED if position is 100%. - CLOSED if position is 100%.
In contrast, HomeKit window covering/door/window have inverted mapping In contrast, HomeKit window covering/door/window have inverted mapping
- OPEN if position 100% - OPEN if position 100%
- CLOSED if position is 0% - CLOSED if position is 0%
@ -519,6 +520,7 @@ Number valve_duration "Valve duration" (gValve) {homekit = "Valve.Dur
``` ```
### Sensors ### Sensors
Sensors have typically one mandatory characteristic, e.g. temperature or lead trigger, and several optional characteristics which are typically used for battery powered sensors and/or wireless sensors. Sensors have typically one mandatory characteristic, e.g. temperature or lead trigger, and several optional characteristics which are typically used for battery powered sensors and/or wireless sensors.
Following table summarizes the optional characteristics supported by sensors. Following table summarizes the optional characteristics supported by sensors.
@ -600,4 +602,3 @@ openhab> log:tail io.github.hapjava
`openhab:homekit list` - list all HomeKit accessories currently advertised to the HomeKit clients. `openhab:homekit list` - list all HomeKit accessories currently advertised to the HomeKit clients.
`openhab:homekit show <accessory_id | name>` - print additional details of the accessories which partially match provided ID or name. `openhab:homekit show <accessory_id | name>` - print additional details of the accessories which partially match provided ID or name.