README.md

Broadlink S1C Alarm Kit Sensors

Component Type : platform
Platform Name : broadlink_s1c
Domain Name : sensor
Component Script : custom_components/sensor/broadlink_s1c.py

Community Discussion

Component Description

Home Assistant Custom Component for integration with Broadlink S1C Alarm Kit.
S1C Alarm Kit is a alarm system made by Broadlink, it's made of a Hub which can control up to 16 designated devices:

• Door/Window Sensor
• Motion Detector
• Key Fob

According to Broadlink's site, more sensor types are to released eventually.
The uniqueness of this system is its integration with the rest of the Broadlink smart home products, for instance you can create an interaction as they call it, and make it so the your Broadlink TC2 switch will be turned on when the door sensor is open.
But... If you're in this repository, You probably looking for a way to integrate this system with Home Assistant, so that last fact doesn't really matters.
So, let's get to it! ;-)

Table Of Contents

• Requirements
• Installation
• Configuration
  • Configuration Keys
• States
  • All Sensors
  • Door Sensor
  • Motion Detector
  • Key Fob
• Special Notes
• Credits

Requirements

• Home Assistant version 0.67.1 or higher.
• Your S1C Hub needs to have a Static IP Address reserved by your router.

Installation

• Copy the file custom_components/sensor/broadlink_s1c.py to your ha_config_dir/custom_components/sensor directory.
• Configure like instructed in the Configuration section below.
• Restart Home-Assistant.

Configuration

To use this component in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml

sensor:
  - platform: broadlink_s1c
    ip_address: xxx.xxx.xxx.xxx
    mac: "xx:xx:xx:xx:xx:xx"
    timeout: 10

Configuration Keys

• ip_address (Required) Inherited from homeassistant.const.CONF_IP_ADDRESS: The IP Address assigned to your device by your router. A static address is preferable.
  
• mac (Required) Inherited from homeassistant.const.CONF_MAC: The MAC Address of your S1C Hub.
  
• timeout (Optional) Inherited from homeassistant.const.CONF_TIMEOUT: Timeout value for S1C Hub connectio. Default=10.
  

States

All Sensors

• tampered
• unknown - Inherited from homeassistant.const.STATE_UNKNOWN

Door Sensor

• open - Inherited from homeassistant.const.STATE_OPEN
• closed - Inherited from homeassistant.const.STATE_CLOSED

Motion Detector

• no_motion
• motion_detected

Key Fob

• disarmed - Inherited from homeassistant.const.STATE_ALARM_DISARMED
• armed_away - Inherited from homeassistant.const.STATE_ALARM_ARMED_AWAY
• armed_home - Inherited from homeassistant.const.STATE_ALARM_ARMED_HOME
• sos

Special Notes

• Initial configuration of the sensor in the Broadlink App is required.
• The platform discovers the sensors upon loading, therefore if you add another sensor, restart Home Assistant and the new sensors will be added to ha.
• The entity name of each sensor is constructed from the original sensor name from the Broadlink App concatenated with the platform name. Spaces and dashes will be replaced with underscores.
  For instance, if you sensor is name Bedroom Door the entity name will be broadlink_s1c_bedroom_door, and to reference it you will call sensor.broadlink_s1c_bedroom_door
• The custom component used a tweaked version of the python-broadlink library from a forked repository of it on my GitHub.
• Although this component is designed for S1C Hubs, users report it to be working well with S2C Hubs too.

Credits

• A script by NightRang3r, here.
• The python-broadlink library made by mjg59, here.