mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Rename Services to Actions in integrations: R (#33826)
* Rename Services to Actions in integrations: R * Update source/_integrations/rfxtrx.markdown * Update source/_integrations/roku.markdown * Update source/_integrations/roku.markdown * Update source/_integrations/roku.markdown * Update source/_integrations/rest_command.markdown --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Franck Nijhof
GitHub
parent
c5f4b246f0
commit
4a9ea9c06a
@ -70,22 +70,22 @@ The `rachio` switch platform allows you to toggle zones, valves, and schedules c
|
||||
|
||||
Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch for each smart hose timer valve and a switch to start or stop every schedule on a controller. There will also be a switch to toggle each controller's standby mode, as well as to activate a 24-hour rain delay on the device.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `rachio.start_watering`
|
||||
### Action `rachio.start_watering`
|
||||
|
||||
Allows starting one zone on a sprinkler controller, any number of smart hose timer valves, or a schedule. To sequentially start multiple zones on a sprinkler controller, use the `start_multiple_zone_schedule` service below.
|
||||
Allows starting one zone on a sprinkler controller, any number of smart hose timer valves, or a schedule. To sequentially start multiple zones on a sprinkler controller, use the `start_multiple_zone_schedule` action below.
|
||||
|
||||
Service data attribute | Optional | Description |
|
||||
Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | Individual zone, schedule, or multiple smart hose timer valves to run. A smart hose timer base station device can also be selected to run all valves on the given base.
|
||||
| `duration` | yes | Duration in minutes to run the zone or valves. Leave empty for schedules.
|
||||
|
||||
{% note %}
|
||||
The services below only apply to sprinkler controllers and will not be shown if only smart hose timers are on the account.
|
||||
The actions below only apply to sprinkler controllers and will not be shown if only smart hose timers are on the account.
|
||||
{% endnote %}
|
||||
|
||||
### Service `rachio.start_multiple_zone_schedule`
|
||||
### Action `rachio.start_multiple_zone_schedule`
|
||||
|
||||
Allows a list of zones to be passed with a corresponding list of durations to create a custom schedule directly from Home Assistant.
|
||||
|
||||
@ -93,7 +93,7 @@ Allows a list of zones to be passed with a corresponding list of durations to cr
|
||||
It is not currently possible to have zones from multiple controllers in the same custom schedule.
|
||||
{% endnote %}
|
||||
|
||||
Service data attribute | Optional | Description |
|
||||
Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | List of zones to run. Will be run in the order listed.
|
||||
| `duration` | no | Duration in minutes to run the zones. If a list of durations is provided, each duration will apply to the corresponding zone listed above. Alternatively, one duration can be provided and will be used for all zones.
|
||||
@ -130,43 +130,43 @@ script:
|
||||
duration: 20
|
||||
```
|
||||
|
||||
### Service `rachio.set_zone_moisture_percent`
|
||||
### Action `rachio.set_zone_moisture_percent`
|
||||
|
||||
Set the zone moisture percentage for a zone or group of zones.
|
||||
|
||||
Rachio allows for setting the moisture percentage of a zone or group of zones. As Rachio only uses moisture levels for zones in a Flex Daily schedule, this service is only available when at least one zone is part of a Flex Daily schedule.
|
||||
Rachio allows for setting the moisture percentage of a zone or group of zones. As Rachio only uses moisture levels for zones in a Flex Daily schedule, this action is only available when at least one zone is part of a Flex Daily schedule.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | String, list or group of zones to set moisture percentage.
|
||||
| `percent` | no | Integer of the desired moisture percentage. Accepts 0-100.
|
||||
|
||||
### Service `rachio.pause_watering`
|
||||
### Action `rachio.pause_watering`
|
||||
|
||||
Pause a currently running schedule.
|
||||
|
||||
This service will not be available if only a Generation 1 controller is on the account, as these controllers do not support pause or resume.
|
||||
This action will not be available if only a Generation 1 controller is on the account, as these controllers do not support pause or resume.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `devices` | yes | Name of the controller(s) to pause. If not given, will pause all running controllers on the account.
|
||||
| `duration` | yes | Duration in minutes to pause. Accepts 1-60. Defaults to 60 minutes if not specified.
|
||||
|
||||
### Service `rachio.resume_watering`
|
||||
### Action `rachio.resume_watering`
|
||||
|
||||
Resume a currently paused schedule.
|
||||
|
||||
This service will not be available if only a Generation 1 controller is on the account, as these controllers do not support pause or resume.
|
||||
This action will not be available if only a Generation 1 controller is on the account, as these controllers do not support pause or resume.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `devices` | yes | Name of the controller(s) to resume. If not given, will resume all paused controllers on the account.
|
||||
|
||||
### Service `rachio.stop_watering`
|
||||
### Action `rachio.stop_watering`
|
||||
|
||||
Stops all currently running schedules.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `devices` | yes | Name of the controller(s) to stop. If not given, will stop all running controllers on the account.
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
## Configuration options
|
||||
|
||||
The integration has a configuration option to change the default amount of time that the irrigation
|
||||
will run when turning on a zone switch (default is 6 minutes). This can be overridden with a service call (see below).
|
||||
will run when turning on a zone switch (default is 6 minutes). This can be overridden with an action (see below).
|
||||
|
||||
## Binary sensor
|
||||
|
||||
@ -57,16 +57,16 @@ The Rain Delay Number Entity lets you set and view the number of days, if any,
|
||||
|
||||
Switches are automatically added for all available zones of configured controllers.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
The integration exposes services to give additional control over a Rain Bird device.
|
||||
The integration exposes actions to give additional control over a Rain Bird device.
|
||||
|
||||
### `rainbird.start_irrigation`
|
||||
|
||||
Start a Rain Bird zone for a set number of minutes. This service accepts a Rain Bird sprinkler
|
||||
Start a Rain Bird zone for a set number of minutes. This action accepts a Rain Bird sprinkler
|
||||
zone switch entity and allows a custom duration unlike the switch.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------- |
|
||||
| `entity_id` | no | The Rain Bird Sprinkler zone switch to turn on. |
|
||||
| `duration` | no | Number of minutes for this zone to be turned on. |
|
||||
|
||||
@ -43,14 +43,14 @@ Note that some entities are disabled by default. If you are missing a sensor or
|
||||
|
||||
The integration has two configuration options:
|
||||
|
||||
1. "Default Zone Run Time": sets a default duration when turning on a zone switch (default: 600 seconds). This can be overriden with a service call (see below).
|
||||
1. "Default Zone Run Time": sets a default duration when turning on a zone switch (default: 600 seconds). This can be overriden with an action (see below).
|
||||
2. "Use Run Times from App": if enabled, will use the zone-specific run times from the last time the zone was turned on manually in the RainMachine App – this allows you to set per-zone default times using the RainMachine app instead of the same default time for all zones.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
Services accept either device IDs or entity IDs, depending on the nature of the service:
|
||||
Actions accept either device IDs or entity IDs, depending on the nature of the action:
|
||||
|
||||
- Services that require a device ID as a target:
|
||||
- Actions that require a device ID as a target:
|
||||
- `rainmachine.pause_watering`
|
||||
- `rainmachine.push_flow_meter_data`
|
||||
- `rainmachine.push_weather_data`
|
||||
@ -58,7 +58,7 @@ Services accept either device IDs or entity IDs, depending on the nature of the
|
||||
- `rainmachine.stop_all`
|
||||
- `rainmachine.unpause_watering`
|
||||
- `rainmachine.unrestrict_watering`
|
||||
- Services that require an entity ID as a target (note that the correct entity ID type must be provided, such as a program for a program-related service)
|
||||
- Action that require an entity ID as a target (note that the correct entity ID type must be provided, such as a program for a program-related action)
|
||||
- `rainmachine.start_program`
|
||||
- `rainmachine.start_zone`
|
||||
- `rainmachine.stop_program`
|
||||
@ -68,7 +68,7 @@ Services accept either device IDs or entity IDs, depending on the nature of the
|
||||
|
||||
Pause all watering activities for a number of seconds. After the pause is complete, the previous watering activities will resume. Note that controllers can only be paused for a maximum of 12 hours.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------ |
|
||||
| `seconds` | no | The number of seconds to pause |
|
||||
|
||||
@ -76,7 +76,7 @@ Pause all watering activities for a number of seconds. After the pause is comple
|
||||
|
||||
Push Flow Meter data from Home Assistant to the RainMachine device.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `value` | no | The flow meter value to send. May be any positive number. |
|
||||
| `unit_of_measurement` | yes | The flow meter units to send. String must be one of "clicks", "gal", "litre", or "m3" (default: "litre"). |
|
||||
@ -90,7 +90,7 @@ Local Weather Push service should be enabled from Settings > Weather > Developer
|
||||
See details of RainMachine API here:
|
||||
<https://rainmachine.docs.apiary.io/#reference/weather-services/parserdata/post>
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `timestamp` | no | UNIX Timestamp for the Weather Data. If omitted, the RainMachine device's local time at the time of the call is used. |
|
||||
| `mintemp` | no | Minimum Temperature (°C) |
|
||||
@ -111,7 +111,7 @@ See details of RainMachine API here:
|
||||
|
||||
Restrict any and all watering activities from staring for a time period.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------ |
|
||||
| `duration` | no | The time period to restrict (e.g., "01:00:00") |
|
||||
|
||||
@ -123,7 +123,7 @@ Start a RainMachine program.
|
||||
|
||||
Start a RainMachine zone for a set number of seconds.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------- |
|
||||
| `zone_run_time` | yes | The number of seconds to run; defaults to 600 seconds |
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ The `random` integration simply creates random values or state. This can be usef
|
||||
|
||||
|
||||
## 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 {% 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.
|
||||
|
||||
|
||||
@ -69,7 +69,7 @@ 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 |
|
||||
| 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" |
|
||||
@ -80,7 +80,7 @@ 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 |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | -------------------------------------------------- | ------- |
|
||||
| id | no | Identifier that was defined when creating the task | "myid" |
|
||||
|
||||
|
||||
@ -38,31 +38,31 @@ This integration provides the following platforms:
|
||||
|
||||
All vehicles linked to the account should then get added as devices, with sensors added as linked entity.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `renault.ac_start`
|
||||
### Action `renault.ac_start`
|
||||
|
||||
Start A/C on vehicle.
|
||||
|
||||
| Service data attribute | Required | Description | Example |
|
||||
| Data attribute | Required | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `vehicle`| yes | device_id of the vehicle | |
|
||||
| `temperature` | yes | Target A/C temperature in °C | |
|
||||
| `when` | no | Timestamp for the start of the A/C (optional - defaults to now) | `2020-05-01T17:45:00` |
|
||||
|
||||
### Service `renault.ac_cancel`
|
||||
### Action `renault.ac_cancel`
|
||||
|
||||
Cancel A/C on vehicle.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
| Data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `vehicle`| yes | device_id of the vehicle |
|
||||
|
||||
### Service `renault.charge_set_schedules`
|
||||
### Action `renault.charge_set_schedules`
|
||||
|
||||
Update charge schedule on vehicle.
|
||||
|
||||
| Service data attribute | Required | Description | Example |
|
||||
| Data attribute | Required | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `vehicle`| yes | device_id of the vehicle |
|
||||
| `schedules` | yes | Schedule details. Can be a single schedule or a list of schedules | see [example below](#schedule_example) |
|
||||
|
||||
@ -29,32 +29,32 @@ The Renson integration pulls in data from the Renson Endura delta device. Most o
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `renson.set_timer_level`
|
||||
### Action `renson.set_timer_level`
|
||||
|
||||
Set the ventilation timer.
|
||||
|
||||
| Service data attribute | Required | Description | Example |
|
||||
| Data attribute | Required | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `timer_level`| yes | Level setting | |
|
||||
| `minutes` | yes | Time of the timer (0 will disable the timer) | |
|
||||
|
||||
### Service `renson.set_breeze`
|
||||
### Action `renson.set_breeze`
|
||||
|
||||
Set the breeze function of the ventilation system.
|
||||
|
||||
| Service data attribute | Required | Description | Example |
|
||||
| Data attribute | Required | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `breeze_level`| no | Ventilation level when breeze function is activated | |
|
||||
| `temperature` | no | Temperature when the breeze function should be activated in °C | |
|
||||
| `activate` | yes | Activate or disable the breeze feature | `2020-05-01T17:45:00` |
|
||||
|
||||
### Service `renson.set_pollution_settings`
|
||||
### Action `renson.set_pollution_settings`
|
||||
|
||||
Set all the pollution settings of the ventilation system.
|
||||
|
||||
| Service data attribute | Required | Description | Example |
|
||||
| Data attribute | Required | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `day_pollution_level`| no | Ventilation level when pollution is detected in the day | |
|
||||
| `night_pollution_level` | no | Ventilation level when pollution is detected in the night | |
|
||||
|
||||
@ -147,11 +147,11 @@ Depending on the supported features of the camera, button entities are added for
|
||||
|
||||
**Guard set current position** will set the current position as the new guard position.
|
||||
|
||||
### Service reolink.ptz_move
|
||||
### Action reolink.ptz_move
|
||||
|
||||
Some Reolink <abbr title="pan, tilt, and zoom">PTZ</abbr> cameras can move at different speeds. For those cameras, the `reolink.ptz_move` service can be used in combination with the **PTZ left**, **right**, **up**, **down**, **zoom in**, or **zoom out** entity which allows specifying the speed attribute. If the <abbr title="pan, tilt, and zoom">PTZ</abbr> button entities for a specific camera are not shown under **Choose entity** under **targets** of the `reolink.ptz_move` service, it means that this camera does not support custom <abbr title="pan, tilt, and zoom">PTZ</abbr> speeds.
|
||||
Some Reolink <abbr title="pan, tilt, and zoom">PTZ</abbr> cameras can move at different speeds. For those cameras, the `reolink.ptz_move` action can be used in combination with the **PTZ left**, **right**, **up**, **down**, **zoom in**, or **zoom out** entity which allows specifying the speed attribute. If the <abbr title="pan, tilt, and zoom">PTZ</abbr> button entities for a specific camera are not shown under **Choose entity** under **targets** of the `reolink.ptz_move` action, it means that this camera does not support custom <abbr title="pan, tilt, and zoom">PTZ</abbr> speeds.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name of the Reolink <abbr title="pan, tilt, and zoom">PTZ</abbr> button entity to control. For example, `button.trackmix_ptz_left`. |
|
||||
| `speed` | no | <abbr title="pan, tilt, and zoom">PTZ</abbr> move speed. For example `10`. |
|
||||
@ -175,9 +175,9 @@ Depending on the supported features of the camera, select entities are added for
|
||||
## Siren entities
|
||||
|
||||
If the camera supports a siren, a siren entity will be created.
|
||||
When using the siren turn-on service, the siren will continue to sound until the siren turn-off service is called.
|
||||
When using the siren turn-on action, the siren will continue to sound until the siren turn-off action is called.
|
||||
|
||||
In some camera models, there is a delay of up to 5 seconds between the turn-off command and the sound stopping. The siren turn-on service supports setting a volume and a duration (no turn-off service call is needed in that case).
|
||||
In some camera models, there is a delay of up to 5 seconds between the turn-off command and the sound stopping. The siren turn-on action supports setting a volume and a duration (no turn-off action call is needed in that case).
|
||||
|
||||
## Switch entities
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ ha_codeowners:
|
||||
- '@jpbede'
|
||||
---
|
||||
|
||||
This {% term 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 actions. Actions can be called from a [script] or in [automation].
|
||||
|
||||
[script]: /integrations/script/
|
||||
[automation]: /getting-started/automation/
|
||||
@ -28,7 +28,7 @@ rest_command:
|
||||
|
||||
{% configuration %}
|
||||
service_name:
|
||||
description: The name used to expose the service. E.g., in the above example, it would be 'rest_command.example_request'.
|
||||
description: The name used to expose the action. E.g., in the above example, it would be 'rest_command.example_request'.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
@ -77,7 +77,7 @@ service_name:
|
||||
|
||||
### Basic example which uses PUT method and payload encoded as form data
|
||||
|
||||
This example implements 2 REST commands to add service calls for the missing shuffle functionality of the iTunes integration.
|
||||
This example implements 2 REST commands to add actions for the missing shuffle functionality of the iTunes integration.
|
||||
|
||||
```yaml
|
||||
rest_command:
|
||||
@ -95,7 +95,7 @@ rest_command:
|
||||
|
||||
### Using REST command Response in automations
|
||||
|
||||
REST commands provide a service response in a dictionary containing `status` (containing the HTTP response code), and `content` containing the response body as text or JSON. This response can be accessed in automations using [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data).
|
||||
REST commands provide an action response in a dictionary containing `status` (containing the HTTP response code) and `content` containing the response body as text or JSON. This response can be accessed in automations using [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data).
|
||||
|
||||
The following example shows how the REST command response may be used in automations. In this case, checking the [Traefik API](https://doc.traefik.io/traefik/operations/api/) for errors.
|
||||
|
||||
@ -144,7 +144,7 @@ rest_command:
|
||||
|
||||
### Using templates to change the payload based on entities
|
||||
|
||||
The commands can be dynamic, using templates to insert values of other entities. Service call support variables for doing things with templates.
|
||||
The commands can be dynamic, using templates to insert values of other entities. Actions support variables for doing things with templates.
|
||||
|
||||
In this example, uses [templates](/docs/configuration/templating/) for dynamic parameters.
|
||||
|
||||
@ -169,7 +169,7 @@ rest_command:
|
||||
|
||||
### How to test your new REST command
|
||||
|
||||
Call the new service from [developer tools](/docs/tools/dev-tools/) in the sidebar with some `data` like:
|
||||
Call the new action from [developer tools](/docs/tools/dev-tools/) in the sidebar with some `data` like:
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@ -91,7 +91,7 @@ connection: &rfxtrx
|
||||
|
||||
## Settings options
|
||||
|
||||
To configure options for RFXtrx integration go to **Settings** -> **Devices & Services** and press **Options** on the RFXtrx card.
|
||||
To configure options for RFXtrx integration, go to **Settings** > **Devices & services** and select **Options** on the RFXtrx card.
|
||||
|
||||
<img src='/images/integrations/rfxtrx/options.png' />
|
||||
|
||||
@ -335,11 +335,11 @@ automation:
|
||||
entity_id: scene.welcomescene
|
||||
```
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
- `rfxtrx.send`: Send a custom event using the RFXtrx device.
|
||||
|
||||
### Service: Send
|
||||
### Action: Send
|
||||
|
||||
Simulate a button being pressed:
|
||||
|
||||
@ -353,8 +353,8 @@ action:
|
||||
|
||||
Alternatively:
|
||||
|
||||
- Go to: {% my developer_call_service title="Developer tools -> Services" service="rfxtrx.send" %}
|
||||
- Select: `RFXCOM RFXtrx: Send` from the Service drop-down menu.
|
||||
- Go to: {% my developer_call_service title="**Developer tools** > **Actions**" service="rfxtrx.send" %}
|
||||
- Select: `RFXCOM RFXtrx: Send` from the **Action** drop-down menu.
|
||||
|
||||
```yaml
|
||||
service: rfxtrx.send
|
||||
|
||||
@ -188,7 +188,7 @@ We are working on adding a lot of features to the core integration. We have reve
|
||||
### How can I clean a specific room?
|
||||
We plan to make the process simpler in the future, but for now, it is a multi-step process.
|
||||
1. Make sure to first name the rooms in the Roborock app; otherwise, they won't appear in the debug log.
|
||||
2. Go to {% my developer_call_service service="roborock.get_maps" title="**Developer Tools** > **Services** > **Roborock: Get Maps**" %}. Select your vacuum as the entity. Note that room IDs and names are only updated on the currently selected map.
|
||||
2. Go to {% my developer_call_service service="roborock.get_maps" title="**Developer Tools** > **Actions** > **Roborock: Get Maps**" %}. Select your vacuum as the entity. Note that room IDs and names are only updated on the currently selected map.
|
||||
|
||||
- **Request**: Your request should look like:
|
||||
|
||||
@ -211,7 +211,7 @@ We plan to make the process simpler in the future, but for now, it is a multi-st
|
||||
"17": Living room
|
||||
```
|
||||
|
||||
3. Go back to {% my developer_call_service service="vacuum.send_command" title="**Developer Tools** > **Services** > **Vacuum: Send Command**" %} then type `app_segment_clean` as your command and `segments` with a list of the 2-digit IDs you want to clean. Then, add `repeat` with a number (ranging from 1 to 3) to determine how many times you want to clean these areas.
|
||||
3. Go back to {% my developer_call_service service="vacuum.send_command" title="**Developer Tools** > **Actions** > **Vacuum: Send Command**" %} then type `app_segment_clean` as your command and `segments` with a list of the 2-digit IDs you want to clean. Then, add `repeat` with a number (ranging from 1 to 3) to determine how many times you want to clean these areas.
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
@ -32,7 +32,7 @@ notify:
|
||||
room: YOUR_ROOM_NAME
|
||||
```
|
||||
|
||||
- `name` (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- `name` (*Optional*): Name displayed in the frontend. The notifier will bind to the `notify.NOTIFIER_NAME` action.
|
||||
- `url` (*Required*): The URL of your Rocket.Chat instance.
|
||||
- `username` (*Required*): The Rocket.Chat username.
|
||||
- `password` (*Required*): The Rocker.Chat password.
|
||||
|
||||
@ -76,7 +76,7 @@ At the moment, the following buttons are supported:
|
||||
- volume_mute
|
||||
- volume_up
|
||||
|
||||
A typical service call for pressing several buttons looks like this.
|
||||
A typical action for pressing several buttons looks like this.
|
||||
|
||||
```yaml
|
||||
service: remote.send_command
|
||||
@ -95,9 +95,9 @@ When the Home Assistant Roku integration is enabled and a Roku device has been c
|
||||
|
||||
## Source Automation
|
||||
|
||||
The `media_player.select_source` service may be used to launch specific applications/streaming channels on your Roku device.
|
||||
The `media_player.select_source` action may be used to launch specific applications/streaming channels on your Roku device.
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `entity_id` | no | Target a specific media player. |
|
||||
| `source` | no | An application name or application ID. | Prime Video
|
||||
@ -132,9 +132,9 @@ Alternatively, you can make a manual HTTP request (GET) to `http://ROKU_IP:8060/
|
||||
|
||||
## TV Channel Tuning
|
||||
|
||||
The `media_player.play_media` service may be used to tune to specific channels on your Roku TV device with OTA antenna.
|
||||
The `media_player.play_media` action may be used to tune to specific channels on your Roku TV device with OTA antenna.
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `entity_id` | no | Target a specific media player. |
|
||||
| `media_content_id` | no | A channel number. | 5.1
|
||||
@ -154,9 +154,9 @@ action:
|
||||
|
||||
## Content Deeplinking
|
||||
|
||||
The `media_player.play_media` service may be used to deep link to content within an application.
|
||||
The `media_player.play_media` action may be used to deep-link to content within an application.
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `entity_id` | no | Target a specific media player. |
|
||||
| `media_content_id` | no | A media identifier. | 291097
|
||||
@ -190,13 +190,13 @@ Content IDs are unique to each streaming service and vary in format but are ofte
|
||||
| Spotify | 22297 | open.spotify.com/playlist/5xddIVAtLrZKtt4YGLM1SQ | spotify:playlist:5xddIVAtLrZKtt4YGLM1SQ | playlist
|
||||
| YouTube | 837 | youtu.be/6ZMXE5PXPqU | 6ZMXE5PXPqU | live
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `roku.search`
|
||||
### Action `roku.search`
|
||||
|
||||
This service allows you to emulate opening the search screen and entering the search keyword.
|
||||
This action allows you to emulate opening the search screen and entering the search keyword.
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | ------- |
|
||||
| `entity_id` | yes | The entities to search on. | media_player.roku
|
||||
| `keyword` | no | The keyword to search for. | Space Jam
|
||||
|
||||
@ -27,9 +27,9 @@ This integration currently supports the following models:
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
Currently supported services are:
|
||||
Currently supported actions are:
|
||||
|
||||
- `start`
|
||||
- `pause`
|
||||
|
||||
@ -21,20 +21,20 @@ This integration uses Roon Core, a Roon application that runs on a machine on yo
|
||||
|
||||
## Configuration
|
||||
|
||||
1. From the Home Assistant front-end, go to {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **Roon** integration. Then, select **Configure**.
|
||||
1. From the Home Assistant front-end, go to {% my integrations title="**Settings** > **Devices & services**" %}. Select the **Roon** integration. Then, select **Configure**.
|
||||
2. Home Assistant will then try to find your Roon Core - if it is successful it will display `Authorize HomeAssistant in Roon`. Select **Submit** and skip to step 4.
|
||||
3. If your Roon Core is not automatically found, enter the `Hostname` or `IP address` for the Roon Core machine when requested and select **Submit**.
|
||||
4. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**. There, you will see an entry for Home Assistant with a button next to it. Select **Enable**.
|
||||
5. Roon core will then provide Home Assistant with the details of your media players.
|
||||
6. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `media_player.play_media`
|
||||
### Action `media_player.play_media`
|
||||
|
||||
Roon uses a path based on the roon browser hierarchy to specify which media to play. You can find this by using the media browser, or by following the examples below. If roon can't follow the path you will find an error in the log that will show which part of the path roon could not follow, and the possibilities at that point.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
|
||||
| `media_content_id` | no | A path to specify the media you want to play, see examples below. |
|
||||
@ -42,18 +42,18 @@ Roon uses a path based on the roon browser hierarchy to specify which media to p
|
||||
|
||||
For example to play the album Harvest by Neil Young you should set `media_content_id` to `Library/Artists/Neil Young/Harvest` and to play BBC Radio 4 you would set `media_content_id` to `My Live Radio/BBC Radio 4`
|
||||
|
||||
### Service `roon.transfer`
|
||||
### Action `roon.transfer`
|
||||
|
||||
Transfer playback from one player to another.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------- |
|
||||
| `entity_id` | yes | id of the source player. |
|
||||
| `transfer_id` | no | id of the destination player. |
|
||||
|
||||
## Roon endpoint volume control via Home Assistant
|
||||
|
||||
For media players that are not fully integrated into roon, it is possible to use Home Assistant to implement a volume control service. This allows the native Roon apps to change the volume of an endpoint via automation in Home Assistant.
|
||||
For media players that are not fully integrated into roon, it is possible to use Home Assistant to implement a volume control action. This allows the native Roon apps to change the volume of an endpoint via automation in Home Assistant.
|
||||
|
||||
For example if you have an amplifier where the volume can be controlled by Home Assistant (perhaps via an integration, or using an IR Blaster) you can have the roon apps use these to change volume.
|
||||
|
||||
@ -71,7 +71,7 @@ The Roon volume control will now show plus and minus buttons rather than a volum
|
||||
|
||||
Clicking on the plus and minus buttons in Roon can now trigger an automation in the volume control entity matching the media_player in Home Assistant.
|
||||
|
||||
In this autimation you can use Home Assistant services to provide `volume_up` and `volume_down`.
|
||||
In this autimation you can use Home Assistant actions to provide `volume_up` and `volume_down`.
|
||||
|
||||
Here is an example automation using an IR blaster to control `media_player_study`
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ related:
|
||||
|
||||
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.
|
||||
The integration will run every hour, but can also be started manually by using the `route53.update_records` action.
|
||||
|
||||
Please note that this platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address.
|
||||
|
||||
@ -108,8 +108,8 @@ ttl:
|
||||
default: 300
|
||||
{% endconfiguration %}
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `route53.update_records`
|
||||
### Action `route53.update_records`
|
||||
|
||||
Use this service to manually trigger an update of the DNS records.
|
||||
Use this action to manually trigger an update of the DNS records.
|
||||
|
||||
@ -24,7 +24,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
## Configuration
|
||||
|
||||
To add a Ruckus Unleashed device to your installation, go to **Settings** -> **Devices & Services**, click the `+` button, then select **Ruckus** from the list of integrations.
|
||||
To add a Ruckus Unleashed device to your installation, go to **Settings** -> **Devices & services**, click the `+` button, then select **Ruckus** from the list of integrations.
|
||||
|
||||
It is required to configure the IP address of your **master access point**. See the section Access Points on the management web interface. And perhaps consider to set a preferred master (Admin & Services>System>System Info>Preferred master).
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user