Skip to content

Commit 08ecffa

Browse files
[nrf52, zigbee] add sensor (esphome#5862)
* fix * fi * fix * fix * Clean * Clean --------- Co-authored-by: Jonathan Swoboda <[email protected]>
1 parent 18162b3 commit 08ecffa

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

content/components/zigbee.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,21 @@ binary_sensor:
3434
3535
## Configuration variables
3636
37-
- **wipe_on_boot** (*Optional*, boolean): Erases all non-volatile memory data on boot.
38-
Use only if the device is in a boot loop crash. Defaults to `false`.
37+
- **wipe_on_boot** (*Optional*): Erases all non-volatile memory data on boot, including
38+
Zigbee network pairing and preferences (e.g., last switch state). One of:
39+
- `false` (default): Preserve data across reboots.
40+
- `true`: Erase all data on every boot. Use only for recovery from boot loops when
41+
you don't have an SWD programmer.
42+
- `once`: Erase data only on first boot after flashing new firmware, then preserve.
3943

4044
- **on_join** (*Optional*, [Automation](/automations#automation)): Automation to run when the device joins the network.
4145

4246
- **id** (*Optional*, [ID](/guides/configuration-types#id)): The ID to use for this `zigbee` component.
4347

48+
- **power_source** (*Optional*, enum): Indicates what kind of power the device uses. Affects
49+
sleep behavior. One of `UNKNOWN`, `MAINS_SINGLE_PHASE`, `MAINS_THREE_PHASE`, `BATTERY`,
50+
`DC_SOURCE`, `EMERGENCY_MAINS_CONST`, or `EMERGENCY_MAINS_TRANSF`. Defaults to `DC_SOURCE`.
51+
4452
## Actions
4553

4654
### `factory_reset` Action
@@ -81,6 +89,39 @@ binary_sensor:
8189
not be exposed over Zigbee. Only specifying an `id` without a `name` will implicitly set this to true.
8290
Use this if you run out of Zigbee endpoints.
8391

92+
### Sensor Configuration
93+
94+
All sensors with a `name` are automatically exposed over Zigbee.
95+
96+
```yaml
97+
sensor:
98+
- platform: template
99+
name: "Analog 1"
100+
lambda: return 10.0;
101+
unit_of_measurement: "°C"
102+
- platform: template
103+
name: "Analog 2"
104+
lambda: return 11.0;
105+
- platform: template
106+
id: internal_sensor
107+
lambda: return 9.0;
108+
- platform: template
109+
name: "Another internal sensor"
110+
internal: true
111+
lambda: return 8.0;
112+
```
113+
114+
#### Configuration variables
115+
116+
- **name** (**Required**, string): The name for the sensor. This is exposed as the
117+
Zigbee endpoint description.
118+
- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
119+
not be exposed over Zigbee. Only specifying an `id` without a `name` will implicitly set this to true.
120+
Use this if you run out of Zigbee endpoints.
121+
- **unit_of_measurement** (*Optional*, string): Manually set the unit. By default, values are unitless.
122+
Only a limited set of units is supported. Unsupported units will revert to unitless.
123+
This is exposed as the Zigbee endpoint engineering units.
124+
84125
## See Also
85126

86127
- [Zigbee2MQTT](https://www.zigbee2mqtt.io/)

0 commit comments

Comments
 (0)