Giter Club home page Giter Club logo

ha-hkc's Introduction

HKC Alarm Integration for Home Assistant

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 systems, allowing you to control and monitor your HKC Alarm directly from Home Assistant.

Installation

You will need HACS 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.
  • 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

Entities

The integration updates data every minute by default. It exposes the following entities:

  • An alarm control panel entity representing the HKC Alarm system.
  • Sensor entities for each input on the HKC Alarm system.

The State of the alarm control panel is either armed_home, armed_away, or disarmed. The sensor entities will have states Open or Closed based on the state of the corresponding input on the HKC Alarm system.

Sample Automation to notify about alarm state changes

alias: HKC Alarm State Notifications
description: ""
trigger:
  - platform: state
    entity_id: alarm_control_panel.hkc_alarm_system
condition: []
action:
  - service: notify.notify
    data:
      title: ๐Ÿšจ HKC Alarm Notification ๐Ÿšจ
      message: >
        Alarm System is now {{ states('alarm_control_panel.hkc_alarm_system') }}
mode: single

Troubleshooting

If you encounter issues with this integration, you can enable debug logging for this component by adding the following lines to your configuration.yaml file:

logger:
  logs:
    custom_components.hkc_alarm: debug

This will produce detailed debug logs which can help in diagnosing the problem.

Links

ha-hkc's People

Contributors

jasonmadigan avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.