jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add mqtt sensor example processing epoch timestamps (#31287)

Browse Source 
* Add mqtt sensor example processing epoch timestamps

* Explain how to test

* Fix

* tiny tweaks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Jan Bouwhuis 2024-02-07 11:36:52 +01:00 committed by GitHub
parent 3fc8d5ba79
commit 1522646b7e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 65 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
source/_integrations/sensor.mqtt.markdown
View File

@ -200,7 +200,71 @@ value_template:
## Examples
In this section you find some real-life examples of how to use this sensor.
In this section, you find some real-life examples showing how to use this sensor.
### Processing Unix EPOCH timestamps
The example below shows how an MQTT sensor can process a Unix EPOCH payload.
{% raw %}
Set up via YAML:
```yaml
# Example configuration.yaml entry
mqtt:
sensor:
- name: "turned on"
state_topic: "pump/timestamp_on"
device_class: "timestamp"
value_template: "{{ as_datetime(value) }}"
unique_id: "hp_1231232_ts_on"
device:
name: "Heat pump"
identifiers:
- "hp_1231232"
```
{% endraw %}
Or set up via MQTT discovery:
Discovery topic: `homeassistant/sensor/hp_1231232/config`
{% raw %}
```json
{
"name": "turned on",
"state_topic": "pump/timestamp_on",
"device_class": "timestamp",
"value_template": "{{ as_datetime(value) }}",
"unique_id": "hp_1231232_ts_on",
"device": {
"name": "Heat pump",
"identifiers": [
"hp_1231232"
]
}
}
```
{% endraw %}
To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages.
Payload topic: `pump/timestamp_on`
Payload: `1707294116`
To set the state of the sensor manually:
```bash
mosquitto_pub -h 127.0.0.1 -u username -p some_password -t pump/timestamp_on -m '1707294116'
```
Make sure the IP address of your MQTT broker is used and that user credentials have been set up correctly.
The `value_template` will render the Unix EPOCH timestamp to correct format: `2024-02-07 08:21:56+00:00`.
### JSON attributes topic configuration