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-17 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

g-h-integrations: add glossary reference to config file (#32756)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-14 15:08:10 +02:00 committed by GitHub
parent b28c0abbdf
commit 88b471a62b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 114 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/garadget.markdown
View File

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

2
source/_integrations/gc100.markdown
View File

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

2
source/_integrations/geniushub.markdown
View File

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

6
source/_integrations/google_assistant.markdown
View File

@ -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] <Action Name>` listed under **Add new**. Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms and nicknames for your devices if you wish.
@ -167,7 +167,7 @@ You can debug the setup by following [these instructions](https://developers.hom
### YAML configuration
Now add your setup to your `configuration.yaml` file, such as:
Now add your setup to your {% term "`configuration.yaml`" %} file, such as:
```yaml
# Example configuration.yaml entry

16
source/_integrations/google_cloud.markdown
View File

@ -17,7 +17,7 @@ The `google_cloud` platform allows you to use [Google Cloud Platform](https://cl
## Configuration
To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-an-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in `configuration.yaml`:
To use Google Cloud Platform, you need to provide `config` directory relative path of [`API key`](#obtaining-an-api-key) file you are going to use. Place it under `config` folder and set `key_file` parameter in {% term "`configuration.yaml`" %}:
```yaml
# Example configuration.yaml entry
@ -71,13 +71,13 @@ Basic instruction for all APIs:
The Cloud text-to-speech API is priced monthly based on the amount of characters to synthesize into audio sent to the service.
| Voice | Monthly free tier | Paid usage |
| ----------------------------- | ------------------------- | --------------------------------- |
| Neural2 | 0 to 1 million bytes | $16.00 USD / 1 million bytes |
| Polyglot (Preview) | 0 to 1 million bytes | $16.00 USD / 1 million bytes |
| Studio (Preview) | 0 to 100 thousand bytes | $160.00 USD / 1 million bytes |
| Standard | 0 to 4 million characters | $4.00 USD / 1 million characters |
| WaveNet | 0 to 1 million characters | $16.00 USD / 1 million characters |
| Voice | Monthly free tier | Paid usage |
| ------------------ | ------------------------- | --------------------------------- |
| Neural2 | 0 to 1 million bytes | $16.00 USD / 1 million bytes |
| Polyglot (Preview) | 0 to 1 million bytes | $16.00 USD / 1 million bytes |
| Studio (Preview) | 0 to 100 thousand bytes | $160.00 USD / 1 million bytes |
| Standard | 0 to 4 million characters | $4.00 USD / 1 million characters |
| WaveNet | 0 to 1 million characters | $16.00 USD / 1 million characters |
### Text-to-speech configuration

2
source/_integrations/greenwave.markdown
View File

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

2
source/_integrations/group.markdown
View File

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

44
source/_integrations/harmony.markdown
View File

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

2
source/_integrations/heatmiser.markdown
View File

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

64
source/_integrations/heos.markdown
View File

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

6
source/_integrations/hikvision.markdown
View File

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

2
source/_integrations/history_stats.markdown
View File

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

68
source/_integrations/homekit.markdown
View File

@ -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:
@ -318,7 +318,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.
@ -391,37 +391,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
@ -511,7 +511,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:

2
source/_integrations/homekit_controller.markdown
View File

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

2
source/_integrations/homematic.markdown
View File

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

2
source/_integrations/homematicip_cloud.markdown
View File

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

2
source/_integrations/hp_ilo.markdown
View File

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

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

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