diff --git a/source/_integrations/nanoleaf.markdown b/source/_integrations/nanoleaf.markdown index 5f326db13fc..3842aac7912 100644 --- a/source/_integrations/nanoleaf.markdown +++ b/source/_integrations/nanoleaf.markdown @@ -31,4 +31,4 @@ This integration does not support the Nanoleaf Remote and Essentials lights. Con # Transition and brightness -When using a transition in service calls (such as `light.turn_on`), the transition is only applied to brightness and does not apply to color. When a service call has a transition set but no brightness is included, the light will automatically transition to 100% brightness. +When using a transition in an action (such as `light.turn_on`), the transition is only applied to brightness and does not apply to color. When an action has a transition set, but no brightness is included, the light will automatically transition to 100% brightness. diff --git a/source/_integrations/neato.markdown b/source/_integrations/neato.markdown index 35d8defa100..67a425d239d 100644 --- a/source/_integrations/neato.markdown +++ b/source/_integrations/neato.markdown @@ -82,9 +82,9 @@ Each `neato` vacuum has a _Dismiss alert_ button. This allows to dismiss an aler The `neato` vacuum platform allows you to control your [Neato Botvac Connected][botvac-connected]. The status will contain attributes on the robots last clean session. -### Services +### Actions -Currently supported services are: +Currently supported actions are: - `start` - `pause` @@ -93,13 +93,11 @@ Currently supported services are: - `locate` - `clean_spot` -And a specific Platform Service: +And a specific integration-specific action: - `neato.custom_cleaning` -### Platform services - -#### Service `neato.custom_cleaning` +#### Action `neato.custom_cleaning` Starts a custom cleaning of your house. You can set the various options like in the mobile application (mode, map usage, navigation mode, zone). @@ -108,7 +106,7 @@ Not all Botvac models support all the attributes. Only the Neato Botvac D7 suppo Some information about the capabilities might be found on the [Neato Developer Portal](https://developers.neatorobotics.com/api/robot-remote-protocol/housecleaning). {% endnote %} -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | Only act on a specific robot | | `mode` | yes | Set the cleaning mode: 1 for eco and 2 for turbo. Defaults to turbo if not set. | diff --git a/source/_integrations/ness_alarm.markdown b/source/_integrations/ness_alarm.markdown index b02c3283ad1..bfbcbbc44c5 100644 --- a/source/_integrations/ness_alarm.markdown +++ b/source/_integrations/ness_alarm.markdown @@ -102,21 +102,21 @@ scan_interval: milliseconds: 0 ``` -## Services +## Actions -### Service `aux` +### Action `aux` Trigger an aux output. This requires PCB version 7.8 or higher. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `output_id` | No | The aux output you wish to change. A number from 1-4. | | `state` | Yes | The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E. | -### Service `panic` +### Action `panic` Trigger a panic -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------ | | `code` | No | The user code to use to trigger the panic. | diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown index 2abcf8fbc27..5e6b30b766d 100644 --- a/source/_integrations/nest.markdown +++ b/source/_integrations/nest.markdown @@ -56,7 +56,7 @@ To add the **Nest** integration to your Home Assistant, use this My Button: {% details "Manual configuration steps" %} 1. Browse to your Home Assistant instance. -2. Go to **{% my integrations title="Settings > Devices & Services" %}**. +2. Go to **{% my integrations title="Settings > Devices & services" %}**. 3. In the bottom right corner, select the **{% my config_flow_start icon domain=page.ha_domain %}** button. 4. From the list, select **Nest** and follow the instructions on screen. @@ -257,8 +257,8 @@ Additional Nest Temperature Sensors are not supported by the SDM API. The Tempe Home Assistant supports all SDM API features. However, every Camera or Doorbell device has a different set of built-in capabilities. A Camera device has one of the following live stream types: -- **RTSP**: These devices have an HLS stream served by the Home Assistant Core. These cameras support server-side `camera` services like stream recording or image preview. See [Low Latency HLS](/integrations/stream#ll-hls) as a great option to enable to reduce stream latency. -- **WebRTC**: These devices support direct browser to camera communication and a super low latency stream. A [Picture Glance Card](/dashboards/picture-glance/) can show the live stream in the grid with the *Camera View* set to `live` (not recommended for battery-powered cameras). `camera` services like stream recording are *not supported*. +- **RTSP**: These devices have an HLS stream served by the Home Assistant Core. These cameras support server-side `camera` actions like stream recording or image preview. See [Low Latency HLS](/integrations/stream#ll-hls) as a great option to enable to reduce stream latency. +- **WebRTC**: These devices support direct browser to camera communication and a super low latency stream. A [Picture Glance Card](/dashboards/picture-glance/) can show the live stream in the grid with the *Camera View* set to `live` (not recommended for battery-powered cameras). `camera` actions like stream recording are *not supported*. {% note %} @@ -454,7 +454,7 @@ To improve security and reduce phishing risk Google has [deprecated](https://dev {% details "Reconfigure the integration" %} 1. Make sure to upgrade to the latest version of Home Assistant. -2. Go to **{% my integrations title="Settings > Devices & Services" %}**. +2. Go to **{% my integrations title="Settings > Devices & services" %}**. 3. The **Nest** integration should appear with alert. ![Screenshot of success](/images/integrations/nest/attention.png) @@ -572,7 +572,7 @@ The *OAuth Client ID* used must be consistent, so check these: - Restart the Thermostat device. See [How to restart or reset a Nest thermostat](https://support.google.com/googlenest/answer/9247296) for more details. - In the official Nest app or on https://home.nest.com: Move the Thermostat to a different or fake/temporary room. -- Reload the integration in Home Assistant: Navigate to **Configuration** then **Devices & Services**, click `...` next to *Nest* and choose **Reload**. +- Reload the integration in Home Assistant: Navigate to **Configuration** then **Devices & services**, click `...` next to *Nest* and choose **Reload**. {% enddetails %} diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index 6b28e8393da..72d7d93e482 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -95,7 +95,7 @@ The `netatmo` sensor platform is consuming the information provided by a [Netatm The `netatmo` switch platform provides support for Legrand/BTicino switches and power plugs. -## Services +## Actions ### Set Outdoor Camera Light Mode @@ -103,7 +103,7 @@ The `netatmo` switch platform provides support for Legrand/BTicino switches and Set the outdoor camera light mode. -| Service data attribute | Required | Description | +| Data attribute | Required | Description | | ---------------------- | -------- | -------------------------- | | `camera_light_mode` | Yes | Outdoor camera light mode. | @@ -113,7 +113,7 @@ Set the outdoor camera light mode. Set the heating schedule. -| Service data attribute | Required | Description | +| Data attribute | Required | Description | | ---------------------- | -------- | ------------------------------------- | | `schedule_name` | Yes | The name of the schedule to activate. | @@ -123,7 +123,7 @@ Set the heating schedule. Set the preset mode for a Netatmo climate device. The preset mode must match a preset mode configured at Netatmo. -| Service data attribute | Required | Description | +| Data attribute | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------- | | `preset_mode` | Yes | Climate preset mode such as Schedule, Away, or Frost Guard. | | `end_datetime` | Yes | Date & time until which the preset will be active. | @@ -134,7 +134,7 @@ Set the preset mode for a Netatmo climate device. The preset mode must match a p Sets the target temperature for a Netatmo climate device with an end date & time. -| Service data attribute | Required | Description | +| Data attribute | Required | Description | | ---------------------- | -------- | -------------------------------------------------------- | | `target_temperature` | Yes | The target temperature for the device. | | `end_datetime` | Yes | Date & time the target temperature will be active until. | @@ -145,7 +145,7 @@ Sets the target temperature for a Netatmo climate device with an end date & time Sets the target temperature for a Netatmo climate device as well as the time period during which this target temperature applies. -| Service data attribute | Required | Description | +| Data attribute | Required | Description | | ---------------------- | -------- | ----------------------------------------------------------- | | `target_temperature` | Yes | The target temperature for the device. | | `time_period` | Yes | Time period during which the target temperature is applied. | @@ -162,7 +162,7 @@ Clears any temperature setting for a Netatmo climate device reverting it to the Set a list of persons as at home. Person's name must match a name known by the Netatmo Smart Indoor Camera. -| Service data attribute | Required | Description | +| Data attribute | Required | Description | | ---------------------- | -------- | -------------- | | `persons` | Yes | List of names. | @@ -172,7 +172,7 @@ Set a list of persons as at home. Person's name must match a name known by the N Set a person away. If no person is set the home will be marked as empty. Person's name must match a name known by the Netatmo Smart Indoor Camera. -| Service data attribute | Required | Description | +| Data attribute | Required | Description | | ---------------------- | -------- | -------------- | | `person` | Yes | Person's name. | @@ -180,7 +180,7 @@ Set a person away. If no person is set the home will be marked as empty. Person' `register_webhook` and `unregister_webhook` -Service to manually register and unregister the webhook. +Actions to manually register and unregister the webhook. ## Webhook Events @@ -306,7 +306,7 @@ In your Netatmo Application configuration, do not enter a 'redirect URI' or a 'w See [Application Credentials](/integrations/application_credentials) for instructions on how to configure your *Client ID* and *Client Secret*, then enable Netatmo through the integrations page. -Menu: **Settings** -> **Devices & Services**. +Menu: **Settings** > **Devices & services**. Click on the `+` sign to add an integration and click on **Netatmo**. After completing the configuration flow, the Netatmo integration will be available. diff --git a/source/_integrations/netgear_lte.markdown b/source/_integrations/netgear_lte.markdown index 15fef5916b5..62748f330e6 100644 --- a/source/_integrations/netgear_lte.markdown +++ b/source/_integrations/netgear_lte.markdown @@ -35,9 +35,9 @@ Splitting of long SMS messages is not supported so notifications can contain a m {% include integrations/config_flow.md %} -## Notification Service +## Notification Actions -The integration will create a `notify` service matching the name of the integration entry. This is the model name of the device by default. +The integration will create a `notify` actions matching the name of the integration entry. This is the model name of the device by default. ## Events @@ -52,38 +52,38 @@ Messages arriving in the modem inbox are sent as events of type `netgear_lte_sms | `from` | The sender of the message. | `message` | The SMS message content. -## Services +## Actions -### Service `netgear_lte.connect_lte` +### Action `netgear_lte.connect_lte` -This service asks the modem to establish its LTE connection, useful if the modem does not autoconnect. +This action asks the modem to establish its LTE connection, useful if the modem does not autoconnect. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `host` | yes | The modem that should connect (optional when just one modem is configured). -### Service `netgear_lte.disconnect_lte` +### Action `netgear_lte.disconnect_lte` -This service asks the modem to close its LTE connection. +This action asks the modem to close its LTE connection. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `host` | yes | The modem that should disconnect (optional when just one modem is configured). -### Service `netgear_lte.delete_sms` +### Action `netgear_lte.delete_sms` -The integration makes a service available to delete messages from the modem inbox. This can be used to clean up after incoming SMS events. +The integration makes an action available to delete messages from the modem inbox. This can be used to clean up after incoming SMS events. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `host` | yes | The modem that should have a message deleted (optional when just one modem is configured). | `sms_id` | no | Integer or list of integers with inbox IDs of messages to delete. -### Service `netgear_lte.set_option` +### Action `netgear_lte.set_option` -This service can set modem configuration options (otherwise available in the modem web UI). +This action can set modem configuration options (otherwise available in the modem web UI). -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `host` | yes | The modem to set options on (optional when just one modem is configured). | `autoconnect` | yes | Autoconnect value: `never`/`home`/`always`, with `home` meaning "not roaming". diff --git a/source/_integrations/nexia.markdown b/source/_integrations/nexia.markdown index fe26f6a4bf6..f14d6c190fd 100644 --- a/source/_integrations/nexia.markdown +++ b/source/_integrations/nexia.markdown @@ -84,21 +84,21 @@ The scene platform lets you activate a nexia automation. The switch platform lets you enable or disable hold mode for each thermostat. -### Service `nexia.set_aircleaner_mode` +### Action `nexia.set_aircleaner_mode` Sets the air cleaner mode. Options include 'auto', 'quick', and 'allergy'. This setting will affect all zones on the same thermostat. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | String or list of strings that point at `entity_id`'s of climate devices to control. | `aircleaner_mode` | no | 'auto', 'quick', or 'allergy' -### Service `nexia.set_humidify_setpoint` +### Action `nexia.set_humidify_setpoint` Sets the humidify setpoint. This setting will affect all zones on the same thermostat. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | String or list of strings that point at `entity_id`'s of climate devices to control. | `humidity` | no | Humidify setpoint level, from 35 to 65. diff --git a/source/_integrations/nfandroidtv.markdown b/source/_integrations/nfandroidtv.markdown index 4ffe982a49f..12f32786fd9 100644 --- a/source/_integrations/nfandroidtv.markdown +++ b/source/_integrations/nfandroidtv.markdown @@ -22,11 +22,11 @@ When setting this up be aware, that there are two apps: one for your smartphone {% include integrations/config_flow.md %} -## Services +## Actions -The following options can be specified inside the data field for the notify service call: +The following options can be specified inside the data field for the notify action: -### Service `notify.[name_of_your_tv]` +### Action `notify.[name_of_your_tv]` {% configuration %} duration: @@ -59,7 +59,7 @@ interrupt: type: boolean {% endconfiguration %} -This is a fully customized YAML you can use inside `data` to test how the final notification will look like (for using this inside a service call look at the service example at the end of this page): +This is a fully customized YAML you can use inside `data` to test how the final notification will look like (for using this inside an action look at the example at the end of this page): ```yaml fontsize: "large" @@ -70,9 +70,9 @@ color: "red" interrupt: 1 ``` -## Service data for sending images and icons +## Action data for sending images and icons -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `image` | yes | Groups the attributes for image upload. It can take a `url` or `path`. It is optional unless you use authentication options. Then, either `url` or `path` has to be provided. | | `icon` | yes | Groups the attributes for icon upload. It can take a `url` or `path`. It is optional unless you use authentication options. Then, either `url` or `path` has to be provided. | @@ -82,7 +82,7 @@ interrupt: 1 | `password` | yes | Password if the URL requires authentication. Is placed inside `image`, `icon` or both. | `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing, HTTP-BASIC-Authentication is used and is placed inside `image`, `icon` or both. -Example Service data for both image and icons: +Example action data for both image and icons: ```yaml # If your urls do not require extra authentication @@ -111,7 +111,7 @@ icon: auth: "digest" # Optional ``` -Example of an automation with an service call, full configuration: +Example of an automation with an action, full configuration: {% raw %} diff --git a/source/_integrations/nissan_leaf.markdown b/source/_integrations/nissan_leaf.markdown index 7b944db0faf..c6c47a53d96 100644 --- a/source/_integrations/nissan_leaf.markdown +++ b/source/_integrations/nissan_leaf.markdown @@ -30,7 +30,7 @@ The {% term integration %} offers offers: - sensors for the battery status, range and charging status. - a switch to start and stop the climate control. - a button to request the car starts charging. -- service to request updates from the car. +- action to request updates from the car. ## Configuration @@ -96,7 +96,7 @@ nissan_leaf: ## Starting a Charge -You can use the `button.press` service to send a request to the Nissan servers to start a charge. The car must be plugged in! +You can use the `button.press` action to send a request to the Nissan servers to start a charge. The car must be plugged in! ```yaml - service: button.press @@ -106,7 +106,7 @@ You can use the `button.press` service to send a request to the Nissan servers t ## Updating on-demand using Automation -You can also use the `nissan_leaf.update` service to request an on-demand update. To update almost exclusively via the service set the `update_interval` to a high value in the integration configuration. The service requests the VIN number as described above. +You can also use the `nissan_leaf.update` action to request an on-demand update. To update almost exclusively via the action set the `update_interval` to a high value in the integration configuration. The action requests the VIN number as described above. ```yaml - id: update_when_driver_not_home @@ -130,7 +130,7 @@ You can also use the `nissan_leaf.update` service to request an on-demand update - The update interval has a minimum of two minutes. - Requesting updates uses a small amount of energy from the 12 V battery. The 12 V battery charges from the main traction battery when the car is not plugged in. If the car is left plugged in for a long time, or if the main traction battery is very low then the 12 V battery may gradually discharge. A low update interval may cause the 12 V battery to become flat. When the 12 V battery is flat the car will not start. _Do not set the update interval too low. Use at your own risk._ - This integration communicates with the Nissan Servers which then communicate with the car. The communication between the car and the Nissan Servers is very slow, and takes up to five minutes to get information from the car, therefore the default polling interval is set to one hour to not overwhelm the connection. -- Responses from the Nissan servers are received separately for the battery/range, climate control and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled, and to indicate if `update_in_progress`. The `nissan_leaf.update` service will reset the `next_update` attribute. +- Responses from the Nissan servers are received separately for the battery/range, climate control, and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled and for indicating if `update_in_progress`. The `nissan_leaf.update` action will reset the `next_update` attribute. - The Nissan APIs do not allow charging to be stopped remotely. - The Nissan servers have a history of being unstable, therefore please confirm that the official Nissan Leaf app/website is working correctly before reporting bugs. - In the UK the cut-off for Carwings was the 16 plate 24 kWh and the 65 plate 30 kWh. Cars after this have NissanConnect. diff --git a/source/_integrations/notify.markdown b/source/_integrations/notify.markdown index ce65e495ad4..90f485bc64b 100644 --- a/source/_integrations/notify.markdown +++ b/source/_integrations/notify.markdown @@ -17,11 +17,11 @@ If you want to send notifications to the Home Assistant web interface, you may u {% include integrations/building_block_integration.md %} -## Service +## Action -The legacy `notify` platform will expose a generic `notify` service that can be called to send notifications. +The legacy `notify` platform will expose a generic `notify` action that can be called to send notifications. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `message` | no | Body of the notification. | `title` | yes | Title of the notification. @@ -30,38 +30,38 @@ The legacy `notify` platform will expose a generic `notify` service that can be ## Usage -The different **Notify** integrations you have set up will each show up as a different automation {% term action %} or {% term service %} call that you can use. +The different **Notify** integrations you have set up will each show up as a different automation {% term action %} that you can use. -One notification integration is automatically included, the Persistent Notifications which creates a notification in the sidebar of the web interface of Home Assistant. This can be chosen with the action named "Notifications: Send a persistent notification" which uses the service `notify.persistent_notification`. +One notification integration is automatically included, the Persistent Notifications which creates a notification in the sidebar of the web interface of Home Assistant. This can be chosen with the action named "Notifications: Send a persistent notification" which uses the `notify.persistent_notification` action. -## Notify entity service +## Notify action -Integrations can also implement the notify entity platform. Entity platform implementations will replace the legacy notify service in time. There is an entity platform service `send_message` which allows you to send notification messages to multiple notify entities. +Integrations can also implement the notify entity platform. Entity platform implementations will replace the legacy notify action in time. There is an entity platform action `send_message` which allows you to send notification messages to multiple notify entities. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `message` | no | Body of the notification. | `title` | yes | Title of the notification. ## Companion app notifications -A common notification integration is via the Home Assistant Companion app for Android or iPhone. This can be chosen with the action "Send a notification via mobile_app_your_phone_name", which uses the service `notify.mobile_app_your_phone_name`. Refer to the [Companion app documentation](https://companion.home-assistant.io/docs/notifications/notifications-basic) for lots of customization options. +A common notification integration is via the Home Assistant Companion app for Android or iPhone. This can be chosen with the action "Send a notification via mobile_app_your_phone_name", which uses the `notify.mobile_app_your_phone_name` action. Refer to the [Companion app documentation](https://companion.home-assistant.io/docs/notifications/notifications-basic) for lots of customization options. With any of these integrations, the `message` data input in the automation editor is the main text that will be sent. Other fields are optional, and some integrations support additional `data` or `target` information to customize the action. For more details, refer to their integration documentation. -Be aware that the `notify.notify` service is shorthand for the first notify service the system can find. It might not work as intended. Choose a specific service to make sure your message goes to the right place. +Be aware that the `notify.notify` action is shorthand for the first notify action the system can find. It might not work as intended. Choose a specific action to make sure your message goes to the right place. Notifications can also be sent using [Notify groups](https://www.home-assistant.io/integrations/group/#notify-groups). These allow you to send notification to multiple devices with a single call, or to update which device is notified by only changing it in a single place. ### Test if it works -After you setup a [notifier](/integrations/#notifications), a simple way to test if you have set up your notify platform correctly is to open {% my developer_services title="**Developer tools** > **Services**" %}** tab from the sidebar. Choose your service from the **Service** dropdown menu depending on the integration you want to test, such as **Notifications: Send a persistent notification** or **Notifications: Send a notification via mobile_app_your_phone_name**. Enter your message into the **message** field, and select the **CALL SERVICE** button. +After you setup a [notifier](/integrations/#notifications), a simple way to test if you have set up your notify platform correctly is to open {% my developer_services title="**Developer tools** > **Actions**" %}** tab from the sidebar. Choose your action from the **Action** dropdown menu depending on the integration you want to test, such as **Notifications: Send a persistent notification** or **Notifications: Send a notification via mobile_app_your_phone_name**. Enter your message into the **message** field, and select the **Perform action** button. -To test the entity platform service, select the `notify.send_message` service, and select one or more of `entity`, `device`, `area`, or `label`. Then, supply a `message`. +To test the entity platform action, select the `notify.send_message` action, and select one or more of `entity`, `device`, `area`, or `label`. Then, supply a `message`. -### Example with the entity platform notify service +### Example with the entity platform notify action -Under {% my developer_services title="**Developer Tools** > **Services**" %}, select the **Notifications: Send a notification message** action. Select some target entity's using the entity selectors, enter a message and test sending it. +Under {% my developer_services title="**Developer Tools** > **Actions**" %}, select the **Notifications: Send a notification message** action. Select some target entity's using the entity selectors, enter a message and test sending it. If you switch to view the YAML data under **Developer Tools**, it will appear as below. The same {% term action %} can be chosen in {% term automation %}. The YAML will appear the same: @@ -91,9 +91,9 @@ action: {% endraw %} -### Examples with the legacy notify service +### Examples with the legacy notify action -In the **Developer Tools**, on the **Services** tab, select the **Notifications: Send a persistent notification** action. Enter a message and test sending it. +In the **Developer Tools**, on the **Action** tab, select the **Notifications: Send a persistent notification** action. Enter a message and test sending it. If you switch to view the YAML data under **Developer Tools**, it will appear as below. The same {% term action %} can be chosen in {% term automation %} actions %, whose YAML will appear the same: diff --git a/source/_integrations/notify.mqtt.markdown b/source/_integrations/notify.mqtt.markdown index fc6a71e48d4..2f02873ff8a 100644 --- a/source/_integrations/notify.mqtt.markdown +++ b/source/_integrations/notify.mqtt.markdown @@ -8,7 +8,7 @@ ha_iot_class: Configurable ha_domain: mqtt --- -The **MQTT notify** platform lets you send an MQTT message when the `send_message` service is called. This can be used to expose a service of a remote device that allows processing a message, such as showing it on a screen. +The **MQTT notify** platform lets you send an MQTT message when the `send_message` action is called. This can be used to expose a action of a remote device that allows processing a message, such as showing it on a screen. ## Configuration diff --git a/source/_integrations/notify.rest.markdown b/source/_integrations/notify.rest.markdown index a5ac079ae33..39b7cb445a2 100644 --- a/source/_integrations/notify.rest.markdown +++ b/source/_integrations/notify.rest.markdown @@ -21,7 +21,7 @@ notify: {% configuration %} name: - description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action. required: false default: notify type: string diff --git a/source/_integrations/notify.tts.markdown b/source/_integrations/notify.tts.markdown index 490371cc652..833f19c3ccc 100644 --- a/source/_integrations/notify.tts.markdown +++ b/source/_integrations/notify.tts.markdown @@ -1,6 +1,6 @@ --- title: "Notify using TTS" -description: "Instructions on how to set up a Notify integration using TTS service and media_player within Home Assistant." +description: "Instructions on how to set up a Notify integration using TTS action and media_player within Home Assistant." ha_category: - Notifications ha_release: 0.117 @@ -9,7 +9,7 @@ ha_quality_scale: internal ha_domain: notify --- -The notify TTS platform lets you use the TTS integration [speak](/integrations/tts/#service-speak) or legacy [say](/integrations/tts/#service-say-legacy) service and a [media_player](/integrations/media_player) to alert you of important events. This integration provides a simple interface to use in your automations and alerts. +The notify TTS platform lets you use the TTS integration [speak](/integrations/tts/#action-speak) or legacy [say](/integrations/tts/#action-say-legacy) action and a [media_player](/integrations/media_player) to alert you of important events. This integration provides a simple interface to use in your automations and alerts. In order to use this integration, you must already have a TTS platform installed and configured, and a media_player working with the TTS platform. @@ -27,7 +27,7 @@ notify: {% configuration %} name: - description: The name of the notify service. + description: The name of the notify action. required: true type: string entity_id: @@ -43,7 +43,7 @@ notify: required: true type: string language: - description: "The `language` to be passed to the TTS `speak` or `say` service." + description: "The `language` to be passed to the TTS `speak` or `say` action." required: false type: string {% endconfiguration %} diff --git a/source/_integrations/notify_events.markdown b/source/_integrations/notify_events.markdown index a7c8bdaa469..aac7092078d 100644 --- a/source/_integrations/notify_events.markdown +++ b/source/_integrations/notify_events.markdown @@ -68,7 +68,7 @@ notify: {% configuration %} name: - description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`." + description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action." required: false type: string default: notify @@ -76,13 +76,13 @@ name: ### That's it! -Now you can use the `notify.events` service inside your Home Assistant to: +Now you can use the `notify.events` action inside your Home Assistant to: - Send any notifications or alerts - Distribute events by `level` and `priority` - Attach **files** and **images** (local or remote) - .. and just keep using your favorite messenger to receive them! -### Example service call +### Example action ```yaml - service: notify.events diff --git a/source/_integrations/nuheat.markdown b/source/_integrations/nuheat.markdown index e32c69247a4..4509dd37541 100644 --- a/source/_integrations/nuheat.markdown +++ b/source/_integrations/nuheat.markdown @@ -110,20 +110,20 @@ Returns the maximum supported temperature by the thermostat | ---------------| ----------- | | Integer | Maximum supported temperature -## Services +## Actions -The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hvac_mode`, `set_preset_mode`. +The following actions are provided by the NuHeat Thermostat: `set_temperature`, `set_hvac_mode`, `set_preset_mode`. -### Service `climate.set_hvac_mode` ([Climate integration](/integrations/climate/)) +### Action `climate.set_hvac_mode` ([Climate integration](/integrations/climate/)) NuHeat Thermostats do not have an off concept. Setting the temperature to `min_temp` and changing the mode to `heat` will cause the device to enter a `Permanent Hold` preset and will stop the thermostat from turning on unless you happen to live in a freezing climate. -### Service `climate.set_temperature` ([Climate integration](/integrations/climate/)) +### Action `climate.set_temperature` ([Climate integration](/integrations/climate/)) If the thermostat is in auto mode, it puts the thermostat into a temporary hold at the given temperature. If the thermostat is in heat mode, it puts the thermostat into a permanent hold at the given temperature. -### Service `climate.set_preset_mode` ([Climate integration](/integrations/climate/)) +### Action `climate.set_preset_mode` ([Climate integration](/integrations/climate/)) The following presets are available: `Run Schedule`, `Temporary Hold`, `Permanent Hold`. diff --git a/source/_integrations/nuki.markdown b/source/_integrations/nuki.markdown index e6196c867e3..6fe076ddda8 100644 --- a/source/_integrations/nuki.markdown +++ b/source/_integrations/nuki.markdown @@ -39,23 +39,23 @@ For faster updates, the callback function of the Nuki bridge can be used. This r description: Use an encrypted token for API calls to the bridge. This should only be deactivated if you experience issues with the API (authentication, etc). The default is `True`. {% endconfiguration_basic %} -## Services +## Actions -### Service `nuki.lock_n_go` +### Action `nuki.lock_n_go` This will first unlock, wait a few seconds (20 by default) then re-lock. The wait period can be customized through the app. See the [Nuki Website](https://nuki.io/en/support/smart-lock/sl-features/locking-with-the-smart-lock/) for more details about this feature. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s Nuki Locks. | `unlatch` | yes | Boolean - Whether to unlatch the door when first opening it. -### Service `nuki.set_continuous_mode` +### Action `nuki.set_continuous_mode` -This service allows you to enable or disable the "Continuous Mode" feature of Nuki Openers. This is similar to the Ring-to-Open feature that is mapped to "lock/unlock", except that it doesn't have a time limit - as long as this mode is enabled, the door will open when the buzzer button is pressed, similar to how it works at e.g. a doctor's office or other business during the day. On other Nuki products, this service is a no-op. +This action allows you to enable or disable the "Continuous Mode" feature of Nuki Openers. This is similar to the Ring-to-Open feature that is mapped to "lock/unlock", except that it doesn't have a time limit - as long as this mode is enabled, the door will open when the buzzer button is pressed, similar to how it works at e.g. a doctor's office or other business during the day. On other Nuki products, this action is a no-op. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`s Nuki Locks. | `enabled` | yes | Boolean - Set to `true` to enable Continuous Mode, or `false` to disable. diff --git a/source/_integrations/number.markdown b/source/_integrations/number.markdown index 636ff6316ed..84ffa781153 100644 --- a/source/_integrations/number.markdown +++ b/source/_integrations/number.markdown @@ -77,10 +77,10 @@ The following device classes are supported for numbers: - **weight**: Generic mass in kg, g, mg, µg, oz, lb, or st - **wind_speed**: Wind speed in ft/s, km/h, kn, m/s, or mph -## Services +## Actions -The Number entities registers the following services: +The Number entities registers the following actions: -| Service | Data | Description | +| Action | Data | Description | | ------- | ---- | ----------- | | `set_value` | `value`
`entity_id(s)`
`area_id(s)` | Set the value of specific `number` entities diff --git a/source/_integrations/nws.markdown b/source/_integrations/nws.markdown index 85a89a9db78..1fc39a17476 100644 --- a/source/_integrations/nws.markdown +++ b/source/_integrations/nws.markdown @@ -26,8 +26,8 @@ According to the [API documentation](https://www.weather.gov/documentation/servi Providing a METAR station code is optional, and if not supplied, the closest station to the latitude and longitude will be chosen. A list of nearby stations is printed to the log with level `DEBUG` if no station is supplied. Stations can also be found on the [NOAA website](https://www.cnrfc.noaa.gov/metar.php). Codes with only three characters, for example, `ADW` should be prefixed with the letter K, `KADW`. -One weather entity is created for each entry in the configuration. Hourly and day/night forecasts are provided through the `weather.get_forecasts` service. The time supplied for each forecast is the start time for the forecast. Sensors are also created as disabled entities after configuration and can be enabled by the user. +One weather entity is created for each entry in the configuration. Hourly and day/night forecasts are provided through the `weather.get_forecasts` action. The time supplied for each forecast is the start time for the forecast. Sensors are also created as disabled entities after configuration and can be enabled by the user. Details about the API are available in the [NWS API documentation](https://www.weather.gov/documentation/services-web-api). The [pynws](https://github.com/MatthewFlamm/pynws) library is used to retrieve data. -Details about the `weather.get_forecasts` service are available in the [`weather` documentation](/integrations/weather/). +Details about the `weather.get_forecasts` action are available in the [`weather` documentation](/integrations/weather/). diff --git a/source/_integrations/nx584.markdown b/source/_integrations/nx584.markdown index ff801f76e5b..5727b406635 100644 --- a/source/_integrations/nx584.markdown +++ b/source/_integrations/nx584.markdown @@ -118,22 +118,22 @@ binary_sensor: 6: moisture ``` -## Services +## Actions -### Service `bypass_zone` +### Action `bypass_zone` -This service will bypass a given zone. +This action will bypass a given zone. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------- | | `entity_id` | yes | entity_id of the NX584 Alarm. | | `zone` | no | Zone number you want to bypass. | -### Service `unbypass_zone` +### Action `unbypass_zone` -This service will unbypass a given zone. +This action will unbypass a given zone. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | --------------------------------- | | `entity_id` | yes | entity_id of the NX584 Alarm. | | `zone` | no | Zone number you want to unbypass. | diff --git a/source/_integrations/nzbget.markdown b/source/_integrations/nzbget.markdown index 015bd1762bb..d091500fb5a 100644 --- a/source/_integrations/nzbget.markdown +++ b/source/_integrations/nzbget.markdown @@ -65,16 +65,16 @@ Example automation to send a Telegram message on a completed download: {% endraw %} -## Services +## Actions -Available services: +Available actions: - `pause`: Pause the download queue. - `resume`: Resume the download queue. - `set_speed`: Set the download queue speed limit. -### Service `nzbget/set_speed` +### Action `nzbget/set_speed` -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------- | | `speed` | yes | Sets the download speed limit, specified in Kb/s. 0 disables the speed limit. Defaults to 1000. |