From cf7d20a1546af4ce11d9ab6a3e4dd6799e893db9 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Sat, 25 Oct 2025 21:13:39 +0200 Subject: [PATCH 1/7] [nrf52,zigbee] add basic doc --- content/components/_index.md | 1 + content/components/zigbee.md | 47 ++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 content/components/zigbee.md diff --git a/content/components/_index.md b/content/components/_index.md index 796409e6b8..86722a488c 100644 --- a/content/components/_index.md +++ b/content/components/_index.md @@ -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 diff --git a/content/components/zigbee.md b/content/components/zigbee.md new file mode 100644 index 0000000000..22a5776d38 --- /dev/null +++ b/content/components/zigbee.md @@ -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/) \ No newline at end of file From 5a5857d91cac970afb437706998085359bf7a5d4 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Sat, 25 Oct 2025 21:20:54 +0200 Subject: [PATCH 2/7] image --- static/images/zigbee.svg | 1 + 1 file changed, 1 insertion(+) create mode 100644 static/images/zigbee.svg diff --git a/static/images/zigbee.svg b/static/images/zigbee.svg new file mode 100644 index 0000000000..03f75c9b70 --- /dev/null +++ b/static/images/zigbee.svg @@ -0,0 +1 @@ + \ No newline at end of file From 9cc987b5e615d8da43b405c65b008d7d4c9371c1 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Sat, 25 Oct 2025 21:22:29 +0200 Subject: [PATCH 3/7] fix --- content/components/zigbee.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/components/zigbee.md b/content/components/zigbee.md index 22a5776d38..eaa0652e25 100644 --- a/content/components/zigbee.md +++ b/content/components/zigbee.md @@ -44,4 +44,4 @@ on_...: - {{< docref "esphome/" >}} - [Zigbee2MQTT](https://www.zigbee2mqtt.io/) -- [Zigbee Home Automation](https://www.home-assistant.io/integrations/zha/) \ No newline at end of file +- [Zigbee Home Automation](https://www.home-assistant.io/integrations/zha/) From 4dadcb626b8976ca5098775d20a3c528d7afffb8 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Sat, 25 Oct 2025 21:33:20 +0200 Subject: [PATCH 4/7] fix --- content/components/zigbee.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/content/components/zigbee.md b/content/components/zigbee.md index eaa0652e25..70e5cc8f6a 100644 --- a/content/components/zigbee.md +++ b/content/components/zigbee.md @@ -7,14 +7,21 @@ params: image: zigbee.svg --- -The `zigbee` component allows exposing supported ESPHome components over a Zigbee network to Home Assistant via **Zigbee2MQTT** or **ZHA**. +The `zigbee` component allows exposing supported ESPHome components over a Zigbee network to Home Assistant via **Zigbee2MQTT** or **ZHA**. +Due to the limitations of the Zigbee protocol, only basic properties are exposed. Additional functionality must be configured manually in Home Assistant. -## Supported Components +### Supported Components -- [Binary Sensor](#config-binary_sensor) +#### Binary Sensor + +- Only **state** and **name** are exposed over Zigbee. ```yaml # Example configuration entry +binary_sensor: + - platform: template + name: "Door 1" + zigbee: wipe_on_boot: true on_join: @@ -42,6 +49,5 @@ on_...: ## See Also -- {{< docref "esphome/" >}} - [Zigbee2MQTT](https://www.zigbee2mqtt.io/) - [Zigbee Home Automation](https://www.home-assistant.io/integrations/zha/) From 0036e436903c331916561ea839e3f3f5de6f6637 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Sat, 25 Oct 2025 21:37:48 +0200 Subject: [PATCH 5/7] fix --- content/components/zigbee.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/components/zigbee.md b/content/components/zigbee.md index 70e5cc8f6a..f48ea9b76b 100644 --- a/content/components/zigbee.md +++ b/content/components/zigbee.md @@ -8,7 +8,7 @@ params: --- The `zigbee` component allows exposing supported ESPHome components over a Zigbee network to Home Assistant via **Zigbee2MQTT** or **ZHA**. -Due to the limitations of the Zigbee protocol, only basic properties are exposed. Additional functionality must be configured manually in Home Assistant. +Due to the limitations of the Zigbee protocol, only basic properties are exposed. Additional properties must be configured manually in Home Assistant. ### Supported Components From 5c755b2e400e985ffbccd3d6dcb62de1ab443ea9 Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Sat, 25 Oct 2025 21:39:18 +0200 Subject: [PATCH 6/7] fix --- content/components/zigbee.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/content/components/zigbee.md b/content/components/zigbee.md index f48ea9b76b..52de9e7360 100644 --- a/content/components/zigbee.md +++ b/content/components/zigbee.md @@ -11,10 +11,7 @@ The `zigbee` component allows exposing supported ESPHome components over a Zigbe Due to the limitations of the Zigbee protocol, only basic properties are exposed. Additional properties must be configured manually in Home Assistant. ### Supported Components - -#### Binary Sensor - -- Only **state** and **name** are exposed over Zigbee. +- [Binary Sensor](#config-binary_sensor): only **state** and **name** are exposed over Zigbee. ```yaml # Example configuration entry From baca7dfdeacf227981130b7a00260dd818ecf5ef Mon Sep 17 00:00:00 2001 From: Tomasz Duda Date: Sat, 25 Oct 2025 21:41:07 +0200 Subject: [PATCH 7/7] fix --- content/components/zigbee.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/components/zigbee.md b/content/components/zigbee.md index 52de9e7360..74a83d4992 100644 --- a/content/components/zigbee.md +++ b/content/components/zigbee.md @@ -11,6 +11,7 @@ The `zigbee` component allows exposing supported ESPHome components over a Zigbe Due to the limitations of the Zigbee protocol, only basic properties are exposed. Additional properties must be configured manually in Home Assistant. ### Supported Components + - [Binary Sensor](#config-binary_sensor): only **state** and **name** are exposed over Zigbee. ```yaml