jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Update MQTT docs for consistency (#3759)

Browse source 
Makes some updates to the MQTT docs pages for spelling and grammar, and
also consistency.
This commit is contained in:
Phil Hawthorne 2017-10-25 06:12:33 +11:00 • committed by Franck Nijhof
parent 5efe58ec85
commit 86a281bfb0
8 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

10
source/_components/light.mqtt.markdown
View file

@ -14,11 +14,11 @@ ha_iot_class: depends
The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`.
When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from device (message from `state_topic`).
When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from `state_topic`).
Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect light operation.
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation.
```yaml
# Example configuration.yml entry
@ -61,7 +61,7 @@ Configuration variables:
- **xy_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the XY value.
<p class='note warning'>
Make sure that your topics match exact. `some-topic/` and `some-topic` are different topics.
Make sure that your topics match exactly. `some-topic/` and `some-topic` are different topics.
</p>
<p class='note warning'>
@ -83,7 +83,7 @@ Configuration variables:
## {% linkable_title Examples %}
In this section you find some real life examples of how to use this sensor.
In this section you will find some real life examples of how to use this sensor.
### {% linkable_title Brightness and RGB support %}