Skip to content
Open

Zigbee2 #5526

Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/components/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ ESPHome-specific components or components supporting ESPHome device provisioning
"StatsD","components/statsd","connection.svg","dark-invert"
"UDP","components/udp","udp.svg",""
"Packet Transport","components/packet_transport/index","packet_transport.svg","dark-invert"
"Zigbee end device","components/zigbee","zigbee.svg",""
{{< /imgtable >}}

## Bluetooth/BLE
Expand Down
47 changes: 47 additions & 0 deletions content/components/zigbee.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
description: "Zigbee end device for zigbee2mqtt and ZHA."
title: "Zigbee end device"
params:
seo:
description: Zigbee end device for zigbee2mqtt and ZHA.
image: zigbee.svg
---

The `zigbee` component allows exposing supported ESPHome components over a Zigbee network to Home Assistant via **Zigbee2MQTT** or **ZHA**.

## Supported Components

- [Binary Sensor](#config-binary_sensor)

```yaml
# Example configuration entry
zigbee:
wipe_on_boot: true
on_join:
then:
- logger.log: "Joined network"
```

## Configuration variables

- **wipe_on_boot** (*Optional*, boolean): erases all non volatile memory data on boot; use only if the device is in boot loop crash. Defaults to `false`.

- **on_join** (*Optional*, [Automation](#automation)): Automation to run when the device join the network.

## Actions

## `factory_reset` Action

This [action](#config-action) triggers a factory reset of the zigbee device. It handles the leaving of the zigbee network.

```yaml
on_...:
then:
- zigbee.factory_reset
```

## See Also

- {{< docref "esphome/" >}}
- [Zigbee2MQTT](https://www.zigbee2mqtt.io/)
- [Zigbee Home Automation](https://www.home-assistant.io/integrations/zha/)
Loading