Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonmadigan authored May 29, 2024
1 parent 9ec490b commit 2dcbe98
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
> [!CAUTION]
> This integration is only recommended for HKC users who have an alarm system with HKC's WiFi card, rather than users who are purely using GSM. GSM-only users may encounter rate limiting from HKC, so it isn't advisable to use.
This repository contains an unofficial Home Assistant integration for [HKC Alarm](https://www.hkcsecurity.com/) systems, allowing you to control and monitor your HKC Alarm directly from Home Assistant.
This repository contains an unofficial Home Assistant integration for [HKC Alarm](https://www.hkcsecurity.com/) systems, allowing you to control and monitor your HKC Alarm directly from Home Assistant. It is provided as-is, with no warranty or support, and is not in any way associated nor endorsed by HKC. Users assume all risk in using this.

## Installation

You will need [HACS](https://hacs.xyz) installed in your Home Assistant server. Install the integration by installing this repository as a Custom Repository. Then, navigate to Integrations, Add an Integration and select HKC Alarm. You will then be asked to enter:

* **Panel ID**: Your HKC Alarm Panel ID.
* **Panel Password**: Your HKC Alarm Panel Password.
* **Alarm Code**: Your HKC Alarm Code.
* **Panel ID**: Your HKC Alarm Panel ID (same as panel ID in HKC mobile app)
* **Panel Password**: Your HKC Alarm Panel Password (same as panel password from HKC mobile app)
* **Alarm Code**: Your HKC Alarm Code/PIN
* **Update Interval (seconds)**: (Optional) Custom update interval for fetching data from HKC Alarm. Default is 60 seconds. Recommend keeping this at 60s, as this is similar to the Mobile App's polling interval, and we want to respect HKC's API.

[![Open your Home Assistant instance and add this integration](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=hkc_alarm)
Expand Down

0 comments on commit 2dcbe98

Please sign in to comment.