jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-16 22:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify state attributes rules for entity

Browse Source
This commit is contained in:
G Johansson 2024-11-03 18:32:58 +00:00
parent 4bd68db9ff
commit ec175df14e
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/core/entity.md
View File

@ -119,6 +119,17 @@ The following properties are also available on entities. However, they are for a
| state_attributes | <code>dict &#124; None</code> | `None` | State attributes of a base domain. This property is implemented by the domain base entity and should not be implemented by integrations. | state_attributes | <code>dict &#124; None</code> | `None` | State attributes of a base domain. This property is implemented by the domain base entity and should not be implemented by integrations.
| unit_of_measurement | <code>str &#124; None</code> | The unit of measurement that the entity's state is expressed in. In most cases, for example for the `number` and `sensor` domains, this is implemented by the domain base entity and should not be implemented by integrations. | unit_of_measurement | <code>str &#124; None</code> | The unit of measurement that the entity's state is expressed in. In most cases, for example for the `number` and `sensor` domains, this is implemented by the domain base entity and should not be implemented by integrations.
## State attributes
Entities can provide additional state attributes besides the built-in ones, to provide further details to it's state.
This should be done by providing a dictionary with keys and values to the `extra_state_attributes` property.
Providing additional state attributes comes with some rules:
- If an attribute is expected, it should be in the dictionary. Attributes should not "come and go".
- If an attribute is expected, but it's not providing a value right now, its value should be `None` and remain in the dictionary
- If an attributes is not expected, it should not be in the dictionary. As example, only some attributes might provide additional context to the state when the entity runs with a certain configuration.
## System properties ## System properties
The following properties are used and controlled by Home Assistant, and should not be overridden by integrations. The following properties are used and controlled by Home Assistant, and should not be overridden by integrations.