ZigBee Binary Sensor


A zigbee binary sensor in this context is a device connected to one of the digital input pins on a ZigBee module. The states reported by such a device are limited to on or off. By default, a binary sensor is considered on when the ZigBee device’s digital input pin is held ‘high’ and considered off when it is held low. This behaviour can be inverted by setting the on_state configuration variable to low.

To enable a digital input pin as binary sensor in your installation, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
binary_sensor:
  - platform: zigbee
    name: Hallway PIR Sensor
    pin: 0

Configuration variables:

  • name (Required): The name you would like to give the binary sensor in Home Assistant.
  • pin (Required): The number identifying which pin to use.
  • address (Optional): The long 64-bit address of the remote ZigBee device whose digital input pin you’d like to sample. Do not include this variable if you want to sample the local ZigBee device’s pins.
  • on_state (Optional): Either high (default) or low, depicting whether the binary sensor is considered on when the pin is high or low.