jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-11-11 12:01:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add entity state formatting documentation and blog article (#1891)

Browse Source 
* Add entity state formatting documentation and blog article

* Apply suggestions from code review

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Update docs/frontend/data.md

* Update docs/frontend/data.md

* Update docs/frontend/data.md

* Update docs/frontend/data.md

* Update blog/2023-08-29-hass-format-state.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
Paul Bottein
2023-08-30 11:49:12 +02:00
committed by GitHub
parent 5cb541c4ce
commit 03abe62825
2 changed files with 63 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/frontend/data.md
View File

@@ -3,7 +3,7 @@ title: "Frontend data"
sidebar_label: "Data"
---
The frontend passes a single `hass` object around. This object contains the latest state and allows you to send commands back to the server.
The frontend passes a single `hass` object around. This object contains the latest state, allows you to send commands back to the server and provides helpers to format entity state.
Whenever a state changes, a new version of the objects that changed are created. So you can easily see if something has changed by doing a strict equality check:
@@ -146,3 +146,43 @@ hass.callApi('delete', 'notify.html5', { subscription: 'abcdefgh' });
:::info
We're moving away from API calls and are migrating everything to `hass.callWS(message)` calls.
:::
## Entity state formatting
These methods allow you to format the state and attributes of an entity. The value will be localized using user profile settings (language, number format, date format, timezone) and unit of measurement.
### `hass.formatEntityState(stateObj, state)`
Format the state of an entity. You need to pass the entity state object.
```js
hass.formatEntityState(hass.states["light.my_light"]); // "On"
```
You can force the state value using the second optional parameter.
```js
hass.formatEntityState(hass.states["light.my_light"], 'off'); // "Off"
```
### `hass.formatEntityAttributeValue(stateObj, attribute, value)`
Format the attribute value of an entity. You need to pass the entity state object and the attribute name.
```js
hass.formatEntityAttributeValue(hass.states["climate.thermostat"], "current_temperature"); // "20.5 °C"
```
You can force the state value using the third optional parameter.
```js
hass.formatEntityAttributeValue(hass.states["climate.thermostat"], "current_temperature", 18); // "18 °C"
```
### `hass.formatEntityAttributeName(stateObj, attribute)`
Format the attribute name of an entity. You need to pass the entity state object and the attribute name.
```js
hass.formatEntityAttributeName(hass.states["climate.thermostat"], "current_temperature"); // "Current temperature"
```