+ You can now reorder the features of the tile card.
+
+
+ You can now reorder the features of the tile card.
+
+1. Go to {% my network title="**Settings** > **System** > **Network**" %} and take note of the **Host name**.
+ - Alternatively, you can look up the host name or IP address of your Home Assistant on your router.
+2. How you connect from another device to Home Assistant depends on your system. Use one of the following options:
+ - **On Windows**: Open **File Explorer** and in the address bar, enter the IP address or hostname with two backslashes as `\\your.ha.ip.address` or `\\hostname`.
-You should then be prompted for the credentials you entered in the Samba add-on configuration. You also have the option of having the credentials stored so that you do not need to enter them again. After that, you'll have access to the directories which you can then mount as a drive or pin to Quick Access.
+
+
+ Screenshot of File Explorer displaying the navigation to a file share using an IP address
+
diff --git a/source/_integrations/frontier_silicon.markdown b/source/_integrations/frontier_silicon.markdown
index 57ddc4efab9..23389fdce46 100644
--- a/source/_integrations/frontier_silicon.markdown
+++ b/source/_integrations/frontier_silicon.markdown
@@ -23,7 +23,7 @@ Frontier Silicon is used by many different brands of radio manufacturers.
Supported devices include, but are not limited to:
-- Hama: [IR50], [IR110], [DIR3110]
+- Hama: [IR50], [IR110], [DIR3110], [DIR355BT]
- Medion: [Medion Radios]
- Silvercrest: [SIRD 14 C2 (archived website)]
- Teufel: [Radio 3sixty (2019)]
diff --git a/source/_integrations/futurenow.markdown b/source/_integrations/futurenow.markdown
index 2ccf6263bec..e2b50ac041b 100644
--- a/source/_integrations/futurenow.markdown
+++ b/source/_integrations/futurenow.markdown
@@ -73,7 +73,7 @@ devices:
### Extended Configuration Sample
-The following example `configuration.yaml` has two different FutureNow units with multiple channels:
+The following example {% term "`configuration.yaml`" %} has two different FutureNow units with multiple channels:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/garadget.markdown b/source/_integrations/garadget.markdown
index b1c5d1115b6..a8b8c86e954 100644
--- a/source/_integrations/garadget.markdown
+++ b/source/_integrations/garadget.markdown
@@ -114,7 +114,7 @@ customize:
{% endraw %}
-Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your `configuration.yaml` to exclude those entries.
+Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your{% term "`configuration.yaml`" %} to exclude those entries.
```yaml
logbook:
diff --git a/source/_integrations/gc100.markdown b/source/_integrations/gc100.markdown
index 147631cb25c..cb7107f8fd3 100644
--- a/source/_integrations/gc100.markdown
+++ b/source/_integrations/gc100.markdown
@@ -53,7 +53,7 @@ port:
## Binary sensor
-To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file:
+To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your{% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/geniushub.markdown b/source/_integrations/geniushub.markdown
index b6ad825d9c5..a175c48be9c 100644
--- a/source/_integrations/geniushub.markdown
+++ b/source/_integrations/geniushub.markdown
@@ -179,7 +179,7 @@ value_template: "{{ state_attr('climate.genius_zone_12', 'status').occupied }}"
## Configuration
-To set up this integration, add one of the following to your `configuration.yaml` file.
+To set up this integration, add one of the following to your{% term "`configuration.yaml`" %}on.yaml`" %} file.
If required, you can switch between one Option and the other and, as the `unique_id` remains consistent, state history will be preserved. This assumes that the correct MAC address is provided for Option 2, below. If a wrong MAC address was provided for Option 1, then the MAC address can be overridden for Option 1 to maintain these links within the entity registry.
diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown
index 51eb1fee5f5..df95fa3648b 100644
--- a/source/_integrations/google_assistant.markdown
+++ b/source/_integrations/google_assistant.markdown
@@ -82,13 +82,13 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
9. Create a private key in JSON format.
10. This will start a download of a JSON file.
1. Rename the file to `SERVICE_ACCOUNT.JSON`.
- 2. Add this file to your config-folder. This will be the same folder as your `configuration.yaml`.
+ 2. Add this file to your config-folder. This will be the same folder as your{% term "`configuration.yaml`" %}.
11. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
12. Then select **Save**.
13. Go to the **Search products and resources** and search for **Homegraph API** and select it.
14. Enable the HomeGraph API.
-5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
+5. Add the `google_assistant` integration configuration to your{% term "`configuration.yaml`" %} file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
6. Add services in the Google Home App (note that app versions may be slightly different).
1. Open the Google Home app.
2. Select the `+` button on the top left corner, select **Set up device**. In the **Set up a device** screen, select **Works with Google**. You should have `[test] The Insteon apps (Director or Insteon for Hub) are a paid service utilizing the Insteon cloud to control an Insteon Hub. Home Assistant does not require the use of the Insteon app but can operate in conjunction with the app if desired.
-The Insteon panel allows for product specific configuration of Insteon devices and Insteon scenes.
+
+ If you choose to use the Insteon app, it is recommended to add devices and scenes using the Insteon app. Home Assistant will see the devices and scenes as well. Editing a device's All-Link Database can cause the device to become unresponsive. If this occurs, simply relink the device to the modem using the **Add device** directions in the [Insteon Panel](#insteon-panel). If you choose to use the Insteon app, it is recommended to add devices and scenes using the Insteon app. Home Assistant will see the devices and scenes as well. Devices and scenes added in Home Assistant will not be available in the Insteon app. Editing a device's All-Link Database can cause the device to become unresponsive. If this occurs, simply relink the device to the modem using the Add device directions above. Device overrides are not used to add a device to the Insteon integration. They are only used if a device that was linked correctly to the Insteon Modem but is not appearing in Home Assistant.
@@ -172,9 +203,9 @@ There are two primary uses for the **device override** feature:
- Devices that do not respond during autodiscovery. This is common for battery operated devices. Before using a device override, please trigger the device a few times and it will likely be discovered by Home Assistant.
- Devices that have not been fully developed. This allows an unknown device to be mapped to a device that operates similarly to another device.
-Device overrides can be set up using the integrations page inside the configuration panel.
+Device overrides can be set up using the [Insteon configuration panel](#insteon-configuration-panel).
-## Recovering After Factory Resetting The Hub
+## Recovering after factory resetting the hub
Many users tried to factory reset their Insteon Hub when the Insteon app stopped working in April 2022. If you are one of those users, you can perform the following steps to connect it to Home Assistant and get all of your devices up and working again.
@@ -186,6 +217,6 @@ Many users tried to factory reset their Insteon Hub when the Insteon app stopped
- If you have a Hub v2 you will need the default username and password which are printed on the bottom of the Hub
-3. Add devices to the Hub using the instructions for adding devices to the Insteon integration using the [Insteon Panel](#insteon-panel)
+3. Add devices to the Hub using the instructions for adding devices to the Insteon integration using the [Insteon configuration panel](#insteon-configuration-panel)
Once your devices are linked to the Hub again they will appear in Home Assistant automatically.
diff --git a/source/_integrations/integration.markdown b/source/_integrations/integration.markdown
index 2295ac90327..7bf9d3e400a 100644
--- a/source/_integrations/integration.markdown
+++ b/source/_integrations/integration.markdown
@@ -48,7 +48,7 @@ Integration time:
Alternatively, this integration can be configured and set up manually via YAML
as well. To enable the Integration sensor in your installation, add the
-following to your `configuration.yaml` file:
+following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/intellifire.markdown b/source/_integrations/intellifire.markdown
index a8e4a5a5c5e..c7649e1e46b 100644
--- a/source/_integrations/intellifire.markdown
+++ b/source/_integrations/intellifire.markdown
@@ -121,7 +121,7 @@ The IFT module can suffer a variety of issues that will render it inoperable. So
#### Enabling Debugging
-To turn on debug logging modify your `configuration.yaml` file in the `/config` directory and add the following:
+To turn on debug logging modify your {% term "`configuration.yaml`" %} file in the `/config` directory and add the following:
```yaml
diff --git a/source/_integrations/intesishome.markdown b/source/_integrations/intesishome.markdown
index 14cec3519bb..0cd50137713 100644
--- a/source/_integrations/intesishome.markdown
+++ b/source/_integrations/intesishome.markdown
@@ -19,7 +19,7 @@ Note: IntesisHome products are a separate product line to IntesisBox. This platf
## Configuration
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
climate:
diff --git a/source/_integrations/izone.markdown b/source/_integrations/izone.markdown
index afdd454ad12..74c64892a02 100644
--- a/source/_integrations/izone.markdown
+++ b/source/_integrations/izone.markdown
@@ -71,7 +71,7 @@ In this mode the current control zone that has been selected is reported, as is
zone (read-only, set the value via the individual zones). The current temperature will also be that of the control
zone.
-You can add configure to read these values into sensors (in `configuration.yaml`),
+You can add configure to read these values into sensors (in {% term "`configuration.yaml`" %}),
along with the supply temperature (use the ID of your unit):
{% raw %}
diff --git a/source/_integrations/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown
index 9d869075372..317995a707b 100644
--- a/source/_integrations/joaoapps_join.markdown
+++ b/source/_integrations/joaoapps_join.markdown
@@ -21,7 +21,7 @@ divided up in two locations, the Join integration, and the Joaoapps Join notify
The notify platform allows us to send messages to Joaoapps Join devices, the integration
allows us to access the other special features that Joaoapps Join offers. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this is based on.
-In the `configuration.yaml` file you need to provide the API key and device id
+In the {% term "`configuration.yaml`" %} file you need to provide the API key and device id
or name of the target device. You can find your device id and API key
[here](https://joinjoaomgcd.appspot.com/).
diff --git a/source/_integrations/keba.markdown b/source/_integrations/keba.markdown
index 427e5c62d97..55b4768c0cc 100644
--- a/source/_integrations/keba.markdown
+++ b/source/_integrations/keba.markdown
@@ -135,7 +135,7 @@ The service `keba.set_failsafe` sets the failsafe mode of the charging station.
## Notifications
-Some Keba chargers are equipped with a LED text display. The notification platform may be used to display text on this display. To enable this, add the following to your `configuration.yaml` file:
+Some Keba chargers are equipped with a LED text display. The notification platform may be used to display text on this display. To enable this, add the following to your {% term "`configuration.yaml`" %} file:
### Configuration
diff --git a/source/_integrations/keyboard.markdown b/source/_integrations/keyboard.markdown
index 2bb44b58147..905c9a7e080 100644
--- a/source/_integrations/keyboard.markdown
+++ b/source/_integrations/keyboard.markdown
@@ -18,7 +18,7 @@ The `keyboard` integration simulates key presses on the host machine. It current
- `keyboard/media_next_track`
- `keyboard/media_prev_track`
-To load this component, add the following lines to your `configuration.yaml`:
+To load this component, add the following lines to your {% term "`configuration.yaml`" %}:
```yaml
keyboard:
diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown
index 2998e7e6120..ff019861220 100644
--- a/source/_integrations/kodi.markdown
+++ b/source/_integrations/kodi.markdown
@@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %}
-If you previously had Kodi configured through `configuration.yaml`, it's advisable to remove it, and configure from the UI.
+If you previously had Kodi configured through {% term "`configuration.yaml`" %}, it's advisable to remove it, and configure from the UI.
If you do not remove it, your configuration will be imported with the following limitations:
- Your turn on/off actions will not be imported. This functionality is now available through device triggers.
- You may have duplicate entities.
@@ -107,7 +107,7 @@ The following scripts can be used in automations for turning on/off your Kodi in
#### Turn on Kodi with Wake on LAN
-With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to configuration the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your `configuration.yaml`.
+With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to configuration the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your {% term "`configuration.yaml`" %}.
```yaml
script:
@@ -307,7 +307,7 @@ script:
The `kodi` notifications platform allows you to send messages to your [Kodi](https://kodi.tv/) multimedia system from Home Assistant.
-To add Kodi to your installation, add the following to your `configuration.yaml` file:
+To add Kodi to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
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/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`. |
+
+ This service isn't tied to any integration entry, so it won't use the model, prompt, or any of the other settings in your options. If you only want to pass text, you should use the `conversation.process` service.
+
+
+
Allows you to ask Gemini Pro or Gemini Pro Vision to generate content from a prompt consisting of text and optionally images.
This service populates [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with the generated content.
diff --git a/source/_integrations/gree.markdown b/source/_integrations/gree.markdown
index 05206e49d3c..7db402cdc3b 100644
--- a/source/_integrations/gree.markdown
+++ b/source/_integrations/gree.markdown
@@ -61,4 +61,4 @@ Gree devices expose multiple switches to control various features:
- Light Panel, turns the front panel light on/off.
- Quiet Mode, enables/disables the quiet mode feature.
-- Xtra Fan, enables/disables extra fan mode to remove help moisture from coils.
+- Xtra Fan, enables/disables extra fan mode to help remove moisture from coils.
diff --git a/source/_integrations/greenwave.markdown b/source/_integrations/greenwave.markdown
index 2191bf2891c..8cc60322e96 100644
--- a/source/_integrations/greenwave.markdown
+++ b/source/_integrations/greenwave.markdown
@@ -17,7 +17,7 @@ This integration has been tested on firmware revisions:
- 2.0.105
-To configure the connection to the gateway, add the following to your `configuration.yaml` file:
+To configure the connection to the gateway, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
light:
diff --git a/source/_integrations/group.markdown b/source/_integrations/group.markdown
index d4d1e3abe3a..d8b53897002 100644
--- a/source/_integrations/group.markdown
+++ b/source/_integrations/group.markdown
@@ -129,7 +129,7 @@ To add or remove entities from an existing group, click on `Group options`, all
## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
-instead. Here are example of how to configure groups when using the `configuration.yaml` file.
+instead. Here are example of how to configure groups when using the {% term "`configuration.yaml`" %} file.
Example YAML configuration of a binary sensor group:
diff --git a/source/_integrations/harmony.markdown b/source/_integrations/harmony.markdown
index 8471327d2b9..e89ddfb5a74 100644
--- a/source/_integrations/harmony.markdown
+++ b/source/_integrations/harmony.markdown
@@ -51,18 +51,18 @@ This file will be overwritten whenever the Harmony HUB has a new configuration,
Turn off all devices that were switched on from the start of the current activity.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Entity ID to target.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------- |
+| `entity_id` | no | Entity ID to target. |
### Service `remote.turn_on`
-Start an activity. Will start the default `activity` from `configuration.yaml` if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/).
+Start an activity. Will start the default `activity` from {% term "`configuration.yaml`" %} if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/).
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Entity ID to target.
-| `activity` | yes | Activity ID or Activity Name to start.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------- |
+| `entity_id` | no | Entity ID to target. |
+| `activity` | yes | Activity ID or Activity Name to start. |
#### Example
@@ -94,13 +94,13 @@ action:
Send a single command or a set of commands to one device, device ID and available commands are written to the configuration file at startup. You can optionally specify the number of times you wish to repeat the command(s) and delay you want between repeated command(s).
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Entity ID to target.
-| `device` | no | Device ID or Device Name to send the command to.
-| `command` | no | A single command or a list of commands to send.
-| `num_repeats` | yes | The number of times to repeat the command(s).
-| `delay_secs` | yes | The number of seconds between sending each command.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------- |
+| `entity_id` | no | Entity ID to target. |
+| `device` | no | Device ID or Device Name to send the command to. |
+| `command` | no | A single command or a list of commands to send. |
+| `num_repeats` | yes | The number of times to repeat the command(s). |
+| `delay_secs` | yes | The number of seconds between sending each command. |
In the file 'harmony_REMOTENAME.conf' you can find the available devices and commands, for example:
@@ -158,10 +158,10 @@ data:
Sends the change channel command to the Harmony HUB
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Entity ID to target.
-| `channel` | no | Channel number to change to
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------- |
+| `entity_id` | no | Entity ID to target. |
+| `channel` | no | Channel number to change to |
A typical service call for changing the channel would be::
@@ -177,9 +177,9 @@ data:
Force synchronization between the Harmony device and the Harmony cloud.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | no | Entity ID to target.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------- |
+| `entity_id` | no | Entity ID to target. |
### Examples
diff --git a/source/_integrations/heatmiser.markdown b/source/_integrations/heatmiser.markdown
index 3052e54f036..d4ca1763ac7 100644
--- a/source/_integrations/heatmiser.markdown
+++ b/source/_integrations/heatmiser.markdown
@@ -17,7 +17,7 @@ The `heatmiser` climate platform lets you control [Heatmiser DT/DT-E/PRT/PRT-E](
Further work would be required to get this setup to connect over Wi-Fi, but the HeatmiserV3 Python module being used is a full implementation of the V3 protocol.
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
climate:
diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown
index 8fba4803b74..84abe6d82c1 100644
--- a/source/_integrations/heos.markdown
+++ b/source/_integrations/heos.markdown
@@ -41,10 +41,10 @@ username: "example@example.com"
password: "password"
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `username` | no | The username or email of the HEOS account.
-| `password` | no | The password of the HEOS account.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------ |
+| `username` | no | The username or email of the HEOS account. |
+| `password` | no | The password of the HEOS account. |
### Service `heos.sign_out`
@@ -62,11 +62,11 @@ media_content_type: "favorite"
media_content_id: "1"
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | `entity_id` of the player(s)
-| `media_content_type` | no | Set to the value `favorite`
-| `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------------------------- |
+| `entity_id` | yes | `entity_id` of the player(s) |
+| `media_content_type` | no | Set to the value `favorite` |
+| `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite |
#### Play playlist
@@ -78,11 +78,11 @@ media_content_type: "playlist"
media_content_id: "Awesome Music"
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | `entity_id` of the player(s)
-| `media_content_type` | no | Set to the value `playlist`
-| `media_content_id` | no | The name of the HEOS playlist
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------- |
+| `entity_id` | yes | `entity_id` of the player(s) |
+| `media_content_type` | no | Set to the value `playlist` |
+| `media_content_id` | no | The name of the HEOS playlist |
#### Play Quick Select
@@ -94,11 +94,11 @@ media_content_type: "quick_select"
media_content_id": "1"
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | `entity_id` of the player(s)
-| `media_content_type` | no | Set to the value `quick_select`
-| `media_content_id` | no | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`)
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------------------------------- |
+| `entity_id` | yes | `entity_id` of the player(s) |
+| `media_content_type` | no | Set to the value `quick_select` |
+| `media_content_id` | no | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`) |
#### Play URL
@@ -110,11 +110,11 @@ media_content_type: "url"
media_content_id: "http://path.to/stream.mp3"
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | `entity_id` of the player(s) to play the URL
-| `media_content_type` | no | Set to the value `url`
-| `media_content_id` | no | The full URL to the stream
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | -------------------------------------------- |
+| `entity_id` | yes | `entity_id` of the player(s) to play the URL |
+| `media_content_type` | no | Set to the value `url` |
+| `media_content_id` | no | The full URL to the stream |
### Service `media_player.join`
@@ -127,19 +127,19 @@ group_members:
- media_player.bathroom
```
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | The media player entity whose playback will be expanded to the players specified in `group_members`.
-| `group_members` | no | The player entities which will be synced with the playback from `entity_id`.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
+| `entity_id` | yes | The media player entity whose playback will be expanded to the players specified in `group_members`. |
+| `group_members` | no | The player entities which will be synced with the playback from `entity_id`. |
### Service `media_player.unjoin`
For removing a HEOS player from a group you can use the `media_player.unjoin` service.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ---------------------------------------------------- |
-| `entity_id` | yes | Unjoin this media player from any player groups. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------------------------ |
+| `entity_id` | yes | Unjoin this media player from any player groups. |
## Notes
@@ -150,7 +150,7 @@ For removing a HEOS player from a group you can use the `media_player.unjoin` se
### Debugging
-The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the relevant line below to the `configuration.yaml` to enable debug logging:
+The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the relevant line below to the {% term "`configuration.yaml`" %} to enable debug logging:
```yaml
logger:
diff --git a/source/_integrations/hikvision.markdown b/source/_integrations/hikvision.markdown
index 3740c932370..47fbbf54016 100644
--- a/source/_integrations/hikvision.markdown
+++ b/source/_integrations/hikvision.markdown
@@ -75,7 +75,7 @@ This platform also was confirmed to work with the following Hikvison-based NVRS
## Configuration
To enable this sensor,
-add the following lines are required in your `configuration.yaml` file:
+add the following lines are required in your {% term "`configuration.yaml`" %} file:
```yaml
binary_sensor:
@@ -166,7 +166,7 @@ Supported sensor/event types are:
## Examples
-Example of a configuration in your `configuration.yaml`
+Example of a configuration in your {% term "`configuration.yaml`" %}
that utilizes the customize options for a camera:
```yaml
@@ -184,7 +184,7 @@ binary_sensor:
ignored: true
```
-Example of a configuration in your `configuration.yaml`
+Example of a configuration in your {% term "`configuration.yaml`" %}
that utilizes the customize options for a nvr:
```yaml
diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown
index cbcac3f108f..99bcefc3c4d 100644
--- a/source/_integrations/history_stats.markdown
+++ b/source/_integrations/history_stats.markdown
@@ -144,7 +144,7 @@ This video tutorial explains how you can use history stats. It also shows how yo
### Examples
-Here are some examples of periods you could work with, and what to write in your `configuration.yaml`:
+Here are some examples of periods you could work with, and what to write in your {% term "`configuration.yaml`" %}:
**Today**: starts at 00:00 of the current day and ends right now.
diff --git a/source/_integrations/homekit.markdown b/source/_integrations/homekit.markdown
index 25662157b2f..4d090c32995 100644
--- a/source/_integrations/homekit.markdown
+++ b/source/_integrations/homekit.markdown
@@ -38,7 +38,7 @@ some trouble later. However, if you do encounter issues, check out the
If you want make specific changes to the way entities are published to HomeKit, override the
IP address the HomeKit integration uses to communicate with your network or change the
IP address the HomeKit uses to advertise itself to the network, then you will need to configure the
-HomeKit integration using an entry in your `configuration.yaml` file.
+HomeKit integration using an entry in your {% term "`configuration.yaml`" %} file.
This is an example entry of how that would look:
@@ -332,7 +332,7 @@ The HomeKit Accessory Protocol Specification only allows a maximum of 150 unique
### Multiple HomeKit instances
-If you create a HomeKit integration via the UI (i.e., **Settings** > **Devices & Services**), it must be configured via the UI **only**. While the UI only offers limited configuration options at the moment, any attempt to configure a HomeKit instance created in the UI via the `configuration.yaml` file will result in another instance of HomeKit running on a different port.
+If you create a HomeKit integration via the UI (i.e., **Settings** > **Devices & Services**), it must be configured via the UI **only**. While the UI only offers limited configuration options at the moment, any attempt to configure a HomeKit instance created in the UI via the {% term "`configuration.yaml`" %} file will result in another instance of HomeKit running on a different port.
It is recommended to only edit a HomeKit instance in the UI that was created in the UI, and likewise, only edit a HomeKit instance in YAML that was created in YAML.
@@ -405,37 +405,37 @@ If you have a firewall configured on your Home Assistant system, make sure you o
The following integrations are currently supported:
-| Integration | Type Name | Description |
-| --------- | --------- | ----------- |
-| alarm_control_panel | SecuritySystem | All security systems. |
-| automation / input_boolean / remote / scene / script / vacuum | Switch | All represented as switches. |
-| input_select / select | Switch | Represented as a power strip with buttons for each option. |
-| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. |
-| camera | Camera | All camera devices. **HomeKit Secure Video is not supported at this time.** |
-| climate | Thermostat | All climate devices. |
-| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` or `gate` as their `device_class`. |
-| cover | WindowCovering | All covers that support `set_cover_position`. |
-| cover | Door | All covers that support `set_cover_position` and have `door` as their `device_class`. |
-| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) |
-| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) |
-| device_tracker / person | Sensor | Support for `occupancy` device class. |
-| fan | Fan | Support for `on / off`, `direction` and `oscillating`. |
-| fan | Fan | All fans that support `speed` and `speed_list` through value mapping: `speed_list` is assumed to contain values in ascending order. The numeric ranges of HomeKit map to a corresponding entry of `speed_list`. The first entry of `speed_list` should be equivalent to `off` to match HomeKit's concept of fan speeds. (Example: `speed_list` = [`off`, `low`, `high`]; `off` -> `<= 33`; `low` -> between `33` and `66`; `high` -> `> 66`) |
-| humidifier | HumidifierDehumidifier | Humidifier and Dehumidifier devices. |
-| light | Light | Support for `on / off`, `brightness` and `rgb_color`. |
-| lock | DoorLock | Support for `lock / unlock`. |
-| media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. |
-| media_player | TelevisionMediaPlayer | All media players that have `tv` as their `device_class`. Represented as Television and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. |
-| media_player | ReceiverMediaPlayer | All media players that have `receiver` as their `device_class`. Represented as Receiver and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. |
-| sensor | TemperatureSensor | All sensors that have `°C` or `°F` as their `unit_of_measurement` and `temperature` as their `device_class`. |
-| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. |
-| sensor | AirQualitySensor | All sensors that have `gas`/`pm10`/`pm25` as part of their `entity_id` or `gas`/`pm10`/`pm25`/`nitrogen_dioxide`/`volatile_organic_compounds` as their `device_class`. The VOC mappings use the IAQ guidelines for Europe released by the WHO (World Health Organization). |
-| sensor | CarbonMonoxideSensor | All sensors that have `co` as their `device_class` |
-| sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` |
-| sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` |
-| switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. |
-| water_heater | WaterHeater | All `water_heater` devices. |
-| device_automation | DeviceTriggerAccessory | All devices that support triggers. |
+| Integration | Type Name | Description |
+| ------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| alarm_control_panel | SecuritySystem | All security systems. |
+| automation / input_boolean / remote / scene / script / vacuum | Switch | All represented as switches. |
+| input_select / select | Switch | Represented as a power strip with buttons for each option. |
+| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. |
+| camera | Camera | All camera devices. **HomeKit Secure Video is not supported at this time.** |
+| climate | Thermostat | All climate devices. |
+| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` or `gate` as their `device_class`. |
+| cover | WindowCovering | All covers that support `set_cover_position`. |
+| cover | Door | All covers that support `set_cover_position` and have `door` as their `device_class`. |
+| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) |
+| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) |
+| device_tracker / person | Sensor | Support for `occupancy` device class. |
+| fan | Fan | Support for `on / off`, `direction` and `oscillating`. |
+| fan | Fan | All fans that support `speed` and `speed_list` through value mapping: `speed_list` is assumed to contain values in ascending order. The numeric ranges of HomeKit map to a corresponding entry of `speed_list`. The first entry of `speed_list` should be equivalent to `off` to match HomeKit's concept of fan speeds. (Example: `speed_list` = [`off`, `low`, `high`]; `off` -> `<= 33`; `low` -> between `33` and `66`; `high` -> `> 66`) |
+| humidifier | HumidifierDehumidifier | Humidifier and Dehumidifier devices. |
+| light | Light | Support for `on / off`, `brightness` and `rgb_color`. |
+| lock | DoorLock | Support for `lock / unlock`. |
+| media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. |
+| media_player | TelevisionMediaPlayer | All media players that have `tv` as their `device_class`. Represented as Television and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. |
+| media_player | ReceiverMediaPlayer | All media players that have `receiver` as their `device_class`. Represented as Receiver and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. |
+| sensor | TemperatureSensor | All sensors that have `°C` or `°F` as their `unit_of_measurement` and `temperature` as their `device_class`. |
+| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. |
+| sensor | AirQualitySensor | All sensors that have `gas`/`pm10`/`pm25` as part of their `entity_id` or `gas`/`pm10`/`pm25`/`nitrogen_dioxide`/`volatile_organic_compounds` as their `device_class`. The VOC mappings use the IAQ guidelines for Europe released by the WHO (World Health Organization). |
+| sensor | CarbonMonoxideSensor | All sensors that have `co` as their `device_class` |
+| sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` |
+| sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` |
+| switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. |
+| water_heater | WaterHeater | All `water_heater` devices. |
+| device_automation | DeviceTriggerAccessory | All devices that support triggers. |
# Device triggers
@@ -525,7 +525,7 @@ The following home hubs have been reported to have trouble with a large number o
### Errors during pairing
-If you encounter any issues during pairing, make sure to add the following to your `configuration.yaml` to try and identify the issue(s).
+If you encounter any issues during pairing, make sure to add the following to your {% term "`configuration.yaml`" %} to try and identify the issue(s).
```yaml
logger:
diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown
index d38ac079152..cca8e9099de 100644
--- a/source/_integrations/homekit_controller.markdown
+++ b/source/_integrations/homekit_controller.markdown
@@ -62,7 +62,7 @@ The HomeKit Device integration automatically detects HomeKit [compatible devices
### Prerequisites
-- If you do not have the [`default_config`](/integrations/default_config/) integration, add [`zeroconf`](/integrations/zeroconf/) to your `configuration.yaml` file.
+- If you do not have the [`default_config`](/integrations/default_config/) integration, add [`zeroconf`](/integrations/zeroconf/) to your {% term "`configuration.yaml`" %} file.
- Find your HomeKit pairing code. The code is on the device itself, or on the packaging. If your device has a screen, it may be shown on screen.
- There is no way to recover this if you do not have it. In this case, you will need to contact the manufacturer to see what options you have.
- Make sure your device is powered up.
diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown
index cbdcf2ddac8..2a67d9a7be6 100644
--- a/source/_integrations/homematic.markdown
+++ b/source/_integrations/homematic.markdown
@@ -547,7 +547,7 @@ automation:
The `homematic` notification platform enables invoking Homematic devices.
-To use this notification platform in your installation, add the following to your `configuration.yaml` file:
+To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file:
### Configuration
diff --git a/source/_integrations/homematicip_cloud.markdown b/source/_integrations/homematicip_cloud.markdown
index 2fdba5f94ee..2c454d0df5b 100644
--- a/source/_integrations/homematicip_cloud.markdown
+++ b/source/_integrations/homematicip_cloud.markdown
@@ -56,7 +56,7 @@ Generate the authentication token:
`hmip_generate_auth_token.py`
-Add the information to your `configuration.yaml` file:
+Add the information to your {% term "`configuration.yaml`" %} file:
```yaml
homematicip_cloud:
diff --git a/source/_integrations/hp_ilo.markdown b/source/_integrations/hp_ilo.markdown
index 47948af801b..90c443a01ba 100644
--- a/source/_integrations/hp_ilo.markdown
+++ b/source/_integrations/hp_ilo.markdown
@@ -98,7 +98,7 @@ Valid sensor_types:
## Example
-In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your `configuration.yaml` file
+In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your {% term "`configuration.yaml`" %} file
{% raw %}
diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown
index 376f852f75b..c50b9e6f47d 100644
--- a/source/_integrations/humidifier.mqtt.markdown
+++ b/source/_integrations/humidifier.mqtt.markdown
@@ -18,7 +18,7 @@ When a `state_topic` is not available, the humidifier will work in optimistic mo
Optimistic mode can be forced even if a `state_topic` is available. Try to enable it if you are experiencing incorrect humidifier operation.
-To enable MQTT humidifiers in your installation, add the following to your `configuration.yaml` file:
+To enable MQTT humidifiers in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/hydrawise.markdown b/source/_integrations/hydrawise.markdown
index 150adb80cea..f50726cd18d 100644
--- a/source/_integrations/hydrawise.markdown
+++ b/source/_integrations/hydrawise.markdown
@@ -68,7 +68,7 @@ Switches are added for each zone, controlling:
When `auto_watering` is `on` the irrigation zone will follow the Smart Watering schedule set through the Hydrawise [mobile or web app](https://www.hydrawise.com). When the `auto_watering` switch is `off` the zone's Smart Watering schedule is suspended for 1 year.
-When `manual_watering` is `on` the zone will run for the amount of time set by `watering_minutes`.
+When `manual_watering` is `on` the zone will run for 15 minutes.
Due to changes in the Hydrawise API the status of the Auto Watering switches has changed. Under normal conditions the Auto Watering switches correctly reflect the Smart Watering schedule on the Hydrawise mobile or web app. However, if a rain sensor is connected to the system and it is active (rain detected), or the zone is running the Auto Watering switch will turn off. After both of those conditions are removed the switch will again show the correct Auto Watering condition.
diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown
index d73d606003d..126e45d4c3d 100644
--- a/source/_integrations/ifttt.markdown
+++ b/source/_integrations/ifttt.markdown
@@ -64,7 +64,7 @@ ifttt:
`key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**.
-Once you have added your key to your `configuration.yaml` file, restart your Home Assistant instance. This will load up the IFTTT integration and make a service available to trigger events in IFTTT.
+Once you have added your key to your {% term "`configuration.yaml`" %} file, restart your Home Assistant instance. This will load up the IFTTT integration and make a service available to trigger events in IFTTT.
After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow.
@@ -108,7 +108,7 @@ value3:
When your screen looks like this, click the 'call service' button.
-By default, the trigger is sent to all the API keys from `configuration.yaml`. If you
+By default, the trigger is sent to all the API keys from {% term "`configuration.yaml`" %}. If you
want to send the trigger to a specific key use the `target` field:
| Field | Value |
diff --git a/source/_integrations/image.mqtt.markdown b/source/_integrations/image.mqtt.markdown
index a63c856045c..366cb11e17d 100644
--- a/source/_integrations/image.mqtt.markdown
+++ b/source/_integrations/image.mqtt.markdown
@@ -18,7 +18,7 @@ An alternative setup is to use the `url_topic` option to receive an image URL fo
## Configuration
-To enable this image in your installation, add the following to your `configuration.yaml` file:
+To enable this image in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -176,7 +176,7 @@ url_topic:
### Example receiving images from a URL
-Add the configuration below to your `configuration.yaml`.
+Add the configuration below to your {% term "`configuration.yaml`" %}.
To test it publish an image URL to the topic from the console:
@@ -197,7 +197,7 @@ mqtt:
### Example receiving images from a file
-Add the configuration below to your `configuration.yaml`.
+Add the configuration below to your {% term "`configuration.yaml`" %}.
To test it, publish an image URL to the topic from the console:
diff --git a/source/_integrations/influxdb.markdown b/source/_integrations/influxdb.markdown
index 13420acfe7d..e1c2a13b056 100644
--- a/source/_integrations/influxdb.markdown
+++ b/source/_integrations/influxdb.markdown
@@ -17,7 +17,7 @@ related:
title: Configuration file
---
-The `influxdb` {% term integration %} makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available.
+The `influxdb` {% term integration %} makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database.
Additionally, you can now make use of an InfluxDB 2.0 installation with this {% term integration %}. See the [official installation instructions](https://v2.docs.influxdata.com/v2.0/) for how to set up an InfluxDB 2.0 database. Or you can sign up for their [cloud service](https://cloud2.influxdata.com/signup) and connect Home Assistant to that. Note that the configuration is significantly different for a 2.xx installation, the documentation below will note when fields or defaults apply to only a 1.xx installation or a 2.xx installation.
@@ -314,7 +314,7 @@ influxdb:
### Configuration
-To configure this sensor, you need to define the sensor connection variables and a list of queries to your `configuration.yaml` file. A sensor will be created for each query:
+To configure this sensor, you need to define the sensor connection variables and a list of queries to your {% term "`configuration.yaml`" %} file. A sensor will be created for each query:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/input_boolean.markdown b/source/_integrations/input_boolean.markdown
index 3ea219ddc1a..d86e1680c65 100644
--- a/source/_integrations/input_boolean.markdown
+++ b/source/_integrations/input_boolean.markdown
@@ -25,12 +25,12 @@ in which they are known as Toggle Helpers. To add one, go to
next choose the **{% my config_flow_start domain="input_boolean" title="Toggle" %}** option.
To be able to add **Helpers** via the user interface you should have
-`default_config:` in your `configuration.yaml`, it should already be there by
+`default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by
default unless you removed it. If you removed `default_config:` from your
-configuration, you must add `input_boolean:` to your `configuration.yaml` first,
+configuration, you must add `input_boolean:` to your {% term "`configuration.yaml`" %} first,
then you can use the UI.
-Input booleans can also be configured via `configuration.yaml`:
+Input booleans can also be configured via {% term "`configuration.yaml`" %}:
{% configuration %}
input_boolean:
diff --git a/source/_integrations/input_button.markdown b/source/_integrations/input_button.markdown
index 36ccde14901..6abcad97259 100644
--- a/source/_integrations/input_button.markdown
+++ b/source/_integrations/input_button.markdown
@@ -23,12 +23,12 @@ To add one, go to **{% my helpers title="Settings -> Devices & Services -> Helpe
and click the add button; next choose the **{% my config_flow_start domain="input_button" title="Button" %}** option.
To be able to add **Helpers** via the user interface you should have
-`default_config:` in your `configuration.yaml`, it should already be there by
+`default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by
default unless you removed it. If you removed `default_config:` from your
configuration, you must add `input_button:` to your `configuration.yaml` first,
then you can use the UI.
-Input buttons can also be configured via `configuration.yaml`:
+Input buttons can also be configured via {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/input_datetime.markdown b/source/_integrations/input_datetime.markdown
index b17c1a4dd99..995af13d187 100644
--- a/source/_integrations/input_datetime.markdown
+++ b/source/_integrations/input_datetime.markdown
@@ -18,12 +18,12 @@ templates.
The preferred way to configure input datetime is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_datetime" title="Date and/or time" %}** option.
-To be able to add **{% my helpers title="Helpers" %}** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it.
+To be able to add **{% my helpers title="Helpers" %}** via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it.
If you removed `default_config:` from your configuration, you must add `input_datetime:` to your `configuration.yaml` first, then you can use the UI.
`input_datetime` can also be configured via YAML. To add three datetime inputs to your installation,
one with both date and time, and one with date or time each,
-add the following lines to your `configuration.yaml`:
+add the following lines to your {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
@@ -78,12 +78,12 @@ input_datetime:
A datetime input entity's state exports several attributes that can be useful in
automations and templates.
-| Attribute | Description |
-| ----- | ----- |
-| `has_time` | `true` if this entity has a time.
-| `has_date` | `true` if this entity has a date.
-| `year`
-To enable this switch, add the following lines to your `configuration.yaml` file:
+To enable this switch, add the following lines to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown
index 307c8723d89..e046f2b3690 100644
--- a/source/_integrations/zwave_js.markdown
+++ b/source/_integrations/zwave_js.markdown
@@ -815,13 +815,15 @@ Switching does not require renaming your devices.
2. Note your network security keys from the official add-on.
-3. Install and configure the Z-Wave JS UI add-on, including setting the location of your Z-Wave device and the network security keys.
+3. Install and start the Z-Wave JS UI add-on.
-4. Add the Z-Wave integration again (even though it is still installed), and uncheck the "Use the Z-Wave JS Supervisor add-on". Enter the correct address for the community add-on in the URL field in the next step.
+4. Configure the Z-Wave JS UI add-on with the added control panel, including setting the location of your Z-Wave device and the network security keys.
-5. Uninstall the official Z-Wave JS add-on.
+5. Add the Z-Wave integration again (even though it is still installed), and uncheck the "Use the Z-Wave JS Supervisor add-on". Enter the correct address for the community add-on in the URL field in the next step.
-6. Enable the Z-Wave integration.
+6. Uninstall the official Z-Wave JS add-on.
+
+7. Enable the Z-Wave integration.
### What's the benefit of using Z-Wave JS UI add-on over the official add-on?
diff --git a/source/_posts/2024-05-01-release-20245.markdown b/source/_posts/2024-05-01-release-20245.markdown
index 30a1826d274..3c5a1c91fb0 100644
--- a/source/_posts/2024-05-01-release-20245.markdown
+++ b/source/_posts/2024-05-01-release-20245.markdown
@@ -53,6 +53,8 @@ Anyway, I will not hold you any longer. Enjoy the release!
- [Release 2024.5.1 - May 3](#release-202451---may-3)
- [Release 2024.5.2 - May 6](#release-202452---may-6)
- [Release 2024.5.3 - May 10](#release-202453---may-10)
+- [Release 2024.5.4 - May 17](#release-202454---may-17)
+- [Release 2024.5.5 - May 24](#release-202455---may-24)
- [Need help? Join the community!](#need-help-join-the-community)
- [Backward-incompatible changes](#backward-incompatible-changes)
- [Farewell to the following](#farewell-to-the-following)
@@ -422,24 +424,24 @@ The following {% term integrations %} are now available via the Home Assistant U
## Release 2024.5.3 - May 10
-- Fix Sonos select_source timeout error ([@PeteRager] - [#115640]) ([sonos docs])
-- Update strings for Bring notification service ([@tr4nt0r] - [#116181]) ([bring docs])
-- Bump Yolink api to 0.4.4 ([@matrixd2] - [#116967]) ([yolink docs])
+- Fix Sonos select_source timeout error ([@PeteRager] - [#115640])
+- Update strings for Bring notification service ([@tr4nt0r] - [#116181])
+- Bump Yolink api to 0.4.4 ([@matrixd2] - [#116967])
- Update jinja2 to 3.1.4 ([@cdce8p] - [#116986])
-- Simplify MQTT subscribe debouncer execution ([@bdraco] - [#117006]) ([mqtt docs])
-- Log an exception mqtt client call back throws ([@jbouwh] - [#117028]) ([mqtt docs])
-- Bump rokuecp to 0.19.3 ([@ctalkington] - [#117059]) ([roku docs])
-- Bump pyenphase to 1.20.3 ([@catsmanac] - [#117061]) ([enphase_envoy docs])
-- Add a missing `addon_name` placeholder to the SkyConnect config flow ([@puddly] - [#117089]) ([homeassistant_sky_connect docs])
-- Goodwe Increase max value of export limit to 200% ([@mletenay] - [#117090]) ([goodwe docs])
+- Simplify MQTT subscribe debouncer execution ([@bdraco] - [#117006])
+- Log an exception mqtt client call back throws ([@jbouwh] - [#117028])
+- Bump rokuecp to 0.19.3 ([@ctalkington] - [#117059])
+- Bump pyenphase to 1.20.3 ([@catsmanac] - [#117061])
+- Add a missing `addon_name` placeholder to the SkyConnect config flow ([@puddly] - [#117089])
+- Goodwe Increase max value of export limit to 200% ([@mletenay] - [#117090])
- Improve config entry has already been setup error message ([@bdraco] - [#117091])
-- Fix nws blocking startup ([@MatthewFlamm] - [#117094]) ([nws docs])
-- Make the mqtt discovery update tasks eager and fix race ([@jbouwh] - [#117105]) ([mqtt docs])
-- Bump goodwe to 0.3.5 ([@mletenay] - [#117115]) ([goodwe docs])
-- Handle tilt position being None in HKC ([@bdraco] - [#117141]) ([homekit_controller docs])
-- Fix typo in xiaomi_ble translation strings ([@jbouwh] - [#117144]) ([xiaomi_ble docs])
-- Bump pytrydan to 0.6.0 ([@dgomes] - [#117162]) ([v2c docs])
-- Bump deebot-client to 7.2.0 ([@edenhaus] - [#117189]) ([ecovacs docs])
+- Fix nws blocking startup ([@MatthewFlamm] - [#117094])
+- Make the mqtt discovery update tasks eager and fix race ([@jbouwh] - [#117105])
+- Bump goodwe to 0.3.5 ([@mletenay] - [#117115])
+- Handle tilt position being None in HKC ([@bdraco] - [#117141])
+- Fix typo in xiaomi_ble translation strings ([@jbouwh] - [#117144])
+- Bump pytrydan to 0.6.0 ([@dgomes] - [#117162])
+- Bump deebot-client to 7.2.0 ([@edenhaus] - [#117189])
[#115640]: https://github.com/home-assistant/core/pull/115640
[#116181]: https://github.com/home-assistant/core/pull/116181
@@ -476,20 +478,152 @@ The following {% term integrations %} are now available via the Home Assistant U
[@mletenay]: https://github.com/mletenay
[@puddly]: https://github.com/puddly
[@tr4nt0r]: https://github.com/tr4nt0r
-[accuweather docs]: /integrations/accuweather/
-[bring docs]: /integrations/bring/
-[ecovacs docs]: /integrations/ecovacs/
-[enphase_envoy docs]: /integrations/enphase_envoy/
-[goodwe docs]: /integrations/goodwe/
-[homeassistant_sky_connect docs]: /integrations/homeassistant_sky_connect/
-[homekit_controller docs]: /integrations/homekit_controller/
-[mqtt docs]: /integrations/mqtt/
-[nws docs]: /integrations/nws/
-[roku docs]: /integrations/roku/
-[sonos docs]: /integrations/sonos/
-[v2c docs]: /integrations/v2c/
-[xiaomi_ble docs]: /integrations/xiaomi_ble/
-[yolink docs]: /integrations/yolink/
+
+## Release 2024.5.4 - May 17
+
+- Fix Fully Kiosk set config service ([@amura11] - [#112840])
+- Mark Duotecno entities unavailable when tcp goes down ([@Cereal2nd] - [#114325])
+- Catch auth exception in husqvarna automower ([@Thomas55555] - [#115365])
+- Avoid exceptions when Gemini responses are blocked ([@tronikos] - [#116847])
+- Reduce update interval in Ondilo Ico ([@nijel] - [#116989])
+- Add reauth for missing token scope in Husqvarna Automower ([@Thomas55555] - [#117098])
+- Fix issue changing Insteon Hub configuration ([@teharris1] - [#117204])
+- Bump SoCo to 0.30.4 ([@jjlawren] - [#117212])
+- Fix zwave_js discovery logic for node device class ([@raman325] - [#117232])
+- Increase MQTT broker socket buffer size ([@jbouwh] - [#117267])
+- Fix Aurora naming ([@joostlek] - [#117314])
+- Call Google Assistant SDK service using async_add_executor_job ([@tronikos] - [#117325])
+- Fix squeezebox blocking startup ([@bdraco] - [#117331])
+- Fix Lutron Serena Tilt Only Wood Blinds set tilt function ([@wujiaqi] - [#117374])
+- Fix Kodi on/off status ([@mk-81] - [#117436])
+- Update wled to 0.17.1 ([@frenck] - [#117444])
+- Bump pyduotecno to 2024.5.0 ([@Cereal2nd] - [#117446])
+- Fix non-thread-safe state write in tellduslive ([@bdraco] - [#117487])
+- Reolink fix not unregistering webhook during ReAuth ([@starkillerOG] - [#117490])
+- Fix API creation for passwordless pi_hole ([@emontnemery] - [#117494])
+- Bump reolink-aio to 0.8.10 ([@starkillerOG] - [#117501])
+- Handle uncaught exceptions in Analytics insights ([@joostlek] - [#117558])
+- Fix poolsense naming ([@joostlek] - [#117567])
+- Improve syncing light states to deCONZ groups ([@Kane610] - [#117588])
+
+[#112840]: https://github.com/home-assistant/core/pull/112840
+[#114325]: https://github.com/home-assistant/core/pull/114325
+[#115365]: https://github.com/home-assistant/core/pull/115365
+[#116538]: https://github.com/home-assistant/core/pull/116538
+[#116696]: https://github.com/home-assistant/core/pull/116696
+[#116847]: https://github.com/home-assistant/core/pull/116847
+[#116937]: https://github.com/home-assistant/core/pull/116937
+[#116989]: https://github.com/home-assistant/core/pull/116989
+[#117098]: https://github.com/home-assistant/core/pull/117098
+[#117203]: https://github.com/home-assistant/core/pull/117203
+[#117204]: https://github.com/home-assistant/core/pull/117204
+[#117212]: https://github.com/home-assistant/core/pull/117212
+[#117232]: https://github.com/home-assistant/core/pull/117232
+[#117267]: https://github.com/home-assistant/core/pull/117267
+[#117314]: https://github.com/home-assistant/core/pull/117314
+[#117325]: https://github.com/home-assistant/core/pull/117325
+[#117331]: https://github.com/home-assistant/core/pull/117331
+[#117374]: https://github.com/home-assistant/core/pull/117374
+[#117436]: https://github.com/home-assistant/core/pull/117436
+[#117444]: https://github.com/home-assistant/core/pull/117444
+[#117446]: https://github.com/home-assistant/core/pull/117446
+[#117487]: https://github.com/home-assistant/core/pull/117487
+[#117490]: https://github.com/home-assistant/core/pull/117490
+[#117494]: https://github.com/home-assistant/core/pull/117494
+[#117501]: https://github.com/home-assistant/core/pull/117501
+[#117558]: https://github.com/home-assistant/core/pull/117558
+[#117567]: https://github.com/home-assistant/core/pull/117567
+[#117588]: https://github.com/home-assistant/core/pull/117588
+[@Cereal2nd]: https://github.com/Cereal2nd
+[@Kane610]: https://github.com/Kane610
+[@Thomas55555]: https://github.com/Thomas55555
+[@amura11]: https://github.com/amura11
+[@balloob]: https://github.com/balloob
+[@bdraco]: https://github.com/bdraco
+[@emontnemery]: https://github.com/emontnemery
+[@frenck]: https://github.com/frenck
+[@jbouwh]: https://github.com/jbouwh
+[@jjlawren]: https://github.com/jjlawren
+[@joostlek]: https://github.com/joostlek
+[@mk-81]: https://github.com/mk-81
+[@nijel]: https://github.com/nijel
+[@raman325]: https://github.com/raman325
+[@starkillerOG]: https://github.com/starkillerOG
+[@teharris1]: https://github.com/teharris1
+[@tronikos]: https://github.com/tronikos
+[@wujiaqi]: https://github.com/wujiaqi
+
+## Release 2024.5.5 - May 24
+
+- Fix Sonos album artwork performance ([@PeteRager] - [#116391])
+- Filter out HTML greater/less than entities from huawei_lte sensor values ([@scop] - [#117209])
+- Add options-property to Plugwise Select ([@bouwew] - [#117655])
+- Fix setting MQTT socket buffer size with WebsocketWrapper ([@bdraco] - [#117672])
+- Bump pyrisco to 0.6.2 ([@OnFreund] - [#117682])
+- Consider only active config entries as media source in Synology DSM ([@mib1185] - [#117691])
+- Bump aranet4 to 2.3.4 ([@Anrijs] - [#117738])
+- Bump crownstone-sse to 2.0.5, crownstone-cloud to 1.4.11 ([@RicArch97] - [#117748])
+- Block older versions of custom integration mydolphin_plus since they cause crashes ([@bdraco] - [#117751])
+- Fix race in config entry setup ([@bdraco] - [#117756])
+- Update wled to 0.18.0 ([@frenck] - [#117790])
+- Account for disabled ZHA discovery config entries when migrating SkyConnect integration ([@puddly] - [#117800])
+- Tesla Wall Connector fix spelling error/typo ([@bajansen] - [#117841])
+- Prevent time pattern reschedule if cancelled during job execution ([@swoga] - [#117879])
+- Update philips_js to 3.2.1 ([@elupus] - [#117881])
+- Bump pyrympro to 0.0.8 ([@OnFreund] - [#117919])
+- Add Shelly debug logging for async_reconnect_soon ([@thecode] - [#117945])
+- Update pySwitchbot to 0.46.0 to fix lock key retrieval ([@bdraco] - [#118005])
+- Improve async_get_issue_tracker for custom integrations ([@emontnemery] - [#118016])
+- Bump pySwitchbot to 0.46.1 ([@bdraco] - [#118025])
+- Extend the blocklist for Matter transitions with more models ([@marcelveldt] - [#118038])
+- Fix rc pylint warning in MQTT ([@frenck] - [#118050])
+- Add state check to config entry setup to ensure it cannot be setup twice ([@bdraco] - [#117193])
+
+[#116391]: https://github.com/home-assistant/core/pull/116391
+[#116538]: https://github.com/home-assistant/core/pull/116538
+[#116696]: https://github.com/home-assistant/core/pull/116696
+[#116937]: https://github.com/home-assistant/core/pull/116937
+[#117193]: https://github.com/home-assistant/core/pull/117193
+[#117203]: https://github.com/home-assistant/core/pull/117203
+[#117209]: https://github.com/home-assistant/core/pull/117209
+[#117631]: https://github.com/home-assistant/core/pull/117631
+[#117655]: https://github.com/home-assistant/core/pull/117655
+[#117672]: https://github.com/home-assistant/core/pull/117672
+[#117682]: https://github.com/home-assistant/core/pull/117682
+[#117691]: https://github.com/home-assistant/core/pull/117691
+[#117738]: https://github.com/home-assistant/core/pull/117738
+[#117748]: https://github.com/home-assistant/core/pull/117748
+[#117751]: https://github.com/home-assistant/core/pull/117751
+[#117756]: https://github.com/home-assistant/core/pull/117756
+[#117790]: https://github.com/home-assistant/core/pull/117790
+[#117800]: https://github.com/home-assistant/core/pull/117800
+[#117841]: https://github.com/home-assistant/core/pull/117841
+[#117879]: https://github.com/home-assistant/core/pull/117879
+[#117881]: https://github.com/home-assistant/core/pull/117881
+[#117919]: https://github.com/home-assistant/core/pull/117919
+[#117945]: https://github.com/home-assistant/core/pull/117945
+[#118005]: https://github.com/home-assistant/core/pull/118005
+[#118016]: https://github.com/home-assistant/core/pull/118016
+[#118025]: https://github.com/home-assistant/core/pull/118025
+[#118038]: https://github.com/home-assistant/core/pull/118038
+[#118050]: https://github.com/home-assistant/core/pull/118050
+[@Anrijs]: https://github.com/Anrijs
+[@OnFreund]: https://github.com/OnFreund
+[@PeteRager]: https://github.com/PeteRager
+[@RicArch97]: https://github.com/RicArch97
+[@bajansen]: https://github.com/bajansen
+[@balloob]: https://github.com/balloob
+[@bdraco]: https://github.com/bdraco
+[@bouwew]: https://github.com/bouwew
+[@elupus]: https://github.com/elupus
+[@emontnemery]: https://github.com/emontnemery
+[@frenck]: https://github.com/frenck
+[@marcelveldt]: https://github.com/marcelveldt
+[@mib1185]: https://github.com/mib1185
+[@puddly]: https://github.com/puddly
+[@scop]: https://github.com/scop
+[@swoga]: https://github.com/swoga
+[@thecode]: https://github.com/thecode
## Need help? Join the community!
diff --git a/source/_posts/2024-05-22-companion-app-for-ios-20245-assist.markdown b/source/_posts/2024-05-22-companion-app-for-ios-20245-assist.markdown
new file mode 100644
index 00000000000..b352722283f
--- /dev/null
+++ b/source/_posts/2024-05-22-companion-app-for-ios-20245-assist.markdown
@@ -0,0 +1,61 @@
+---
+layout: post
+title: "Companion app for iOS 2024.5: Let me Assist you 🍎"
+description: "Assist on iOS and companion App progress so far."
+date: 2024-05-22 00:00:02
+date_formatted: "May 22, 2024"
+author: Bruno Pantaleão
+comments: true
+categories: iOS Release-Notes
+og_image: /images/blog/2024-05-ios-assist/ios-og.jpg
+---
+
+Hey, this is Bruno. It has been a great few months since I joined Nabu Casa to work full-time on the Home Assistant iOS app, again a big thanks to our Home Assistant Cloud subscribers for making this possible. Today, I would like to recap what has been introduced since [the last blog post for version 2024.1](/blog/2024/01/29/companion-app-for-ios-20241-carplay/) and discuss more about how Assist is being integrated into the Apple ecosystem - along with a number of other improvements to the app.
+
+
+
+
+
+## Assist on iOS
+
+I am very happy to bring Assist for iOS with a new native UI, integrated with iOS shortcuts and widgets, so let’s start with a quick demo:
+
+
`month`
`day` | The year, month and day of the date.
(only available if `has_date: true`)
-| `timestamp` | A timestamp representing the time held in the input.
(only available if `has_time: true`)
+| Attribute | Description |
+| -------------------------- | -------------------------------------------------------------------------------------------- |
+| `has_time` | `true` if this entity has a time. |
+| `has_date` | `true` if this entity has a date. |
+| `year`
`month`
`day` | The year, month and day of the date.
(only available if `has_date: true`) |
+| `timestamp` | A timestamp representing the time held in the input.
(only available if `has_time: true`) |
### Restore state
@@ -95,12 +95,12 @@ Available service: `input_datetime.set_datetime` and `input_datetime.reload`.
#### input_datetime.set_datetime
-Service data attribute | Format String | Description
--|-|-
-`date` | `%Y-%m-%d` | This can be used to dynamically set the date.
-`time` | `%H:%M:%S` | This can be used to dynamically set the time.
-`datetime` | `%Y-%m-%d %H:%M:%S` | This can be used to dynamically set both the date & time.
-`timestamp` | N/A | This can be used to dynamically set both the date & time using a UNIX timestamp.
+| Service data attribute | Format String | Description |
+| ---------------------- | ------------------- | -------------------------------------------------------------------------------- |
+| `date` | `%Y-%m-%d` | This can be used to dynamically set the date. |
+| `time` | `%H:%M:%S` | This can be used to dynamically set the time. |
+| `datetime` | `%Y-%m-%d %H:%M:%S` | This can be used to dynamically set both the date & time. |
+| `timestamp` | N/A | This can be used to dynamically set both the date & time using a UNIX timestamp. |
To set both the date and time in the same call, use `date` and `time` together, or use `datetime` or `timestamp` by itself. Using `datetime` or `timestamp` has the advantage that both can be set using one template.
diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown
index cc9252568f5..b95f5b4a876 100644
--- a/source/_integrations/input_number.markdown
+++ b/source/_integrations/input_number.markdown
@@ -16,10 +16,10 @@ The **Input number** {% term integration %} allows the user to define values tha
The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_number" title="Number" %}** option.
-To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it.
+To be able to add **Helpers** via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it.
If you removed `default_config:` from you configuration, you must add `input_number:` to your `configuration.yaml` first, then you can use the UI.
-Input numbers can also be configured via `configuration.yaml`:
+Input numbers can also be configured via {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/input_select.markdown b/source/_integrations/input_select.markdown
index 72900456e38..442636fda92 100644
--- a/source/_integrations/input_select.markdown
+++ b/source/_integrations/input_select.markdown
@@ -16,10 +16,10 @@ The **Input select** {% term integration %} allows the user to define a list of
The preferred way to configure an input select is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_select" title="Dropdown" %}** option.
-To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it.
+To be able to add **Helpers** via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it.
If you removed `default_config:` from you configuration, you must add `input_select:` to your `configuration.yaml` first, then you can use the UI.
-Input selects can also be configured via `configuration.yaml`:
+Input selects can also be configured via {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown
index 8a57b830987..8960f0fa54c 100644
--- a/source/_integrations/input_text.markdown
+++ b/source/_integrations/input_text.markdown
@@ -16,10 +16,10 @@ The **Input text** {% term integration %} allows the user to define values that
The preferred way to configure an input text is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_text" title="Text" %}** option.
-To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it.
+To be able to add **Helpers** via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it.
If you removed `default_config:` from your configuration, you must add `input_text:` to your `configuration.yaml` first, then you can use the UI.
-It can also be configured via `configuration.yaml`:
+It can also be configured via {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entries
diff --git a/source/_integrations/insteon.markdown b/source/_integrations/insteon.markdown
index b815aba3616..193dca0801c 100644
--- a/source/_integrations/insteon.markdown
+++ b/source/_integrations/insteon.markdown
@@ -29,9 +29,9 @@ ha_dhcp: true
+The Insteon configuration panel allows for product specific configuration of Insteon devices and Insteon scenes.
@@ -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 3911011abf2..604a68376dc 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 4d9d8269828..862ee9531b5 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
diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown
index 278fe2491fe..a94c3500060 100644
--- a/source/_integrations/matrix.markdown
+++ b/source/_integrations/matrix.markdown
@@ -163,7 +163,7 @@ This configuration will:
The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](https://matrix.org/) room. Rooms can be both direct as well as group chats.
-To enable Matrix notifications in your installation, you first need to configure the [Matrix integration](#configuration). Then, add the following to your `configuration.yaml` file:
+To enable Matrix notifications in your installation, you first need to configure the [Matrix integration](#configuration). Then, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/media_source.markdown b/source/_integrations/media_source.markdown
index e00c857c581..fa6260eabb3 100644
--- a/source/_integrations/media_source.markdown
+++ b/source/_integrations/media_source.markdown
@@ -42,7 +42,7 @@ for example, the Samba add-on. Users of Home Assistant Container can
mount a volume of their choice to `/media`.
If you are a Home Assistant Core user, the default directory called is called
-`media` under the configuration path (where your `configuration.yaml` is located).
+`media` under the configuration path (where your {% term "`configuration.yaml`" %} is located).
Files served from `media` are protected by Home Assistant authentication
unlike those served from `www`.
diff --git a/source/_integrations/meteo_france.markdown b/source/_integrations/meteo_france.markdown
index 8d20f88deb8..7a3ea544391 100644
--- a/source/_integrations/meteo_france.markdown
+++ b/source/_integrations/meteo_france.markdown
@@ -32,9 +32,7 @@ It displays the current weather along with a 5 days forecast and create sensors,
## Weather platform
-To be used with the weather dashboard card to access current condition, today and next four days forecast.
-
-The weather platform can be configured in the frontend to decide if the forecast is given daily (default) or hourly. To change the setting go in **Settings** -> **Devices & Services**, click on the city name in **Météo-France** box and click on **Options**. You can update the `Forecast mode` by choosing between `daily` or `hourly`.
+To be used with the weather dashboard card to access current condition, today and next four days (default) or hours forecast.
## Sensor platforms
diff --git a/source/_integrations/meteoalarm.markdown b/source/_integrations/meteoalarm.markdown
index 10e8a2e4a6c..1f98c75c204 100644
--- a/source/_integrations/meteoalarm.markdown
+++ b/source/_integrations/meteoalarm.markdown
@@ -19,7 +19,7 @@ The binary sensor state shows the warning message if applicable. The details are
## Configuration
-To enable this binary sensor, add the following lines to your `configuration.yaml`:
+To enable this binary sensor, add the following lines to your {% term "`configuration.yaml`" %}:
```yaml
binary_sensor:
diff --git a/source/_integrations/mfi.markdown b/source/_integrations/mfi.markdown
index f1083aa5c8b..c243201875f 100644
--- a/source/_integrations/mfi.markdown
+++ b/source/_integrations/mfi.markdown
@@ -72,7 +72,7 @@ verify_ssl:
The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/).
-To add this platform to your installation, add the following to your `configuration.yaml` file:
+To add this platform to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown
index a41fb8d96e1..dd2f6a65a2c 100644
--- a/source/_integrations/microsoft_face.markdown
+++ b/source/_integrations/microsoft_face.markdown
@@ -27,7 +27,7 @@ Please note that all keys on cognitive services must be recreated every 90 days.
## Configuration
To enable the Microsoft Face {% term integration %},
-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/min_max.markdown b/source/_integrations/min_max.markdown
index 01fbed157ca..43a830e968b 100644
--- a/source/_integrations/min_max.markdown
+++ b/source/_integrations/min_max.markdown
@@ -39,7 +39,7 @@ Precision:
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
-following to your `configuration.yaml` file:
+following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/minio.markdown b/source/_integrations/minio.markdown
index 20ae31afb3f..6932373dd74 100644
--- a/source/_integrations/minio.markdown
+++ b/source/_integrations/minio.markdown
@@ -18,7 +18,7 @@ To download or upload files, folders must be added to [allowlist_external_dirs](
## Configuration
-To enable the Minio integration in your installation, add the following to your `configuration.yaml` file:
+To enable the Minio integration in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
minio:
diff --git a/source/_integrations/mochad.markdown b/source/_integrations/mochad.markdown
index 92a250b71b4..5fafc926e4e 100644
--- a/source/_integrations/mochad.markdown
+++ b/source/_integrations/mochad.markdown
@@ -62,7 +62,7 @@ mochad:
The `mochad` light platform lets you control an X10 enabled dimmer/light device.
-To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file:
+To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -99,7 +99,7 @@ brightness_levels:
The `mochad` switch platform lets you control an X10 enabled switch device.
-To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file:
+To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/modbus.markdown b/source/_integrations/modbus.markdown
index 329eee69ef3..06941962629 100644
--- a/source/_integrations/modbus.markdown
+++ b/source/_integrations/modbus.markdown
@@ -1386,6 +1386,10 @@ sensors:
description: "Suppress values close to zero. If -zero_suppress <= value <= +zero_suppress --> 0. Can be float or integer"
required: false
type: float
+ unique_id:
+ description: ID that uniquely identifies the entity. If two sensors have the same unique ID, Home Assistant will raise an exception.
+ required: false
+ type: string
{% endconfiguration %}
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/zestimate.markdown b/source/_integrations/zestimate.markdown
index 345614f771b..d05697c03ba 100644
--- a/source/_integrations/zestimate.markdown
+++ b/source/_integrations/zestimate.markdown
@@ -21,7 +21,7 @@ You will need to sign up for the Zillow API at the following link [Zillow API](h
For example, the White House zpid is 84074482 and can be found in its Zillow URL: [https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/](https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/)
-To enable this sensor, add the following lines to your `configuration.yaml`.
+To enable this sensor, add the following lines to your {% term "`configuration.yaml`" %}.
```yaml
sensor:
diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown
index 2a16e3f1761..05a15875915 100644
--- a/source/_integrations/zha.markdown
+++ b/source/_integrations/zha.markdown
@@ -223,7 +223,7 @@ Additional devices in the [Known working Zigbee radio modules](#known-working-zi
## Configuration - YAML
-For more advanced configuration, you can modify `configuration.yaml` and restart Home Assistant
+For more advanced configuration, you can modify {% term "`configuration.yaml`" %} and restart Home Assistant
{% configuration %}
database_path:
@@ -247,7 +247,7 @@ The ZHA {% term integration %} has the ability to automatically download and per
Online OTA providers for firmware updates are currently only available for IKEA, LEDVANCE/OSRAM, SALUS/Computime, and INOVELLI devices. Support for OTA updates from other manufacturers could be supported in the future if they publish their firmware images publicly.
-To enable OTA firmware updates for the ZHA {% term integration %} you need to add the following configuration to your `configuration.yaml` and restart Home Assistant:
+To enable OTA firmware updates for the ZHA {% term integration %} you need to add the following configuration to your {% term "`configuration.yaml`" %} and restart Home Assistant:
```yaml
zha:
@@ -308,7 +308,7 @@ The general recommendation is to only use channels 15, 20, or 25 in order to avo
As not all device manufacturers follow the Zigbee standard, at times a device can be incorrectly classified. For example, a switch could be classified as a light.
-To correct the device type, also called domain, add the following to your `configuration.yaml` and restart Home Assistant:
+To correct the device type, also called domain, add the following to your {% term "`configuration.yaml`" %} and restart Home Assistant:
```yaml
zha:
@@ -632,7 +632,7 @@ Note: Please also make sure you give it your best effort to follow the recommend
### Debug logging
-To enable debug logging for the ZHA {% term integration %} and radio libraries, add the following [logger](/integrations/logger/) configuration to `configuration.yaml`:
+To enable debug logging for the ZHA {% term integration %} and radio libraries, add the following [logger](/integrations/logger/) configuration to {% term "`configuration.yaml`" %}:
```yaml
logger:
diff --git a/source/_integrations/zhong_hong.markdown b/source/_integrations/zhong_hong.markdown
index f4270bdecc0..aedadb289af 100644
--- a/source/_integrations/zhong_hong.markdown
+++ b/source/_integrations/zhong_hong.markdown
@@ -13,7 +13,7 @@ ha_integration_type: integration
The `zhong_hong` climate platform lets you control Zhonghong HVAC Gateway Controller thermostats through Home Assistant.
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
climate:
diff --git a/source/_integrations/zone.markdown b/source/_integrations/zone.markdown
index 8d7f7d06798..b3411912a37 100644
--- a/source/_integrations/zone.markdown
+++ b/source/_integrations/zone.markdown
@@ -20,7 +20,7 @@ Zones can be added and managed through the user interface at {% my zones title="
You can add a zone in the user interface by specifying the GPS coordinates or dragging the icon on the map. You can adjust the zone radius (except for the Home zone) by changing the size of the zone circle.
-Zones can also be configured via `configuration.yaml`:
+Zones can also be configured via {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/zoneminder.markdown b/source/_integrations/zoneminder.markdown
index 32e50499bf7..7959118599a 100644
--- a/source/_integrations/zoneminder.markdown
+++ b/source/_integrations/zoneminder.markdown
@@ -124,7 +124,7 @@ The `zoneminder` camera platform lets you monitor the current stream of your [Zo
### Configuration
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -136,7 +136,7 @@ camera:
The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state.
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -178,7 +178,7 @@ You must have the [ZoneMinder integration](/integrations/zoneminder/) configured
diff --git a/source/_integrations/motioneye.markdown b/source/_integrations/motioneye.markdown
index 52a32384196..04aca2ec904 100644
--- a/source/_integrations/motioneye.markdown
+++ b/source/_integrations/motioneye.markdown
@@ -405,7 +405,7 @@ An automation to cast stored movie clips to a TV as they arrive.
### Debug Logging
To enable debug logging for both the integration and the underlying client library,
-enable the following in your `configuration.yaml` and then restart:
+enable the following in your {% term "`configuration.yaml`" %} and then restart:
```yaml
logger:
diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown
index b1b61e47fb6..11bee3cbaa6 100644
--- a/source/_integrations/mqtt.markdown
+++ b/source/_integrations/mqtt.markdown
@@ -153,7 +153,7 @@ If you experience an error message like `Failed to connect due to exception: [SS
### Advanced broker configuration
-Advanced broker configuration options include setting a custom client ID, setting a client certificate and key for authentication and enabling TLS validation of the brokers certificate for. To access the advanced settings, open the MQTT broker settings, switch on `Advanced options` and click `Next`. The advanced options will be shown by default if there are advanced settings active already.
+Advanced broker configuration options include setting a custom client ID, setting a client certificate and key for authentication, and enabling TLS validation of the broker's certificate for secure connection. To access the advanced settings, open the MQTT broker settings, switch on `Advanced options` and click `Next`. The advanced options will be shown by default if there are advanced settings active already.
diff --git a/source/_integrations/zabbix.markdown b/source/_integrations/zabbix.markdown
index 4aef704bbcd..fe5ef010379 100644
--- a/source/_integrations/zabbix.markdown
+++ b/source/_integrations/zabbix.markdown
@@ -148,7 +148,7 @@ The `zabbix` sensor platform let you monitor the current count of active trigger
You must have the Zabbix integration configured to use those sensors.
@@ -171,7 +171,7 @@ The time in seconds between sending keep alive messages for this client. The def
#### Broker certificate validation
-To enable a secure the broker certificate should be validated. If your broker uses a trusted certificate then choose `Auto`. This will allow validation against certifite CAs bundled certificates. If a self-signed certificate is used, select `Custom`. A custom PEM encoded CA-certificate can be uploaded. Click `NEXT` to show the control to upload the CA certificate.
+To enable a secure connection to the broker, the broker certificate should be validated. If your broker uses a trusted certificate, then choose `Auto`. This will allow validation against certificate CAs bundled certificates. If a self-signed certificate is used, select `Custom`. A custom PEM-encoded CA certificate can be uploaded. Click `NEXT` to show the control to upload the CA certificate.
If the server certificate does not match the hostname then validation will fail. To allow a connection without the verification of the hostname, turn the `Ignore broker certificate validation` switch on.
#### MQTT Protocol
diff --git a/source/_integrations/msteams.markdown b/source/_integrations/msteams.markdown
index db46b193c49..bbe20e2bef7 100644
--- a/source/_integrations/msteams.markdown
+++ b/source/_integrations/msteams.markdown
@@ -17,12 +17,12 @@ The `Microsoft Teams` platform allows you to send notifications from Home Assist
## Setup
-To send a notification to teams, you need to add the Incoming Webhook app to your team channel. When the app is added, you will receive a webhook URL that needs to be added to your `configuration.yaml`.
+To send a notification to teams, you need to add the Incoming Webhook app to your team channel. When the app is added, you will receive a webhook URL that needs to be added to your {% term "`configuration.yaml`" %}.
## Configuration
-To add the Microsoft Teams platform to your installation, add the following to your `configuration.yaml` file:
+To add the Microsoft Teams platform to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
notify:
@@ -46,9 +46,9 @@ url:
The following attributes can be placed inside `data` for extended functionality.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `image_url` | yes | Attach an image to the message.
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ------------------------------- |
+| `image_url` | yes | Attach an image to the message. |
The image must be an HTTPS URL, and as outlined by Microsoft in the [Documentation](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#common-properties-for-all-cards), the picture must be on a publicly available location.
diff --git a/source/_integrations/my.markdown b/source/_integrations/my.markdown
index fc650ba001b..07fb231a475 100644
--- a/source/_integrations/my.markdown
+++ b/source/_integrations/my.markdown
@@ -19,7 +19,7 @@ My Home Assistant allows the documentation to link you to specific pages in your
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
-Add the following section to your `configuration.yaml` file:
+Add the following section to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/mycroft.markdown b/source/_integrations/mycroft.markdown
index d1b230be3d0..33c91b31f58 100644
--- a/source/_integrations/mycroft.markdown
+++ b/source/_integrations/mycroft.markdown
@@ -41,7 +41,7 @@ host:
## Using notifications
-To use Mycroft for sending notifications, add the following to your `configuration.yaml` file:
+To use Mycroft for sending notifications, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown
index dd3fb8e3072..2568f640bdb 100644
--- a/source/_integrations/nest.markdown
+++ b/source/_integrations/nest.markdown
@@ -351,12 +351,12 @@ If you are still not getting notifications, you can read this [troubleshooting g
{% details "Google Home App Notification Settings" %}
-| Google Home App Setting | Notes |
-| ------------------------ | :-----------------------------------------------------------------------------------: |
-| Notifications: Push | Required for any detection event to be published |
-| Notifications: Away-Only | Events will only be published when a user is detected as away from home |
-| Seen: Motion | Required for `Motion` events to be published |
-| Seen: Person | Required for `Person` events to be published |
+| Google Home App Setting | Notes |
+| ------------------------ | :---------------------------------------------------------------------: |
+| Notifications: Push | Required for any detection event to be published |
+| Notifications: Away-Only | Events will only be published when a user is detected as away from home |
+| Seen: Motion | Required for `Motion` events to be published |
+| Seen: Person | Required for `Person` events to be published |
@@ -586,13 +586,13 @@ The *OAuth Client ID* used must be consistent, so check these:
- *Error: invalid_client no application name* means the [OAuth Consent Screen](https://console.developers.google.com/apis/credentials/consent) has not been fully configured for the project. Enter the required fields (App Name, Support Email, Developer Email) and leave everything else as default.
-- *Subscriber error* means that `configuration.yaml` has an incorrect `subscriber_id` or the subscription is misconfigured. It is recommended to delete this from the configuration, then delete and re-add the integration to let it create a subscription for you.
+- *Subscriber error* means that {% term "`configuration.yaml`" %} has an incorrect `subscriber_id` or the subscription is misconfigured. It is recommended to delete this from the configuration, then delete and re-add the integration to let it create a subscription for you.
- *Not receiving updates* typically means a problem with the subscriber configuration. Make sure to check the logs for any error messages. Changes for things like sensors or thermostat temperature set points should be instantly published to a topic and received by the Home Assistant subscriber when everything is configured correctly.
- You can see stats about your subscriber in the [Cloud Console](https://console.cloud.google.com/cloudpubsub/subscription/list) which includes counts of messages published by your devices, and how many have been acknowledged by your Home Assistant subscriber. You can also `View Messages` to see examples of published. Many old unacknowledged messages indicate the subscriber is not receiving the messages and working properly or not connected at all.
-- To aid in diagnosing subscriber problems or camera stream issues it may help to turn up verbose logging by adding some or all of these to your `configuration.yaml` depending on where you are having trouble:
+- To aid in diagnosing subscriber problems or camera stream issues it may help to turn up verbose logging by adding some or all of these to your {% term "`configuration.yaml`" %} depending on where you are having trouble:
```yaml
diff --git a/source/_integrations/netdata.markdown b/source/_integrations/netdata.markdown
index 42870d67453..28b329a1ff0 100644
--- a/source/_integrations/netdata.markdown
+++ b/source/_integrations/netdata.markdown
@@ -77,7 +77,7 @@ Once the `data_group` "system.load" and the `element` "load15" have been identif
## Configuration
-Add the following to your `configuration.yaml`.
+Add the following to your {% term "`configuration.yaml`" %}.
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/network.markdown b/source/_integrations/network.markdown
index 038d58736c6..93318f70b8d 100644
--- a/source/_integrations/network.markdown
+++ b/source/_integrations/network.markdown
@@ -28,7 +28,7 @@ If the next-hop cannot be detected or is a loopback address, auto detection will
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
-Add the following section to your `configuration.yaml` file:
+Add the following section to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/nfandroidtv.markdown b/source/_integrations/nfandroidtv.markdown
index fd1f994c6ed..4ffe982a49f 100644
--- a/source/_integrations/nfandroidtv.markdown
+++ b/source/_integrations/nfandroidtv.markdown
@@ -131,4 +131,4 @@ data:
{% endraw %}
-Please note that `path` is validated against the `allowlist_external_dirs` in the `configuration.yaml`.
+Please note that `path` is validated against the `allowlist_external_dirs` in the {% term "`configuration.yaml`" %}.
diff --git a/source/_integrations/notify.rest.markdown b/source/_integrations/notify.rest.markdown
index 493a1dea1af..a5ac079ae33 100644
--- a/source/_integrations/notify.rest.markdown
+++ b/source/_integrations/notify.rest.markdown
@@ -9,7 +9,7 @@ ha_domain: rest
The `rest` notification platform allows you to deliver [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) notifications from Home Assistant to another party.
-To enable the REST notification in your installation, add the following to your `configuration.yaml` file:
+To enable the REST notification in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/notify.tts.markdown b/source/_integrations/notify.tts.markdown
index eea95023dc7..490371cc652 100644
--- a/source/_integrations/notify.tts.markdown
+++ b/source/_integrations/notify.tts.markdown
@@ -15,7 +15,7 @@ In order to use this integration, you must already have a TTS platform installed
To enable this platform in your installation, consider the following example using [google_translate](/integrations/google_translate/) and an example `media_player.living_room`.
-In your `configuration.yaml` file type:
+In your {% term "`configuration.yaml`" %} file type:
```yaml
notify:
diff --git a/source/_integrations/notify_events.markdown b/source/_integrations/notify_events.markdown
index 60ada8c75cc..a7c8bdaa469 100644
--- a/source/_integrations/notify_events.markdown
+++ b/source/_integrations/notify_events.markdown
@@ -41,7 +41,7 @@ To start getting notifications, you need to follow those simple steps:
1. Sign up to [Notify.Events](https://notify.events/) and create a Channel
2. Add **Home Assistant** source to this channel and get your **token**
-3. Add the Notify.Events integration to your installation by adding the following to your `configuration.yaml` file:
+3. Add the Notify.Events integration to your installation by adding the following to your {% term "`configuration.yaml`" %} file:
```yaml
notify_events:
diff --git a/source/_integrations/nsw_fuel_station.markdown b/source/_integrations/nsw_fuel_station.markdown
index 28aae749533..6071c5ff867 100644
--- a/source/_integrations/nsw_fuel_station.markdown
+++ b/source/_integrations/nsw_fuel_station.markdown
@@ -32,7 +32,7 @@ Alternatively:
## Configuration
-To add the NSW fuel station price sensor to your installation, add the following to your `configuration.yaml` file:
+To add the NSW fuel station price sensor to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
sensor:
diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown
index 220cc1a6a65..ca7c58e4019 100644
--- a/source/_integrations/number.mqtt.markdown
+++ b/source/_integrations/number.mqtt.markdown
@@ -12,7 +12,7 @@ The `mqtt` Number platform allows you to integrate devices that might expose con
## Configuration
-To enable MQTT Number in your installation, add the following to your `configuration.yaml` file:
+To enable MQTT Number in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/nx584.markdown b/source/_integrations/nx584.markdown
index 23a44649cb7..ff801f76e5b 100644
--- a/source/_integrations/nx584.markdown
+++ b/source/_integrations/nx584.markdown
@@ -56,7 +56,7 @@ port:
Enabling this binary sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger.
-To enable this feature, add the following lines to your `configuration.yaml`:
+To enable this feature, add the following lines to your {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/opensky.markdown b/source/_integrations/opensky.markdown
index 0be281206c7..ecc9199afba 100644
--- a/source/_integrations/opensky.markdown
+++ b/source/_integrations/opensky.markdown
@@ -52,7 +52,7 @@ Both events have two attributes in common:
- **longitude**: Longitude of the flight in decimal.
- **icao24**: The ICAO 24-bit address of the aircraft's transponder.
-To receive notifications of the entering flights using the [Home Assistant Companion App](https://companion.home-assistant.io/), add the following lines to your `configuration.yaml` file:
+To receive notifications of the entering flights using the [Home Assistant Companion App](https://companion.home-assistant.io/), add the following lines to your {% term "`configuration.yaml`" %} file:
{% raw %}
diff --git a/source/_integrations/owntracks.markdown b/source/_integrations/owntracks.markdown
index a4b97ae3578..fe09773b832 100644
--- a/source/_integrations/owntracks.markdown
+++ b/source/_integrations/owntracks.markdown
@@ -53,7 +53,7 @@ By default, the integration listens for incoming messages from OwnTracks via HTT
## Advanced configuration
-OwnTracks allows the user to set advanced configuration by adding a section to your `configuration.yaml`.
+OwnTracks allows the user to set advanced configuration by adding a section to your {% term "`configuration.yaml`" %}.
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/person.markdown b/source/_integrations/person.markdown
index d098505ed26..ac2de5440e1 100644
--- a/source/_integrations/person.markdown
+++ b/source/_integrations/person.markdown
@@ -30,7 +30,7 @@ In short, when you're at home, your position is determined first by stationary t
**Hint**: When you use multiple device trackers together, especially stationary and GPS trackers, it's advisable to set `consider_home` for stationary trackers as low as possible see [device_tracker](/integrations/device_tracker/#configuring-a-device_tracker-platform)).
-You can manage persons {% my people title="via the UI from the person page inside the configuration panel" %} or via `YAML` in your `configuration.yaml` file.
+You can manage persons {% my people title="via the UI from the person page inside the configuration panel" %} or via `YAML` in your {% term "`configuration.yaml`" %} file.
## Configuring the `person` integration via the Home Assistant configuration panel
@@ -42,7 +42,7 @@ person:
## Configuring the `person` integration via YAML
-If you prefer YAML, you can also configure your persons via the `configuration.yaml` file:
+If you prefer YAML, you can also configure your persons via the {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/pilight.markdown b/source/_integrations/pilight.markdown
index 8d070eb7dd9..948ccc27b04 100644
--- a/source/_integrations/pilight.markdown
+++ b/source/_integrations/pilight.markdown
@@ -89,7 +89,7 @@ pilight:
The `pilight` binary sensor platform implements the [pilight hub](#configuration) binary sensor functionality. There are two types of Pilight binary sensor configuration: a normal sensor which sends the on and off cyclical state and a trigger sensor which sends only a trigger when an event happened (for example lots of cheap PIR motion detectors).
-To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:
+To enable a Pilight binary sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -156,7 +156,7 @@ binary_sensor:
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up.
-To use your sensor via pilight, make sure it is [supported](https://manual.pilight.org/protocols/index.html) and add the following to your `configuration.yaml` file:
+To use your sensor via pilight, make sure it is [supported](https://manual.pilight.org/protocols/index.html) and add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -222,7 +222,7 @@ Additionally, RF commands can be defined that trigger this switch to turn on and
To be really sure that Home Assistant knows the actual state of your device it is recommended to use the RF remote with codes unknown to any of your 433 MHz devices. Thus you use the remote to trigger this switch to send the correct RF code to the device.
-To define a Pilight switch, add the following lines to your `configuration.yaml`:
+To define a Pilight switch, add the following lines to your {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/proliphix.markdown b/source/_integrations/proliphix.markdown
index 500187b8f9e..ea652055267 100644
--- a/source/_integrations/proliphix.markdown
+++ b/source/_integrations/proliphix.markdown
@@ -17,7 +17,7 @@ Currently supported and tested thermostats:
- NT10e
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
climate:
diff --git a/source/_integrations/ps4.markdown b/source/_integrations/ps4.markdown
index 935361aef43..802fdba083b 100644
--- a/source/_integrations/ps4.markdown
+++ b/source/_integrations/ps4.markdown
@@ -81,7 +81,7 @@ sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5
To find your system Python path:
-- Add the [System Health](/integrations/system_health/) integration to your `configuration.yaml`. In a web browser, access your frontend and navigate to the about/logs page "http://
-To change the defaults for the `recorder` integration in your installation, add the following to your `configuration.yaml` file:
+To change the defaults for the `recorder` integration in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -208,21 +208,21 @@ recorder:
Call the service `recorder.purge` to start a purge task which deletes events and states older than x days, according to `keep_days` service data.
Note that purging will not immediately decrease disk space usage but it will significantly slow down further growth.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the integration `purge_keep_days` configuration) |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `keep_days` | yes | The number of history days to keep in recorder database (defaults to the integration `purge_keep_days` configuration) |
| `repack` | yes | When using SQLite or PostgreSQL this will rewrite the entire database. When using MySQL or MariaDB it will optimize or recreate the events and states tables. This is a heavy operation that can cause slowdowns and increased disk space usage while it runs. Only supported by SQLite, PostgreSQL, MySQL and MariaDB. |
-| `apply_filter` | yes | Apply entity_id and event_type filter in addition to time based purge. Useful in combination with `include` / `exclude` filter to remove falsely added states and events. Combine with `repack: true` to reduce database size. |
+| `apply_filter` | yes | Apply entity_id and event_type filter in addition to time based purge. Useful in combination with `include` / `exclude` filter to remove falsely added states and events. Combine with `repack: true` to reduce database size. |
### Service `purge_entities`
Call the service `recorder.purge_entities` to start a task that purges events and states from the recorder database that match any of the specified `entity_id`, `domains`, and `entity_globs` fields. At least one of the three selection criteria fields must be provided.
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `entity_id` | yes | A list of entity_ids that should be purged from the recorder database. |
-| `domains` | yes | A list of domains that should be purged from the recorder database. |
-| `entity_globs` | yes | A list of regular expressions that identify entities to purge from the recorder database. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
+| `entity_id` | yes | A list of entity_ids that should be purged from the recorder database. |
+| `domains` | yes | A list of domains that should be purged from the recorder database. |
+| `entity_globs` | yes | A list of regular expressions that identify entities to purge from the recorder database. |
| `keep_days` | yes | Number of history days to keep in the database of matching rows. The default of 0 days will remove all matching rows. |
#### Example automation to remove data rows for specific entities
diff --git a/source/_integrations/remember_the_milk.markdown b/source/_integrations/remember_the_milk.markdown
index 51fc05b9e66..5a5063690f8 100644
--- a/source/_integrations/remember_the_milk.markdown
+++ b/source/_integrations/remember_the_milk.markdown
@@ -6,7 +6,7 @@ ha_category:
ha_iot_class: Cloud Push
ha_release: 0.57
ha_domain: remember_the_milk
-ha_integration_type:
+ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
diff --git a/source/_integrations/remote_rpi_gpio.markdown b/source/_integrations/remote_rpi_gpio.markdown
index 11240d92841..23d816ca603 100644
--- a/source/_integrations/remote_rpi_gpio.markdown
+++ b/source/_integrations/remote_rpi_gpio.markdown
@@ -77,7 +77,7 @@ For more details about the GPIO layout, visit the Wikipedia [article](https://en
The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/).
-To use your remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
+To use your remote Raspberry Pi's GPIO in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/rflink.markdown b/source/_integrations/rflink.markdown
index c20d59ebaec..4479a40d2c1 100644
--- a/source/_integrations/rflink.markdown
+++ b/source/_integrations/rflink.markdown
@@ -93,10 +93,12 @@ rflink:
TCP mode allows you to connect to an RFLink device over a TCP/IP network. This is useful if placing the RFLink device next to the HA server is not optimal or desired (eg: bad reception).
-To expose the USB/serial interface over TCP on a different host (Linux) the following command can be used:
+The following command can be used to expose the USB/serial interface over TCP on a different host (Linux). The arguments are separated by spaces, further info on all arguments can be found for example [on the Debian manpages](https://manpages.debian.org/stretch/socat/socat.1.en.html).
+- `/dev/ttyACM0,b57600,rawer` specifies the device location, a `b57600` 57600 baud rate, and `rawer` causes socat to ignore control sequences sent via the port (for example, it makes socat pass all information 'rawest form', rather than picking up control characters such as control-C which would close socat).
+- `TCP-LISTEN:1234,reuseaddr,range=192.168.0.0/16` listens on IPV4 on the specified port (1234, change as suits your needs), the details behind the `reuseaddr` option [are fairly complex](https://stackoverflow.com/a/3233022/1049701) but it allows faster reconnects from the client (Home Assistant) in case of connection drops. An important security option is `range=192.168.0.0/16`, which specifies that socat should only accept connections from a certain range of IP addresses - the /16 subnet mask specifies a range from 192.168.0.0 to 192.168.255.255. Change this as required for your LAN network.
```bash
-socat /dev/ttyACM0,b57600,rawer TCP-LISTEN:1234,reuseaddr
+socat /dev/ttyACM0,b57600,rawer TCP-LISTEN:1234,reuseaddr,range=192.168.0.0/16
```
Other methods of exposing the serial interface over TCP are possible (eg: ESP8266 or using Arduino Wifi shield). Essentially the serial stream should be directly mapped to the TCP stream.
@@ -161,7 +163,7 @@ This configuration will ignore the button `1` of the `newkaku` device with ID `0
### Invert cover
-Devices can be configure to work in inverted mode by adding option in `configuration.yaml`:
+Devices can be configure to work in inverted mode by adding option in {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry for inverted RTS cover
diff --git a/source/_integrations/rfxtrx.markdown b/source/_integrations/rfxtrx.markdown
index d9d3a68b6d8..a1c876e043b 100644
--- a/source/_integrations/rfxtrx.markdown
+++ b/source/_integrations/rfxtrx.markdown
@@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant:
## Debug logging
-To receive debug logging from the RFXCOM device, add the following lines to `configuration.yaml`:
+To receive debug logging from the RFXCOM device, add the following lines to {% term "`configuration.yaml`" %}:
```yaml
logger:
diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown
index 504d469ecf8..9726760b587 100644
--- a/source/_integrations/ring.markdown
+++ b/source/_integrations/ring.markdown
@@ -106,7 +106,7 @@ You may consider some modifications in the subdirectory and the filename to suit
the above modification will save the video file under `
+
This integration only supports TTNv2 that has been definitively switched off in 2022 (deprecated).
For TTNv3, use the [MQTT integration](/integrations/mqtt).
+
The `thethingsnetwork` integration allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15 km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network.
@@ -53,7 +55,7 @@ Access keys
## Configuration
-To enable this integration, add the following lines to your `configuration.yaml`:
+To enable this integration, add the following lines to your {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
@@ -120,7 +122,7 @@ Devices overview
### Configuration
-To enable this platform, add the following lines to your `configuration.yaml`:
+To enable this platform, add the following lines to your {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/thingspeak.markdown b/source/_integrations/thingspeak.markdown
index df5b0b5d95c..e8171cbf885 100644
--- a/source/_integrations/thingspeak.markdown
+++ b/source/_integrations/thingspeak.markdown
@@ -16,7 +16,7 @@ For now, it records exactly one entity at once, which is great for testing purpo
You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use.
-To setup the ThingSpeak integration in your installation, add the following to your `configuration.yaml` file:
+To setup the ThingSpeak integration in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/thinkingcleaner.markdown b/source/_integrations/thinkingcleaner.markdown
index f049c8f2d3c..e008060e9d3 100644
--- a/source/_integrations/thinkingcleaner.markdown
+++ b/source/_integrations/thinkingcleaner.markdown
@@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
The `thinkingcleaner` sensor platform simple displays information about your [Thinking Cleaner (archived website)](https://web.archive.org/web/20220802042114/https://www.thinkingcleaner.com/) add-on.
-To enable this sensor in your installation, add the following to your `configuration.yaml` file:
+To enable this sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
sensor:
@@ -43,7 +43,7 @@ This will automatically add sensors for each Thinking Cleaner in your network.
The `thinkingcleaner` switch platform allows you to control your [Thinking Cleaner (archived website)](https://web.archive.org/web/20220802042114/https://www.thinkingcleaner.com/) add-on.
-To enable this switch in your installation, add the following to your `configuration.yaml` file:
+To enable this switch in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
switch:
diff --git a/source/_integrations/thomson.markdown b/source/_integrations/thomson.markdown
index 85305376800..d7009388d8f 100644
--- a/source/_integrations/thomson.markdown
+++ b/source/_integrations/thomson.markdown
@@ -15,7 +15,7 @@ Thomson produced networking equipment (under the brand name SpeedTouch) till 201
This platform allows you to detect presence by looking at connected devices to a [Thomson](https://www.technicolor.com/) device.
-To use this device tracker in your installation, add the following to your `configuration.yaml` file:
+To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/threshold.markdown b/source/_integrations/threshold.markdown
index 5e880d62806..10fd2092f39 100644
--- a/source/_integrations/threshold.markdown
+++ b/source/_integrations/threshold.markdown
@@ -37,7 +37,7 @@ Upper limit:
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
-following to your `configuration.yaml` file:
+following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/tikteck.markdown b/source/_integrations/tikteck.markdown
index b78090d7fed..1234327ea0b 100644
--- a/source/_integrations/tikteck.markdown
+++ b/source/_integrations/tikteck.markdown
@@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
-Support for the Bluetooth smart bulb from [Tikteck](https://www.tikteck.com/). To enable these lights, add the following lines to your `configuration.yaml` file:
+Support for the Bluetooth smart bulb from [Tikteck](https://www.tikteck.com/). To enable these lights, add the following lines to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown
index 60acde7ac07..cefa8f42d82 100644
--- a/source/_integrations/timer.markdown
+++ b/source/_integrations/timer.markdown
@@ -26,10 +26,10 @@ However, automations using the `timer.finished` event **will not** trigger if th
The preferred way to configure timer helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button; next choose the {% my config_flow_start domain=page.ha_domain title=page.title %} option.
-To be able to add Helpers via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI.
+To be able to add Helpers via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI.
Timers can also be configured via configuration.yaml:
-To add a timer to your installation, add the following to your `configuration.yaml` file:
+To add a timer to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/tmb.markdown b/source/_integrations/tmb.markdown
index dcc5767f0c0..1b70653784d 100644
--- a/source/_integrations/tmb.markdown
+++ b/source/_integrations/tmb.markdown
@@ -17,7 +17,7 @@ This sensor will provide you the remaining time, in minutes, for the next bus in
You must create an application on [developer.tmb.cat](https://developer.tmb.cat/account/applications/public/new) to obtain the `app_id` and `app_key` values that you will need.
-Add the data to your `configuration.yaml` file as shown in the example:
+Add the data to your {% term "`configuration.yaml`" %} file as shown in the example:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/tod.markdown b/source/_integrations/tod.markdown
index d7a193c03b3..57e458ef019 100644
--- a/source/_integrations/tod.markdown
+++ b/source/_integrations/tod.markdown
@@ -35,7 +35,7 @@ The time ranges can be provided as absolute local time or using the `sunrise` or
In addition for sun position based ranges, the negative or positive offset can be configured.
To enable the Times of Day binary sensor in your installation, add the
-following to your `configuration.yaml` file:
+following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown
index 127d9401328..6c50a7b9c59 100644
--- a/source/_integrations/todoist.markdown
+++ b/source/_integrations/todoist.markdown
@@ -42,7 +42,7 @@ You need to determine your Todoist API token. Go to the [**Integrations** > **De
## Custom projects
-You can manually configure the Todoist calendar (only) integration using `configuration.yaml` which can specify "custom" projects which match against criteria you set. You should
+You can manually configure the Todoist calendar (only) integration using {% term "`configuration.yaml`" %} which can specify "custom" projects which match against criteria you set. You should
prefer the above instructions for configuring Todoist from the UI.
{% details "Manual custom projects configuration" %}
@@ -75,7 +75,7 @@ custom_projects:
type: list
{% endconfiguration %}
-Here's an example of a more advanced `configuration.yaml`:
+Here's an example of a more advanced {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/tomato.markdown b/source/_integrations/tomato.markdown
index 81582046bbc..300986e4005 100644
--- a/source/_integrations/tomato.markdown
+++ b/source/_integrations/tomato.markdown
@@ -28,7 +28,7 @@ value can be obtained by logging in to the Tomato admin interface and search for
## Configuration
To use this device tracker 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
diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown
index 57d91555332..298ed953961 100644
--- a/source/_integrations/toon.markdown
+++ b/source/_integrations/toon.markdown
@@ -56,7 +56,7 @@ In order to be able to use this integration, you'll need to sign up for a free T
4. Click on "Create App" to complete the creation process.
5. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page again and click on the app that you've just created.
6. You need the codes now shown: "Consumer Key" and "Consumer Secret".
-7. Add the following Toon configuration to your `configuration.yaml` and restart Home Assistant.
+7. Add the following Toon configuration to your {% term "`configuration.yaml`" %} and restart Home Assistant.
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/torque.markdown b/source/_integrations/torque.markdown
index 0315b754782..f446f1db1b6 100644
--- a/source/_integrations/torque.markdown
+++ b/source/_integrations/torque.markdown
@@ -37,7 +37,7 @@ Under the **Realtime Web Upload** header:
### Configuration
-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/touchline.markdown b/source/_integrations/touchline.markdown
index 1dcf6aa8b69..0f2dc45df46 100644
--- a/source/_integrations/touchline.markdown
+++ b/source/_integrations/touchline.markdown
@@ -13,7 +13,7 @@ ha_integration_type: integration
The `touchline` climate platform let you control [ROTH Touchline](https://www.roth-uk.com/en/roth-touchline.htm) floor heating thermostats from Roth.
-To set it up, add the following information to your `configuration.yaml` file:
+To set it up, add the following information to your {% term "`configuration.yaml`" %} file:
```yaml
climate:
diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown
index 6ec871c023e..7d6708816e4 100644
--- a/source/_integrations/tplink.markdown
+++ b/source/_integrations/tplink.markdown
@@ -105,6 +105,7 @@ Devices not listed below may work but if you encounter issues submit a bug repor
- EP25 (Hardware version >= 2.6)
- KP125M
- P110
+- P115
- HS100 (UK Hardware version 4.1 with firmware 1.1.0)
#### Wall switches
diff --git a/source/_integrations/tplink_lte.markdown b/source/_integrations/tplink_lte.markdown
index cf063e03057..68cae3a7c4e 100644
--- a/source/_integrations/tplink_lte.markdown
+++ b/source/_integrations/tplink_lte.markdown
@@ -18,7 +18,7 @@ The integration provides a notification service that will send an SMS.
## Configuration
-To enable the integration, add the following lines to your `configuration.yaml` file:
+To enable the integration, add the following lines to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown
index c2dc09c22e8..e3ffea13499 100644
--- a/source/_integrations/tradfri.markdown
+++ b/source/_integrations/tradfri.markdown
@@ -23,7 +23,7 @@ ha_platforms:
ha_integration_type: integration
---
-The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file.
+The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your {% term "`configuration.yaml`" %} file.
{% include integrations/config_flow.md %}
diff --git a/source/_integrations/transport_nsw.markdown b/source/_integrations/transport_nsw.markdown
index 29abd108826..399165b7f57 100644
--- a/source/_integrations/transport_nsw.markdown
+++ b/source/_integrations/transport_nsw.markdown
@@ -25,7 +25,7 @@ As a default the sensor picks up the next mode of transport leaving from a stop
## Configuration
-To enable the sensor, add the following lines to your `configuration.yaml` file:
+To enable the sensor, add the following lines to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/travisci.markdown b/source/_integrations/travisci.markdown
index ae48238c9d5..7886cb21906 100644
--- a/source/_integrations/travisci.markdown
+++ b/source/_integrations/travisci.markdown
@@ -25,7 +25,7 @@ Create a GitHub [access token](https://github.com/settings/tokens) with the foll
## Configuration
-To enable this platform, please add the following to your `configuration.yaml` file:
+To enable this platform, please add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/trend.markdown b/source/_integrations/trend.markdown
index 776db5da820..dca6ef56421 100644
--- a/source/_integrations/trend.markdown
+++ b/source/_integrations/trend.markdown
@@ -38,7 +38,7 @@ Invert the result:
### YAML Configuration
To enable Trend binary sensors 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
diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown
index 22e8cdf8afe..0b5b497abe4 100644
--- a/source/_integrations/twilio.markdown
+++ b/source/_integrations/twilio.markdown
@@ -17,7 +17,7 @@ Calls are limited to 10 minutes and will play a short trial message before your
## Configuration
-To use this notification integration in your installation, add the following to your `configuration.yaml` file:
+To use this notification integration in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -74,6 +74,7 @@ The above opens the garage door when the number `+1XXXXXXXXXXX` calls `+1YYYYYYY
An example of an SMS handler:
+{% raw %}
```yaml
alias: Twilio incoming
trigger:
@@ -91,3 +92,4 @@ action:
incoming twilio message from {{sender}}: {{ message }}
all event data: {{ trigger.event.data }}
```
+{% endraw %}
diff --git a/source/_integrations/twilio_call.markdown b/source/_integrations/twilio_call.markdown
index 38cee1467fc..5c5a12516f2 100644
--- a/source/_integrations/twilio_call.markdown
+++ b/source/_integrations/twilio_call.markdown
@@ -18,7 +18,7 @@ The requirement is that you have setup [Twilio](/integrations/twilio/).
## Configuration
-To use this notification platform in your installation, add the following to your `configuration.yaml` file:
+To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/twilio_sms.markdown b/source/_integrations/twilio_sms.markdown
index f896c924a12..bcfadebe646 100644
--- a/source/_integrations/twilio_sms.markdown
+++ b/source/_integrations/twilio_sms.markdown
@@ -17,7 +17,7 @@ The requirement is that you have setup [Twilio](/integrations/twilio/).
## Configuration
-To use this notification platform in your installation, add the following to your `configuration.yaml` file:
+To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/twitter.markdown b/source/_integrations/twitter.markdown
index 1e728e841b5..9d58565e48e 100644
--- a/source/_integrations/twitter.markdown
+++ b/source/_integrations/twitter.markdown
@@ -37,7 +37,7 @@ It does not matter for the integration what you enter as a callback or website U
## Configuration
-To add X to your installation, add the following to your `configuration.yaml` file:
+To add X to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown
index 4571e82e39e..917632db8ba 100644
--- a/source/_integrations/ubus.markdown
+++ b/source/_integrations/ubus.markdown
@@ -9,6 +9,9 @@ ha_domain: ubus
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
This is a presence detection scanner for [OpenWrt](https://openwrt.org/) using [ubus](https://wiki.openwrt.org/doc/techref/ubus). It scans for changes in `hostapd.*`, which will detect and report changes in devices connected to the access point on the router.
@@ -66,7 +69,8 @@ Check if the `file` namespaces is registered with the RPC server.
file
```
-After this is done, add the following to your `configuration.yaml` file:
+After this is done, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -106,7 +110,7 @@ If you find that this never creates `known_devices.yaml`, or if you need more in
### Increase log level
1. On your Home Assistant device, stop Home Assistant
-2. Adjust `configuration.yaml` to log more detail for the `device_tracker` integration.
+2. Adjust {% term "`configuration.yaml`" %} to log more detail for the `device_tracker` integration.
```yaml
logger:
diff --git a/source/_integrations/ue_smart_radio.markdown b/source/_integrations/ue_smart_radio.markdown
index da0cc8d87ce..0ef82a723ed 100644
--- a/source/_integrations/ue_smart_radio.markdown
+++ b/source/_integrations/ue_smart_radio.markdown
@@ -9,11 +9,15 @@ ha_domain: ue_smart_radio
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `ue_radio` platform allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update.
+The `ue_radio` {% term integration %} allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update.
-To add your UE Smart Radio player to your installation, add the following to your `configuration.yaml` file:
+To add your UE Smart Radio player to your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown
index df549398783..720e22c7c76 100644
--- a/source/_integrations/uk_transport.markdown
+++ b/source/_integrations/uk_transport.markdown
@@ -9,9 +9,12 @@ ha_domain: uk_transport
ha_platforms:
- sensor
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `uk_transport` sensor will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes.
+The `uk_transport` {% term integration %} will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/blog/2022/08/introducing-the-home-use-plan-for-transportapi/) allows 30 requests a day, which is sufficient for a single sensor refreshing every 48 minutes.
@@ -23,7 +26,8 @@ Queries are entered as a list, with the two transport modes available being `bus
Train departure sensors require three character long `origin` and `destination` station codes which are searchable on the [National Rail enquiries](https://www.nationalrail.co.uk/times_fares/ldb.aspx) website (e.g., `WAT` is London Waterloo). The validity of a route can be checked by performing a GET request to `/uk/train/station/{station_code}/live.json` in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml#request_uk_train_station_station_code_live_json).
-To add a single train departure sensor add the following to your `configuration.yaml` file:
+To add a single train departure {% term integration %} add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry for a single sensor
@@ -114,7 +118,7 @@ follows:
3. Tick the 'map data' layer, and wait for clickable objects to load.
4. Click the bus stop node to reveal its tags on the left.
-The `destination` must be a valid location in the "direction" field returned by a GET query to `/uk/bus/stop/{atcocode}/live.json` as described in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information). A bus sensor is added in the following `configuration.yaml` file entry:
+The `destination` must be a valid location in the "direction" field returned by a GET query to `/uk/bus/stop/{atcocode}/live.json` as described in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information). A bus sensor is added in the following {% term "`configuration.yaml`" %} file entry:
```yaml
# Example configuration.yaml entry for multiple sensors
diff --git a/source/_integrations/unifi_direct.markdown b/source/_integrations/unifi_direct.markdown
index 44b835b7b6b..2decfc3e17c 100644
--- a/source/_integrations/unifi_direct.markdown
+++ b/source/_integrations/unifi_direct.markdown
@@ -11,11 +11,15 @@ ha_platforms:
ha_integration_type: integration
ha_codeowners:
- '@tofuSCHNITZEL'
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs from [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi Network application.
+This {% term integration %} allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs from [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi Network application.
-To use this device tracker in your installation, add the following to your `configuration.yaml` file:
+To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/unifiled.markdown b/source/_integrations/unifiled.markdown
index fb0f18dcb11..9141fede2f0 100644
--- a/source/_integrations/unifiled.markdown
+++ b/source/_integrations/unifiled.markdown
@@ -11,6 +11,9 @@ ha_domain: unifiled
ha_platforms:
- light
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
[UniFi LED](https://unifi-led.ui.com/) by [Ubiquiti Networks, inc.](https://www.ui.com/) is a system of controller managed LED light panels and dimmers.
@@ -21,6 +24,9 @@ There is currently support for the following device type within Home Assistant:
## Configuration
+To use the {% term integration %} in your installation, add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
+
```yaml
# Example configuration.yaml entry
light:
diff --git a/source/_integrations/unifiprotect.markdown b/source/_integrations/unifiprotect.markdown
index 93dfad061be..d7a27af29da 100644
--- a/source/_integrations/unifiprotect.markdown
+++ b/source/_integrations/unifiprotect.markdown
@@ -22,7 +22,6 @@ ha_iot_class: Local Push
ha_config_flow: true
ha_quality_scale: platinum
ha_codeowners:
- - '@AngellusMortis'
- '@bdraco'
ha_domain: unifiprotect
ha_platforms:
diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown
index b2fb1e6959d..2ecac991410 100644
--- a/source/_integrations/universal.markdown
+++ b/source/_integrations/universal.markdown
@@ -10,13 +10,17 @@ ha_domain: universal
ha_platforms:
- media_player
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
A universal media player can combine multiple existing entities in Home Assistant into a single media player {% term entity %}. This is used to create a single media player {% term entity %} that can control an entire media center.
Multiple media player entities may be controlled from a universal media player. Additionally, the universal media player can enable volume and power commands to be directed to other Home Assistant entities. This enables the media player power and volume commands to control devices like a television, amplifier or audio receiver, for example.
-A universal media player is created in `configuration.yaml` as follows.
+To use a universal media player add it to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/upb.markdown b/source/_integrations/upb.markdown
index b87d4828a5d..f5c3fc787b6 100644
--- a/source/_integrations/upb.markdown
+++ b/source/_integrations/upb.markdown
@@ -235,7 +235,7 @@ kitchen_fade_on:
## Debugging
-Debug logs are often required to solve an issue. To enable UPB debug logs add the following to your `configuration.yaml` file in your Home Assistant `config` directory:
+Debug logs are often required to solve an issue. To enable UPB debug logs add the following to your {% term "`configuration.yaml`" %} file in your Home Assistant `config` directory:
```yaml
logger:
diff --git a/source/_integrations/upc_connect.markdown b/source/_integrations/upc_connect.markdown
index d53eb8e69aa..6a7833b9717 100644
--- a/source/_integrations/upc_connect.markdown
+++ b/source/_integrations/upc_connect.markdown
@@ -12,15 +12,19 @@ ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria, the Netherlands (under Ziggo) and Hungary (under Vodafone).
+The `upc_connect` {% term integration %} offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria, the Netherlands (under Ziggo) and Hungary (under Vodafone).
-Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`):
+Minimal {% term "`configuration.yaml`" %} (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`):
```yaml
sensor:
@@ -139,7 +139,7 @@ monitored_conditions:
description: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$).
{% endconfiguration %}
-Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_gb` and `sensor.server_pending_charges`):
+Full {% term "`configuration.yaml`" %} using `{}` to format condition name (produces `sensor.server_current_bandwidth_gb` and `sensor.server_pending_charges`):
```yaml
sensor:
@@ -151,7 +151,7 @@ sensor:
- pending_charges
```
-Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`):
+Custom {% term "`configuration.yaml`" %} with only one condition monitored (produces `sensor.web_server_bandwidth`):
```yaml
sensor:
@@ -170,7 +170,7 @@ To control your Vultr subscription, you first have to set up your Vultr hub.
### Configuration
-Minimal `configuration.yaml` (produces `switch.vultr_web_server`):
+Minimal {% term "`configuration.yaml`" %} (produces `switch.vultr_web_server`):
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/w800rf32.markdown b/source/_integrations/w800rf32.markdown
index 6d39f942aee..6a339d39ff2 100644
--- a/source/_integrations/w800rf32.markdown
+++ b/source/_integrations/w800rf32.markdown
@@ -43,7 +43,7 @@ The `w800rf32` platform supports X10 RF binary sensors such as Palm Pad remotes,
## Setting up your devices
-Once you have set up your [w800rf32 hub](/integrations/w800rf32/), add the binary sensors to your `configuration.yaml`:
+Once you have set up your [w800rf32 hub](/integrations/w800rf32/), add the binary sensors to your {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown
index 2232b1069df..206d51deaca 100644
--- a/source/_integrations/wake_on_lan.markdown
+++ b/source/_integrations/wake_on_lan.markdown
@@ -70,7 +70,7 @@ The WOL switch can only turn on your computer and monitor the state. There is no
It's required that the binary `ping` is in your `$PATH`.
-To enable this switch in your installation, add the following to your `configuration.yaml` file:
+To enable this switch in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/water_heater.markdown b/source/_integrations/water_heater.markdown
index 98ac0686bab..be9c62129d1 100644
--- a/source/_integrations/water_heater.markdown
+++ b/source/_integrations/water_heater.markdown
@@ -12,7 +12,7 @@ ha_integration_type: entity
The **Water heater** {% term integration %} is built for the controlling and monitoring of hot water heaters.
-To enable this {% term integration %}, pick one of the platforms, and add it to your `configuration.yaml`:
+To enable this {% term integration %}, pick one of the platforms, and add it to your {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/water_heater.mqtt.markdown b/source/_integrations/water_heater.mqtt.markdown
index 13fc7706be3..884c1252c18 100644
--- a/source/_integrations/water_heater.mqtt.markdown
+++ b/source/_integrations/water_heater.mqtt.markdown
@@ -12,7 +12,7 @@ The `mqtt` water heater platform lets you control your MQTT enabled water heater
## Configuration
-To enable this water heater platform in your installation, first add the following to your `configuration.yaml` file:
+To enable this water heater platform in your installation, first add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/weather.template.markdown b/source/_integrations/weather.template.markdown
index b5c8c7cb655..690843bdc26 100644
--- a/source/_integrations/weather.template.markdown
+++ b/source/_integrations/weather.template.markdown
@@ -19,7 +19,7 @@ Output will be converted according to the user's unit system or {% term entity %
## Configuration
-To enable a Template Weather provider in your installation, add the following to your `configuration.yaml` file:
+To enable a Template Weather provider in your installation, add the following to your {% term "`configuration.yaml`" %} file:
(Note, be sure to update my_region in the condition and forecast templates to an appropriate value for your setup).
diff --git a/source/_integrations/wirelesstag.markdown b/source/_integrations/wirelesstag.markdown
index 7774e25fc38..2a11074631f 100644
--- a/source/_integrations/wirelesstag.markdown
+++ b/source/_integrations/wirelesstag.markdown
@@ -54,7 +54,7 @@ password:
## Binary sensor
-To enable the binary sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your `configuration.yaml` file:
+To enable the binary sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -96,7 +96,7 @@ monitored_conditions:
## Sensor
-To enable the sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your `configuration.yaml` file:
+To enable the sensor platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -127,7 +127,7 @@ monitored_conditions:
## Switch
-To enable the switch platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your `configuration.yaml` file:
+To enable the switch platform for your tags, set up with your [wirelesstag.net](https://wirelesstag.net/) account. Add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/xbox.markdown b/source/_integrations/xbox.markdown
index efdc87dda0d..7db8af298f2 100644
--- a/source/_integrations/xbox.markdown
+++ b/source/_integrations/xbox.markdown
@@ -30,7 +30,7 @@ Note that for the media player and remote entities to be added your Xbox will ne
This integration works by logging into the router with a password. The router can only have one active session at any time, so if you want to access your router settings then stop Home Assistant first.
-To use a Connect Box in your installation, add the following to your `configuration.yaml` file:
+To use a Connect Box in your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/update.mqtt.markdown b/source/_integrations/update.mqtt.markdown
index fbc6b890617..9c2fa161468 100644
--- a/source/_integrations/update.mqtt.markdown
+++ b/source/_integrations/update.mqtt.markdown
@@ -12,7 +12,7 @@ The `mqtt` Update platform allows you to integrate devices that might expose fir
## Configuration
-To enable MQTT Update in your installation, add the following to your `configuration.yaml` file:
+To enable MQTT Update in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/uptimerobot.markdown b/source/_integrations/uptimerobot.markdown
index adf8edc4b22..e69de52cd11 100644
--- a/source/_integrations/uptimerobot.markdown
+++ b/source/_integrations/uptimerobot.markdown
@@ -23,6 +23,6 @@ The **UptimeRobot** {% term integration %} provides entities to get the status f
{% include integrations/config_flow.md %}
-To get your API key, go to [My Settings](https://uptimerobot.com/dashboard#mySettings) on the UptimeRobot website, at the bottom you will find your "Main API Key".
+To get your API key, go to [My Settings](https://old.uptimerobot.com/dashboard#mySettings) on the UptimeRobot website, at the bottom you will find your "Main API Key".
All the data will be fetched from [UptimeRobot](https://uptimerobot.com).
diff --git a/source/_integrations/usb.markdown b/source/_integrations/usb.markdown
index 1345f1d282d..be2896831f0 100644
--- a/source/_integrations/usb.markdown
+++ b/source/_integrations/usb.markdown
@@ -20,7 +20,7 @@ The **USB Discovery** {% term integration %} will detect newly connected USB dev
## Configuration
-This {% term integration %} is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this {% term integration %} by adding the following lines to your `configuration.yaml`
+This {% term integration %} is part of [`default_config:`](/integrations/default_config/) if you have opted to not use [`default_config:`](/integrations/default_config/)you can add this {% term integration %} by adding the following lines to your {% term "`configuration.yaml`" %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/usgs_earthquakes_feed.markdown b/source/_integrations/usgs_earthquakes_feed.markdown
index 825a7376bae..2c09b6fd270 100644
--- a/source/_integrations/usgs_earthquakes_feed.markdown
+++ b/source/_integrations/usgs_earthquakes_feed.markdown
@@ -11,6 +11,9 @@ ha_domain: usgs_earthquakes_feed
ha_platforms:
- geo_location
ha_integration_type: service
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
The `usgs_earthquakes_feed` platform lets you integrate a GeoJSON feed provided by the [U.S. Geological Survey](https://earthquake.usgs.gov/) with information about seismic events like earthquakes. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location.
@@ -29,7 +32,8 @@ The data is updated every 5 minutes.
## Configuration
-To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your `configuration.yaml`.
+To integrate the U.S. Geological Survey Earthquake Hazards Program feed, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@@ -68,7 +72,7 @@ longitude:
### Supported feed types
| Description | Feed Type |
-|----------------------------------------|--------------------------------------|
+| -------------------------------------- | ------------------------------------ |
| Past Hour - Significant Earthquakes | `past_hour_significant_earthquakes` |
| Past Hour - M4.5+ Earthquakes | `past_hour_m45_earthquakes` |
| Past Hour - M2.5+ Earthquakes | `past_hour_m25_earthquakes` |
@@ -95,18 +99,18 @@ longitude:
The following state attributes are available for each {% term entity %} in addition to the standard ones:
-| Attribute | Description |
-|--------------------|-------------|
-| latitude | Latitude of the earthquake. |
-| longitude | Longitude of the earthquake. |
-| source | `usgs_earthquakes_feed` to be used in conjunction with `geo_location` automation trigger. |
-| external_id | The external ID used in the feed to identify the earthquake in the feed. |
-| place | Textual description of named geographic region near to the event. |
-| magnitude | Reported magnitude of the earthquake. |
-| time | Date and time when this event occurred. |
-| updated | Date and time when this event was most recently updated. |
-| status | Indicates whether the event has been reviewed by a human: "automatic", "reviewed", "deleted" |
-| type | Type of seismic event: "earthquake" or "quarry". |
+| Attribute | Description |
+| ----------- | -------------------------------------------------------------------------------------------- |
+| latitude | Latitude of the earthquake. |
+| longitude | Longitude of the earthquake. |
+| source | `usgs_earthquakes_feed` to be used in conjunction with `geo_location` automation trigger. |
+| external_id | The external ID used in the feed to identify the earthquake in the feed. |
+| place | Textual description of named geographic region near to the event. |
+| magnitude | Reported magnitude of the earthquake. |
+| time | Date and time when this event occurred. |
+| updated | Date and time when this event was most recently updated. |
+| status | Indicates whether the event has been reviewed by a human: "automatic", "reviewed", "deleted" |
+| type | Type of seismic event: "earthquake" or "quarry". |
## Full configuration
diff --git a/source/_integrations/utility_meter.markdown b/source/_integrations/utility_meter.markdown
index b21a08b2054..10b157114d5 100644
--- a/source/_integrations/utility_meter.markdown
+++ b/source/_integrations/utility_meter.markdown
@@ -72,7 +72,7 @@ that provide a greater flexibility.
Alternatively, this {% term integration %} can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the
-following to your `configuration.yaml` file:
+following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/uvc.markdown b/source/_integrations/uvc.markdown
index d9ec5f8be5b..cd44234fc1f 100644
--- a/source/_integrations/uvc.markdown
+++ b/source/_integrations/uvc.markdown
@@ -9,22 +9,26 @@ ha_domain: uvc
ha_platforms:
- camera
ha_integration_type: integration
+related:
+ - docs: /docs/configuration/
+ title: Configuration file
---
-The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ui.com/products/#unifivideo) into Home Assistant.
+The `uvc` camera {% term integration %} allows you to integrate [UniFi Video Camera (UVC)](https://www.ui.com/products/#unifivideo) into Home Assistant.
The platform connects to the [UniFi NVR software](https://www.ui.com/download/unifi-video) and automatically discovers/adds any camera connected to the NVR.
### Setup
-It is recommended that you create a new user for this platform in the NVR software and only give the user the permissions it need to operate.
+It is recommended that you create a new user for this {% term integration %} in the NVR software and only give the user the permissions it need to operate.
- The API key is found in `User` -> `My account` -> `API Access` in the NVR software.
- The camera password is found in `Settings` -> `Camera Settings` -> `Camera Password` in the NVR software.
### Configuration
-To enable, add the following to your `configuration.yaml` file:
+To use the {% term integration %} in your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
diff --git a/source/_integrations/valve.mqtt.markdown b/source/_integrations/valve.mqtt.markdown
index 96662a5d1ab..d1c05dab534 100644
--- a/source/_integrations/valve.mqtt.markdown
+++ b/source/_integrations/valve.mqtt.markdown
@@ -18,7 +18,7 @@ A valve entity can be have the following states: `open`, `opening`, `closed` or
If a `state_topic` is configured, the entity's state will be updated only after an MQTT message is received on `state_topic` matching `state_open`, `state_opening`, `state_closed` or `state_closing`. Commands configured through `payload_open`, `payload_closed`, and `payload_stop` will be published to `command_topic` to control the valve.
-To use your MQTT valve in your installation, add the following to your `configuration.yaml` file:
+To use your MQTT valve in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry for a value that is set by open or close command
@@ -40,7 +40,7 @@ Example of a JSON state update:
The wanted position value or `payload_stop` will be published to `command_topic` to control the valve when the services `valve.open`, `value.close`, or `value.set_position` are called.
-To use your MQTT valve in your installation, add the following to your `configuration.yaml` file:
+To use your MQTT valve in your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry for a valve that reports position
diff --git a/source/_integrations/vizio.markdown b/source/_integrations/vizio.markdown
index 558f48de7c5..d845eb8ffa8 100644
--- a/source/_integrations/vizio.markdown
+++ b/source/_integrations/vizio.markdown
@@ -104,7 +104,7 @@ You will need the authentication token returned by this command to configure Hom
## Configuration
-To add your VIZIO TV to your installation, add the following to your `configuration.yaml` file:
+To add your VIZIO TV to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry
@@ -204,7 +204,7 @@ vizio:
### Obtaining an app configuration
-If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device.
+If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in {% term "`configuration.yaml`" %}. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device.
### Obtaining a list of valid apps to include or exclude
diff --git a/source/_integrations/vultr.markdown b/source/_integrations/vultr.markdown
index 70d9ff34409..abd76fbe334 100644
--- a/source/_integrations/vultr.markdown
+++ b/source/_integrations/vultr.markdown
@@ -88,7 +88,7 @@ name:
### Full example
-Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
+Full {% term "`configuration.yaml`" %} (produces `binary_sensor.totally_awesome_server`):
```yaml
binary_sensor:
@@ -109,7 +109,7 @@ The following examples assume a subscription that has an ID of `123456` and a la
-Because it uses the Home Assistant Cloud account linking service you **must** have either `cloud:` or `default_config:` in your `configuration.yaml`.
+Because it uses the Home Assistant Cloud account linking service you **must** have either `cloud:` or `default_config:` in your {% term "`configuration.yaml`" %}.
diff --git a/source/_integrations/xiaomi_miio.markdown b/source/_integrations/xiaomi_miio.markdown
index 436c5e4aca9..c2813807e7d 100644
--- a/source/_integrations/xiaomi_miio.markdown
+++ b/source/_integrations/xiaomi_miio.markdown
@@ -179,7 +179,7 @@ The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repea
Please follow the instructions on [Retrieving the Access Token](/integrations/xiaomi_miio/#retrieving-the-access-token) to get the API token.
-To add a Xiaomi Mi WiFi Repeater device tracker to your installation, add the following to your `configuration.yaml` file:
+To add a Xiaomi Mi WiFi Repeater device tracker to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
device_tracker:
@@ -1232,11 +1232,11 @@ The `xiaomi miio` remote platform allows you to send IR commands from your Xiaom
### Setup
-Please follow the instructions on [Retrieving the Access Token](/integrations/xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file.
+Please follow the instructions on [Retrieving the Access Token](/integrations/xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the {% term "`configuration.yaml`" %} file.
### Configuring the Platform
-To add a Xiaomi IR Remote to your installation, add the following to your `configuration.yaml` file:
+To add a Xiaomi IR Remote to your installation, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
remote:
diff --git a/source/_integrations/yeelight.markdown b/source/_integrations/yeelight.markdown
index c434ee99fc7..381ca2440e5 100644
--- a/source/_integrations/yeelight.markdown
+++ b/source/_integrations/yeelight.markdown
@@ -161,7 +161,9 @@ Per default, the bulb limits the number of requests per minute to 60, a limitati
Before trying to control your light through Home Assistant, you have to set up your bulb using the Yeelight app. ( [Android](https://play.google.com/store/apps/details?id=com.yeelight.cherry&hl=fr), [IOS](https://itunes.apple.com/us/app/yeelight/id977125608?mt=8) ).
In the bulb property, you have to enable "LAN Control" (previously called "Developer mode"). LAN Control may only be available with the latest firmware installed on your bulb. Firmware can be updated in the application after connecting the bulb.
Determine your bulb IP (using router, software, ping...).
-Information on how to enable "LAN Control" can be found [here](https://www.yeelight.com/faqs/lan_control).
+Currently, there is no official way to change LAN mode. However, some methods might be found here:
+- [Desktop app](https://community.home-assistant.io/t/the-easiest-method-to-enable-lan-developer-mode-on-xiaomi-bulb/727360)
+- CLI using the python-miio library: [1](https://community.home-assistant.io/t/integrate-mi-smart-led-bulb-easy-steps/312174), [2](https://community.home-assistant.io/t/integrate-mi-smart-led-bulb-warm-white-xmbgdp01ylk/290404)