mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Rename Services to Actions in integrations: G (#33813)
This commit is contained in:
Franck Nijhof
GitHub
parent
9162850d6e
commit
eeb63debc4
@ -85,12 +85,12 @@ min_cycle_duration:
|
||||
required: false
|
||||
type: [time, integer]
|
||||
dry_tolerance:
|
||||
description: Set a minimum amount of difference between the humidity read by the sensor specified in the *target_sensor* option and the target humidity that must change prior to being switched on. For example, if the target humidity is 45 and the tolerance is 3 the humidifier will start when the sensor equals or goes below 42. It is advised to set this parameter equal or above your sensor precision. This parameter is only used on *target_sensor* changes and is ignored on initialization, on manual operation or `humidifier.turn_on` service.
|
||||
description: Set a minimum amount of difference between the humidity read by the sensor specified in the *target_sensor* option and the target humidity that must change prior to being switched on. For example, if the target humidity is 45 and the tolerance is 3 the humidifier will start when the sensor equals or goes below 42. It is advised to set this parameter equal or above your sensor precision. This parameter is only used on *target_sensor* changes and is ignored on initialization, on manual operation or `humidifier.turn_on` action.
|
||||
required: false
|
||||
default: 3
|
||||
type: float
|
||||
wet_tolerance:
|
||||
description: Set a minimum amount of difference between the humidity read by the sensor specified in the *target_sensor* option and the target humidity that must change prior to being switched off. For example, if the target humidity is 45 and the tolerance is 3 the humidifier will stop when the sensor equals or goes above 48. It is advised to set this parameter equal or above your sensor precision. This parameter is only used on *target_sensor* changes and is ignored on initialization, on manual operation or `humidifier.turn_on` service.
|
||||
description: Set a minimum amount of difference between the humidity read by the sensor specified in the *target_sensor* option and the target humidity that must change prior to being switched off. For example, if the target humidity is 45 and the tolerance is 3 the humidifier will stop when the sensor equals or goes above 48. It is advised to set this parameter equal or above your sensor precision. This parameter is only used on *target_sensor* changes and is ignored on initialization, on manual operation or `humidifier.turn_on` action.
|
||||
required: false
|
||||
default: 3
|
||||
type: float
|
||||
|
||||
@ -37,11 +37,11 @@ Each zone controlled by your Genius Hub will be exposed as either a:
|
||||
|
||||
Currently, there is no support for altering zone schedules, although entities can be switched to/from geniushub modes that utilize schedules.
|
||||
|
||||
There are limitations due to the differences between the Genius Hub and Home Assistant schemas (e.g., HA has no **Footprint** mode) - use the service handlers, below, for this functionality.
|
||||
There are limitations due to the differences between the Genius Hub and Home Assistant schemas (for example, Home Assistant has no **Footprint** mode) - use the actions below, for this functionality.
|
||||
|
||||
### Service handlers
|
||||
### Action handlers
|
||||
|
||||
Home Assistant is obligated to place restrictions upon integrations such as **geniushub** to maintain compatibility with other ecosystems (e.g., Google Home) and so not all of the **geniushub** functionality is available via the web UI. Some of this missing functionality is exposed via integration-specific service handlers:
|
||||
Home Assistant is obligated to place restrictions upon integrations such as **geniushub** to maintain compatibility with other ecosystems (e.g., Google Home) and so not all of the **geniushub** functionality is available via the web UI. Some of this missing functionality is exposed via integration-specific actions:
|
||||
|
||||
- `set_switch_override`: change the switches on time _for a specified duration_ (up to 24h),
|
||||
- `set_zone_override`: change the zone's setpoint _for a specified duration_ (up to 24h), and
|
||||
|
||||
@ -28,14 +28,14 @@ The integration works by subscribing to events on the repository to provide a pu
|
||||
|
||||
## Remove authorization
|
||||
|
||||
After you have removed the integration from {% my integrations title="Settings -> Devices & Services" %}, you need to manually revoke OAuth app authorization.
|
||||
After you have removed the integration from {% my integrations title="Settings -> Devices & services" %}, you need to manually revoke OAuth app authorization.
|
||||
|
||||
1. Go to your [Authorized OAuth Apps](https://github.com/settings/applications)
|
||||
2. Find the "Home Assistant GitHub Integration" application
|
||||
3. Click the 3 dots (`...`) to the right of the name
|
||||
4. Select "Revoke"
|
||||
|
||||
## Service
|
||||
## Action
|
||||
|
||||
When you configure a repository to be tracked in this integration it will be represented as a service in the device panel and all entities related to the repository will be nested under that device. The device also provides a link to the repository on GitHub and an option to download [diagnostics](/integrations/diagnostics) for the service.
|
||||
|
||||
@ -117,13 +117,13 @@ These entities are simpler diagnostic entities without any additional attributes
|
||||
Here are some small examples on how you can automate using the provided entities from this integration.
|
||||
|
||||
{% note %}
|
||||
Remember that the service names and entity IDs used in these examples are examples as well,
|
||||
you need to replace it with services and entities that you have in your installation.
|
||||
Remember that the action names and entity IDs used in these examples are examples as well,
|
||||
you need to replace it with actions and entities that you have in your installation.
|
||||
{% endnote %}
|
||||
|
||||
### Notify new releases
|
||||
|
||||
This example uses the [Latest release](#latest-release) entity provided by this integration, and a [notify](/integrations/notify) service,
|
||||
This example uses the [Latest release](#latest-release) entity provided by this integration, and a [notify](/integrations/notify) action,
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -145,7 +145,7 @@ action:
|
||||
|
||||
### Notify new stars
|
||||
|
||||
This example uses the [Stars](#diagnostic-entities) diagnostic entity provided by this integration, and a [notify](/integrations/notify) service,
|
||||
This example uses the [Stars](#diagnostic-entities) diagnostic entity provided by this integration, and a [notify](/integrations/notify) action,
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -80,11 +80,11 @@ Using the entity state and attributes is more error prone and less flexible than
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
### Service `google.create_event`
|
||||
### Action `google.create_event`
|
||||
|
||||
You can use the service `google.create_event` to create a new calendar event in a calendar.
|
||||
You can use the `google.create_event` action to create a new calendar event in a calendar.
|
||||
|
||||
{% details "Create Event Service details" %}
|
||||
{% details "Create event action details" %}
|
||||
|
||||
{% note %}
|
||||
This will only be available if you have given Home Assistant `read-write` access in configuration options.
|
||||
@ -92,7 +92,7 @@ This will only be available if you have given Home Assistant `read-write` access
|
||||
|
||||
A calendar `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | --------------------------------------------------- | ------------------- |
|
||||
| `summary` | no | Acts as the title of the event. | Bowling |
|
||||
| `description` | yes | The description of the event. | Birthday bowling |
|
||||
@ -107,7 +107,7 @@ A calendar `target` is selected with a [Target Selector](/docs/blueprint/selecto
|
||||
You either use `start_date_time` and `end_date_time`, or `start_date` and `end_date`, or `in`.
|
||||
{% endimportant %}
|
||||
|
||||
This is a full example of service call in YAML:
|
||||
This is a full example of an action in YAML:
|
||||
|
||||
```yaml
|
||||
service: google.create_event
|
||||
|
||||
@ -338,11 +338,11 @@ Verify that the Google Assistant is available on `https://[YOUR HOME ASSISTANT U
|
||||
|
||||
#### 403 errors on request sync
|
||||
|
||||
The `request_sync` service may fail with a 403 if the HomeGraph API is not enabled. Go to [Google API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) and verify that HomeGraph API is enabled for your project.
|
||||
The `request_sync` action may fail with a 403 if the HomeGraph API is not enabled. Go to [Google API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) and verify that HomeGraph API is enabled for your project.
|
||||
|
||||
#### 404 errors on report state
|
||||
|
||||
If you receive 404 errors linked to reporting state in your log, Home Assistant is reporting state for entities that were never synced to Google. Ask your Google Home to `Sync my devices` or run the service `google_assistant.request_sync`.
|
||||
If you receive 404 errors linked to reporting state in your log, Home Assistant is reporting state for entities that were never synced to Google. Ask your Google Home to `Sync my devices` or run the `google_assistant.request_sync` action.
|
||||
|
||||
#### Error during linking: "Could not update the setting. Please check your connection"
|
||||
|
||||
|
||||
@ -116,7 +116,7 @@ This guide is for advanced users only. It requires creating an OAuth client ID o
|
||||
|
||||
{% details "Enable personal results" %}
|
||||
|
||||
1. Go to **{% my developer_services title="Developer Tools > Services" %}** and issue a query that requires personal results, for example call `google_assistant_sdk.send_text_command` with `command: "what is my name"`
|
||||
1. Go to **{% my developer_services title="Developer Tools > Actions" %}** and issue a query that requires personal results, for example call `google_assistant_sdk.send_text_command` with `command: "what is my name"`
|
||||
2. On your phone, you should receive a notification **Allow personal answers** **Allow Google Assistant to answer your questions about your calendar, trips, and more**.
|
||||
3. DO NOT tap on **ALLOW** (it won't work until you enter a device name). Instead, tap on the notification text.
|
||||
4. If the app doesn't open, you need to retry on a device running Android 12. If you don't have such a device, you can use an Android emulator.
|
||||
@ -148,13 +148,13 @@ The easiest way to check if the integration is working is to check [My Google Ac
|
||||
|
||||
On the configure page, you can set the language code of the interactions with Google Assistant. If not configured, the integration picks one based on Home Assistant's configured language and country. Supported languages are listed [here](https://developers.google.com/assistant/sdk/reference/rpc/languages).
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `google_assistant_sdk.send_text_command`
|
||||
### Action `google_assistant_sdk.send_text_command`
|
||||
|
||||
You can use the service `google_assistant_sdk.send_text_command` to send commands to Google Assistant.
|
||||
You can use the `google_assistant_sdk.send_text_command` action to send commands to Google Assistant.
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | --------|
|
||||
| `command` | no | Command(s) to send to Google Assistant. | turn off kitchen TV |
|
||||
| `media_player` | yes | Name(s) of media player entities to play response on | media_player.living_room_speaker |
|
||||
@ -207,11 +207,11 @@ responses:
|
||||
The drumsticks 🍗
|
||||
```
|
||||
|
||||
### Service `notify.google_assistant_sdk`
|
||||
### Action `notify.google_assistant_sdk`
|
||||
|
||||
You can use the service `notify.google_assistant_sdk` to broadcast messages to Google Assistant speakers and displays without interrupting music/video playback.
|
||||
You can use the `notify.google_assistant_sdk` action to broadcast messages to Google Assistant speakers and displays without interrupting music/video playback.
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | --------------------------- | ---------------------------- |
|
||||
| `message` | no | Message to broadcast. | someone is at the front door |
|
||||
| `target` | yes | Rooms (in Google Assistant) | bedroom |
|
||||
@ -243,6 +243,6 @@ Then you can converse with Google Assistant by tapping the Assist icon at the to
|
||||
|
||||
|
||||
|
||||
Or by calling the `conversation.process` service.
|
||||
Or by calling the `conversation.process` action.
|
||||
|
||||
Note: due to a bug in the Google Assistant API, not all responses contain text, especially for home control commands, like turn on the lights. These will be shown as `<empty response>`. For those, Google Assistant responds with HTML and Home Assistant integrations are [not allowed](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md) to parse HTML.
|
||||
|
||||
@ -88,18 +88,18 @@ You can use an OpenAI Conversation integration to [talk to Super Mario and, if y
|
||||
|
||||
The tutorial is using OpenAI, but this could also be done with the Google Generative AI integration.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `google_generative_ai_conversation.generate_content`
|
||||
### Action `google_generative_ai_conversation.generate_content`
|
||||
|
||||
{% tip %}
|
||||
This service isn't tied to any integration entry, so it won't use the model, prompt, or any of the other settings in your options. If you only want to pass text, you should use the `conversation.process` service.
|
||||
This action isn't tied to any integration entry, so it won't use the model, prompt, or any of the other settings in your options. If you only want to pass text, you should use the `conversation.process` action.
|
||||
{% endtip %}
|
||||
|
||||
Allows you to ask Gemini Pro or Gemini Pro Vision to generate content from a prompt consisting of text and optionally images.
|
||||
This service populates [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with the generated content.
|
||||
This action populates [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with the generated content.
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------------------------------------------- | ------------------- |
|
||||
| `prompt` | no | The prompt for generating the content. | Describe this image |
|
||||
| `image_filename` | yes | File names for images to include in the prompt. | /tmp/image.jpg |
|
||||
|
||||
@ -18,7 +18,7 @@ api: Gmail API
|
||||
api_link: https://console.cloud.google.com/apis/library/gmail.googleapis.com
|
||||
---
|
||||
|
||||
The Google Mail integration allows you to connect your [Google Mail](https://mail.google.com) to Home Assistant. The integration adds a service to allow you to set an email auto-response for when you go on vacation. A `notify` service is also added, allowing you to draft or send emails in plain text.
|
||||
The Google Mail integration allows you to connect your [Google Mail](https://mail.google.com) to Home Assistant. The integration adds an action to allow you to set an email auto-response for when you go on vacation. A `notify` action is also added, allowing you to draft or send emails in plain text.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -36,13 +36,13 @@ These are not the same as *Device Auth* credentials previously recommended for [
|
||||
|
||||
If you have an error with your credentials you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface.
|
||||
|
||||
### Service `google_mail.set_vacation`
|
||||
### Action `google_mail.set_vacation`
|
||||
|
||||
You can use the service `google_mail.set_vacation` to set vacation options.
|
||||
You can use the `google_mail.set_vacation` action to set vacation options.
|
||||
|
||||
{% details "Create Event Service details" %}
|
||||
{% details "Create event action details" %}
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | --------|
|
||||
| `enabled` | yes | Turn this off to end vacation responses. | True
|
||||
| `title` | no | The subject for the email. | Vacation
|
||||
@ -57,9 +57,9 @@ You can use the service `google_mail.set_vacation` to set vacation options.
|
||||
|
||||
The added `notify` service will be named after the email address you chose on the consent screen. For example, an email address named "example@gmail.com" wil display as `notify.example_gmail_com`.
|
||||
|
||||
### Google Mail notify service data
|
||||
### Google Mail notify action data
|
||||
|
||||
The following attributes can be placed inside the `data` key of the service call for extended functionality:
|
||||
The following attributes can be placed inside the `data` key of the action for extended functionality:
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
|
||||
@ -17,7 +17,7 @@ api2: Google Sheets API
|
||||
api2_link: https://console.cloud.google.com/apis/enableflow?apiid=sheets.googleapis.com
|
||||
---
|
||||
|
||||
The Google Sheets integration allows you to connect your [Google Drive](https://drive.google.com) to Home Assistant. The integration adds a service to allow you to append rows to a Sheets document. The idea is that you can store data on there for further processing. When you set up a config entry, your drive will have a new sheet called Home Assistant. You can then rename this to whatever you like.
|
||||
The Google Sheets integration allows you to connect your [Google Drive](https://drive.google.com) to Home Assistant. The integration adds an actiion to allow you to append rows to a Sheets document. The idea is that you can store data on there for further processing. When you set up a config entry, your drive will have a new sheet called Home Assistant. You can then rename this to whatever you like.
|
||||
|
||||
**Note**:
|
||||
The integration currently only has access to that one document that is created during setup.
|
||||
@ -45,13 +45,13 @@ This video tutorial explains how to set up the Google Sheets integration and how
|
||||
|
||||
<lite-youtube videoid="hgGMgoxLYwo" videotitle="How to use Google Sheets in Home Assistant - TUTORIAL" posterquality="maxresdefault"></lite-youtube>
|
||||
|
||||
### Service `google_sheets.append_sheet`
|
||||
### Action `google_sheets.append_sheet`
|
||||
|
||||
You can use the service `google_sheets.append_sheet` to add rows of data to the Sheets document created at setup.
|
||||
You can use the `google_sheets.append_sheet` action to add rows of data to the Sheets document created at setup.
|
||||
|
||||
{% details "Create Event Service details" %}
|
||||
{% details "Create event action details" %}
|
||||
|
||||
| Service data attribute | Optional | Description | Example |
|
||||
| Data attribute | Optional | Description | Example |
|
||||
| ---------------------- | -------- | ----------- | --------|
|
||||
| `config_entry` | no | Config entry to use. |
|
||||
| `worksheet` | yes | Name of the worksheet. Defaults to the first one in the document. | Sheet1 |
|
||||
@ -60,7 +60,7 @@ You can use the service `google_sheets.append_sheet` to add rows of data to the
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
# Example service call
|
||||
# Example action
|
||||
service: google_sheets.append_sheet
|
||||
data:
|
||||
config_entry: 1b4a46c6cba0677bbfb5a8c53e8618b0
|
||||
@ -70,7 +70,7 @@ data:
|
||||
KWh: "{{ states('input_number.car_charging_kwh')|float(0) }}"
|
||||
Cost: "{{ states('input_number.car_charging_cost')|float(0) }}"
|
||||
|
||||
# Example service call multiple rows
|
||||
# Example action with multiple rows
|
||||
service: google_sheets.append_sheet
|
||||
data:
|
||||
config_entry: 1b4a46c6cba0677bbfb5a8c53e8618b0
|
||||
|
||||
@ -113,11 +113,11 @@ You can also use supported BCP 47 tags like the below or the 2-2 digit format fo
|
||||
| es-us | es | com |
|
||||
|
||||
|
||||
## Service speak
|
||||
## Action speak
|
||||
|
||||
The `tts.speak` service is the modern way to use Google translate TTS action. Add the `speak` action, select the entity for your Google translate TTS (it's named for the language you created it with), select the media player entity or group to send the TTS audio to, and enter the message to speak.
|
||||
The `tts.speak` actiion is the modern way to use Google translate TTS action. Add the `speak` action, select the entity for your Google translate TTS (it's named for the language you created it with), select the media player entity or group to send the TTS audio to, and enter the message to speak.
|
||||
|
||||
For more options about `speak`, see the Speak section on the main [TTS](/integrations/tts/#service-speak) building block page.
|
||||
For more options about `speak`, see the Speak section on the main [TTS](/integrations/tts/#action-speak) building block page.
|
||||
|
||||
In YAML, your action will look like this:
|
||||
```yaml
|
||||
@ -129,13 +129,13 @@ data:
|
||||
message: Hello, can you hear me now?
|
||||
```
|
||||
|
||||
## Service say (legacy)
|
||||
## Action say (legacy)
|
||||
|
||||
{% tip %}
|
||||
The `google_translate_say` service can be used when configuring the legacy `google_translate` text-to-speech platform in `configuration.yaml`. We recommend new users to instead set up the integration in the UI and use the `tts.speak` service with the corresponding Google Translate text-to-speech entity as target.
|
||||
The `google_translate_say` action can be used when configuring the legacy `google_translate` text-to-speech platform in `configuration.yaml`. We recommend new users to instead set up the integration in the UI and use the `tts.speak` action with the corresponding Google Translate text-to-speech entity as target.
|
||||
{% endtip %}
|
||||
|
||||
The `google_translate_say` service supports `language` and also `options` for setting `tld`. The text for speech is set with `message`. Since release 0.92, the service name can be defined in the configuration `service_name` option.
|
||||
The `google_translate_say` action supports `language` and also `options` for setting `tld`. The text for speech is set with `message`. Since release 0.92, the action name can be defined in the configuration `service_name` option.
|
||||
|
||||
Say to all `media_player` device entities:
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ Destination: Eddies House
|
||||
|
||||
Using automatic polling can lead to calls that exceed your API limit, especially when you are tracking multiple travel times using the same API key. To use more granular polling, disable automated polling.
|
||||
|
||||
You can use the `homeassistant.update_entity` service to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation:
|
||||
You can use the `homeassistant.update_entity` action to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation:
|
||||
|
||||
```yaml
|
||||
- id: update_morning_commute_sensor
|
||||
|
||||
@ -44,12 +44,12 @@ Any Gree Smart device working with the Gree+ app should be supported, including
|
||||
|
||||
The `gree` climate platform integrates Gree HVAC systems into Home Assistant, enabling control of setting the following parameters:
|
||||
|
||||
- [`set_hvac_mode`](/integrations/climate/#service-climateset_hvac_mode)
|
||||
- [`target temperature`](/integrations/climate#service-climateset_temperature)
|
||||
- [`turn on/off`](/integrations/climate#service-climateturn_on)
|
||||
- [`fan mode`](/integrations/climate#service-climateset_fan_mode)
|
||||
- [`swing mode`](/integrations/climate#service-climateset_swing_mode)
|
||||
- [`set_preset_mode`](/integrations/climate#service-climateset_preset_mode)
|
||||
- [`set_hvac_mode`](/integrations/climate/#action-climateset_hvac_mode)
|
||||
- [`target temperature`](/integrations/climate#action-climateset_temperature)
|
||||
- [`turn on/off`](/integrations/climate#action-climateturn_on)
|
||||
- [`fan mode`](/integrations/climate#action-climateset_fan_mode)
|
||||
- [`swing mode`](/integrations/climate#action-climateset_swing_mode)
|
||||
- [`set_preset_mode`](/integrations/climate#action-climateset_preset_mode)
|
||||
|
||||
{% note %}
|
||||
Preset mode **Away** represents Gree's "8°C heating mode."
|
||||
|
||||
@ -124,7 +124,7 @@ In short, when any group member entity is `unlocked`, the group will also be `un
|
||||
|
||||
## Managing groups
|
||||
|
||||
To edit a group, **{% my helpers title="Settings -> Devices & Services -> Helpers" %}**. Find and select the group from the list.
|
||||
To edit a group, **{% my helpers title="Settings -> Devices & services -> Helpers" %}**. Find and select the group from the list.
|
||||
|
||||
|
||||
|
||||
@ -309,7 +309,7 @@ state_class:
|
||||
|
||||
This group is a special case of groups currently only available via YAML configuration.
|
||||
|
||||
Notify groups are used to combine multiple notification services into a single service. This allows you to send notification to multiple devices with a single call.
|
||||
Notify groups are used to combine multiple notification actions into a single action. This allows you to send notification to multiple devices by performing a single action.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -329,12 +329,12 @@ name:
|
||||
required: true
|
||||
type: string
|
||||
services:
|
||||
description: A list of all the services to be included in the group.
|
||||
description: A list of all the actions to be included in the group.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
service:
|
||||
description: The service part of an entity ID, e.g., if you use `notify.html5` normally, just put `html5`. Note that you must put everything in lower case here. Although you might have capitals written in the actual notification services!
|
||||
description: The name part of an entity ID, e.g., if you use `notify.html5` normally, just put `html5`. Note that you must put everything in lower case here. Although you might have capitals written in the actual notification actions!
|
||||
required: true
|
||||
type: string
|
||||
data:
|
||||
@ -439,13 +439,13 @@ When a group contains entities from domains that have multiple `on` states or on
|
||||
|
||||
It is possible to create a group that the system cannot calculate a group state. Groups with entities from unsupported domains will always have an unknown state.
|
||||
|
||||
These groups can still be in templates with the `expand()` directive, called using the `homeassistant.turn_on` and `homeassistant.turn_off` services, etc.
|
||||
These groups can still be in templates with the `expand()` directive, called using the `homeassistant.turn_on` and `homeassistant.turn_off` actions, etc.
|
||||
|
||||
### Services
|
||||
### Actions
|
||||
|
||||
This integration provides the following services to modify groups and a service to reload the configuration without restarting Home Assistant itself.
|
||||
This integration provides the following actions to modify groups and a action to reload the configuration without restarting Home Assistant itself.
|
||||
|
||||
| Service | Data | Description |
|
||||
| Action | Data | Description |
|
||||
| -------- | ----------------- | ----------------------------------------------------------------------------- |
|
||||
| `set` | `Object ID` | Group id and part of entity id. |
|
||||
| | `Name` | Name of the group. |
|
||||
|
||||
@ -38,13 +38,13 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### `guardian.pair_sensor`
|
||||
|
||||
Add a new paired sensor to the valve controller.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------ |
|
||||
| `uid` | yes | The unique device ID on the bottom of the sensor.|
|
||||
|
||||
@ -52,7 +52,7 @@ Add a new paired sensor to the valve controller.
|
||||
|
||||
Remove a paired sensor from the valve controller.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------ |
|
||||
| `uid` | yes | The unique device ID on the bottom of the sensor.|
|
||||
|
||||
@ -60,15 +60,17 @@ Remove a paired sensor from the valve controller.
|
||||
|
||||
Upgrade the device firmware.
|
||||
|
||||
| Service Data Attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------ |
|
||||
| `url` | yes | The URL of the server hosting the firmware file. |
|
||||
| `port` | yes | The port on which the firmware file is served. |
|
||||
| `filename` | yes | The firmware filename. |
|
||||
|
||||
*Note:* not all service calls are available on all Guardian valve controller firmwares.
|
||||
{% note %}
|
||||
Not all actions are available on all Guardian valve controller firmwares.
|
||||
Please ensure you upgrade your valve controller to the latest firmware before opening
|
||||
bugs related to non-working service calls.
|
||||
bugs related to non-working actions.
|
||||
{% endnote %}
|
||||
|
||||
## Paired Sensor Notes
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user