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-14 12:56:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

o-r-integrations: add glossary reference to config file (#32761)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-14 15:40:15 +02:00 committed by GitHub
parent 5e853cf251
commit 42c3b4524b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 51 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/opensky.markdown
View File

@ -52,7 +52,7 @@ Both events have two attributes in common:
- **longitude**: Longitude of the flight in decimal. - **longitude**: Longitude of the flight in decimal.
- **icao24**: The ICAO 24-bit address of the aircraft's transponder. - **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 %} {% raw %}

2
source/_integrations/owntracks.markdown
View File

@ -53,7 +53,7 @@ By default, the integration listens for incoming messages from OwnTracks via HTT
## Advanced configuration ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

4
source/_integrations/person.markdown
View File

@ -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)). **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 ## Configuring the `person` integration via the Home Assistant configuration panel
@ -42,7 +42,7 @@ person:
## Configuring the `person` integration via YAML ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

6
source/_integrations/pilight.markdown
View File

@ -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). 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 ```yaml
# Example configuration.yaml entry # 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. 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 ```yaml
# Example configuration.yaml entry # 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 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/proliphix.markdown
View File

@ -17,7 +17,7 @@ Currently supported and tested thermostats:
- NT10e - 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 ```yaml
climate: climate:

24
source/_integrations/ps4.markdown
View File

@ -81,7 +81,7 @@ sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5
To find your system Python path: 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://<yourhomeassistanturl>/developer-tools/info). In the System Health box, locate the item **python_version** and note the value that is displayed. Then in a terminal run: - Add the [System Health](/integrations/system_health/) integration to your {% term "`configuration.yaml`" %}. In a web browser, access your frontend and navigate to the about/logs page "http://<yourhomeassistanturl>/developer-tools/info). In the System Health box, locate the item **python_version** and note the value that is displayed. Then in a terminal run:
```bash ```bash
whereis python<version> whereis python<version>
@ -137,7 +137,7 @@ Occasionally, the integration may fail to get the data at all, or may get incorr
### Formatting ### Formatting
When the integration retrieves data from the PlayStation Store, it stores it in a JSON file named `.ps4-games.json` in the same directory as where your `configuration.yaml` file is located. The first line in the file will be `{` and the last line will be `}`. Between these lines, there will be indented entries for each game or app the integration finds. See the following example and table: When the integration retrieves data from the PlayStation Store, it stores it in a JSON file named `.ps4-games.json` in the same directory as where your {% term "`configuration.yaml`" %} file is located. The first line in the file will be `{` and the last line will be `}`. Between these lines, there will be indented entries for each game or app the integration finds. See the following example and table:
```json ```json
{ {
@ -156,12 +156,12 @@ When the integration retrieves data from the PlayStation Store, it stores it in
} }
``` ```
| Field | Value | Description | | Field | Value | Description |
| ----- | ----- | ----------- | | -------------------- | ------- | ---------------------------- |
| `locked` | boolean | Must be `true` or `false` | `locked` | boolean | Must be `true` or `false` |
| `media_content_type` | string | Must be `game` or `app` | `media_content_type` | string | Must be `game` or `app` |
| `media_image_url` | string | Any valid URL for an image | `media_image_url` | string | Any valid URL for an image |
| `media_title` | string | The title of the game or app | `media_title` | string | The title of the game or app |
The data in the example shows 2 entries. The data in the example shows 2 entries.
@ -182,10 +182,10 @@ To edit, simply open the file in a text editor, find the game or app you would l
Opens new application/game and closes currently running application/game. The game/app must be in the entity's source list. Games will be added automatically when you open them normally. Opens new application/game and closes currently running application/game. The game/app must be in the entity's source list. Games will be added automatically when you open them normally.
| Service data attribute | Optional | Example | Description | | Service data attribute | Optional | Example | Description |
| ---------------------- | -------- | -------------------------- | ------------------------------------- | | ---------------------- | -------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `entity_id` | No | `media_player.ps4` | The entity id for your PlayStation 4. | | `entity_id` | No | `media_player.ps4` | The entity id for your PlayStation 4. |
| `source` | No | `Some Game` or `CUSA00123` | The game/app you want to open. You can use the title or SKU ID. Using the SKU ID will be the most reliable.| | `source` | No | `Some Game` or `CUSA00123` | The game/app you want to open. You can use the title or SKU ID. Using the SKU ID will be the most reliable. |
### Service `send_command` ### Service `send_command`

22
source/_integrations/python_script.markdown
View File

@ -11,15 +11,15 @@ ha_integration_type: integration
This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox: This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox:
| Name | Description | | Name | Description |
| ---- | ----------- | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api] | `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api] |
| `data` | The data passed to the Python Script service call. | `data` | The data passed to the Python Script service call. |
| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api] | `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api] |
| `time` | The stdlib `time` available as limited access. | `time` | The stdlib `time` available as limited access. |
| `datetime` | The stdlib `datetime` available as limited access. | `datetime` | The stdlib `datetime` available as limited access. |
| `dt_util` | The ` homeassistant.util.dt` module. | `dt_util` | The ` homeassistant.util.dt` module. |
| `output` | An empty dictionary. Add items to return data as [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data). | `output` | An empty dictionary. Add items to return data as [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data). |
Other imports like `min`, `max` are available as builtins. See the [python_script](https://github.com/home-assistant/core/blob/dev/homeassistant/components/python_script/__init__.py) source code for up-to-date information on the available objects inside the script. Other imports like `min`, `max` are available as builtins. See the [python_script](https://github.com/home-assistant/core/blob/dev/homeassistant/components/python_script/__init__.py) source code for up-to-date information on the available objects inside the script.
@ -45,7 +45,7 @@ It is created as a first step, to help with:
Start by enabling the Python Scripts integration and create the first script. Start by enabling the Python Scripts integration and create the first script.
- Add to `configuration.yaml`: `python_script:` - Add to {% term "`configuration.yaml`" %}: `python_script:`
- Create the folder `<config>/python_scripts` - Create the folder `<config>/python_scripts`
- Create a file `<config>/python_scripts/hello_world.py` in the folder and give it this content: - Create a file `<config>/python_scripts/hello_world.py` in the folder and give it this content:
@ -69,7 +69,7 @@ data:
Running this script show absolutely no output on the screen, but it logs with level `info`. You must have the [Logger](/integrations/logger/) enabled at least for level `info`. Running this script show absolutely no output on the screen, but it logs with level `info`. You must have the [Logger](/integrations/logger/) enabled at least for level `info`.
Your `configuration.yaml` should include something like this. Your {% term "`configuration.yaml`" %} should include something like this.
```yaml ```yaml
logger: logger:

6
source/_integrations/raincloud.markdown
View File

@ -54,7 +54,7 @@ password:
## Binary sensor ## Binary sensor
Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file: Once you have enabled the [Raincloud integration](#configuration), add the following to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -77,7 +77,7 @@ monitored_conditions:
## Sensor ## Sensor
Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file: Once you have enabled the [Raincloud integration](#configuration), add the following to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -104,7 +104,7 @@ monitored_conditions:
## Switch ## Switch
Once you have enabled the [Raincloud integration](#configuration), add the following to your `configuration.yaml` file: Once you have enabled the [Raincloud integration](#configuration), add the following to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

6
source/_integrations/random.markdown
View File

@ -25,13 +25,13 @@ The `random` integration simply creates random values or state. This can be usef
## Configuration ## Configuration
The preferred way to configure random helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and select the add button; next, select the {% my config_flow_start domain=page.ha_domain title=page.title %} option. The preferred way to configure random helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and select the add button; next, select 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 `random:` 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 `random:` to your {% term "`configuration.yaml`" %} first, then you can use the UI.
## Binary sensor ## Binary sensor
The random binary sensor creates random states (`true`, 1, `on` or `false`, 0, `off`). The random binary sensor creates random states (`true`, 1, `on` or `false`, 0, `off`).
### YAML configuration ### YAML configuration
To create the random binary sensor, add the following lines to your `configuration.yaml` file: To create the random binary sensor, add the following lines to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -51,7 +51,7 @@ name:
The random sensor creates random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. The random sensor creates random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn.
### YAML configuration ### YAML configuration
To create the random sensor, add the following lines to your `configuration.yaml` file: To create the random sensor, add the following lines to your {% term "`configuration.yaml`" %} file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

20
source/_integrations/recorder.markdown
View File

@ -38,7 +38,7 @@ Changing database used by the recorder may result in losing your existing histor
</div> </div>
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 ```yaml
# Example configuration.yaml entry # 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. 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. Note that purging will not immediately decrease disk space usage but it will significantly slow down further growth.
| Service data attribute | Optional | Description | | 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) | | `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. | | `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` ### 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. 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 | | Service data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | A list of entity_ids that should be purged from the recorder database. | | `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. | | `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. | | `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. | | `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 #### Example automation to remove data rows for specific entities

2
source/_integrations/remote_rpi_gpio.markdown
View File

@ -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/). 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

2
source/_integrations/rflink.markdown
View File

@ -161,7 +161,7 @@ This configuration will ignore the button `1` of the `newkaku` device with ID `0
### Invert cover ### 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 ```yaml
# Example configuration.yaml entry for inverted RTS cover # Example configuration.yaml entry for inverted RTS cover

2
source/_integrations/rfxtrx.markdown
View File

@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant:
## Debug logging ## 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 ```yaml
logger: logger:

2
source/_integrations/ring.markdown
View File

@ -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 `<config>/downloads/<camera_name>/YYYY-MM/YYYY-MM-DD-at-HH-MM-SS.mp4`. You can change the date according to your localization format. the above modification will save the video file under `<config>/downloads/<camera_name>/YYYY-MM/YYYY-MM-DD-at-HH-MM-SS.mp4`. You can change the date according to your localization format.
If you want to use `python_script`, enable it your `configuration.yaml` file first: If you want to use `python_script`, enable it your {% term "`configuration.yaml`" %} file first:
```yaml ```yaml
python_script: python_script: