jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

u-z-integrations: add glossary reference to config file (#32764)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-14 16:38:47 +02:00 committed by GitHub
parent d545c0bf86
commit d234271c54
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
29 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_integrations/ubus.markdown
View File

@ -66,7 +66,7 @@ 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:
```yaml
# Example configuration.yaml entry
@ -106,7 +106,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:

2
source/_integrations/ue_smart_radio.markdown
View File

@ -13,7 +13,7 @@ ha_integration_type: integration
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.
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:
```yaml
# Example configuration.yaml entry

4
source/_integrations/uk_transport.markdown
View File

@ -23,7 +23,7 @@ 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 sensor add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry for a single sensor
@ -114,7 +114,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

2
source/_integrations/unifi_direct.markdown
View File

@ -15,7 +15,7 @@ ha_codeowners:
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.
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

2
source/_integrations/universal.markdown
View File

@ -16,7 +16,7 @@ A universal media player can combine multiple existing entities in Home Assistan
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.
A universal media player is created in {% term "`configuration.yaml`" %} as follows.
```yaml
# Example configuration.yaml entry

2
source/_integrations/upb.markdown
View File

@ -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:

2
source/_integrations/upc_connect.markdown
View File

@ -20,7 +20,7 @@ The `upc_connect` platform offers presence detection by looking at connected dev
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.
</div>
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:
```yaml
# Example configuration.yaml entry

2
source/_integrations/update.mqtt.markdown
View File

@ -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

2
source/_integrations/usb.markdown
View File

@ -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

2
source/_integrations/usgs_earthquakes_feed.markdown
View File

@ -29,7 +29,7 @@ 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`" %}.
```yaml
# Example configuration.yaml entry

2
source/_integrations/utility_meter.markdown
View File

@ -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

2
source/_integrations/uvc.markdown
View File

@ -24,7 +24,7 @@ It is recommended that you create a new user for this platform in the NVR softwa
### Configuration
To enable, add the following to your `configuration.yaml` file:
To enable, add the following to your {% term "`configuration.yaml`" %} file:
```yaml
# Example configuration.yaml entry

4
source/_integrations/valve.mqtt.markdown
View File

@ -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

4
source/_integrations/vizio.markdown
View File

@ -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

10
source/_integrations/vultr.markdown
View File

@ -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
</div>
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

2
source/_integrations/w800rf32.markdown
View File

@ -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

2
source/_integrations/wake_on_lan.markdown
View File

@ -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

2
source/_integrations/water_heater.markdown
View File

@ -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

2
source/_integrations/water_heater.mqtt.markdown
View File

@ -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

2
source/_integrations/weather.template.markdown
View File

@ -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).

6
source/_integrations/wirelesstag.markdown
View File

@ -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

2
source/_integrations/xbox.markdown
View File

@ -30,7 +30,7 @@ Note that for the media player and remote entities to be added your Xbox will ne
<div class='note'>
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`" %}.
</div>

6
source/_integrations/xiaomi_miio.markdown
View File

@ -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:

2
source/_integrations/zabbix.markdown
View File

@ -148,7 +148,7 @@ The `zabbix` sensor platform let you monitor the current count of active trigger
You must have the <a href="#configuration">Zabbix integration</a> configured to use those sensors.
</div>
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

2
source/_integrations/zestimate.markdown
View File

@ -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:

8
source/_integrations/zha.markdown
View File

@ -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:

2
source/_integrations/zhong_hong.markdown
View File

@ -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:

2
source/_integrations/zone.markdown
View File

@ -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

6
source/_integrations/zoneminder.markdown
View File

@ -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
</div>
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