[homekit] add support for QR code based pairing (#9475)

* add support qrcode based pairing Signed-off-by: Eugen Freiter <freiter@gmx.de> * add screenshots Signed-off-by: Eugen Freiter <freiter@gmx.de> * fix typo Signed-off-by: Eugen Freiter <freiter@gmx.de> * update config only if differnt to prevent endless update loop Signed-off-by: Eugen Freiter <freiter@gmx.de> * clean up Signed-off-by: Eugen Freiter <freiter@gmx.de> * add support qrcode based pairing Signed-off-by: Eugen Freiter <freiter@gmx.de> * add screenshots Signed-off-by: Eugen Freiter <freiter@gmx.de> * fix typo Signed-off-by: Eugen Freiter <freiter@gmx.de> * update config only if differnt to prevent endless update loop Signed-off-by: Eugen Freiter <freiter@gmx.de> * clean up Signed-off-by: Eugen Freiter <freiter@gmx.de> * incorporate review feedback Signed-off-by: Eugen Freiter <freiter@gmx.de> * fix Nullable based on feedback Signed-off-by: Eugen Freiter <freiter@gmx.de> * correct the java hap version Signed-off-by: Eugen Freiter <freiter@gmx.de> * Update bundles/org.openhab.io.homekit/pom.xml * adapt groupid Signed-off-by: Eugen Freiter <freiter@gmx.de> * incorporate review feedback Signed-off-by: Eugen Freiter <freiter@gmx.de> Co-authored-by: Eugen Freiter <freiter@gmx.de> Co-authored-by: J-N-K <J-N-K@users.noreply.github.com>
2021-01-08 23:03:54 +01:00
parent d7d4fda2b2
commit fcb774ca35
16 changed files with 158 additions and 20 deletions
--- a/bundles/org.openhab.io.homekit/README.md
+++ b/bundles/org.openhab.io.homekit/README.md
@@ -34,6 +34,40 @@ HomeKit integration supports following accessory types:
 - Carbon Dioxide Sensor
 - Carbon Monoxide Sensor

+## Quick start
+
+- install homekit binding via UI
+  
+- add metadata to an existing item (see [UI based configuration](#UI-based-Configuration))
+  
+- go to scan QR code from UI->Setting-HomeKit Integration
+  
+  ![settings_qrcode.png](doc/settings_qrcode.png)
+  
+- open home app on your iPhone or iPad
+- create new home
+  
+  ![ios_add_new_home.png](doc/ios_add_new_home.png)
+  
+- add accessory
+  
+  ![ios_add_accessory.png](doc/ios_add_accessory.png)
+  
+- scan QR code from UI->Setting-HomeKit Integration
+  
+  ![ios_scan_qrcode.png](doc/ios_scan_qrcode.png)  
+
+- click "Add Anyway"
+  
+  ![ios_add_anyway.png](doc/ios_add_anyway.png)
+  
+- follow the instruction of the home app wizard
+  
+  ![ios_add_accessory_wizard.png](doc/ios_add_accessory_wizard.png)
+  
+Add metadata to more item or fine-tune your configuration using further settings
+
+
 ## Global Configuration

 Your first step will be to create the `homekit.cfg` in your `$OPENHAB_CONF/services` folder.
@@ -93,8 +127,30 @@ Complex accessories require a tag on a Group Item indicating the accessory type,

 A HomeKit accessory has mandatory and optional characteristics (listed below in the table).
 The mapping between openHAB items and HomeKit accessory and characteristics is done by means of [metadata](https://www.openhab.org/docs/concepts/items.html#item-metadata)
-e.g.

+### UI based Configuration
+In order to add metadata to an item:
+- select desired item in mainUI
+- click on "Add Metadata"
+  
+  ![item_add_metadata_button.png](doc/item_add_metadata_button.png)
+  
+- select "Apple HomeKit" namespace
+  
+  ![select_homekit_namespace.png](doc/select_homekit_namespace.png)
+  
+- click on "HomeKit Accessory/Characteristic"
+  
+  ![add_homekit_tag.png](doc/add_homekit_tag.png)
+
+- select required HomeKit accessory type or characteristic
+  
+  ![select_homekit_accessory_type.png](doc/select_homekit_accessory_type.png)
+  
+- click on "Save"
+
+
+### Textual configuration
 ```xtend
 Switch leaksensor_metadata  "Leak Sensor"           {homekit="LeakSensor"}
 ```