From 0073d7a08fef79347ffc3292920084b32e51464d Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:23:47 +0200 Subject: [PATCH] l-integrations: add glossary reference to config file (#32758) --- source/_integrations/lacrosse.markdown | 2 +- source/_integrations/lawn_mower.mqtt.markdown | 2 +- source/_integrations/lcn.markdown | 246 +++++++++--------- source/_integrations/lg_netcast.markdown | 2 +- source/_integrations/light.markdown | 54 ++-- source/_integrations/light.mqtt.markdown | 18 +- source/_integrations/linode.markdown | 4 +- source/_integrations/lock.mqtt.markdown | 2 +- source/_integrations/lock.template.markdown | 2 +- source/_integrations/logger.markdown | 4 +- source/_integrations/lutron_caseta.markdown | 2 +- 11 files changed, 169 insertions(+), 169 deletions(-) diff --git a/source/_integrations/lacrosse.markdown b/source/_integrations/lacrosse.markdown index acfe2ba575c..48976ef6c57 100644 --- a/source/_integrations/lacrosse.markdown +++ b/source/_integrations/lacrosse.markdown @@ -110,7 +110,7 @@ sensor: ## Examples -To setup a LaCrosse sensor with multiple sensors, add the following to your `configuration.yaml` file: +To setup a LaCrosse sensor with multiple sensors, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lawn_mower.mqtt.markdown b/source/_integrations/lawn_mower.mqtt.markdown index d8c58a26742..315bdc45828 100644 --- a/source/_integrations/lawn_mower.mqtt.markdown +++ b/source/_integrations/lawn_mower.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` `lawn_mower` platform allows controlling a lawn mower over MQTT. ## Configuration -To enable MQTT lawn mower in your installation, add the following to your `configuration.yaml` file: +To enable MQTT lawn mower in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index 499f22f59c6..eaf16048618 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -51,7 +51,7 @@ There is currently support for the following device types within Home Assistant: ## Configuration -To use your LCN system in your installation, add the following lines to your `configuration.yaml` file. +To use your LCN system in your installation, add the following lines to your {% term "`configuration.yaml`" %} file. You have to specify at least one IP/port with login credentials for a PCHK host. Consider to store your credentials in a [`secrets.yaml`](/docs/configuration/secrets). @@ -370,49 +370,49 @@ The platforms and service calls use several predefined constants as parameters. ### Ports -| Constant | Values | -| -------- | ------ | -| OUTPUT_PORT | `output1`, `output2`, `output3`, `output4` | -| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` | -| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4`, `outputs` | -| LED_PORT | `led1`, `led2`, `led3`, `led4`, `led5`, `led6`, `led7`, `led8`, `led9`, `led10`, `led11`, `led12` | -| LOGICOP_PORT | `logicop1`, `logicop2`, `logicop3`, `logicop4` | +| Constant | Values | +| -------------- | -------------------------------------------------------------------------------------------------------------- | +| OUTPUT_PORT | `output1`, `output2`, `output3`, `output4` | +| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` | +| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4`, `outputs` | +| LED_PORT | `led1`, `led2`, `led3`, `led4`, `led5`, `led6`, `led7`, `led8`, `led9`, `led10`, `led11`, `led12` | +| LOGICOP_PORT | `logicop1`, `logicop2`, `logicop3`, `logicop4` | | BINSENSOR_PORT | `binsensor1`, `binsensor2`, `binsensor3`, `binsensor4`, `binsensor5`, `binsensor6`, `binsensor7`, `binsensor8` | The [MOTOR_PORT](#ports) values specify which hardware relay or outputs configuration will be used: -| Motor | Relay on/off | Relay up/down | +| Motor | Relay on/off | Relay up/down | | :------: | :----------: | :-----------: | -| `motor1` | `relay1` | `relay2` | -| `motor2` | `relay3` | `relay4` | -| `motor3` | `relay5` | `relay6` | -| `motor4` | `relay7` | `relay8` | +| `motor1` | `relay1` | `relay2` | +| `motor2` | `relay3` | `relay4` | +| `motor3` | `relay5` | `relay6` | +| `motor4` | `relay7` | `relay8` | -| Motor | Output up | Output down | +| Motor | Output up | Output down | | :-------: | :-------: | :---------: | -| `outputs` | `output1` | `output2` | +| `outputs` | `output1` | `output2` | ### Variables and Units -| Constant | Values | -| -------- | ------ | -| VARIABLE | `var1`, `var2`, `var3`, `var4`, `var5`, `var6`, `var7`, `var8`, `var9`, `var10`, `var11`, `var12`, `tvar`, `r1var`, `r2var` | -| SETPOINT | `r1varsetpoint`, `r2varsetpoint` | -| THRESHOLD | `thrs1`, `thrs2`, `thrs3`, `thrs4`, `thrs5`, `thrs2_1`, `thrs2_2`, `thrs2_3`, `thrs2_4`, `thrs3_1`, `thrs3_2`, `thrs3_3`, `thrs3_4`, `thrs4_1`, `thrs4_2`, `thrs4_3`, `thrs4_4` | -| S0_INPUT | `s0input1`, `s0input2`, `s0input3`, `s0input4` | -| VAR_UNIT | `native`, `°C`, `°K`, `°F`, `lux_t`, `lux_i`, `m/s`, `%`, `ppm`, `volt`, `ampere`, `degree` | -| TIME_UNIT | `seconds`, `minutes`, `hours`, `days` | -| RELVARREF | `current`, `prog` | -| REVERSE_TIME | `rt70`, `rt600`, `rt1200` | +| Constant | Values | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| VARIABLE | `var1`, `var2`, `var3`, `var4`, `var5`, `var6`, `var7`, `var8`, `var9`, `var10`, `var11`, `var12`, `tvar`, `r1var`, `r2var` | +| SETPOINT | `r1varsetpoint`, `r2varsetpoint` | +| THRESHOLD | `thrs1`, `thrs2`, `thrs3`, `thrs4`, `thrs5`, `thrs2_1`, `thrs2_2`, `thrs2_3`, `thrs2_4`, `thrs3_1`, `thrs3_2`, `thrs3_3`, `thrs3_4`, `thrs4_1`, `thrs4_2`, `thrs4_3`, `thrs4_4` | +| S0_INPUT | `s0input1`, `s0input2`, `s0input3`, `s0input4` | +| VAR_UNIT | `native`, `°C`, `°K`, `°F`, `lux_t`, `lux_i`, `m/s`, `%`, `ppm`, `volt`, `ampere`, `degree` | +| TIME_UNIT | `seconds`, `minutes`, `hours`, `days` | +| RELVARREF | `current`, `prog` | +| REVERSE_TIME | `rt70`, `rt600`, `rt1200` | ### States: -| Constant | Values | -| -------- | ------ | -| LED_STATE | `on`, `off`, `blink`, `flicker` | -| LOGICOP_STATE | `none`, `some`, `all` | -| KEY_STATE | `hit`, `make`, `break`, `dontsend` | +| Constant | Values | +| ------------- | ---------------------------------- | +| LED_STATE | `on`, `off`, `blink`, `flicker` | +| LOGICOP_STATE | `none`, `some`, `all` | +| KEY_STATE | `hit`, `make`, `break`, `dontsend` | ### Keys: @@ -577,11 +577,11 @@ Examples are button presses from remote controls (transmitters), transponder fin All events have some common attributes in their `event_data` which identify the sending LCN hardware module (e.g., the module the transponder is connected to): -| Event payload | Description | Values | -| ------------- | ----------- | ------ | -| `device_id` | Internal device id of LCN module | string | -| `segment_id` | Module's segment id | 5..128 | -| `module_id` | Module id | 5..254 | +| Event payload | Description | Values | +| ------------- | -------------------------------- | ------ | +| `device_id` | Internal device id of LCN module | string | +| `segment_id` | Module's segment id | 5..128 | +| `module_id` | Module id | 5..254 | In addition, every event has its own special attributes which are described below. All special attributes are optional and can be used as supplementary filters. @@ -590,12 +590,12 @@ All special attributes are optional and can be used as supplementary filters. The `lcn_transmitter` event is fired if a LCN remote control command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Transmitter code | string (6 hex values) | -| `level` | Key level | 0..4 | -| `key` | Key | 0..4 | -| `action` | Key action | `hit`, `make`, `break` | +| Special payload | Description | Values | +| --------------- | ---------------- | ---------------------- | +| `code` | Transmitter code | string (6 hex values) | +| `level` | Key level | 0..4 | +| `key` | Key | 0..4 | +| `action` | Key action | `hit`, `make`, `break` | Example: @@ -618,9 +618,9 @@ automation: The `lcn_transponder` event is fired if a LCN transponder command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Transponder code | string (6 hex values) | +| Special payload | Description | Values | +| --------------- | ---------------- | --------------------- | +| `code` | Transponder code | string (6 hex values) | Example: @@ -640,9 +640,9 @@ automation: The `lcn_fingerprint` event is fired if a LCN fingerprint command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Fingerprint code | string (6 hex values) | +| Special payload | Description | Values | +| --------------- | ---------------- | --------------------- | +| `code` | Fingerprint code | string (6 hex values) | Example: @@ -662,9 +662,9 @@ automation: The `lcn_codelock` event is fired if a LCN code lock command is received. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `code` | Code lock code | string (6 hex values) | +| Special payload | Description | Values | +| --------------- | -------------- | --------------------- | +| `code` | Code lock code | string (6 hex values) | Example: @@ -684,10 +684,10 @@ automation: The `lcn_send_keys` event is fired if the PCHK host receives a *send keys* command. -| Special payload | Description | Values | -| --------------- | ----------- | ------ | -| `key` | LCN Key | a1..c8 | -| `action` | Key action | `hit`, `make`, `break` | +| Special payload | Description | Values | +| --------------- | ----------- | ---------------------- | +| `key` | LCN Key | a1..c8 | +| `action` | Key action | `hit`, `make`, `break` | Example: @@ -723,12 +723,12 @@ Refer to the [Services Calls](/docs/scripts/service-calls) page for examples on Set absolute brightness of output port in percent. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | -| `brightness` | Yes | Absolute brightness in percent | 0..100 | -| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | --------------------------------- | --------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | +| `brightness` | Yes | Absolute brightness in percent | 0..100 | +| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | Example: @@ -745,12 +745,12 @@ data: Set relative brightness of output port in percent. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | -| `brightness` | Yes | Relative brightness in percent | -100..100 | -| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | --------------------------------- | --------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | +| `brightness` | Yes | Relative brightness in percent | -100..100 | +| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | Example: @@ -766,11 +766,11 @@ data: Toggle output port. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | -| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | --------------------------------- | --------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `output` | No | Output port of module | [OUTPUT_PORT](#ports) | +| `transition` | Yes | Transition (ramp) time in seconds | 0..486 | Example: @@ -789,10 +789,10 @@ Each character represents the state change of a relay (1=on, 0=off, t=toggle, -= Example states: `t---001-` -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `state` | No | Relay states as string | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `state` | No | Relay states as string | Example: @@ -807,10 +807,10 @@ data: Set the LED status. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `state` | No | LED state as string | [LED_STATE](#states) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | -------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `state` | No | LED state as string | [LED_STATE](#states) | Example: @@ -828,12 +828,12 @@ Set the absolute value of a variable or setpoint. If `value` is not defined, it is assumed to be 0. If `unit_of_measurement` is not defined, it is assumed to be `native`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | -| `value` | Yes | Variable value | _any positive number_ | -| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------------------------------------------------------------------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | +| `value` | Yes | Variable value | _any positive number_ | +| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | Example: @@ -857,12 +857,12 @@ Set the relative value of a variable or setpoint. If `value` is not defined, it is assumed to be 0. If `unit_of_measurement` is not defined, it is assumed to be `native`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units), [THRESHOLD](#variables-and-units) | -| `value` | Yes | Variable value | _any positive or negative number_ | -| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ----------------------------------------------------------------------------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units), [THRESHOLD](#variables-and-units) | +| `value` | Yes | Variable value | _any positive or negative number_ | +| `unit_of_measurement` | Yes | Variable unit | [VAR_UNIT](#variables-and-units) | Example: @@ -884,10 +884,10 @@ data: Reset value of variable or setpoint. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------------------------------------------------------------------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) | Example: @@ -908,11 +908,11 @@ data: Locks a regulator setpoint. If `state` is not defined, it is assumed to be `False`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `setpoint` | No | Setpoint name | [SETPOINT](#variables-and-units) | -| `state` | Yes | Lock state | true, false | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | -------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `setpoint` | No | Setpoint name | [SETPOINT](#variables-and-units) | +| `state` | Yes | Lock state | true, false | Example: @@ -932,13 +932,13 @@ If `state` is not defined, it is assumed to be `hit`. The command allows the sending of keys immediately or deferred. For a deferred sending the attributes `time` and `time_unit` have to be specified. For deferred sending, the only key state allowed is `hit`. If `time_unit` is not defined, it is assumed to be `seconds`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `keys` | No | Keys string | -| `state` | Yes | Keys state | [KEY_STATE](#states) | -| `time` | Yes | Deferred time | 0.. | -| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | --------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `keys` | No | Keys string | +| `state` | Yes | Keys state | [KEY_STATE](#states) | +| `time` | Yes | Deferred time | 0.. | +| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) | Examples: @@ -969,13 +969,13 @@ The key lock states are defined as a string with eight characters. Each characte The command allows the locking of keys for a specified time period. For a time period, the attributes `time` and `time_unit` have to be specified. For a time period, only table `a` is allowed. If `time_unit` is not defined, it is assumed to be `seconds`. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `table` | Yes | Table with keys to lock | -| `state` | No | Key lock states as string | [KEY_STATE](#states) | -| `time` | Yes | Time period to lock | 0.. | -| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | --------------------------------- | +| `address` | No | [LCN address](#lcn-addresses) | +| `table` | Yes | Table with keys to lock | +| `state` | No | Key lock states as string | [KEY_STATE](#states) | +| `time` | Yes | Time period to lock | 0.. | +| `time_unit` | Yes | Time unit | [TIME_UNIT](#variables-and-units) | Examples: @@ -1005,11 +1005,11 @@ The displays support four rows for text messages. Each row can be set independently and can store up to 60 characters (encoded in UTF-8). -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `row` | No | Text row 1..4 | -| `text` | No | Text to send for the specified row | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ---------------------------------- | ------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `row` | No | Text row 1..4 | +| `text` | No | Text to send for the specified row | Example: @@ -1025,10 +1025,10 @@ data: Send arbitrary PCK command. Only the command part of the PCK command has to be specified in the `pck` string. -| Service data attribute | Optional | Description | Values | -| ---------------------- | -------- | ----------- | ------ | -| `address` | No | [LCN address](#lcn-addresses) | -| `pck` | No | PCK command | +| Service data attribute | Optional | Description | Values | +| ---------------------- | -------- | ----------------------------- | ------ | +| `address` | No | [LCN address](#lcn-addresses) | +| `pck` | No | PCK command | Example: diff --git a/source/_integrations/lg_netcast.markdown b/source/_integrations/lg_netcast.markdown index 197b22c3458..54fcb6d7ebd 100644 --- a/source/_integrations/lg_netcast.markdown +++ b/source/_integrations/lg_netcast.markdown @@ -17,7 +17,7 @@ ha_config_flow: true The `lg_netcast` platform allows you to control a LG Smart TV running NetCast 3.0 (LG Smart TV models released in 2012) and NetCast 4.0 (LG Smart TV models released in 2013). For the new LG WebOS TV's use the [webostv](/integrations/webostv#media-player) platform. -To add a LG TV to your installation, add the following to your `configuration.yaml` file: +To add a LG TV to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/light.markdown b/source/_integrations/light.markdown index 6c530a915a4..e79877da712 100644 --- a/source/_integrations/light.markdown +++ b/source/_integrations/light.markdown @@ -17,7 +17,7 @@ This integration allows you to track and control various light bulbs. Read the i ### Default turn-on values -To set the default color, brightness and transition values when the light is turned on, create a custom `light_profiles.csv`, normally located in the default configuration folder where you find `configuration.yaml`. +To set the default color, brightness and transition values when the light is turned on, create a custom `light_profiles.csv`, normally located in the default configuration folder where you find {% term "`configuration.yaml`" %}. The `light_profiles.csv` has to have a header. The format of the header is: @@ -41,27 +41,27 @@ Turns one light on or multiple lights on using [groups](/integrations/group/). Most lights do not support all attributes. You can check the integration documentation of your particular light for hints, but in general, you will have to try things out and see what works. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. -| `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. -| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/core/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define an xy color, brightness and a transition value (if no transition is desired, set to 0 or leave out the column entirely). If a profile is given, and a brightness is set, then the profile brightness will be overwritten. -| `hs_color` | yes | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. -| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. -| `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets. -| `rgbw_color` | yes | A list containing four integers between 0 and 255 representing the RGBW color you want the light to be. Four comma-separated integers that represent the color in RGBW (red, green, blue, white), within square brackets. This attribute will be ignored by lights which do not support RGBW colors. -| `rgbww_color` | yes | A list containing five integers between 0 and 255 representing the RGBWW color you want the light to be. Five comma-separated integers that represent the color in RGBWW (red, green, blue, cold white, warm white), within square brackets. This attribute will be ignored by lights which do not support RGBWW colors. -| `color_temp_kelvin` | yes | An integer in Kelvin representing the color temperature you want the light to be. -| `kelvin` | yes | (Deprecated) Use `color_temp_kelvin` instead. -| `color_temp` | yes | (Deprecated) Alternatively, you can specify the color temperature in Mireds. -| `color_name` | yes | A human-readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/css-color-3/#svg-color) are supported. -| `brightness` | yes | Integer between 0 and 255 for how bright the light should be, where 0 means the light is off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light. -| `brightness_pct`| yes | Alternatively, you can specify brightness in percent (a number between 0 and 100), where 0 means the light is off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light. -| `brightness_step` | yes | Change brightness by an amount. Should be between -255..255. -| `brightness_step_pct` | yes | Change brightness by a percentage. Should be between -100..100. -| `white` | yes | Set the light to white mode by setting this to `True`. Note that `white` does not have a corresponding state attribute, so the `color_mode` state attribute will be set to `white`. -| `flash` | yes | Tell light to flash, can be either value `short` or `long`. -| `effect`| yes | Applies an effect such as `colorloop` or `random`. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. | +| `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. | +| `profile` | yes | String with the name of one of the [built-in profiles](https://github.com/home-assistant/core/blob/master/homeassistant/components/light/light_profiles.csv) (relax, energize, concentrate, reading) or one of the custom profiles defined in `light_profiles.csv` in the current working directory. Light profiles define an xy color, brightness and a transition value (if no transition is desired, set to 0 or leave out the column entirely). If a profile is given, and a brightness is set, then the profile brightness will be overwritten. | +| `hs_color` | yes | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. | +| `xy_color` | yes | A list containing two floats representing the xy color you want the light to be. Two comma-separated floats that represent the color in XY. | +| `rgb_color` | yes | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets. | +| `rgbw_color` | yes | A list containing four integers between 0 and 255 representing the RGBW color you want the light to be. Four comma-separated integers that represent the color in RGBW (red, green, blue, white), within square brackets. This attribute will be ignored by lights which do not support RGBW colors. | +| `rgbww_color` | yes | A list containing five integers between 0 and 255 representing the RGBWW color you want the light to be. Five comma-separated integers that represent the color in RGBWW (red, green, blue, cold white, warm white), within square brackets. This attribute will be ignored by lights which do not support RGBWW colors. | +| `color_temp_kelvin` | yes | An integer in Kelvin representing the color temperature you want the light to be. | +| `kelvin` | yes | (Deprecated) Use `color_temp_kelvin` instead. | +| `color_temp` | yes | (Deprecated) Alternatively, you can specify the color temperature in Mireds. | +| `color_name` | yes | A human-readable string of a color name, such as `blue` or `goldenrod`. All [CSS3 color names](https://www.w3.org/TR/css-color-3/#svg-color) are supported. | +| `brightness` | yes | Integer between 0 and 255 for how bright the light should be, where 0 means the light is off, 1 is the minimum brightness and 255 is the maximum brightness supported by the light. | +| `brightness_pct` | yes | Alternatively, you can specify brightness in percent (a number between 0 and 100), where 0 means the light is off, 1 is the minimum brightness and 100 is the maximum brightness supported by the light. | +| `brightness_step` | yes | Change brightness by an amount. Should be between -255..255. | +| `brightness_step_pct` | yes | Change brightness by a percentage. Should be between -100..100. | +| `white` | yes | Set the light to white mode by setting this to `True`. Note that `white` does not have a corresponding state attribute, so the `color_mode` state attribute will be set to `white`. | +| `flash` | yes | Tell light to flash, can be either value `short` or `long`. | +| `effect` | yes | Applies an effect such as `colorloop` or `random`. |
@@ -111,11 +111,11 @@ If no data is sent, and a default profile exists, the default profile will be ap Turns one or multiple lights off. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. -| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. -| `flash` | yes | Tell light to flash, can be either value `short` or `long`. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | +| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. | +| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. | +| `flash` | yes | Tell light to flash, can be either value `short` or `long`. | ### Service `light.toggle` diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 31ee29164a1..f59f2413fa4 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -413,7 +413,7 @@ In this section you will find some real-life examples of how to use this sensor. ### Brightness and RGB support -To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness and RGB support in your installation, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} @@ -441,7 +441,7 @@ mqtt: ### Brightness and no RGB support -To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness (no RGB version) in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -460,7 +460,7 @@ mqtt: ### Brightness without on commands -To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case: +To enable a light that sends only brightness topics to turn it on, add the following to your {% term "`configuration.yaml`" %} file. The `command_topic` is only used to send an off command in this case: ```yaml # Example configuration.yaml entry @@ -742,7 +742,7 @@ In this section you find some real-life examples of how to use this sensor. ### Brightness and RGB support -To enable a light with brightness and RGB support in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness and RGB support in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -758,7 +758,7 @@ mqtt: ### Brightness and no RGB support -To enable a light with brightness (but no color support) in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness (but no color support) in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -827,7 +827,7 @@ Home Assistant expects the hue values to be in the range 0 to 360 and the satura ### Brightness and RGBW support -To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your `configuration.yaml` file: +To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -1090,7 +1090,7 @@ In this section you find some real-life examples of how to use this light. ### Simple string payload -For a simple string payload with the format `state,brightness,r-g-b,h-s` (e.g., `on,255,255-255-255,360-100`), add the following to your `configuration.yaml` file: +For a simple string payload with the format `state,brightness,r-g-b,h-s` (e.g., `on,255,255-255-255,360-100`), add the following to your {% term "`configuration.yaml`" %} file: {% raw %} @@ -1114,7 +1114,7 @@ mqtt: ### JSON payload -For a JSON payload with the format `{"state": "on", "brightness": 255, "color": [255, 255, 255], "effect": "rainbow"}`, add the following to your `configuration.yaml` file: +For a JSON payload with the format `{"state": "on", "brightness": 255, "color": [255, 255, 255], "effect": "rainbow"}`, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} @@ -1159,7 +1159,7 @@ mqtt: This example comes from a configuration of Shelly RGBW Bulb working in White mode. `max_mireds` and `min_mireds` set color temperature boundaries to 3000K - 6500K. Notice the same limits are applied in `command_on_template`, but in kelvin units this time. It's due to conversion from mired to kelvin which causes exceeding boundary values accepted by the device. The code also ensures bi-directional conversion of brightness scale between 0-100 (required by the device) and 0-255 (required by Home Assistant). -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: {% raw %} diff --git a/source/_integrations/linode.markdown b/source/_integrations/linode.markdown index 5e18b151220..d3e9d820b9c 100644 --- a/source/_integrations/linode.markdown +++ b/source/_integrations/linode.markdown @@ -56,7 +56,7 @@ linode: The `linode` binary sensor platform allows you to monitor your Linode nodes. -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -77,7 +77,7 @@ nodes: The `linode` switch platform allows you to turn your Linode nodes on and off. -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index ea94daec7fc..83dc4571e03 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -21,7 +21,7 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i It's mandatory for locks to support `lock` and `unlock`. A lock may optionally support `open`, (e.g. to open the bolt in addition to the latch), in this case, `payload_open` is required in the configuration. If the lock is in optimistic mode, it will change states to `unlocked` when handling the `open` command. An MQTT lock can also report the intermediate states `unlocking`, `locking` or `jammed` if the motor reports a jammed state. -To enable MQTT locks in your installation, add the following to your `configuration.yaml` file: +To enable MQTT locks in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/lock.template.markdown b/source/_integrations/lock.template.markdown index 341c8680440..db5153e48f2 100644 --- a/source/_integrations/lock.template.markdown +++ b/source/_integrations/lock.template.markdown @@ -19,7 +19,7 @@ In optimistic mode, the lock will immediately change state after every command. ## Configuration -To enable Template Locks in your installation, add the following to your `configuration.yaml` file: +To enable Template Locks in your installation, add the following to your {% term "`configuration.yaml`" %} file: {% raw %} diff --git a/source/_integrations/logger.markdown b/source/_integrations/logger.markdown index 48bf62f3773..6fc27a0e667 100644 --- a/source/_integrations/logger.markdown +++ b/source/_integrations/logger.markdown @@ -15,14 +15,14 @@ The `logger` integration lets you define the level of logging activities in Home Assistant. To enable the `logger` integration in your installation, -add the following to your `configuration.yaml` file: +add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry logger: ``` -The log severity level is `warning` if the logger integration is not enabled in `configuration.yaml`. +The log severity level is `warning` if the logger integration is not enabled in {% term "`configuration.yaml`" %}. To log all messages and ignore events lower than critical for specified integrations: diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown index ca13682b775..4ca57f96e97 100644 --- a/source/_integrations/lutron_caseta.markdown +++ b/source/_integrations/lutron_caseta.markdown @@ -69,7 +69,7 @@ To use Lutron Caseta devices in your installation, you must first log in to your If you already have `caseta.key`, `caseta.crt`, `caseta-bridge.crt`, and cannot physically access the bridge to press the button, pairing can be done by utilizing these existing files. -Once you have the three necessary files, place them in your configuration directory and add the following to your `configuration.yaml`: +Once you have the three necessary files, place them in your configuration directory and add the following to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry