Skip to content

Mqtt light command templates #25504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 3 commits into from
Jan 3, 2023
Merged

Mqtt light command templates #25504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f88fac
MQTT light hs_command_template documentation
orosam Dec 28, 2022
96d31c5
MQTT light xy_command_template documentation
orosam Jan 2, 2023
1970ff7
Clarify expected payload format for MQTT light hs_state_topic and xy_…
orosam Jan 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions source/_integrations/light.mqtt.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,14 +217,18 @@ effect_value_template:
description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the effect value."
required: false
type: string
hs_command_template:
description: "Defines a [template](/docs/configuration/templating/) to compose message which will be sent to `hs_command_topic`. Available variables: `hue` and `sat`."
required: false
type: string
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.
description: "The MQTT topic subscribed to receive color state updates in HS format. The expected payload is the hue and saturation values separated by commas, for example, `359.5,100.0`.
Comment thread
jbouwh marked this conversation as resolved.
Note: Brightness is received separately in the `brightness_state_topic`."
required: false
type: string
Expand Down Expand Up @@ -374,12 +378,16 @@ white_scale:
required: false
type: integer
default: 255
xy_command_template:
description: "Defines a [template](/docs/configuration/templating/) to compose message which will be sent to `xy_command_topic`. Available variables: `x` and `y`."
required: false
type: string
xy_command_topic:
description: "The MQTT topic to publish commands to change the light's XY state."
required: false
type: string
xy_state_topic:
description: The MQTT topic subscribed to receive XY state updates.
description: The MQTT topic subscribed to receive XY state updates. The expected payload is the X and Y color values separated by commas, for example, `0.675,0.322`.
required: false
type: string
xy_value_template:
Expand Down
2 changes: 2 additions & 0 deletions source/_integrations/mqtt.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ Configuration variable names in the discovery payload may be abbreviated to cons
'hold_stat_tpl': 'hold_state_template',
'hold_stat_t': 'hold_state_topic',
'hs_cmd_t': 'hs_command_topic',
'hs_cmd_tpl': 'hs_command_template',
Comment thread
jbouwh marked this conversation as resolved.
'hs_stat_t': 'hs_state_topic',
'hs_val_tpl': 'hs_value_template',
'ic': 'icon',
Expand Down Expand Up @@ -483,6 +484,7 @@ Configuration variable names in the discovery payload may be abbreviated to cons
'whit_val_stat_t': 'white_value_state_topic',
'whit_val_tpl': 'white_value_template',
'xy_cmd_t': 'xy_command_topic',
'xy_cmd_tpl': 'xy_command_template',
'xy_stat_t': 'xy_state_topic',
'xy_val_tpl': 'xy_value_template',
```
Expand Down