mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-04-29 15:57:15 +00:00
d6e06a716d
* Replace quotes with tip boxes The use of quotes was making important content less clear than the body. Docusaurus now has native tip boxes use remark-admonitions so use these instead. * Replace json5 codeblock language with json json5 doesn't have native syntax colouring. Rather than handle with custom css just flip block to have `json` set as language to create same result. All blocks were standard JSON anyway
1.1 KiB
1.1 KiB
| title | sidebar_label |
|---|---|
| Sensor Entity | Sensor |
A sensor is a read-only entity that provides some information. Information has a value and optionally, a unit of measurement.
Properties
:::tip
Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data.
:::
| Name | Type | Default | Description |
|---|---|---|---|
| state | string | Required | The value of the sensor. |
| unit_of_measurement | string | None |
The unit of measurement that the sensor is expressed in. |
| device_class | string | None |
Type of sensor. |
Available device classes
If specifying a device class, your sensor entity will need to also return the correct unit of measurement.
| Type | Unit | Description |
|---|---|---|
| battery | % | % of battery that is left. |
| humidity | % | % of humidity in the air. |
| illuminance | lx/lm | Light level. |
| signal_strength | dB/dBm | Signal strength. |
| temperature | °C/°F | Temperature. |
| timestamp | ISO8601 | Timestamp. |
| power | W,kW | Power. |
| pressure | hPa,mbar | Pressure. |