Zigbee Home Automation for Home Assistant (built-in integration)

About

Zigbee Home Automation is a built-in integration that runs a Zigbee network locally through a compatible coordinator adapter. It adds Zigbee devices as entities such as lights, locks, covers, fans, climate, sirens, sensors, switches, numbers and selects. Setup happens in the UI, where a serial port or socket address, baud rate and flow control are chosen, and a backup can be restored or uploaded. Actions cover permitting nodes to join, removing nodes, reconfiguring a device, issuing cluster commands, setting cluster attributes and managing lock user codes. Warning devices can be told to squawk or start an alert, and device triggers such as dropped, shaken or tilted can start automations. Repair notices appear when network settings change, and a diagnostics file can be downloaded for bug reports.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Device triggers Its devices can start automations directly.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Lights
Climate
Fans
Covers
Valves
Locks
Alarms
Switches
Sensors
Presence

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Restore automatic backup

Choose an automatic backup

Select a serial port

Serial device path

Overwrite adapter IEEE address

Permanently replace the adapter IEEE address

Select an adapter type

Adapter type

Serial port settings

Serial port speedBaudrate to use when communicating with the serial port, usually 115200 or 460800
Serial port flow controlCheck your adapter's documentation for the correct option, usually None or Hardware
Serial device pathPath to the serial port or socket:// TCP address

Upload a manual backup

Upload a file

After setup

Choose an automatic backup
Serial device path
Permanently replace the adapter IEEE address
Adapter type
Serial port speed
Serial port flow control
Serial device path
Upload a file

Texts from Home Assistant's source code, Apache License 2.0.

Entities

AlarmsAlarm control panel
Binary sensorsAccelerometer, Binary input, Calibrated, Consumer connected, Error or battery low, External sensor, Fault alarm, Flow switch, IN1, and 28 more
ButtonsAllow remote binding, Boost mode, Calibrate sensor, Calibrate TVOC sensor, Calibrate valve, Calibrate Z axis, Configure cover limits, Delete all limits, Delete lower limit, and 24 more
ClimateThermostat
CoversCover, Keen vent, Shade
FansFan, Fan group
LightsLight, Light group
LocksDoor lock
NumbersAdditional steps, Air threshold, Alarm duration, Alarm humidity max, Alarm humidity min, Alarm temperature max, Alarm temperature min, Ambient sensor correction, and 223 more
SelectsActuator type, Adaptation run command, Alarm mode, Alarm ringtone, Alarm sound level, Alarm sound mode, Alarm volume, Approach distance, and 98 more
SensorsAC frequency, Acceleration X, Acceleration Y, Acceleration Z, Power phase B, Power phase C, Adaptation run status, Alarm level, and 122 more
SwitchesAdaptation run enabled, Adaptive mode, Alarm switch, Autoclean, Autorelock, Aux switch scenes, Away mode, Binding off to on sync level, and 85 more

Actions

Clear lock userClears a user code from a lock.Fields: Code slot
Disable lock userDisables a user code on a lock.Fields: Code slot
Enable lock userEnables a user code on a lock.Fields: Code slot
Issue Zigbee cluster commandIssues a command on the specified cluster on the specified entity.Fields: Args, Cluster ID, Cluster type, Command, Command Type, Endpoint ID, IEEE, Manufacturer, Params
Issue Zigbee group commandIssues a command on the specified cluster on the specified group.Fields: Args, Cluster ID, Cluster type, Command, Group, Manufacturer
PermitAllows nodes to join the Zigbee network.Fields: Duration, IEEE, Install code, QR code, Source IEEE
Reconfigure deviceReconfigures a ZHA device (heal device). Use this if you are having issues with the device. If the device in question is a battery-powered device, ensure it is awake and accepting commands when you use this action.Fields: IEEE
RemoveRemoves a node from the Zigbee network.Fields: IEEE
Set lock user codeSets a user code on a lock.Fields: Code slot, Code
Set Zigbee cluster attributeSets an attribute value for the specified cluster on the specified entity.Fields: Attribute, Cluster ID, Cluster type, Endpoint ID, IEEE, Manufacturer, Value
Warning device squawkThis action uses the WD capabilities to emit a quick audible/visible pulse called a "squawk". The squawk command has no effect if the WD is currently active (warning in progress).Fields: IEEE, Level, Mode, Strobe
Warning device starts alertThis action starts the operation of the warning device. The warning device alerts the surrounding area by audible (siren) and visual (strobe) signals.Fields: Duration, Duty cycle, IEEE, Intensity, Level, Mode, Strobe

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Zigbee network settings have changed, Zigbee adapter in incorrect state