Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

r-integrations: restart HA after changing config #32718

Merged
merged 1 commit into from
May 13, 2024
Merged

r-integrations: restart HA after changing config #32718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions source/_integrations/raincloud.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down
8 changes: 7 additions & 1 deletion source/_integrations/raspyrfm.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,22 @@ 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.

Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this integration like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html).

## 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:
Expand Down
8 changes: 6 additions & 2 deletions source/_integrations/recswitch.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand All @@ -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
Expand Down
6 changes: 5 additions & 1 deletion source/_integrations/reddit.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
84 changes: 44 additions & 40 deletions source/_integrations/rejseplanen.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 changes: 13 additions & 9 deletions source/_integrations/remember_the_milk.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -65,20 +69,20 @@ 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`

Complete a tasks that was privously created from Home Assistant. You can not complete tasks that were created outside of Home Assistant.

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

Expand Down
10 changes: 7 additions & 3 deletions source/_integrations/remote_rpi_gpio.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
5 changes: 3 additions & 2 deletions source/_integrations/rest_command.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 7 additions & 3 deletions source/_integrations/rflink.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
8 changes: 6 additions & 2 deletions source/_integrations/ripple.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions source/_integrations/rmvtransport.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,21 @@ 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

Visit the [RMV OpenData web site](https://opendata.rmv.de) to find a list of valid station IDs.

## 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
Expand Down
8 changes: 6 additions & 2 deletions source/_integrations/rocketchat.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading