mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-28 19:57:12 +00:00
Rename Services to Actions in integrations: U (#33830)
* Rename Services to Actions in integrations: U * Update source/_integrations/utility_meter.markdown --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Franck Nijhof
GitHub
parent
4a9ea9c06a
commit
2b0e78caf6
@ -155,6 +155,6 @@ template:
|
||||
|
||||
## Managing API requests
|
||||
|
||||
If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the service `homeassistant.update_entity` to request the update of an {% term entity %}, rather than waiting for the next scheduled update.
|
||||
If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the configuration options, and use the `homeassistant.update_entity` action to request the update of an {% term entity %}, rather than waiting for the next scheduled update.
|
||||
|
||||
Powered by [transportAPI](https://www.transportapi.com/)
|
||||
|
||||
@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
- [Button](#button)
|
||||
- [Image](#image)
|
||||
- [Presence detection](#presence-detection)
|
||||
- [Services](#services)
|
||||
- [Actions](#actions)
|
||||
- [Switch](#switch)
|
||||
- [Sensor](#sensor)
|
||||
- [Firmware updates](#firmware-updates)
|
||||
@ -94,17 +94,17 @@ If Home Assistant and the UniFi Network application are running on separate mach
|
||||
|
||||
[Related Issue](https://github.com/home-assistant/home-assistant/issues/10507)
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service unifi.reconnect_client
|
||||
### Action unifi.reconnect_client
|
||||
|
||||
Try to get a wireless client to reconnect to the network.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------- |
|
||||
| `device_id` | No | String representing a device ID related to a UniFi Network {% term integration %} . |
|
||||
|
||||
### Service unifi.remove_clients
|
||||
### Action unifi.remove_clients
|
||||
|
||||
Clean up clients on the UniFi Network application that has only been associated with the Network application for a short period of time. The difference between first seen and last seen needs to be less than 15 minutes and the client can not have a fixed IP, hostname or name associated with it.
|
||||
|
||||
|
||||
@ -120,7 +120,7 @@ Each UniFi Protect camera will get a device in Home Assistant with the following
|
||||
|
||||
- **Camera** - A camera for each camera channel and RTSP(S) combination found for each camera (up to 7). Only the highest resolution RTSPS camera {% term entity %} will be enabled by default.
|
||||
- If your camera is a G4 Doorbell Pro, an additional camera {% term entity %} will be added for the Package Camera. The Package Camera {% term entity %} will _not_ have streaming capabilities regardless of whether RTSPS is enabled on the channel or not. This is due to the Package Camera having a very low FPS that does not make it compatible with HLS streaming.
|
||||
- **Media Player** - If your camera has a speaker, you will get a media player {% term entity %} that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say Service](/integrations/tts/#service-say).
|
||||
- **Media Player** - If your camera has a speaker, you will get a media player {% term entity %} that allows you to play audio to your camera's speaker. Any audio file URI that is playable by FFmpeg will be able to be played to your speaker, including via the [TTS Say action](/integrations/tts/#action-say).
|
||||
- **Privacy Mode** - If your camera allows for Privacy Masks, there will be a configuration switch to toggle a "Privacy Mode" that disables recording, microphone, and a black privacy zone over the whole camera.
|
||||
- **Sensors** - Sensors include "Is Dark", "Motion Detected", detected object sensors (if the camera supports smart detections), and "Doorbell Chime" (if the camera has a chime). Several diagnostics sensors are added including sensors on uptime, network connection stats, and storage stats. Doorbells will also have a "Voltage" sensor for troubleshooting electrical issues.
|
||||
- There is one detected object sensor per Smart Detection supported by the camera and a combined sensor for if _any_ object is detected.
|
||||
@ -216,40 +216,40 @@ Below are the accepted identifiers to resolve media. Since events do not necessa
|
||||
| `{nvr_id}:event:{event_id}` | MP4 video clip for specific event. |
|
||||
| `{nvr_id}:eventthumb:{event_id}` | JPEG thumbnail for specific event. |
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service unifiprotect.add_doorbell_text
|
||||
### Action unifiprotect.add_doorbell_text
|
||||
|
||||
Adds a new custom message for Doorbells.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
|
||||
| `message` | No | New custom message to add for Doorbells. Must be less than 30 characters. |
|
||||
|
||||
### Service unifiprotect.remove_doorbell_text
|
||||
### Action unifiprotect.remove_doorbell_text
|
||||
|
||||
Removes an existing message for Doorbells.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect instances. |
|
||||
| `message` | No | Existing custom message to remove for Doorbells. |
|
||||
|
||||
### Service unifiprotect.set_chime_paired_doorbells
|
||||
### Action unifiprotect.set_chime_paired_doorbells
|
||||
|
||||
Use to set the paired doorbell(s) with a smart chime.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `device_id` | No | The device ID of the Chime you want to pair or unpair doorbells to. |
|
||||
| `doorbells` | Yes | A target selector for any number of doorbells you want to pair to the chime. No value means unpair all. |
|
||||
|
||||
### Service unifiprotect.remove_privacy_zone
|
||||
### Action unifiprotect.remove_privacy_zone
|
||||
|
||||
Use to remove a privacy zone from a camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `device_id` | No | Camera you want to remove privacy zone from. |
|
||||
| `name` | No | The name of the zone to remove. |
|
||||
@ -258,7 +258,7 @@ Use to remove a privacy zone from a camera.
|
||||
|
||||
The {% term integrations %} provides two proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips from within the context of Home Assistant without having to expose your UniFi Protect NVR Console. As with the media identifiers, all IDs are UniFi Protect IDs as they may not map to specific Home Assistant entities depending on how you have configured your {% term integrations %}.
|
||||
|
||||
These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an {% term automation %} or [notify service](/integrations/notify/).
|
||||
These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an {% term automation %} or [notify action](/integrations/notify/).
|
||||
|
||||
| View URL | Description |
|
||||
| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|
||||
@ -84,7 +84,7 @@ state_template:
|
||||
required: false
|
||||
type: template
|
||||
commands:
|
||||
description: "Media player commands to be overridden. Almost all media player service commands may be overridden. Example entries are `turn_on`, `turn_off`, `select_source`, `volume_set`, `volume_up`, `volume_down`, `volume_mute`, `media_play`, `media_pause`, `media_stop`, `media_previous_track`, `media_next_track` and `play_media` (refer to the [`media_player` documentation](/integrations/media_player/) to see the full list)."
|
||||
description: "Media player commands to be overridden. Almost all media player action commands may be overridden. Example entries are `turn_on`, `turn_off`, `select_source`, `volume_set`, `volume_up`, `volume_down`, `volume_mute`, `media_play`, `media_pause`, `media_stop`, `media_previous_track`, `media_next_track` and `play_media` (refer to the [`media_player` documentation](/integrations/media_player/) to see the full list)."
|
||||
required: false
|
||||
type: string
|
||||
attributes:
|
||||
@ -111,7 +111,7 @@ Using `active_child_template` will allow you to specify an active {% term entity
|
||||
|
||||
It is recommended that the command `turn_on`, the command `turn_off`, and the attribute `state` all be provided together. The `state` attribute indicates if the media player is on or off. If `state` indicates the media player is off, this status will take precedence over the states of the children. If all the children are idle/off and `state` is on, the Universal Media Player's state will be on. If not provided, the `toggle` command will delegate to `turn_on` or `turn_off` based on the `state`.
|
||||
|
||||
It is also recommended that the command `volume_up`, the command `volume_down`, the command `volume_mute`, and the attribute `is_volume_muted` all be provided together. The attribute `is_volume_muted` should return either True or the on state when the volume is muted. The `volume_mute` {% term service %} should toggle the mute setting.
|
||||
It is also recommended that the command `volume_up`, the command `volume_down`, the command `volume_mute`, and the attribute `is_volume_muted` all be provided together. The attribute `is_volume_muted` should return either True or the on state when the volume is muted. The `volume_mute` {% term action %} should toggle the mute setting.
|
||||
|
||||
When providing `select_source` as a command, it is recommended to also provide the attributes `source`, and `source_list`. The `source` attribute is the currently select source, while the `source_list` attribute is a list of all available sources.
|
||||
|
||||
|
||||
@ -58,9 +58,9 @@ The `event_data` contains the following:
|
||||
- `rate`: The rate for link to transition to the new level. `rate` is
|
||||
-1 for the default transition rate.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
Besides the standard services provided by the Home Assistant [Light](/integrations/light/) and [Scene](/integrations/scene) integrations, the following extra services are provided by the UPB integration:
|
||||
Besides the standard actions provided by the Home Assistant [Light](/integrations/light/) and [Scene](/integrations/scene) integrations, the following extra actions are provided by the UPB integration:
|
||||
|
||||
- `upb.light_fade_start`
|
||||
- `upb.light_fade_stop`
|
||||
@ -73,7 +73,7 @@ Besides the standard services provided by the Home Assistant [Light](/integratio
|
||||
|
||||
### Rate transition time
|
||||
|
||||
Both standard and custom services that take a `transition` or a `rate` for changing brightness levels take time in seconds. The UPB
|
||||
Both standard and custom actions that take a `transition` or a `rate` for changing brightness levels take time in seconds. The UPB
|
||||
system only offers a discrete set of transition times. As such, the transition time requested is changed to the closest time based on
|
||||
the table below. Note that this table does not apply to blink rates, only to brightness transition times.
|
||||
|
||||
@ -96,77 +96,77 @@ the table below. Note that this table does not apply to blink rates, only to bri
|
||||
| 22.5 minutes | 45 minutes | 30 minutes
|
||||
| 45 minutes | ∞ | 1 hour
|
||||
|
||||
### Service `upb.light_fade_start`
|
||||
### Action `upb.light_fade_start`
|
||||
|
||||
Starts a transition of a light to the specified level. Lights that are not dimmable ignore the fade start command.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB light which to start fading operation.
|
||||
| `brightness` | no* | Integer between 0 and 255 for how bright the light should be, where 0 means the light is off, 1 is the minimum brightness and 255 is the maximum brightness. *Only one of `brightness` and `brightness_pct` may be used.
|
||||
| `brightness_pct`| no* | Number between 0 and 100 in percentage that specifies how bright the light should be, where 0 means the light is off, 1 is the minimum brightness and 100 is the maximum brightness. *Only one of `brightness` and `brightness_pct` may be used.
|
||||
| `rate` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. See section on "Rate Transition Time" for how this time value is interpreted.
|
||||
|
||||
### Service `upb.light_fade_stop`
|
||||
### Action `upb.light_fade_stop`
|
||||
|
||||
Stop a light when transitioning from one light level to another. Stops either a fade or a goto (goto occurs when using a `light.turn_on` or `light.turn_off`.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB light which to stop fading operation.
|
||||
|
||||
### Service `upb.light_blink`
|
||||
### Action `upb.light_blink`
|
||||
|
||||
Start a light blinking.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB light which to blink.
|
||||
| `rate` | no | Number between 0 and 4.25 that represents the time (in seconds) the rate the light blinks. Note the UPB implementation limits the blink rate to no faster than 1/3 of a second.
|
||||
|
||||
### Service `upb.scene_deactivate`
|
||||
### Action `upb.scene_deactivate`
|
||||
|
||||
Deactivate a scene. The term “deactivate” is a general UPB term that usually means to turn to the OFF state, but each individual device manufacturer can define it differently for their device.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB scene to deactivate.
|
||||
|
||||
### Service `upb.scene_goto`
|
||||
### Action `upb.scene_goto`
|
||||
|
||||
Starts a transition of a scene to the specified level.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB scene to transition.
|
||||
| `brightness` | no* | Integer between 0 and 255 for how bright the scene should be, where 0 means the scene is off, 1 is the minimum brightness and 255 is the maximum brightness. *Only one of `brightness` and `brightness_pct` may be used.
|
||||
| `brightness_pct`| no* | Number between 0 and 100 in percentage that specifies how bright the scene should be, where 0 means the scene is off, 1 is the minimum brightness and 100 is the maximum brightness. *Only one of `brightness` and `brightness_pct` may be used.
|
||||
| `rate` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. See section on "Rate Transition Time" for how this time value is interpreted.
|
||||
|
||||
### Service `upb.scene_fade_start`
|
||||
### Action `upb.scene_fade_start`
|
||||
|
||||
Starts a transition of a scene to the specified level. Lights within the scene that are not dimmable ignore the fade start command.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB scene to transition.
|
||||
| `brightness` | no* | Integer between 0 and 255 for how bright the scene should be, where 0 means the scene is off, 1 is the minimum brightness and 255 is the maximum brightness. *Only one of `brightness` and `brightness_pct` may be used.
|
||||
| `brightness_pct`| no* | Number between 0 and 100 in percentage that specifies how bright the scene should be, where 0 means the scene is off, 1 is the minimum brightness and 100 is the maximum brightness. *Only one of `brightness` and `brightness_pct` may be used.
|
||||
| `rate` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. See section on "Rate Transition Time" for how this time value is interpreted.
|
||||
|
||||
### Service `upb.scene_fade_stop`
|
||||
### Action `upb.scene_fade_stop`
|
||||
|
||||
Stop a scene when transitioning from one light level to another. Stops either a fade or a goto.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB scene which to stop fading operation.
|
||||
|
||||
### Service `upb.scene_blink`
|
||||
### Action `upb.scene_blink`
|
||||
|
||||
Start a scene blinking.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | UPB scene which to blink.
|
||||
| `rate` | no | Number between 0 and 4.25 that represents the time (in seconds) the rate the scene blinks. Note the UPB implementation limits the blink rate to no faster than 1/3 of a second.
|
||||
|
||||
@ -26,9 +26,9 @@ provided by an integration to the {% term entity %}. For example, the version th
|
||||
available, a summary of the release notes, and even links that provide more
|
||||
information on the available update.
|
||||
|
||||
Lastly, there are two services available for the update {% term entity %}. If possible and
|
||||
Lastly, there are two actions available for the update {% term entity %}. If possible and
|
||||
made available by the integration providing the update {% term entity %}, triggering
|
||||
the actual update from Home Assistant. The other service exposed allows for
|
||||
the actual update from Home Assistant. The other action exposed allows for
|
||||
skipping the offered update.
|
||||
|
||||
{% include integrations/building_block_integration.md %}
|
||||
@ -64,22 +64,22 @@ The following device classes are supported for update entities:
|
||||
to be set.
|
||||
- **`firmware`**: This update {% term integration %} provides firmwares.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
The update {% term entity %} exposes two services that can be used to install or skip
|
||||
The update {% term entity %} exposes two actions that can be used to install or skip
|
||||
an offered software update.
|
||||
|
||||
### Service {% my developer_call_service service="update.install" %}
|
||||
### Action {% my developer_call_service service="update.install" %}
|
||||
|
||||
The {% my developer_call_service service="update.install" %} service can be used
|
||||
The {% my developer_call_service service="update.install" %} action can be used
|
||||
to install an offered update to the device or service.
|
||||
|
||||
This service is only available for an update {% term entity %} if an {% term integration %} provides
|
||||
this capability. Additionally, if allowed by the {% term integration %}, the service
|
||||
This action is only available for an update {% term entity %} if an {% term integration %} provides
|
||||
this capability. Additionally, if allowed by the {% term integration %}, the action
|
||||
provides for installing a specific version and even could make a
|
||||
backup before installing the update.
|
||||
|
||||
#### Service data attributes
|
||||
#### Action data attributes
|
||||
|
||||
{% configuration_basic %}
|
||||
entity_id (required):
|
||||
@ -90,7 +90,7 @@ backup:
|
||||
description: "If set to `true`, a backup will be made before installing the update. Availability of this attribute is dependent on the {% term integration %}."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
Example service call:
|
||||
Example action:
|
||||
|
||||
```yaml
|
||||
service: update.install
|
||||
@ -99,9 +99,9 @@ target:
|
||||
- update.my_light_bulb
|
||||
```
|
||||
|
||||
### Service {% my developer_call_service service="update.skip" %}
|
||||
### Action {% my developer_call_service service="update.skip" %}
|
||||
|
||||
The {% my developer_call_service service="update.skip" %} service can be used
|
||||
The {% my developer_call_service service="update.skip" %} action can be used
|
||||
to skip an offered update to the device or service.
|
||||
|
||||
After skipping an offered update, the {% term entity %} will return to the `off` state,
|
||||
@ -115,19 +115,19 @@ target:
|
||||
```
|
||||
|
||||
Even if an update is skipped and shows as `off` (meaning no update), if there
|
||||
is a newer version available, calling the `update.install` service on the entity
|
||||
is a newer version available, calling the `update.install` action on the entity
|
||||
will still install the latest version.
|
||||
|
||||
### Service {% my developer_call_service service="update.clear_skipped" %}
|
||||
### Action {% my developer_call_service service="update.clear_skipped" %}
|
||||
|
||||
The {% my developer_call_service service="update.clear_skipped" %} service can
|
||||
The {% my developer_call_service service="update.clear_skipped" %} action can
|
||||
be used to remove skipped version marker of a previously skipped an offered
|
||||
update to the device or service.
|
||||
|
||||
After skipping an offered update, the {% term entity %} will return to the `off` state,
|
||||
but will not return to it until a newer version becomes available again.
|
||||
|
||||
Using the `update.clear_skipped` service, the skipped version marker can be
|
||||
Using the `update.clear_skipped` action, the skipped version marker can be
|
||||
removed and thus the entity will return to the `on` state and the update
|
||||
notification will return.
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ The **Utility Meter** {% term integration %} provides functionality to track con
|
||||
|
||||
From a user perspective, utility meters operate in cycles (usually monthly) for billing purposes. This sensor will track a source sensor values, automatically resetting the meter based on the configured cycle. On reset an attribute will store the previous meter value, providing the means for comparison operations (e.g., "did I spend more or less this month?") or billing estimation (e.g., through a sensor template that multiplies the metered value per the charged unit amount).
|
||||
|
||||
Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new {% term entity %} will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
|
||||
Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts for your consumption accordingly. When tariffs are defined a new {% term entity %} will show up, indicating the current tariff. In order to change the tariff, the user must perform an action, usually through an automation that can be based on time or other external sources (for example, a REST sensor).
|
||||
|
||||
{% note %}
|
||||
Sensors created with this {% term integration %} are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor will be incomplete; a sensor tracking daily usage will start to be accurate the next day after the {% term integration %} was activated. A sensor tracking monthly usage will present accurate data starting the first of the next month after being added to Home Assistant.
|
||||
@ -151,23 +151,23 @@ offset:
|
||||
minutes: 0
|
||||
```
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
Some of the services are only available if tariffs are configured.
|
||||
Some of the actions are only available if tariffs are configured.
|
||||
|
||||
### Service `utility_meter.reset`
|
||||
### Action `utility_meter.reset`
|
||||
|
||||
Reset the Utility Meter. All sensors tracking tariffs will be reset to 0.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String or list of strings that point at `entity_id`s of utility_meters.
|
||||
|
||||
### Service `utility_meter.calibrate`
|
||||
### Action `utility_meter.calibrate`
|
||||
|
||||
Calibrate the Utility Meter. Change the value of a given sensor.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String or list of strings that point at `entity_id`s of utility_meters.
|
||||
| `value` | no | Number | Value to calibrate the sensor with |
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user