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-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

mqtt_statestream: Update docs for attribute/timestamp options (#3491)

Browse Source
This commit is contained in:
Matt White 2017-10-02 09:42:14 -06:00 committed by Fabian Affolter
parent 5297271d3a
commit e5fc3a363e
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
source/_components/mqtt_statestream.markdown
View File

@ -2,7 +2,7 @@
layout: page layout: page
title: "MQTT Statestream" title: "MQTT Statestream"
description: "Instructions how to setup MQTT Statestream within Home Assistant." description: "Instructions how to setup MQTT Statestream within Home Assistant."
date: 2017-09-11 08:00 date: 2017-10-01 20:00
sidebar: true sidebar: true
comments: false comments: false
sharing: true sharing: true
@ -21,11 +21,17 @@ To enable MQTT Statestream in Home Assistant, add the following section to your
# Example configuration.yaml entry # Example configuration.yaml entry
mqtt_statestream: mqtt_statestream:
base_topic: homeassistant base_topic: homeassistant
publish_attributes: true
publish_timestamps: true
``` ```
Configuration variables: Configuration variables:
- **base_topic** (*Required*): Base topic used to generate the actual topic used to publish. - **base_topic** (*Required*): Base topic used to generate the actual topic used to publish.
- **publish_attributes** (*Optional*): Publish attributes of the entity as well as the state.
Default is false.
- **publish_timestamps** (*Optional*): Publish the last_changed and last_updated timestamps for the entity.
Default is false.
## Operation ## Operation
@ -34,4 +40,8 @@ When any Home Assistant entity changes, this component will publish that change
The topic for each entity is different, so you can easily subscribe other systems to just the entities you are interested in. The topic for each entity is different, so you can easily subscribe other systems to just the entities you are interested in.
The topic will be in the form `base_topic/domain/entity/state`. The topic will be in the form `base_topic/domain/entity/state`.
For example, with the example configuration above, if an entity called 'light.master_bedroom_dimmer' is turned on, this component will publish `on` to `homeassistant/light/master_bedroom_dimmer/state`. For example, with the example configuration above, if an entity called 'light.master_bedroom_dimmer' is turned on, this component will publish `on` to `homeassistant/light/master_bedroom_dimmer/state`.
If that entity also has an attribute called `brightness`, the component will also publish the value of that attribute to `homeassistant/light/master_bedroom_dimmer/brightness`.
The last_updated and last_changed values for the entity will be published to `homeassistant/light/master_bedroom_dimmer/last_updated` and `homeassistant/light/master_bedroom_dimmer/last_changed`, respectively. The timestamps are in ISO 8601 format - for example, `2017-10-01T23:20:30.920969+00:00`.