diff --git a/.gitignore b/.gitignore index 880ad43..23ab267 100644 --- a/.gitignore +++ b/.gitignore @@ -165,3 +165,6 @@ cython_debug/ # VSCode .vscode/ + +# OS X +.DS_Store diff --git a/README.md b/README.md index da22b1a..4392244 100644 --- a/README.md +++ b/README.md @@ -81,39 +81,51 @@ YAML example: ```yaml service: alarm_control_panel.alarm_arm_away target: - entity_id: alarm_control_panel.alarm_panel + entity_id: alarm_control_panel. data: code: !secret alarm_code # (check how to use secrets if you are not familiar) ``` +You can find `` under *Settings > Devices & Services > e-Connect/Metronet Alarm* opening the list of entities and searching for *Alarm Panel* + + + UI example: -### HomeKit integration +### Apple Home integration (HomeKit) -If you want to integrate your alarm with the Apple ecosystem to use Siri or Apple Home automations, follow these steps: +If you want to integrate your alarm with the Apple Home to use Siri or automations, follow these steps: -1) Add these entries inside `configuration.yaml` to let Home Assistant create a new bridge with just the Alarm Panel exposed. +1) Add these entries inside `configuration.yaml` to let Home Assistant create a new HomeKit bridge with just the Alarm Panel exposed. ``` homekit: - - filter: + - name: HASS Bridge Alarm + port: 21065 + filter: include_domains: - alarm_control_panel entity_config: - alarm_control_panel.alarm_panel: - code: - - name: HASS Bridge Alarm - port: 21065 + alarm_control_panel.: + code: ``` -2) Please replace `` with your specific alarm code. -3) Reboot Home Assistant. -4) Scan the QR code available in your Home Assistant Notifications area (bottom-left badge) with your iPhone to add the alarm into the Apple Home app. +1) Please replace `` with your specific alarm code and `` with your alarm entity id. +2) Reboot Home Assistant. +3) Scan the QR code available in your Home Assistant Notifications area (bottom-left badge) with your iPhone to add the alarm into the Apple Home app. + +**Multiple HomeKit bridges**: If you have others HomeKit integrations created via the UI (i.e., Settings > Devices & Services), be careful to not use the same `port` twice to prevent conflicts. Also note, if you don't specify a `port` the default `21063` is used. Please note that Apple Home requires you to confirm automations that involves security devices such as lockers and alarm systems. +As a result of the integration you should have a similar configuration in your Home app: + +| Alarm panel | Alarm panel opened | +|---|---| +| | | + ## Troubleshooting If you encounter an issue, providing `DEBUG` logs can greatly assist us in identifying the bug. Please follow these steps to send us the debug logs: diff --git a/images/alarm_panel_entity_id.png b/images/alarm_panel_entity_id.png new file mode 100644 index 0000000..042b446 Binary files /dev/null and b/images/alarm_panel_entity_id.png differ diff --git a/images/homekit_alarm_panel.jpg b/images/homekit_alarm_panel.jpg new file mode 100644 index 0000000..a83f419 Binary files /dev/null and b/images/homekit_alarm_panel.jpg differ diff --git a/images/homekit_alarm_panel_open.png b/images/homekit_alarm_panel_open.png new file mode 100644 index 0000000..b839968 Binary files /dev/null and b/images/homekit_alarm_panel_open.png differ