XBee


Zigbee integration for Home Assistant allows you to utilize modules such as the XBee as wireless General Purpose Input/Output (GPIO) devices. The integration requires a local Xbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network.

There is currently support for the following device types within Home Assistant:

Configuration

The local Zigbee device (assuming XBee) must have an up to date Router or Coordinator API firmware installed.

A xbee section must be present in the configuration.yaml file and contain the following options as required:

# Example configuration.yaml entry
xbee:

Configuration Variables

device string (Optional)

The serial port to which the local XBee device is connected.

Default:

/dev/ttyUSB0

baud integer (Optional, default: 9600)

The baud rate at which to communicate with the local XBee device.

To find the possible serial port names of your device, run:

ls /dev/ttyUSB*
The port may also appear as /dev/ttyACM* if you're communicating with the XBee device through an Arduino.

Example

# Example configuration.yaml entry
xbee:
  device: /dev/ttyACM1
  baud: 115200

Binary Sensor

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

Configuration

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: xbee
    name: Hallway PIR Sensor
    pin: 0

Configuration Variables

name string Required

The name you would like to give the binary sensor in Home Assistant.

pin integer Required

The number identifying which pin to use.

address string (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 XBee device’s pins.

on_state string (Optional, default: high)

Either high or low, depicting whether the binary sensor is considered on when the pin is high or low.

Light

A Zigbee light in this context is a light connected to one of the digital output pins on a XBee module. It can simply be switched on and off. By default, a light is considered on when the XBee device’s digital output is held high and considered off when it is held low. This behavior can be inverted by setting the on_state configuration variable to low.

To configure a digital output pin as light, add the following to your configuration.yaml file:

light:
  - name: Desk Lamp
    platform: xbee
    pin: 0

Configuration Variables

name string Required

The name you would like to give the light in Home Assistant.

pin integer Required

The number identifying which pin to use.

address string (Optional)

The long 64-bit address of the remote Zigbee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local XBee device’s pins.

on_state string (Optional, default: high)

Either high or low, depicting whether the digital output pin is pulled high or low when the light is turned on.

Sensor

There are two types of Zigbee sensor available to Home Assistant:

To configure an analog input pin sensor, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: xbee
    name: My Analog Zigbee Input
    type: analog
    pin: 0
    address: 0013A2004233D138

Configuration Variables

name string Required

The name you would like to give the sensor in Home Assistant.

type string Required

Set to analog or temperature.

pin integer (Optional)

The number identifying which pin to sample.

address string (Optional)

The long 64-bit address of the remote Zigbee device whose pin you would like to sample. Do not include this variable if you want to sample the local XBee device’s pins.

max_volts float (Optional, default: 1.2)

The maximum voltage which the input pin is able to read.

Examples

Analog Input Pin

The analog input pins on an XBee (non-Pro) will read 0V to 1.2 V. This is translated by the xbee-helper library into a percentage. The maximum voltage your Zigbee device will read is configurable using the max_volts configuration variable.

To configure an analog input pin sensor, add the following to your configuration.yaml file:

## Example configuration.yaml entry
sensor:
  - platform: xbee
    name: My Analog Zigbee Input
    type: analog
    pin: 0
    address: 0013A2004233D138

See the Digi knowledge base for more XBee sampling details.

Temperature Sensor

The XBee Pro (and perhaps other third party modules) contains a thermometer device which can be read by using the TP AT command.

To configure a temperature sensor device, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: xbee
    name: Living Room Temperature Zigbee
    type: temperature
    address: 0013A20050E752C5

Switch

A Zigbee switch in this context is a device connected to one of the digital output pins on a XBee module. It can simply be switched on and off. By default, a switch is considered on when the XBee device’s digital output is held high and considered off when it is held low. This behavior can be inverted by setting the on_state configuration variable to low.

To configure a digital output pin as switch, add the following to your configuration.yaml file:

switch:
  - name: Pond Fountain
    platform: xbee
    pin: 0
    address: 0013A20040791FA2
    on_state: low

Configuration Variables

name string Required

The name you would like to give the switch in Home Assistant.

pin integer Required

The number identifying which pin to use.

address string (Optional)

The long 64-bit address of the remote Zigbee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local XBee device’s pins.

on_state string (Optional, default: high)

Either high or low, depicting whether the digital output pin is pulled high or low when the switch is turned on.