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 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

r-integrations: restart HA after changing config (#32718)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-13 17:33:01 +02:00 committed by GitHub
parent e16346db9f
commit fb0fd4a6cb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 147 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/_integrations/raincloud.markdown
View File

@ -16,9 +16,12 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `raincloud` integration allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant.
The `raincloud` {% term integration %} allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant.
There is currently support for the following device types within Home Assistant:
@ -28,7 +31,8 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To enable it, add the following to your `configuration.yaml` file:
To enable it, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/raspyrfm.markdown
View File

@ -9,9 +9,12 @@ ha_domain: raspyrfm
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `raspyrfm` integration adds support for cheap RC 433 MHz outlets via one of the supported gateways.
The `raspyrfm` {% term integration %} adds support for cheap RC 433 MHz outlets via one of the supported gateways.
Initially, this integration was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir gateway like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM#connairpy) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi.
@ -19,6 +22,9 @@ Other vendors of 433 MHz RC outlets have also created gateways that use a very s
## Configuration
To use the RaspyRFM {% 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
switch:

8
source/_integrations/recswitch.markdown
View File

@ -9,9 +9,12 @@ ha_domain: recswitch
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `recswitch` switch platform allows you to control the Ankuoo REC Switch devices.
The `recswitch` switch {% term integration %} allows you to control the Ankuoo REC Switch devices.
Supported devices (tested):
@ -21,7 +24,8 @@ Supported devices (tested):
## Configuration
To enable this switch, add the following lines to your `configuration.yaml`:
To enable this switch, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

6
source/_integrations/reddit.markdown
View File

@ -9,6 +9,9 @@ ha_domain: reddit
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor your favorite subreddits.
@ -23,7 +26,8 @@ This integration does not support Reddit's two-factor authentication. If you use
## Configuration
To enable this platform, add the following to your `configuration.yaml` file:
To enable this {% term integration %}, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

84
source/_integrations/rejseplanen.markdown
View File

@ -9,13 +9,17 @@ ha_domain: rejseplanen
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `rejseplanen` sensor will provide you with travel details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/).
The `rejseplanen` {% term integration %} will provide you with travel details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/).
## Configuration
Add a sensor to your `configuration.yaml` file as shown in the example:
Add a sensor to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -137,48 +141,48 @@ sensor:
The sensor can filter the timetables by one or more routes, directions and types. The known types are listed in the table below.
| Departure type | Description |
|--------------|-------------|
| BUS | Normal bus |
| EXB | Express bus |
| TB | Harbour bus|
| LET | Letbanen |
| M | Metro |
| S | S-train |
| REG | Regional train |
| IC | Intercity train |
| LYN | Intercity express train |
| TOG | Other trains |
| Departure type | Description |
| -------------- | ----------------------- |
| BUS | Normal bus |
| EXB | Express bus |
| TB | Harbour bus |
| LET | Letbanen |
| M | Metro |
| S | S-train |
| REG | Regional train |
| IC | Intercity train |
| LYN | Intercity express train |
| TOG | Other trains |
## Attributes
| Attribute | Description |
| ------------ | -------------------------------------- |
| `due_in` | Minutes until departure |
| `due_at` | Departure date and time |
| `scheduled_at` | Scheduled departure date and time |
| `real_time_at` | Real time departure date and time (in cases where it's different from scheduled) |
| `type` | Transport type |
| `route` | Route code |
| `direction` | Destination stop |
| `final_stop` | Final stop (if departure doesn't go all the way to the destination stop) |
| `stop` | Departure stop |
| `stop_id` | ID of departure stop |
| `track` | Departure track (if available) |
| `attribution` | Attribution (required by data source) |
| `next_departures` | List of further departures |
| Attribute | Description |
| ----------------- | -------------------------------------------------------------------------------- |
| `due_in` | Minutes until departure |
| `due_at` | Departure date and time |
| `scheduled_at` | Scheduled departure date and time |
| `real_time_at` | Real time departure date and time (in cases where it's different from scheduled) |
| `type` | Transport type |
| `route` | Route code |
| `direction` | Destination stop |
| `final_stop` | Final stop (if departure doesn't go all the way to the destination stop) |
| `stop` | Departure stop |
| `stop_id` | ID of departure stop |
| `track` | Departure track (if available) |
| `attribution` | Attribution (required by data source) |
| `next_departures` | List of further departures |
### `next_departures`
| Attribute | Description |
| ------------ | -------------------------------------- |
| `due_in` | Minutes until departure |
| `due_at` | Departure date and time |
| `scheduled_at` | Scheduled departure date and time |
| Attribute | Description |
| -------------- | -------------------------------------------------------------------------------- |
| `due_in` | Minutes until departure |
| `due_at` | Departure date and time |
| `scheduled_at` | Scheduled departure date and time |
| `real_time_at` | Real time departure date and time (in cases where it's different from scheduled) |
| `type` | Transport type |
| `route` | Route code |
| `direction` | Destination stop |
| `final_stop` | Final stop (if departure doesn't go all the way to the destination stop) |
| `stop` | Departure stop |
| `track` | Departure track (if available) |
| `type` | Transport type |
| `route` | Route code |
| `direction` | Destination stop |
| `final_stop` | Final stop (if departure doesn't go all the way to the destination stop) |
| `stop` | Departure stop |
| `track` | Departure track (if available) |

22
source/_integrations/remember_the_milk.markdown
View File

@ -6,7 +6,10 @@ ha_category:
ha_iot_class: Cloud Push
ha_release: 0.57
ha_domain: remember_the_milk
ha_integration_type: integration
ha_integration_type:
related:
- docs: /docs/configuration/
title: Configuration file
---
The `remember_the_milk` integration allows you to create tasks in [Remember The Milk (RTM)](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel.
@ -17,7 +20,8 @@ The setup consists of two steps: getting an API key and registering your account
### Step 1: API key
To be able to use this integration, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal shared secret. Both of them need to be stored in your Home Assistant configuration:
To be able to use this integration, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal shared secret. Both of them need to be stored in your Home Assistant {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
@ -65,10 +69,10 @@ The task creation supports the "smart syntax", so to create a task with the tag
**Note:**
At the moment, smart syntax is *not* supported when updating tasks. All smart syntax commands are ignored during the update and will end up as normal text in the name of the task.
|Service data attribute | Optional | Description | Example |
|-----------------------|----------|-------------|---------|
| name | no | Name of the new task, you can use the smart syntax here. | "do this ^today #from_hass" |
| id | yes | Identifier for the task you're creating, can be used to update or complete the task later on | "myid" |
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------- | --------------------------- |
| name | no | Name of the new task, you can use the smart syntax here. | "do this ^today #from_hass" |
| id | yes | Identifier for the task you're creating, can be used to update or complete the task later on | "myid" |
## Completing tasks with service `complete_task`
@ -76,9 +80,9 @@ Complete a tasks that was privously created from Home Assistant. You can not com
If you have created your task with an `id`, calling `<account>_complete_task` with the parameter `id` will then complete your task.
|Service data attribute | Optional | Description | Example |
|-----------------------|----------|-------------|---------|
| id | no | Identifier that was defined when creating the task | "myid" |
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | -------------------------------------------------- | ------- |
| id | no | Identifier that was defined when creating the task | "myid" |
## Automation example

10
source/_integrations/remote_rpi_gpio.markdown
View File

@ -12,9 +12,12 @@ ha_platforms:
- binary_sensor
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `remote_rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections.
The `remote_rpi_gpio` {% term integration %} is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections.
The remote Raspberry Pi, and the control computer where Home Assistant is running must be configured to be able to run `remote_rpi_gpio`, see [Configuring Remote GPIO](https://gpiozero.readthedocs.io/en/stable/remote_gpio.html) for more details.
@ -24,9 +27,10 @@ Note that for virtual environments, you may need to set an environment variable
## Binary sensor
The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a remote [Raspberry Pi](https://www.raspberrypi.org/).
The `remote_rpi_gpio` binary sensor {% term integration %} allows you to read sensor values of 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`](/docs/configuration/) file:
To use your remote Raspberry Pi's GPIO 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

5
source/_integrations/rest_command.markdown
View File

@ -11,12 +11,13 @@ ha_codeowners:
- '@jpbede'
---
This integration can expose regular REST commands as services. Services can be called from a [script] or in [automation].
This {% term integration %} can expose regular REST commands as services. Services can be called from a [script] or in [automation].
[script]: /integrations/script/
[automation]: /getting-started/automation/
To use this integration, add the following lines to your `configuration.yaml` file:
To use this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

10
source/_integrations/rflink.markdown
View File

@ -15,9 +15,12 @@ ha_platforms:
ha_codeowners:
- '@javicalle'
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `rflink` integration supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/21-rflink-). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The `rflink` {% term integration %} supports devices that use [RFLink gateway firmware](https://www.rflink.nl/download.php), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/21-rflink-). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The 433 MHz spectrum is used by many manufacturers mostly using their own protocol/standard and includes devices like: light switches, blinds, weather stations, alarms and various other sensors.
@ -29,13 +32,14 @@ Note: Versions later than R44 add support for Ikea Ansluta, Philips Living Color
A complete list of devices supported by RFLink can be found [here](https://www.rflink.nl/devlist.php).
This integration is tested with the following hardware/software:
This {% term integration %} is tested with the following hardware/software:
- Nodo RFLink Gateway V1.4/RFLink R46
## Configuration
To enable RFLink in your installation, add the following to your `configuration.yaml` file:
To enable RFLink 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

8
source/_integrations/ripple.markdown
View File

@ -9,11 +9,15 @@ ha_domain: ripple
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `ripple` sensor platform displays Ripple wallet balances from [Ripple.com](https://ripple.com).
The `ripple` sensor {% term integration %} displays Ripple wallet balances from [Ripple.com](https://ripple.com).
To add the Ripple sensor to your installation, specify a ripple address to watch in the `configuration.yaml` file:
To add the Ripple {% term integration %} to your installation, specify a ripple address to watch in the {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/rmvtransport.markdown
View File

@ -11,9 +11,12 @@ ha_domain: rmvtransport
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes.
The `rvmtransport` {% term integration %} will give you the departure time of the next bus, tram, subway or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes.
## Setup
@ -21,7 +24,8 @@ Visit the [RMV OpenData web site](https://opendata.rmv.de) to find a list of val
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file:
To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/rocketchat.markdown
View File

@ -9,13 +9,17 @@ ha_domain: rocketchat
ha_platforms:
- notify
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `rocketchat` notify platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant.
The `rocketchat` notify {% term integration %} allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant.
## Configuration
To add Rocket.Chat to your installation, add the following to your `configuration.yaml` file:
To add Rocket.Chat 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

8
source/_integrations/route53.markdown
View File

@ -7,9 +7,12 @@ ha_iot_class: Cloud Push
ha_release: 0.81
ha_domain: route53
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
With the `route53` integration can you keep your AWS Route53 DNS records up to date.
With the `route53` {% term integration %} can you keep your AWS Route53 DNS records up to date.
The integration will run every hour, but can also be started manually by using the service `route53.update_records` under services.
@ -61,7 +64,8 @@ Here is an IAM Policy sample, don't forget to update your Zone ID on the Resourc
## Configuration
To use the integration in your installation, 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

8
source/_integrations/rpi_camera.markdown
View File

@ -9,9 +9,12 @@ ha_domain: rpi_camera
ha_platforms:
- camera
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `rpi_camera` integration allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
The `rpi_camera` {% term integration %} allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
<div class='note'>
This integration is only available on Home Assistant Core installation types. Unfortunately, it cannot be used with Home Assistant OS, Supervised or Container.
@ -19,7 +22,8 @@ This integration is only available on Home Assistant Core installation types. Un
## Configuration
To enable this camera in your installation, add the following to your `configuration.yaml` file:
To enable this camera 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

2
source/_integrations/rss_feed_template.markdown
View File

@ -12,7 +12,7 @@ ha_codeowners:
ha_integration_type: integration
---
The `rss_feed_template` integration can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform.
The `rss_feed_template` {% term integration %} can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform.
For example, on Android, the app "Simple RSS Widget" can be used to display temperatures on the home screen.

8
source/_integrations/rtorrent.markdown
View File

@ -9,11 +9,15 @@ ha_domain: rtorrent
ha_platforms:
- sensor
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `rtorrent` platform allows you to monitor your downloads with [rTorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information.
The `rtorrent` {% term integration %} allows you to monitor your downloads with [rTorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information.
To enable this sensor, add the following lines to your `configuration.yaml`:
To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry

8
source/_integrations/russound_rio.markdown
View File

@ -9,13 +9,17 @@ ha_domain: russound_rio
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `russound_rio` platform allows you to control Russound devices that make use of the RIO protocol.
The `russound_rio` {% term integration %} allows you to control Russound devices that make use of the RIO protocol.
The platform automatically discovers all enabled zones and sources. Each zone is added as a media player device with the enabled sources available as inputs. Media information is supported if the selected source reports it.
To add a device to your installation, add the following to your `configuration.yaml` file:
To add a device 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

8
source/_integrations/russound_rnet.markdown
View File

@ -9,15 +9,19 @@ ha_domain: russound_rnet
ha_platforms:
- media_player
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
---
The `russound_rnet` platform allows you to control Russound devices that make use of the RNET protocol.
The `russound_rnet` {% term integration %} allows you to control Russound devices that make use of the RNET protocol.
This has initially been tested against a Russound CAV6.6 unit with six zones and six sources. It will also work with a Russound CAA66, but be sure to use a null-modem cable. If you have mutiple controllers connected via the RNET link ports, every increment of 6 zones maps to the corresponding controller ID.
Connecting to the Russound device is only possible by TCP, you can make use of a TCP to Serial gateway such as [tcp_serial_redirect](https://github.com/pyserial/pyserial/blob/master/examples/tcp_serial_redirect.py)
To add a device to your installation, add the following to your `configuration.yaml` file:
To add an {% term integration %} 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