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 17:57:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

MQTT Light: Add documentation of hs-formatted color support (#6377)

Browse Source 
* Update light.mqtt.markdown

* Update light.mqtt.markdown
This commit is contained in:
emontnemery 2018-10-08 21:14:47 +02:00 committed by Franck Nijhof
parent 21472419df
commit 6a0427d2c2
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
source/_components/light.mqtt.markdown
View File

@ -88,6 +88,21 @@ effect_list:
description: The list of effects the light supports. description: The list of effects the light supports.
required: false required: false
type: string list type: string list
hs_command_topic:
description: "The MQTT topic to publish commands to change the light's color state in HS format (Hue Saturation).
Range for Hue: 0° .. 360°, Range of Saturation: 0..100.
Note: Brightness is sent separately in the `brightness_command_topic`."
required: false
type: string
hs_state_topic:
description: "The MQTT topic subscribed to receive color state updates in HS format.
Note: Brightness is received separately in the `brightness_state_topic`."
required: false
type: string
hs_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the HS value."
required: false
type: string
on_command_type: on_command_type:
description: "Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on." description: "Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on."
required: false required: false
@ -200,7 +215,7 @@ payload_not_available:
| RGB Color | ✔ | ✔ | ✔ | | RGB Color | ✔ | ✔ | ✔ |
| Transitions | ✘ | ✔ | ✔ | | Transitions | ✘ | ✔ | ✔ |
| XY Color | ✔ | ✔ | ✘ | | XY Color | ✔ | ✔ | ✘ |
| HS Color | ✘ | ✔ | ✘ | | HS Color | ✔ | ✔ | ✘ |
| White Value | ✔ | ✔ | ✔ | | White Value | ✔ | ✔ | ✔ |
## {% linkable_title Examples %} ## {% linkable_title Examples %}