jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 13:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: T (#33829)

Browse Source 
* Rename Services to Actions in integrations: T

* Update source/_integrations/timer.markdown

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Franck Nijhof 2024-07-17 06:49:05 +02:00 committed by GitHub
parent 0a5312d5ed
commit 02dce15a8f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
22 changed files with 153 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/_integrations/tado.markdown
View File

@ -57,34 +57,34 @@ Polling Tado API for presence information will happen at most once every 30 seco
Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status. Beware that the Tado (v2) API does not provide GPS location of devices, only a bearing, therefore Home Assistant only uses `home`/`not-home` status.
## Services ## Actions
### Service `tado.set_climate_timer` ### Action `tado.set_climate_timer`
You can use the service `tado.set_climate_timer` to set your Tado climate device, for example a radiator valve, to switch on for a set time period. You can use the `tado.set_climate_timer` action to set your Tado climate device, for example a radiator valve, to switch on for a set time period.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------- |
| `entity_id` | yes | String, Name of entity e.g., `climate.heating` | | `entity_id` | yes | String, Name of entity e.g., `climate.heating` |
| `temperature` | no | String, The required target temperature e.g., `20.5` | | `temperature` | no | String, The required target temperature e.g., `20.5` |
| `time_period` | yes | Time Period, Period of time the boost should last for e.g., `01:30:00` | | `time_period` | yes | Time Period, Period of time the boost should last for e.g., `01:30:00` |
| `overlay` | yes | Override your defaults setting. NB dont set this and the time period | | `overlay` | yes | Override your defaults setting. NB dont set this and the time period |
### Service `tado.set_water_heater_timer` ### Action `tado.set_water_heater_timer`
You can use the service `tado.set_water_heater_timer` to set your water heater to switch on for a set time period. You can use the `tado.set_water_heater_timer` action to set your water heater to switch on for a set time period.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------- |
| `entity_id` | yes | String, Name of entity e.g., `water_heater.hot_water` | | `entity_id` | yes | String, Name of entity e.g., `water_heater.hot_water` |
| `time_period` | no | Time Period, Period of time the boost should last for e.g., `01:30:00` | | `time_period` | no | Time Period, Period of time the boost should last for e.g., `01:30:00` |
| `temperature` | yes | String, The required target temperature e.g., `20.5` | | `temperature` | yes | String, The required target temperature e.g., `20.5` |
### Service `tado.set_climate_temperature_offset` ### Action `tado.set_climate_temperature_offset`
You can use the service `tado.set_climate_temperature_offset` to set the temperature offset for Tado climate devices. You can use the `tado.set_climate_temperature_offset` action to set the temperature offset for Tado climate devices.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------- |
| `entity_id` | yes | String, Name of entity e.g., `climate.heating` | | `entity_id` | yes | String, Name of entity e.g., `climate.heating` |
| `offset` | no | Float, Offset you would like to set | | `offset` | no | Float, Offset you would like to set |
@ -143,11 +143,11 @@ automation:
``` ```
{% endraw %} {% endraw %}
### Service `tado.add_meter_reading` ### Action `tado.add_meter_reading`
You can use the service `tado.add_meter_reading` to add your meter readings to Tado Energy IQ. With Energy IQ, you can track your energy consumption and take control of your heating expenses. You can use the `tado.add_meter_reading` action to add your meter readings to Tado Energy IQ. With Energy IQ, you can track your energy consumption and take control of your heating expenses.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------- |
| `config_entry` | no | String, Config entry to add meter readings to. | | `config_entry` | no | String, Config entry to add meter readings to. |
| `reading` | no | Integer, Reading in m³ or kWh without decimals. | | `reading` | no | Integer, Reading in m³ or kWh without decimals. |

8
source/_integrations/telegram.markdown
View File

@ -58,8 +58,8 @@ To create your first [Telegram bot](https://core.telegram.org/bots#how-do-i-crea
5. From the conversation with BotFather, select the link to open a chat with your new bot. 5. From the conversation with BotFather, select the link to open a chat with your new bot.
6. In the chat with the new bot, enter `/start`. 6. In the chat with the new bot, enter `/start`.
7. Test the service: 7. Test the action:
- Go to [**Developer tools** > **Services** > **YAML mode**](https://my.home-assistant.io/redirect/developer_call_service/?service=homeassistant.turn_on). - Go to [**Developer tools** > **Actions** > **YAML mode**](https://my.home-assistant.io/redirect/developer_call_service/?service=homeassistant.turn_on).
- Paste this into the YAML file: - Paste this into the YAML file:
- Replace the `service` and the `message` with your data. - Replace the `service` and the `message` with your data.
@ -68,7 +68,7 @@ To create your first [Telegram bot](https://core.telegram.org/bots#how-do-i-crea
data: data:
message: "Yay! A message from Home Assistant." message: "Yay! A message from Home Assistant."
``` ```
- Select **Call service**. You should now get a message. - Select **Perform action**. You should now get a message.
8. You can do more with this. Check out the configuration descriptions and examples below. 8. You can do more with this. Check out the configuration descriptions and examples below.
@ -160,7 +160,7 @@ Refer to the platforms mentioned in the
{% configuration %} {% configuration %}
name: 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 required: false
default: notify default: notify
type: string type: string

66
source/_integrations/telegram_bot.markdown
View File

@ -11,19 +11,19 @@ ha_integration_type: integration
Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant. Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant.
This integration creates notification services to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/integrations/telegram_polling) platform or with the [webhooks](/integrations/telegram_webhooks) one, and trigger events when receiving messages. This integration creates notification actions to send, or edit previously sent, messages from a [Telegram Bot account](https://core.telegram.org/bots) configured either with the [polling](/integrations/telegram_polling) platform or with the [webhooks](/integrations/telegram_webhooks) one, and trigger events when receiving messages.
If you don't need to receive messages, you can use the [broadcast](/integrations/telegram_broadcast) platform instead. If you don't need to receive messages, you can use the [broadcast](/integrations/telegram_broadcast) platform instead.
## Notification services ## Notification actions
Available services: `send_message`, `send_photo`, `send_video`, `send_animation`, `send_voice`, `send_sticker`, `send_document`, `send_location`, `edit_message`, `edit_caption`, `edit_replymarkup`, `answer_callback_query`, `delete_message` and `leave_chat`. Available actions: `send_message`, `send_photo`, `send_video`, `send_animation`, `send_voice`, `send_sticker`, `send_document`, `send_location`, `edit_message`, `edit_caption`, `edit_replymarkup`, `answer_callback_query`, `delete_message` and `leave_chat`.
### Service `telegram_bot.send_message` ### Action `telegram_bot.send_message`
Send a notification. Send a notification.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message` | no | Message body of the notification. | | `message` | no | Message body of the notification. |
| `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. | | `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. |
@ -39,11 +39,11 @@ Send a notification.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_photo` ### Action `telegram_bot.send_photo`
Send a photo. Send a photo.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | no | Remote path to an image. | | `url` | no | Remote path to an image. |
| `file` | no | Local path to an image. | | `file` | no | Local path to an image. |
@ -64,11 +64,11 @@ Send a photo.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_video` ### Action `telegram_bot.send_video`
Send a video. Send a video.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | no | Remote path to a video. | | `url` | no | Remote path to a video. |
| `file` | no | Local path to a video. | | `file` | no | Local path to a video. |
@ -88,11 +88,11 @@ Send a video.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_animation` ### Action `telegram_bot.send_animation`
Send an animation. Send an animation.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | no | Remote path to a GIF or H.264/MPEG-4 AVC video without sound. | | `url` | no | Remote path to a GIF or H.264/MPEG-4 AVC video without sound. |
| `file` | no | Local path to a GIF or H.264/MPEG-4 AVC video without sound. | | `file` | no | Local path to a GIF or H.264/MPEG-4 AVC video without sound. |
@ -113,11 +113,11 @@ Send an animation.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_voice` ### Action `telegram_bot.send_voice`
Send a voice message. Send a voice message.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | no | Remote path to a voice message. | | `url` | no | Remote path to a voice message. |
| `file` | no | Local path to a voice message. | | `file` | no | Local path to a voice message. |
@ -137,11 +137,11 @@ Send a voice message.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_sticker` ### Action `telegram_bot.send_sticker`
Send a sticker. Send a sticker.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | no | Remote path to a static .webp or animated .tgs sticker. | | `url` | no | Remote path to a static .webp or animated .tgs sticker. |
| `file` | no | Local path to a static .webp or animated .tgs sticker. | | `file` | no | Local path to a static .webp or animated .tgs sticker. |
@ -161,11 +161,11 @@ Send a sticker.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_document` ### Action `telegram_bot.send_document`
Send a document. Send a document.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | no | Remote path to a document. | | `url` | no | Remote path to a document. |
| `file` | no | Local path to a document. | | `file` | no | Local path to a document. |
@ -186,11 +186,11 @@ Send a document.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_location` ### Action `telegram_bot.send_location`
Send a location. Send a location.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `latitude` | no | The latitude to send. | | `latitude` | no | The latitude to send. |
| `longitude` | no | The longitude to send. | | `longitude` | no | The longitude to send. |
@ -204,11 +204,11 @@ Send a location.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.send_poll` ### Action `telegram_bot.send_poll`
Send a poll. Send a poll.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `question` | no | Poll question, 1-300 characters. | | `question` | no | Poll question, 1-300 characters. |
| `options` | no | List of answer options, 2-10 strings 1-100 characters each. | | `options` | no | List of answer options, 2-10 strings 1-100 characters each. |
@ -221,11 +221,11 @@ Send a poll.
| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | | `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} |
| `message_thread_id` | yes | Send the message to a specific topic or thread. | `message_thread_id` | yes | Send the message to a specific topic or thread.
### Service `telegram_bot.edit_message` ### Action `telegram_bot.edit_message`
Edit a previously sent message in a conversation. Edit a previously sent message in a conversation.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to edit the message. | | `chat_id` | no | The chat_id where to edit the message. |
@ -235,11 +235,11 @@ Edit a previously sent message in a conversation.
| `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. | | `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` |
### Service `telegram_bot.edit_caption` ### Action `telegram_bot.edit_caption`
Edit the caption of a previously sent message. Edit the caption of a previously sent message.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to edit the caption. | | `chat_id` | no | The chat_id where to edit the caption. |
@ -247,41 +247,41 @@ Edit the caption of a previously sent message.
| `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. | | `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` |
### Service `telegram_bot.edit_replymarkup` ### Action `telegram_bot.edit_replymarkup`
Edit the inline keyboard of a previously sent message. Edit the inline keyboard of a previously sent message.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to edit the reply_markup. | | `chat_id` | no | The chat_id where to edit the reply_markup. |
| `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. | | `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | | `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` |
### Service `telegram_bot.answer_callback_query` ### Action `telegram_bot.answer_callback_query`
Respond to a callback query originated by clicking on an online keyboard button. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. Respond to a callback query originated by clicking on an online keyboard button. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `message` | no | Unformatted text message body of the notification. | | `message` | no | Unformatted text message body of the notification. |
| `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: {% raw %}`{{ trigger.event.data.id }}`{% endraw %} | | `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: {% raw %}`{{ trigger.event.data.id }}`{% endraw %} |
| `show_alert` | yes | True/false for show a permanent notification. Defaults to False. | | `show_alert` | yes | True/false for show a permanent notification. Defaults to False. |
### Service `telegram_bot.delete_message` ### Action `telegram_bot.delete_message`
Delete a previously sent message in a conversation. Delete a previously sent message in a conversation.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | | `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to delete the message. | | `chat_id` | no | The chat_id where to delete the message. |
### Service `telegram_bot.leave_chat` ### Action `telegram_bot.leave_chat`
Remove the bot from the chat group where it was added. Remove the bot from the chat group where it was added.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------- | | ---------------------- | -------- | ----------------------------------------- |
| `chat_id` | no | The chat_id from where to remove the bot. | | `chat_id` | no | The chat_id from where to remove the bot. |

4
source/_integrations/telegram_broadcast.markdown
View File

@ -9,7 +9,7 @@ ha_domain: telegram_bot
Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the internet and there is no polling to receive messages or commands sent to the bot. Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the internet and there is no polling to receive messages or commands sent to the bot.
Information on how to send a message via the service `telegram_bot.send_message` can be found [here](/integrations/telegram_bot/#service-telegram_botsend_message). Information on how to send a message via the `telegram_bot.send_message` action can be found [here](/integrations/telegram_bot/#action-telegram_botsend_message).
## Configuration ## Configuration
@ -27,7 +27,7 @@ telegram_bot:
{% configuration %} {% configuration %}
allowed_chat_ids: allowed_chat_ids:
description: A list of ids representing the users and group chats to which messages can be send. Default the message will be send to the first alllowed chat_id. By using the `target` service data attribute the message can be send to other chat_ids from the list. description: A list of ids representing the users and group chats to which messages can be send. Default the message will be send to the first alllowed chat_id. By using the `target` action data attribute the message can be send to other chat_ids from the list.
required: true required: true
type: list type: list
api_key: api_key:

12
source/_integrations/template.markdown
View File

@ -60,7 +60,7 @@ _For old sensor/binary sensor configuration format, [see below](#legacy-binary-s
## UI configuration ## UI configuration
Sensor template, binary sensor template, button template, image template and select template can be configured using the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Select the **+ Add helper** button and then select the **{% my config_flow_start domain=page.ha_domain title=page.title %}** helper. Sensor template, binary sensor template, button template, image template and select template can be configured using the user interface at **{% my helpers title="Settings > Devices & services > Helpers" %}**. Select the **+ Add helper** button and then select the **{% my config_flow_start domain=page.ha_domain title=page.title %}** helper.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
@ -138,7 +138,7 @@ unique_id:
required: false required: false
type: string type: string
action: action:
description: Define actions to be executed when the trigger fires. Optional. Variables set by the action script are available when evaluating entity templates. This can be used to interact with anything via services, in particular services with [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data). [See action documentation](/docs/automation/action). description: Define actions to be executed when the trigger fires. Optional. Variables set by the action script are available when evaluating entity templates. This can be used to interact with anything using actions, in particular actions with [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data). [See action documentation](/docs/automation/action).
required: false required: false
type: list type: list
sensor: sensor:
@ -466,7 +466,7 @@ template:
{% endraw %} {% endraw %}
If the template accesses every state on the system, a rate limit of one update per minute is applied. If the template accesses all states under a specific domain, a rate limit of one update per second is applied. If the template only accesses specific states, receives update events for specifically referenced entities, or the `homeassistant.update_entity` service is used, no rate limit is applied. If the template accesses every state on the system, a rate limit of one update per minute is applied. If the template accesses all states under a specific domain, a rate limit of one update per second is applied. If the template only accesses specific states, receives update events for specifically referenced entities, or the `homeassistant.update_entity` action is used, no rate limit is applied.
### Considerations ### Considerations
@ -744,7 +744,7 @@ template:
### State based select - Control Day/Night mode of a camera ### State based select - Control Day/Night mode of a camera
This show how a state based template select can be used to call a service. This show how a state based template select can be used to perform an action.
{% raw %} {% raw %}
@ -784,9 +784,9 @@ template:
{% endraw %} {% endraw %}
### Trigger based handling of service response data ### Trigger based handling of action response data
This example demonstrates how to use an `action` to call a [service with response data](/docs/scripts/service-calls/#use-templates-to-handle-response-data) This example demonstrates how to use an `action` to call a [action with response data](/docs/scripts/service-calls/#use-templates-to-handle-response-data)
and use the response in a template. and use the response in a template.
{% raw %} {% raw %}

2
source/_integrations/tensorflow.markdown
View File

@ -194,7 +194,7 @@ image_processing:
## Optimizing resources ## Optimizing resources
[Image processing components](/integrations/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. [Image processing components](/integrations/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` action when you actually want to perform processing.
```yaml ```yaml
# Example advanced configuration.yaml entry # Example advanced configuration.yaml entry

6
source/_integrations/teslemetry.markdown
View File

@ -197,11 +197,11 @@ These are the entities available in the Teslemetry integration. Not all entities
## Vehicle sleep ## Vehicle sleep
Constant API polling will prevent most Model S and Model X vehicles manufactured before 2021 from sleeping, so the Teslemetry integration will stop polling these vehicles for 15 minutes, after 15 minutes of inactivity. You can call the `homeassistant.update_entity` service to force polling the API, which will reset the timer. Constant API polling will prevent most Model S and Model X vehicles manufactured before 2021 from sleeping, so the Teslemetry integration will stop polling these vehicles for 15 minutes, after 15 minutes of inactivity. You can call the `homeassistant.update_entity` action to force polling the API, which will reset the timer.
## Services ## Actions
Teslemetry provides various custom services to interact with the Tesla Fleet API directly. Teslemetry provides various custom actions to interact with the Tesla Fleet API directly.
### Navigate to coordinates ### Navigate to coordinates

10
source/_integrations/text.markdown
View File

@ -17,17 +17,17 @@ The Text integration is built for the controlling and monitoring of text values
If you are looking for a way to create a text entity, please take a look at the [Text helper](/integrations/input_text). If you are looking for a way to create a text entity, please take a look at the [Text helper](/integrations/input_text).
## Services ## Actions
### text services ### Text actions
Available services: `text.set_value` Available actions: `text.set_value`
### Service `text.set_value` ### Action `text.set_value`
Set the textual value of the text entity. Set the textual value of the text entity.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`'s of texts to control. | `entity_id` | no | String or list of strings that point at `entity_id`'s of texts to control.
| `value` | no | The new text value to set. | `value` | no | The new text value to set.

8
source/_integrations/thread.markdown
View File

@ -121,7 +121,7 @@ Follow these steps if you want to turn Home Assistant into a Thread border route
Find out if you already have Thread networks: Find out if you already have Thread networks:
- Go to {% my integrations title="**Settings** > **Devices & Services**" %}. - Go to {% my integrations title="**Settings** > **Devices & services**" %}.
- If you do not see a **Thread** integration, add it. - If you do not see a **Thread** integration, add it.
- Then, select **Configure** and check if you see any Thread networks on the overview page. - Then, select **Configure** and check if you see any Thread networks on the overview page.
- Case 1: If you do not have any Thread networks yet, follow [Case 1: Make Home Assistant your first Thread network](#case-1-making-home-assistant-your-first-thread-network) - Case 1: If you do not have any Thread networks yet, follow [Case 1: Make Home Assistant your first Thread network](#case-1-making-home-assistant-your-first-thread-network)
@ -145,7 +145,7 @@ Follow these steps if you want to turn Home Assistant into a Thread border route
2. Make sure the Home Assistant Thread network is defined as preferred network. 2. Make sure the Home Assistant Thread network is defined as preferred network.
- This should happen automatically, but check to be sure. - This should happen automatically, but check to be sure.
- Go to {% my integrations title="**Settings** > **Devices & Services**" %}, select the **Thread** integration. - Go to {% my integrations title="**Settings** > **Devices & services**" %}, select the **Thread** integration.
- Then, select **Configure**. - Then, select **Configure**.
- You should see the Home Assistant logo under **Preferred network**. - You should see the Home Assistant logo under **Preferred network**.
@ -157,7 +157,7 @@ Follow these steps if you want to turn Home Assistant into a Thread border route
- Follow the instructions on screen. - Follow the instructions on screen.
- **Result**: You will see a confirmation stating that Thread credentials from Home Assistant have been added to this device. - **Result**: You will see a confirmation stating that Thread credentials from Home Assistant have been added to this device.
- To share the credentials with your iPhone, open the Home Assistant Companion app. - To share the credentials with your iPhone, open the Home Assistant Companion app.
- Go to {% my integrations title="**Settings** > **Devices & Services**" %}, select the **Thread** integration. - Go to {% my integrations title="**Settings** > **Devices & services**" %}, select the **Thread** integration.
- At the bottom of the preferred network box, select **Send credentials to phone**. - At the bottom of the preferred network box, select **Send credentials to phone**.
4. To add Matter-based Thread devices, follow the steps on [Adding a matter device to Home Assistant](/integrations/matter/#adding-a-matter-device-to-home-assistant). 4. To add Matter-based Thread devices, follow the steps on [Adding a matter device to Home Assistant](/integrations/matter/#adding-a-matter-device-to-home-assistant).
@ -181,7 +181,7 @@ Note: the steps and images here show the process with a Google Thread network. B
1. Make sure you have an Android/iPhone phone and your phone is in the same Wi-Fi network as your Google border router. 1. Make sure you have an Android/iPhone phone and your phone is in the same Wi-Fi network as your Google border router.
2. First you need to import the Thread credentials of your Google thread network. 2. First you need to import the Thread credentials of your Google thread network.
- In the companion app, go to {% my integrations title="**Settings** > **Devices & Services**" %}, select the **Thread** integration. - In the companion app, go to {% my integrations title="**Settings** > **Devices & services**" %}, select the **Thread** integration.
- On Android, select **Configure** and **Import Credentials**. - On Android, select **Configure** and **Import Credentials**.
- **Result**: You should see a notification that the credentials are imported. - **Result**: You should see a notification that the credentials are imported.
- On iOS, select **Send credentials to Home Assistant**. - On iOS, select **Send credentials to Home Assistant**.

10
source/_integrations/tibber.markdown
View File

@ -35,7 +35,7 @@ Go to [developer.tibber.com/settings/accesstoken](https://developer.tibber.com/s
## Notifications ## Notifications
Tibber can send a notification by calling the [`notify.send_message` service](/integrations/notify/). It will send a notification to all devices registered in the Tibber account. Tibber can send a notification by calling the [`notify.send_message` action](/integrations/notify/). It will send a notification to all devices registered in the Tibber account.
To use notifications, please see the [getting started with automation page](/getting-started/automation/). To use notifications, please see the [getting started with automation page](/getting-started/automation/).
@ -83,15 +83,15 @@ If you have a Tibber Pulse it will also show the electricity consumption in real
</div> </div>
## Services ## Actions
The hourly prices are exposed using [service calls](/docs/scripts/service-calls/). The services populate [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with price data. The hourly prices are exposed using [actions](/docs/scripts/service-calls/). The actions populate [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with price data.
### Service `tibber.get_prices` ### Action `tibber.get_prices`
Fetches hourly energy prices including price level. Fetches hourly energy prices including price level.
| Service data attribute | Optional | Description | Example | | Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------| | ---------------------- | -------- | ----------- | --------|
| `start` | yes | Start time to get prices. Defaults to today 00:00:00 | 2024-01-01 00:00:00 | | `start` | yes | Start time to get prices. Defaults to today 00:00:00 | 2024-01-01 00:00:00 |
| `end` | yes | End time to get prices. Defaults to tomorrow 00:00:00 | 2024-01-01 00:00:00 | | `end` | yes | End time to get prices. Defaults to tomorrow 00:00:00 | 2024-01-01 00:00:00 |

10
source/_integrations/time.markdown
View File

@ -17,17 +17,17 @@ The Time integration is built for the controlling and monitoring of times on dev
If you are looking for a way to create a similar entity, please take a look at the [Date/Time helper](/integrations/input_datetime). If you are looking for a way to create a similar entity, please take a look at the [Date/Time helper](/integrations/input_datetime).
## Services ## Actions
### time services ### Time actions
Available services: `time.set_value` Available actions: `time.set_value`
### Service `time.set_value` ### Action `time.set_value`
Set a new value for the time entity. Set a new value for the time entity.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings that point at `entity_id`'s of times to control. | `entity_id` | no | String or list of strings that point at `entity_id`'s of times to control.
| `time` | no | New time value to set. | `time` | no | New time value to set.

36
source/_integrations/timer.markdown
View File

@ -12,7 +12,7 @@ ha_integration_type: helper
The `timer` integration aims to simplify automations based on (dynamic) durations. The `timer` integration aims to simplify automations based on (dynamic) durations.
When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restarts the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event. When a timer finishes or gets canceled the corresponding events are fired. This allows you to differentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been canceled. To control timers in your automations you can use the actions mentioned below. When calling the `start` action on a timer that is already running, it resets the duration it will need to finish and restarts the timer without triggering a canceled or finished event. This, for example, makes it easy to create timed lights that get triggered by motion. Starting a timer triggers a started event unless the timer is paused, in that case, it triggers a restarted event.
{% note %} {% note %}
Timers will be restored to their correct state and time on Home Assistant startup and restarts when configured with the `restore` option. Timers will be restored to their correct state and time on Home Assistant startup and restarts when configured with the `restore` option.
@ -22,7 +22,7 @@ However, automations using the `timer.finished` event **will not** trigger if th
## Configuration ## Configuration
The preferred way to configure timer helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button; next choose the {% my config_flow_start domain=page.ha_domain title=page.title %} option. The preferred way to configure timer helpers is via the user interface at **{% my helpers title="Settings > Devices & services > Helpers" %}** and click the add button; next choose the {% my config_flow_start domain=page.ha_domain title=page.title %} option.
To be able to add Helpers via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI. To be able to add Helpers via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI.
@ -82,58 +82,58 @@ Pick an icon from [Material Design Icons](https://pictogrammers.com/library/mdi/
| `timer.restarted` | Fired when a timer has been restarted | | `timer.restarted` | Fired when a timer has been restarted |
| `timer.paused` | Fired when a timer has been paused | | `timer.paused` | Fired when a timer has been paused |
## Services ## Actions
### Service `timer.start` ### Action `timer.start`
Starts or restarts a timer with the provided duration. If no duration is given, it will either restart with its initial value, or continue a paused timer with the remaining duration. If a new duration is provided, this will be the duration for the timer until it finishes or is canceled, which then will reset the duration back to the original configured value. The duration can be specified as a number of seconds or the easier to read `01:23:45` format. Starts or restarts a timer with the provided duration. If no duration is given, it will either restart with its initial value, or continue a paused timer with the remaining duration. If a new duration is provided, this will be the duration for the timer until it finishes or is canceled, which then will reset the duration back to the original configured value. The duration can be specified as a number of seconds or the easier to read `01:23:45` format.
You can also use `entity_id: all` and all active timers will be started. You can also use `entity_id: all` and all active timers will be started.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. | | `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. |
| `duration` | yes | Duration in seconds or `01:23:45` format until the timer finishes. | | `duration` | yes | Duration in seconds or `01:23:45` format until the timer finishes. |
### Service `timer.change` ### Action `timer.change`
Change an active timer. This changes the duration of the timer with the duration given. You can also use `entity_id: all` and all active timers will be changed. Change an active timer. This changes the duration of the timer with the duration given. You can also use `entity_id: all` and all active timers will be changed.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. | | `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. |
| `duration` | no | Duration in seconds or `00:00:00` to add or subtract from the running timer. | | `duration` | no | Duration in seconds or `00:00:00` to add or subtract from the running timer. |
### Service `timer.pause` ### Action `timer.pause`
Pause a running timer. This will retain the remaining duration for later continuation. To resume a timer use the `timer.start` service without passing a duration. You can also use `entity_id: all` and all active timers will be paused. Pause a running timer. This will retain the remaining duration for later continuation. To resume a timer use the `timer.start` action without passing a duration. You can also use `entity_id: all` and all active timers will be paused.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. | | `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. |
### Service `timer.cancel` ### Action `timer.cancel`
Cancel an active timer. This resets the duration to the last known initial value without firing the `timer.finished` event. You can also use `entity_id: all` and all active timers will be canceled. Cancel an active timer. This resets the duration to the last known initial value without firing the `timer.finished` event. You can also use `entity_id: all` and all active timers will be canceled.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. | | `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. |
### Service `timer.finish` ### Action `timer.finish`
Manually finish a running timer earlier than scheduled. You can also use `entity_id: all` and all active timers will be finished. Manually finish a running timer earlier than scheduled. You can also use `entity_id: all` and all active timers will be finished.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. | | `entity_id` | no | Name of the entity to take action, e.g., `timer.timer0`. |
### Service `timer.reload` ### Action `timer.reload`
Reload `timer`'s configuration without restarting Home Assistant itself. This service takes no service data attributes. Reload `timer`'s configuration without restarting Home Assistant itself. This action takes no data attributes.
### Use the service ### Using the action
Navigate to **Developer Tools** -> **Services** and select the `timer.start` service, then click the **Fill Example Data** button. Now change the `entity_id` and `duration` and click **Call Service** button. Navigate to **Developer Tools** > **Actions** and select the `timer.start` action, then click the **Fill Example Data** button. Now change the `entity_id` and `duration` and select **Perform action** button.
## Examples ## Examples

30
source/_integrations/todo.markdown
View File

@ -42,16 +42,16 @@ item to a pre-configured to-do list.
{% my blueprint_import badge blueprint_url="https://community.home-assistant.io/t/add-to-do-item/699193" %} {% my blueprint_import badge blueprint_url="https://community.home-assistant.io/t/add-to-do-item/699193" %}
## Services ## Actions
Some to-do list integrations allow Home Assistant to manage the to-do items in the list. The Some to-do list integrations allow Home Assistant to manage the to-do items in the list. The
services provided by some to-do list entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/). actions provided by some to-do list entities are described below or you can read more about [actions](/docs/scripts/service-calls/).
### Service `todo.get_items` ### Action `todo.get_items`
Get to-do items from a to-do list. A to-do list `target` is selected with a [target selector](/docs/blueprint/selectors/#target-selector). The `data` payload supports the following fields: Get to-do items from a to-do list. A to-do list `target` is selected with a [target selector](/docs/blueprint/selectors/#target-selector). The `data` payload supports the following fields:
| Service data attribute | Optional | Description | Example | | Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------------------------------------- | --------------------------- | | ---------------------- | -------- | ----------------------------------------- | --------------------------- |
| `status` | yes | Only return to-do items with this status. | `needs_action`, `completed` | | `status` | yes | Only return to-do items with this status. | `needs_action`, `completed` |
@ -66,11 +66,11 @@ data:
- needs_action - needs_action
``` ```
### Service `todo.add_item` ### Action `todo.add_item`
Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: Add a new to-do item. A to-do list `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 |
| ---------------------- | -------- | ---------------------------------------------------------------- | ------------------------------------------------------------ | | ---------------------- | -------- | ---------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | the name of the to-do Item. | Submit income tax return | | `item` | no | the name of the to-do Item. | Submit income tax return |
| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 | | `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
@ -79,7 +79,7 @@ Add a new to-do item. A to-do list `target` is selected with a [Target Selector]
Only one of `due_date` or `due_datetime` may be specified. Only one of `due_date` or `due_datetime` may be specified.
This is a full example of service call in YAML: This is a full example in YAML:
```yaml ```yaml
service: todo.add_item service: todo.add_item
@ -91,11 +91,11 @@ data:
description: "Collect all necessary documents and submit the final return." description: "Collect all necessary documents and submit the final return."
``` ```
### Service `todo.update_item` ### Action `todo.update_item`
Update a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: Update a to-do item. A to-do list `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 |
| ---------------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ | | ---------------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | The name of the to-do Item to update. | Submit income tax return | | `item` | no | The name of the to-do Item to update. | Submit income tax return |
| `rename` | yes | The new name of the to-do Item. | Something else | | `rename` | yes | The new name of the to-do Item. | Something else |
@ -104,7 +104,7 @@ Update a to-do item. A to-do list `target` is selected with a [Target Selector](
| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 | | `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. | | `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |
At least one of `rename` or `status` is required. Only one of `due_date` or `due_datetime` may be specified. This is a full example of a service call that updates the status and the name of a to-do item. At least one of `rename` or `status` is required. Only one of `due_date` or `due_datetime` may be specified. This is a full example that updates the status and the name of a to-do item.
```yaml ```yaml
service: todo.update_item service: todo.update_item
@ -116,15 +116,15 @@ data:
status: "completed" status: "completed"
``` ```
### Service `todo.remove_item` ### Action `todo.remove_item`
Removing a to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector), and the `data` payload supports the following fields: Removing a to-do item. A to-do list `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 |
| ---------------------- | -------- | --------------------------- | ------------------------ | | ---------------------- | -------- | --------------------------- | ------------------------ |
| `item` | no | The name of the to-do item. | Submit income tax return | | `item` | no | The name of the to-do item. | Submit income tax return |
This is a full example of a service call that deletes a to-do Item with the specified name. This is a full example that deletes a to-do Item with the specified name.
```yaml ```yaml
service: todo.remove_item service: todo.remove_item
@ -134,11 +134,11 @@ data:
item: "Submit income tax return" item: "Submit income tax return"
``` ```
### Service `todo.remove_completed_items` ### Action `todo.remove_completed_items`
Removes all completed to-do items. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector). Removes all completed to-do items. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector).
This is a full example of a service call that deletes all completed to-do items. This is a full example that deletes all completed to-do items.
```yaml ```yaml
service: todo.remove_completed_items service: todo.remove_completed_items

8
source/_integrations/todoist.markdown
View File

@ -115,7 +115,7 @@ Home Assistant does its best to [determine what task in each project is "most" i
## To-do list entity ## To-do list entity
See the [todo](/integrations/todo/) integration for details on how to manage See the [todo](/integrations/todo/) integration for details on how to manage
items on the Todoist to-do list, including services for creating and items on the Todoist to-do list, including actions for creating and
deleting to-do items. deleting to-do items.
Todoist completed to-do items are not visible in Home Assistant because they Todoist completed to-do items are not visible in Home Assistant because they
@ -151,12 +151,12 @@ the Todoist UI.
- **due_today**: Whether the reported task is due today. - **due_today**: Whether the reported task is due today.
## Services ## Actions
You may use the services from the [todo](/integrations/todo/) integration for You may use the actions from the [todo](/integrations/todo/) integration for
creating, updating, or deleting to-do items on the to-do list. creating, updating, or deleting to-do items on the to-do list.
Todoist also comes with an additional service, `todoist.new_task` that offers Todoist also comes with an additional action, `todoist.new_task` that offers
more advanced attributes when creating a Todoist task. You can specify labels more advanced attributes when creating a Todoist task. You can specify labels
and a project, or you can leave them blank, and the task will go to your and a project, or you can leave them blank, and the task will go to your
**Inbox** project. **Inbox** project.

2
source/_integrations/totalconnect.markdown
View File

@ -82,7 +82,7 @@ sudo apt install libxml2-dev libxmlsec1-dev
The integration provides an alarm control panel for each Total Connect location. It uses the name of your location from Total Connect. For example, if your location name in Total Connect is "Home", Home Assistant will use `alarm_control_panel.home`. The integration provides an alarm control panel for each Total Connect location. It uses the name of your location from Total Connect. For example, if your location name in Total Connect is "Home", Home Assistant will use `alarm_control_panel.home`.
The alarm control panel supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night`, and `alarm_disarm`. The integration also provides unique services for `totalconnect.arm_home_instant` and `totalconnect.arm_away_instant` which arms the system with zero entry delay, triggering the alarm instantly if an entry/exit zone is faulted. The alarm control panel supports the following actions: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night`, and `alarm_disarm`. The integration also provides unique actions for `totalconnect.arm_home_instant` and `totalconnect.arm_away_instant` which arms the system with zero entry delay, triggering the alarm instantly if an entry/exit zone is faulted.
The `triggered` state also provides a state attribute called `triggered_source` giving more detail on what triggered the alarm: The `triggered` state also provides a state attribute called `triggered_source` giving more detail on what triggered the alarm:

12
source/_integrations/tplink.markdown
View File

@ -80,11 +80,11 @@ Devices not listed below may work but if you encounter issues submit a bug repor
If light effects are supported by a device they can be selected from the bottom of the light card. If light effects are supported by a device they can be selected from the bottom of the light card.
They are currently not supported on Kasa bulbs. They are currently not supported on Kasa bulbs.
### Random Effect - Service `tplink.random_effect` ### Random Effect - Action `tplink.random_effect`
Light strips allow setting a random effect. Light strips allow setting a random effect.
| Service data attribute | Description | | Data attribute | Description |
| ---------------------- | ----------- | | ---------------------- | ----------- |
| `entity_id` | The entity_id of the light strip to set the effect on | | `entity_id` | The entity_id of the light strip to set the effect on |
| `init_states` | Initial HSV sequence | | `init_states` | Initial HSV sequence |
@ -101,7 +101,7 @@ Light strips allow setting a random effect.
| `random_seed` | Random seed | | `random_seed` | Random seed |
```yaml ```yaml
#Example Service Call #Example action
service: tplink.random_effect service: tplink.random_effect
target: target:
entity_id: entity_id:
@ -129,11 +129,11 @@ data:
random_seed: 80 random_seed: 80
``` ```
### Sequence Effect - Service `tplink.sequence_effect` ### Sequence Effect - Action `tplink.sequence_effect`
Light strips allow setting a sequence effect. Light strips allow setting a sequence effect.
| Service data attribute | Description | | Data attribute | Description |
| ---------------------- | ----------- | | ---------------------- | ----------- |
| `entity_id` | The entity_id of the light strip to set the effect on | | `entity_id` | The entity_id of the light strip to set the effect on |
| `sequence` | List of HSV sequences (Max 16) | | `sequence` | List of HSV sequences (Max 16) |
@ -146,7 +146,7 @@ Light strips allow setting a sequence effect.
| `direction` | Direction | | `direction` | Direction |
```yaml ```yaml
#Example Service Call #Example action
service: tplink.sequence_effect service: tplink.sequence_effect
target: target:
entity_id: entity_id:

8
source/_integrations/tplink_lte.markdown
View File

@ -12,9 +12,9 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The TP-Link LTE integration for Home Assistant makes it possible to send SMS's from the TP-Link LTE router. Phone numbers have to be pre-defined as part of the YAML configuration, and each phone number will turn up as additional notify service in Home Assistant. The integration adds a new notify service for each adds a notification service to Home Assistant that can be used to send SMSs provides a notification service that will send an SMS. Tested only with TL-MR6400 v4. The TP-Link LTE integration for Home Assistant makes it possible to send SMS's from the TP-Link LTE router. Phone numbers have to be pre-defined as part of the YAML configuration, and each phone number will turn up as additional notify action in Home Assistant. The integration adds a new notify action for each adds a notification action to Home Assistant that can be used to send SMSs provides a notification action that will send an SMS. Tested only with TL-MR6400 v4.
The integration provides a notification service that will send an SMS. The integration provides a notification action that will send an SMS.
## Configuration ## Configuration
@ -42,7 +42,7 @@ password:
required: true required: true
type: string type: string
notify: notify:
description: A list of notification services connected to this specific host. description: A list of notification targets connected to this specific host.
required: false required: false
type: list type: list
keys: keys:
@ -51,7 +51,7 @@ notify:
required: true required: true
type: [string, list] type: [string, list]
name: name:
description: The name of the notification service. description: The name of the notification action.
required: false required: false
default: notify default: notify
type: string type: string

20
source/_integrations/transmission.markdown
View File

@ -78,43 +78,43 @@ Example of an automation that notifies on successful download and removes the to
{% endraw %} {% endraw %}
## Services ## Actions
All Transmission services require integration `entry_id`. To find it, go to Developer Tools -> Services. Choose the desired service and select your integration from dropdown. Then switch to YAML mode to see `entry_id`. All Transmission actions require integration `entry_id`. To find it, go to **Developer tools** > **Actions**. Choose the desired action and select your integration from dropdown. Then switch to YAML mode to see `entry_id`.
### Service `add_torrent` ### Action `add_torrent`
Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/integrations/homeassistant/#allowlist_external_dirs)). Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/integrations/homeassistant/#allowlist_external_dirs)).
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------ | | ---------------------- | -------- | ------------------------ |
| `entry_id` | no | The integration entry_id | | `entry_id` | no | The integration entry_id |
| `torrent` | no | Torrent to download | | `torrent` | no | Torrent to download |
### Service `remove_torrent` ### Action `remove_torrent`
Removes a torrent from the client. Removes a torrent from the client.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- | | ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
| `entry_id` | no | The integration entry_id | | `entry_id` | no | The integration entry_id |
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors | | `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
| `delete_data` | yes | Delete torrent data (Default: false) | | `delete_data` | yes | Delete torrent data (Default: false) |
### Service `start_torrent` ### Action `start_torrent`
Starts a torrent. Starts a torrent.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- | | ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
| `entry_id` | no | The integration entry_id | | `entry_id` | no | The integration entry_id |
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors | | `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
### Service `stop_torrent` ### Action `stop_torrent`
Stops a torrent. Stops a torrent.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- | | ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
| `entry_id` | no | The integration entry_id | | `entry_id` | no | The integration entry_id |
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors | | `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |

18
source/_integrations/tts.markdown
View File

@ -31,13 +31,13 @@ Text-to-speech (TTS) enables Home Assistant to speak to you.
See all [TTS integrations](https://www.home-assistant.io/integrations/#text-to-speech) using this building block for ways to use it in your automations. If you are using the Home Assistant voice assistant, [Assist](https://www.home-assistant.io/voice_control/), Assist is using TTS when replying to you. Another way to use TTS is by using [TTS with Home Assistant Cloud](https://www.nabucasa.com/config/tts/). See all [TTS integrations](https://www.home-assistant.io/integrations/#text-to-speech) using this building block for ways to use it in your automations. If you are using the Home Assistant voice assistant, [Assist](https://www.home-assistant.io/voice_control/), Assist is using TTS when replying to you. Another way to use TTS is by using [TTS with Home Assistant Cloud](https://www.nabucasa.com/config/tts/).
## Services ## Actions
### Service speak ### Action speak
Modern platforms will create entities under the `tts` domain, where each entity represents one text-to-speech service provider. These entities may be used as targets for the `tts.speak` service. Modern platforms will create entities under the `tts` domain, where each entity represents one text-to-speech service provider. These entities may be used as targets for the `tts.speak` action.
The `tts.speak` service supports `language` and on some platforms also `options` for settings, e.g., _voice, motion, speed, etc_. The text that should be spoken is set with `message`, and the media player that should output the sound is selected with `media_player_entity_id`. the `tts.speak` action supports `language` and on some platforms also `options` for settings, e.g., _voice, motion, speed, etc_. The text that should be spoken is set with `message`, and the media player that should output the sound is selected with `media_player_entity_id`.
```yaml ```yaml
service: tts.speak service: tts.speak
@ -48,9 +48,9 @@ data:
message: "May the force be with you." message: "May the force be with you."
``` ```
### Service say (legacy) ### Action say (legacy)
The `say` service supports `language` and on some platforms also `options` for settings, e.g., _voice, motion, speed, etc_. The text that should be spoken is set with `message`. Since release 0.92, service name can be defined in configuration `service_name` option. The `say` action supports `language` and on some platforms also `options` for settings, e.g., _voice, motion, speed, etc_. The text that should be spoken is set with `message`. Since release 0.92, action name can be defined in configuration `service_name` option.
Say to all `media_player` entities: Say to all `media_player` entities:
@ -96,7 +96,7 @@ data:
## Cache ## Cache
The integration cache can be controlled with the `cache` option in the service call to `speak` or `say`. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period. The integration cache can be controlled with the `cache` option in the action to `speak` or `say`. A long time cache will be located on the file system. The in-memory cache for fast responses to media players will be auto-cleaned after a short period.
## REST API ## REST API
@ -141,7 +141,7 @@ The following sections describe some of the problems encountered with media devi
This problem occurs when your Home Assistant instance is configured to be accessed through SSL, and you are using a self-signed certificate on your internal URL. This problem occurs when your Home Assistant instance is configured to be accessed through SSL, and you are using a self-signed certificate on your internal URL.
The `tts` service will send an `https://` URL to the media device, which will check the certificate, and reject it. So it won't play your file. If you could make the device accept your certificate, it would play the file. However, many media devices do not allow changing settings to accept self-signed certificates. Ultimately, your option may be to serve files to local devices as `http://` rather than `https://`. The `tts` action will send an `https://` URL to the media device, which will check the certificate, and reject it. So it won't play your file. If you could make the device accept your certificate, it would play the file. However, many media devices do not allow changing settings to accept self-signed certificates. Ultimately, your option may be to serve files to local devices as `http://` rather than `https://`.
### Google cast devices ### Google cast devices
@ -149,6 +149,6 @@ The Google cast devices (Google Home, Chromecast, etc.) present the following pr
- They [reject self-signed certificates](#self-signed-certificates). - They [reject self-signed certificates](#self-signed-certificates).
- They do not work with URLs that contain hostnames established by local naming means. Let's say your Home Assistant instance is running on a machine made known locally as `ha`. All your machines on your local network are able to access it as `ha`. However, try as you may, your cast device won't download the media files from your `ha` machine. That's because your cast device ignores your local naming setup. In this example, the `say` service creates a URL like `http://ha/path/to/media.mp3` (or `https://...` if you are using SSL). If you are _not_ using SSL then setting an internal URL that contains the IP address of your server works around this issue. By using an IP address, the cast device does not have to resolve the hostname. - They do not work with URLs that contain hostnames established by local naming means. Let's say your Home Assistant instance is running on a machine made known locally as `ha`. All your machines on your local network are able to access it as `ha`. However, try as you may, your cast device won't download the media files from your `ha` machine. That's because your cast device ignores your local naming setup. In this example, the `say` action creates a URL like `http://ha/path/to/media.mp3` (or `https://...` if you are using SSL). If you are _not_ using SSL then setting an internal URL that contains the IP address of your server works around this issue. By using an IP address, the cast device does not have to resolve the hostname.
- If you are using SSL (e.g., `https://yourhost.example.org/...`) then you _must_ use the hostname in the certificate (e.g., `external_url: https://yourhost.example.org`). You cannot use an IP address since the certificate won't be valid for the IP address, and the cast device will refuse the connection. - If you are using SSL (e.g., `https://yourhost.example.org/...`) then you _must_ use the hostname in the certificate (e.g., `external_url: https://yourhost.example.org`). You cannot use an IP address since the certificate won't be valid for the IP address, and the cast device will refuse the connection.

4
source/_integrations/twilio_call.markdown
View File

@ -34,7 +34,7 @@ from_number:
required: true required: true
type: string type: string
name: 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 required: false
default: "`notify`" default: "`notify`"
type: string type: string
@ -42,7 +42,7 @@ name:
### Usage ### Usage
Twilio is a notification platform and thus can be controlled by calling the notify service [as described here](/integrations/notify/). It will send a notification to all E.164 phone numbers in the notification **target**. See the notes above regarding the `from_number` configuration variable for information about formatting phone numbers. Twilio is a notification platform and thus can be controlled by calling the notify action [as described here](/integrations/notify/). It will send a notification to all E.164 phone numbers in the notification **target**. See the notes above regarding the `from_number` configuration variable for information about formatting phone numbers.
```yaml ```yaml
# Example automation notification entry # Example automation notification entry

4
source/_integrations/twilio_sms.markdown
View File

@ -33,7 +33,7 @@ from_number:
required: true required: true
type: string type: string
name: 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 required: false
default: "`notify`" default: "`notify`"
type: string type: string
@ -41,7 +41,7 @@ name:
### Usage ### Usage
Twilio is a notification platform and thus can be controlled by calling the notify service [as described here](/integrations/notify/). It will send a notification to all E.164 phone numbers in the notification **target**. See the notes above regarding the `from_number` configuration variable for information about formatting phone numbers. It's also possible to use `whatsapp:+123456789` for sending notifications to a Whatsapp user. Twilio is a notification platform and thus can be controlled by calling the notify action [as described here](/integrations/notify/). It will send a notification to all E.164 phone numbers in the notification **target**. See the notes above regarding the `from_number` configuration variable for information about formatting phone numbers. It's also possible to use `whatsapp:+123456789` for sending notifications to a Whatsapp user.
Media can be included with messages by setting the optional `media_url` variable. Only `.gif`, `.png`, or `.jpeg` content are supported, according to the Twilio documentation and this feature is [only supported in the US and Canada.][mms] Media can be included with messages by setting the optional `media_url` variable. Only `.gif`, `.png`, or `.jpeg` content are supported, according to the Twilio documentation and this feature is [only supported in the US and Canada.][mms]

2
source/_integrations/twitter.markdown
View File

@ -52,7 +52,7 @@ notify:
{% configuration %} {% configuration %}
name: 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 required: false
default: "`notify`" default: "`notify`"
type: string type: string