Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readme improvements for HomeKit integration #142

Merged
merged 2 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -165,3 +165,6 @@ cython_debug/

# VSCode
.vscode/

# OS X
.DS_Store
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<YOUR ALARM ENTITY ID>
data:
code: !secret alarm_code # (check how to use secrets if you are not familiar)
```

You can find `<YOUR ALARM ENTITY ID>` under *Settings > Devices & Services > e-Connect/Metronet Alarm* opening the list of entities and searching for *Alarm Panel*

<img src="images/alarm_panel_entity_id.png" width="400"/>

UI example:

<img src="https://user-images.githubusercontent.com/1560405/110870435-ba91f900-82cc-11eb-9ebc-442152fd67f1.png" width="500"/>

### 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: <PIN CODE>
- name: HASS Bridge Alarm
port: 21065
alarm_control_panel.<YOUR ALARM ENTITY ID>:
code: <PIN CODE>
```

2) Please replace `<PIN CODE>` 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 `<PIN CODE>` with your specific alarm code and `<YOUR ALARM ENTITY ID>` 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 |
|---|---|
| <img src="images/homekit_alarm_panel.jpg" width="300"/> | <img src="images/homekit_alarm_panel_open.png" width="300"/> |

## 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:
Expand Down
Binary file added images/alarm_panel_entity_id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/homekit_alarm_panel.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/homekit_alarm_panel_open.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading