mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Integration names: apply sentence style capitalization (#32460)
This commit is contained in:
parent
aef281cf49
commit
25a317bb90
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Air Quality
|
||||
title: Air quality
|
||||
description: Instructions on how to add air quality sensors with Home Assistant
|
||||
ha_release: 0.85
|
||||
ha_domain: air_quality
|
||||
@ -10,7 +10,7 @@ ha_codeowners:
|
||||
ha_integration_type: entity
|
||||
---
|
||||
|
||||
The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
|
||||
The **Air quality** {% term integration %} allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
|
||||
|
||||
The platforms cover the following levels (if they are available):
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Application Credentials
|
||||
title: Application credentials
|
||||
description: Allows users to link accounts with integrations that support OAuth2
|
||||
ha_release: 2022.6
|
||||
ha_domain: application_credentials
|
||||
@ -10,7 +10,7 @@ ha_codeowners:
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The Application Credentials integration is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking.
|
||||
The **Application credentials** {% term integration %} is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking.
|
||||
|
||||
## Automatic setup
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Command Line
|
||||
description: Instructions on how to integrate the Command Line utility within Home Assistant.
|
||||
title: Command line
|
||||
description: Instructions on how to integrate the command line utility within Home Assistant.
|
||||
ha_category:
|
||||
- Binary sensor
|
||||
- Cover
|
||||
@ -21,7 +21,7 @@ ha_codeowners:
|
||||
- '@gjohansson-ST'
|
||||
---
|
||||
|
||||
The `command_line` offers functionality that issues specific commands to get data or to control a device.
|
||||
The **Command line** {% term integration %} offers functionality that issues specific commands to get data or to control a device.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Device Automation
|
||||
description: Information about the Device Automation plugin.
|
||||
title: Device automation
|
||||
description: Information about the device automation plugin.
|
||||
ha_category:
|
||||
- Automation
|
||||
ha_release: 0.7
|
||||
@ -11,7 +11,7 @@ ha_domain: device_automation
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
Device Automations is a plugin for the automation integration to allow other integrations to provide device specific triggers, conditions and actions.
|
||||
**Device automation** is a plugin for the automation integration to allow other integrations to provide device specific triggers, conditions and actions.
|
||||
|
||||
There is no device automation specific configuration. Instead, it is configured as part of the normal automations.
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: File Upload
|
||||
title: File upload
|
||||
description: File upload integration supports various frontend features within Home Assistant
|
||||
ha_release: 2022.9
|
||||
ha_quality_scale: internal
|
||||
@ -10,6 +10,6 @@ ha_codeowners:
|
||||
ha_category: []
|
||||
---
|
||||
|
||||
The file upload integration allows various features in the frontend to upload files.
|
||||
The **File upload** {% term integration %} allows various features in the frontend to upload files.
|
||||
|
||||
{% include integrations/building_block_integration.md %}
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: File Size
|
||||
title: File size
|
||||
description: Integration for monitoring the size of a file.
|
||||
ha_category:
|
||||
- Sensor
|
||||
@ -15,7 +15,7 @@ ha_config_flow: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `filesize` sensor is for displaying the size in MB of a file.
|
||||
The **File size** {% term integration %} is for displaying the size in MB of a file.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Folder Watcher
|
||||
title: Folder watcher
|
||||
description: Integration for monitoring changes within the filesystem.
|
||||
ha_category:
|
||||
- System monitor
|
||||
@ -10,7 +10,7 @@ ha_domain: folder_watcher
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are:
|
||||
The **Folder watcher** {% term integration %} adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are:
|
||||
|
||||
- `closed`
|
||||
- `created`
|
||||
@ -22,7 +22,7 @@ Configured folders must be added to [allowlist_external_dirs](/integrations/home
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable the Folder Watcher integration in your installation, add the following to your `configuration.yaml` file:
|
||||
To enable the **Folder watcher** {% term integration %} in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
folder_watcher:
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: History Stats
|
||||
title: History stats
|
||||
description: Instructions about how to integrate historical statistics into Home Assistant.
|
||||
ha_category:
|
||||
- Sensor
|
||||
@ -13,7 +13,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `history_stats` sensor platform provides quick statistics about another integration or platforms, using data from the [`history`](/integrations/history/) integration.
|
||||
The **History stats** {% term integration %} provides quick statistics about another integration or platforms, using data from the [`history`](/integrations/history/) integration.
|
||||
|
||||
It can track how long the integration has been in a specific state, in a custom time period.
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Image Upload
|
||||
title: Image upload
|
||||
description: The image upload integration handle image assets in Home Assistant.
|
||||
ha_category:
|
||||
- Other
|
||||
@ -11,7 +11,7 @@ ha_quality_scale: internal
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
The Image Upload integration allows Home Assistant to handle image assets in
|
||||
The **Image upload** {% term integration %} allows Home Assistant to handle image assets in
|
||||
Home Assistant, for example, the profile photos of your systems account.
|
||||
|
||||
## Configuration
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Input Boolean
|
||||
description: Instructions on how to use the Input Boolean helper with Home Assistant.
|
||||
title: Input boolean
|
||||
description: Instructions on how to use the input boolean helper with Home Assistant.
|
||||
ha_category:
|
||||
- Automation
|
||||
- Helper
|
||||
@ -12,7 +12,7 @@ ha_domain: input_boolean
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The Input Boolean helper integration allows you to define boolean values that
|
||||
The **Input boolean** helper integration allows you to define boolean values that
|
||||
can be controlled via the user interface and can be used within conditions of
|
||||
an {% term automation %}. This can for example be used to disable or enable certain
|
||||
automations by using them in their {% term conditions %}.
|
||||
@ -67,12 +67,12 @@ This integration provides the following {% term services %} to modify the state
|
||||
`input_boolean` and a service to reload the configuration without restarting
|
||||
Home Assistant itself.
|
||||
|
||||
| Service | Data | Description |
|
||||
| ------- | ---- | ----------- |
|
||||
| `turn_on` | `entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_boolean` entities to `on`
|
||||
| `turn_off` | `entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_boolean` entities to `off`
|
||||
| `toggle` | `entity_id(s)`<br>`area_id(s)` | Toggle the value of specific `input_boolean` entities
|
||||
| `reload` | | Reload `input_boolean` configuration |
|
||||
| Service | Data | Description |
|
||||
| ---------- | ------------------------------ | ----------------------------------------------------------- |
|
||||
| `turn_on` | `entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_boolean` entities to `on` |
|
||||
| `turn_off` | `entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_boolean` entities to `off` |
|
||||
| `toggle` | `entity_id(s)`<br>`area_id(s)` | Toggle the value of specific `input_boolean` entities |
|
||||
| `reload` | | Reload `input_boolean` configuration |
|
||||
|
||||
### Restore state
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Input Button
|
||||
description: Instructions on how to use the Input Button helper with Home Assistant.
|
||||
title: Input button
|
||||
description: Instructions on how to use the input button helper with Home Assistant.
|
||||
ha_category:
|
||||
- Automation
|
||||
- Helper
|
||||
@ -12,7 +12,7 @@ ha_domain: input_button
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The Input Button helper integration allows you to define buttons that
|
||||
The **Input button** helper integration allows you to define buttons that
|
||||
can be pressed via the user interface, and can be used to trigger things,
|
||||
like an automation.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Input Number
|
||||
description: Instructions on how to integrate the Input Number integration into Home Assistant.
|
||||
title: Input number
|
||||
description: Instructions on how to integrate the input number integration into Home Assistant.
|
||||
ha_category:
|
||||
- Automation
|
||||
- Helper
|
||||
@ -12,7 +12,7 @@ ha_domain: input_number
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well.
|
||||
The **Input number** {% term integration %} allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well.
|
||||
|
||||
The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_number" title="Number" %}** option.
|
||||
|
||||
@ -87,12 +87,12 @@ input_number:
|
||||
This integration provides the following services to modify the state of the `input_number` and a service to reload the
|
||||
configuration without restarting Home Assistant itself.
|
||||
|
||||
| Service | Data | Description |
|
||||
| ------- | ---- | ----------- |
|
||||
| `decrement` | `entity_id(s)`<br>`area_id(s)` | Decrement the value of specific `input_number` entities by `step`
|
||||
| `increment` | `entity_id(s)`<br>`area_id(s)` | Increment the value of specific `input_number` entities by `step`
|
||||
| `reload` | | Reload `input_number` configuration |
|
||||
| `set_value` | `value`<br>`entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_number` entities
|
||||
| Service | Data | Description |
|
||||
| ----------- | ----------------------------------------- | ----------------------------------------------------------------- |
|
||||
| `decrement` | `entity_id(s)`<br>`area_id(s)` | Decrement the value of specific `input_number` entities by `step` |
|
||||
| `increment` | `entity_id(s)`<br>`area_id(s)` | Increment the value of specific `input_number` entities by `step` |
|
||||
| `reload` | | Reload `input_number` configuration |
|
||||
| `set_value` | `value`<br>`entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_number` entities |
|
||||
|
||||
### Restore state
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Input Select
|
||||
description: Instructions on how to integrate the Input Select integration into Home Assistant.
|
||||
title: Input select
|
||||
description: Instructions on how to integrate the input select integration into Home Assistant.
|
||||
ha_category:
|
||||
- Automation
|
||||
- Helper
|
||||
@ -12,7 +12,7 @@ ha_domain: input_select
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The `input_select` integration allows the user to define a list of values that can be selected via the frontend and can be used within conditions of an automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger.
|
||||
The **Input select** {% term integration %} allows the user to define a list of values that can be selected via the frontend and can be used within conditions of an automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger.
|
||||
|
||||
The preferred way to configure an input select is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_select" title="Dropdown" %}** option.
|
||||
|
||||
@ -77,29 +77,29 @@ If you set a valid value for `initial` this integration will start with the stat
|
||||
|
||||
This integration provides three services to modify the state of the `input_select`.
|
||||
|
||||
| Service | Data | Description |
|
||||
| ------- | ---- | ----------- |
|
||||
| `select_option` | `option` | This can be used to select a specific option.
|
||||
| `set_options` | `options`<br>`entity_id(s)` | Set the options for specific `input_select` entities.
|
||||
| `select_first` | | Select the first option.
|
||||
| `select_last` | | Select the last option.
|
||||
| `reload` | | Reload `input_select` configuration |
|
||||
| Service | Data | Description |
|
||||
| --------------- | --------------------------- | ----------------------------------------------------- |
|
||||
| `select_option` | `option` | This can be used to select a specific option. |
|
||||
| `set_options` | `options`<br>`entity_id(s)` | Set the options for specific `input_select` entities. |
|
||||
| `select_first` | | Select the first option. |
|
||||
| `select_last` | | Select the last option. |
|
||||
| `reload` | | Reload `input_select` configuration |
|
||||
|
||||
#### Service `input_select.select_next`
|
||||
|
||||
Select the next option.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `cycle` | yes | Whether to cycle to the first value after the last. Default: `true`
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------- |
|
||||
| `cycle` | yes | Whether to cycle to the first value after the last. Default: `true` |
|
||||
|
||||
#### Service `input_select.select_previous`
|
||||
|
||||
Select the previous option.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `cycle` | yes | Whether to cycle to the last value before the first. Default: `true`
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | -------------------------------------------------------------------- |
|
||||
| `cycle` | yes | Whether to cycle to the last value before the first. Default: `true` |
|
||||
|
||||
### Scenes
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Input Text
|
||||
description: Instructions on how to integrate the Input Text integration into Home Assistant.
|
||||
title: Input text
|
||||
description: Instructions on how to integrate the Input text integration into Home Assistant.
|
||||
ha_category:
|
||||
- Automation
|
||||
- Helper
|
||||
@ -12,7 +12,7 @@ ha_domain: input_text
|
||||
ha_integration_type: helper
|
||||
---
|
||||
|
||||
The `input_text` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text).
|
||||
The **Input text** {% term integration %} allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text).
|
||||
|
||||
The preferred way to configure an input text is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_text" title="Text" %}** option.
|
||||
|
||||
@ -83,10 +83,10 @@ input_text:
|
||||
|
||||
This integration provides a service to modify the state of the `input_text` and a service to reload the `input_text` configuration without restarting Home Assistant itself.
|
||||
|
||||
| Service | Data | Description |
|
||||
| ------- | ---- | ----------- |
|
||||
| `set_value` | `value`<br>`entity_id(s)` | Set the value for specific `input_text` entities.
|
||||
| `reload` | | Reload `input_text` configuration |
|
||||
| Service | Data | Description |
|
||||
| ----------- | ------------------------- | ------------------------------------------------- |
|
||||
| `set_value` | `value`<br>`entity_id(s)` | Set the value for specific `input_text` entities. |
|
||||
| `reload` | | Reload `input_text` configuration |
|
||||
|
||||
### Restore state
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Local Calendar
|
||||
description: Instructions on how to use Local Calendars in Home Assistant.
|
||||
title: Local calendar
|
||||
description: Instructions on how to use local calendars in Home Assistant.
|
||||
ha_category:
|
||||
- Calendar
|
||||
ha_iot_class: Local Polling
|
||||
@ -15,7 +15,7 @@ ha_codeowners:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The local calendar integration allows you to create a calendar of events in Home Assistant for powering automations.
|
||||
The **Local calendar** {% term integration %} allows you to create a calendar of events in Home Assistant for powering automations.
|
||||
|
||||
A calendar entity has a state and attributes that represent the next upcoming event (only). A calendar trigger is a much more flexible way to power automations with fewer limitations than using the entity state.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Local File
|
||||
description: Instructions how to use Local File as a Camera within Home Assistant.
|
||||
title: Local file
|
||||
description: Instructions how to use local file as a camera within Home Assistant.
|
||||
ha_category:
|
||||
- Camera
|
||||
ha_iot_class: Local Polling
|
||||
@ -11,7 +11,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `local_file` camera platform allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation.
|
||||
The **Local file** camera {% term integration %} allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation.
|
||||
|
||||
The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
|
||||
|
||||
@ -41,7 +41,7 @@ name:
|
||||
|
||||
Use this service to change the file displayed by the camera.
|
||||
|
||||
| Service data attribute | Description |
|
||||
| -----------------------| ----------- |
|
||||
| `entity_id` | String of the `entity_id` of the camera to update. |
|
||||
| `file_path` | The full path to the new image file to be displayed. |
|
||||
| Service data attribute | Description |
|
||||
| ---------------------- | ---------------------------------------------------- |
|
||||
| `entity_id` | String of the `entity_id` of the camera to update. |
|
||||
| `file_path` | The full path to the new image file to be displayed. |
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Local To-do
|
||||
title: Local to-do
|
||||
description: Instructions on how to use local to-do lists in Home Assistant.
|
||||
ha_category:
|
||||
- To-do list
|
||||
@ -19,7 +19,7 @@ related:
|
||||
title: To-do list card
|
||||
---
|
||||
|
||||
The **Local to-do list** integration allows you to create to-do lists in Home Assistant.
|
||||
The **Local to-do list** {% term integration %} allows you to create to-do lists in Home Assistant.
|
||||
To-do lists are shown on the **To-do list** dashboard for tracking items and whether
|
||||
or not they have been completed.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Network Configuration
|
||||
description: Network Configuration for Home Assistant
|
||||
title: Network configuration
|
||||
description: Network configuration for Home Assistant
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 2021.6
|
||||
@ -12,7 +12,7 @@ ha_codeowners:
|
||||
ha_integration_type: system
|
||||
---
|
||||
|
||||
This integration provides network configuration for integrations such as [Zeroconf](/integrations/zeroconf/). It is managed by going to **{% my network title="Settings > System > Network" %}** and is only available to users that have "Advanced Mode" enabled on their {% my profile title="user profile" %}.
|
||||
The **Network configuration** {% term integration %} provides network configuration for integrations such as [Zeroconf](/integrations/zeroconf/). It is managed by going to **{% my network title="Settings > System > Network" %}** and is only available to users that have "Advanced Mode" enabled on their {% my profile title="user profile" %}.
|
||||
|
||||
**{% my general badge %}**
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Recovery Mode
|
||||
title: Recovery mode
|
||||
description: Allows Home Assistant to start up in recovery mode.
|
||||
ha_category: []
|
||||
ha_release: 0.105
|
||||
@ -13,7 +13,7 @@ related:
|
||||
title: General troubleshooting
|
||||
---
|
||||
|
||||
The **Recovery mode** integration is an internal integration used by the
|
||||
The **Recovery mode** {% term integration %} is an internal integration used by the
|
||||
Home Assistant Core.
|
||||
|
||||
You don't have to configure it since it is automatically always
|
||||
|
@ -14,9 +14,9 @@ ha_platforms:
|
||||
- todo
|
||||
---
|
||||
|
||||
The `shopping_list` integration allows you to keep track of shopping list items.
|
||||
The **Shopping list** {% term integration %} allows you to keep track of shopping list items.
|
||||
|
||||
Your shopping list will be accessible from the sidebar, and you can optionally add the [To-do list card](/dashboards/todo-list/) to your dashboard. With the [conversation integration](/integrations/conversation/), you can add items to your shopping list using voice commands like "Add eggs to my shopping list."
|
||||
Your shopping list will be accessible from the sidebar, and you can optionally add the [To-do list card](/dashboards/todo-list/) to your dashboard. With the [conversation integration](/integrations/conversation/), you can add items to your shopping list using voice commands like "Add eggs to my shopping list."
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -28,33 +28,33 @@ You can add or remove items from your shopping list by using the following servi
|
||||
|
||||
Add an item to the shopping list.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------|
|
||||
| `name` | no | Name of the item to add. Example: "Milk" |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------- |
|
||||
| `name` | no | Name of the item to add. Example: "Milk" |
|
||||
|
||||
### Service `shopping_list.remove_item`
|
||||
|
||||
Remove the first item with matching name from the shopping list.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------|
|
||||
| `name` | no | Name of the item to remove. Example: "Milk" |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------- |
|
||||
| `name` | no | Name of the item to remove. Example: "Milk" |
|
||||
|
||||
### Service `shopping_list.complete_item`
|
||||
|
||||
Mark the first item with matching name as completed in the shopping list. It does not remove the item.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------|
|
||||
| `name` | no | Name of the item to mark as completed. Example: "Milk" |
|
||||
| ---------------------- | -------- | ------------------------------------------------------ |
|
||||
| `name` | no | Name of the item to mark as completed. Example: "Milk" |
|
||||
|
||||
### Service `shopping_list.incomplete_item`
|
||||
|
||||
Mark the first item with matching name as incomplete in the shopping list.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------|
|
||||
| `name` | no | Name of the item to mark as incomplete. Example: "Milk" |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------- |
|
||||
| `name` | no | Name of the item to mark as incomplete. Example: "Milk" |
|
||||
|
||||
### Service `shopping_list.complete_all`
|
||||
|
||||
@ -73,15 +73,15 @@ Clear completed items from the shopping list.
|
||||
Sort all items by name in the shopping list.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|---------------------------------------------------------------------|
|
||||
| `reverse` | yes | Whether to sort in reverse (_descending_) order. (default: `False`) |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------- |
|
||||
| `reverse` | yes | Whether to sort in reverse (_descending_) order. (default: `False`) |
|
||||
|
||||
## Using in automations
|
||||
|
||||
A `shopping_list_updated` event is triggered when items in the list are modified, with the following data payload attached to it. This can be used to trigger automations such as sending a push notification when someone adds an item to the shopping list, which when clicked, will open the list.
|
||||
|
||||
| Data payload attribute | Description |
|
||||
|------------------------|--------------------------------------------------------------------------------------------------------------------|
|
||||
| ---------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `action` | What action was taken on the item. Either `add` for a new item being added, or `update` for an item being updated. |
|
||||
| `item` | A dictionary containing details of the item that was updated. |
|
||||
| `item.id` | A unique ID for this item |
|
||||
|
Loading…
x
Reference in New Issue
Block a user