KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #desktop-app #typescript #rust #ai-agent #cli

hacs-anylist

★ 38 Open GitHub ↗

Home Assistant integration for Anylist

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Home Assistant Integration For Anylist

## Prerequisites
This integration requires [Home Assistant Addon For Anylist](https://github.com/kevdliu/hassio-addon-anylist). Please install and configure the addon first before setting up this integration.

## Installation
You can install this custom integration using [HACS](https://hacs.xyz/). It is not a part of the official list of repositories but you can add it as a [custom repository](https://hacs.xyz/docs/faq/custom_repositories/).

If you already have HACS installed, you can simply click this button:

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=kevdliu&repository=hacs-anylist&category=integration)

## Add Integration
After installing the custom integration, you have to add the integration to Home Assistant. You may do so manually by going to the Settings -> Devices & Services -> Integrations page in Home Assistant, or by clicking the button:

[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=anylist)

## Configuration
The integration will prompt for the address of the [Anylist Home Assistant addon](https://github.com/kevdliu/hassio-addon-anylist) server during setup. The address includes the scheme (currently only plain-text http is supported), hostname or IP, and port of the server. For example, if you're running the addon locally and have it configured to listen on port 1234, the server address would be `http://127.0.0.1:1234`. Please do not include a trailing slash at the end of the address.

## Usage
There are three ways to use this integration: service calls, [Home Assistant To-do lists](https://www.home-assistant.io/integrations/todo/), and Home Assistant intents.

### Service Calls
The integration has six services: `anylist.add_item`, `anylist.remove_item`, `anylist.check_item`, `anylist.uncheck_item`, `anylist.get_items`, and `anylist.get_all_items`.

#### anylist.add_item
Parameters:
| Parameter | Required | Description          |
| --------- | -------- | -------------------- |
| name      | Yes      | The name of the item |
| notes     | No       | Notes for the item   |
| list      | No       | The name of the list |

Example service call:
```
service: anylist.add_item
data:
  name: milk
  notes: Skim milk
  list: Shopping
```

#### anylist.remove_item
Parameters:
| Parameter   | Required | Description                                     |
| ----------- | -------- | ----------------------------------------------- |
| name        | Yes      | The name of the item                            |
| ignore_case | No       | Ignore the case of the item name when searching |
| list        | No       | The name of the list                            |

Example service call:
```
service: anylist.remove_item
data:
  name: milk
  ignore_case: True
  list: Shopping
```

#### anylist.check_item
Parameters:
| Parameter | Required | Description          |
| --------- | -------- | -------------------- |
| name      | Yes      | The name of the item |
| list      | No       | The name of the list |

Example service call:
```
service: anylist.check_item
data:
  name: milk
  list: Shopping
```

#### anylist.uncheck_item
Parameters:
| Parameter | Required | Description          |
| --------- | -------- | -------------------- |
| name      | Yes      | The name of the item |
| list      | No       | The name of the list |

Example service call:
```
service: anylist.uncheck_item
data:
  name: milk
  list: Shopping
```

#### anylist.get_items
Parameters:
| Parameter | Required | Description          |
| --------- | -------- | -------------------- |
| list      | No       | The name of the list |

Response: A dictionary containing the field `items` which contains an array of unchecked items on the list.

Example service call:
```
service: anylist.get_items
data:
  list: Shopping
```

Example response:

items:
  - Milk
  - Flour
  - [Your kiss](https://www.youtube.com/watch?v=lsHld-iArOc)
  - Eggs

#### anylist.get_all_items
Parameters:
| Parameter | Required | Description          |
| --------- | -------- | -------------------- |
| list      | No       | The name of the list |

Response: A dictionary containing the field `uncheckedItems` which contains an array of unchecked items on the list and an additional field `checkedItems` which contains an array of checked / completed items on the list.

Example service call:
```
service: anylist.get_all_items
data:
  list: Shopping
```

Example response:

uncheckedItems:
  - Milk
  - Flour
  - [Your kiss](https://www.youtube.com/watch?v=lsHld-iArOc)
  - Eggs

checkedItems:
  - Yogurt
  - Bread

### Home Assistant To-do Lists
The integration supports the to-do lists feature introduced in [Home Assistant 2023.11.0](https://www.home-assistant.io/blog/2023/11/01/release-202311). The to-do list feature enables displaying and managing Anylist lists in the Home Assistant UI. See [the release notes](https://www.home-assistant.io/blog/2023/11/01/release-202311/#there-is-a-lot-to-do) for more details. A corresponding `todo` entity will be created by the integration for each available Anylist list.

### Home Assistant Intents

#### Assist
If you wish to use this integration with [Home Assistant Assist](https://www.home-assistant.io/voice_control/), Home Assistant 2023.12.0 added support for adding items to to-do lists using intents. For more details, see [built-in intents](https://developers.home-assistant.io/docs/intent_builtin/) and [the intents repository](https://github.com/home-assistant/intents). Please make sure to specify the default Anylist list in integration options. It is required in order to use intents.

However, the built-in intents are very limited in functionality. It currently only supports adding items to lists. For the ability to remove and query items, custom sentences need to be added. 
To add custom sentences, download and place the `custom_sentences` directory in this repository into the `config` directory of your Home Assistant installation. For more details, see [Adding support for custom sentences](https://www.home-assistant.io/integrations/conversation/#adding-custom-sentences).

The `custom_sentences` directory contains a few starter commands allowing you to modify and query your Anylist. For example:
- Adding an item: `Add {item} to my list`
- Removing an item: `Remove {item} from my list`
- Getting items: `What's on my list`

Slight sentence variations are supported in order to capture more commands. If you wish to customize the commands yourself, see [Template sentence syntax](https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/).

#### Automation
Home Assistant 2023.8.0 introduced support for [wildcards in sentence triggers](https://www.home-assistant.io/blog/2023/08/02/release-20238/#wildcard-support-for-sentence-triggers) for automations. As a result, you can build your own Anylist automation by combining [sentence triggers](https://www.home-assistant.io/docs/automation/trigger/#sentence-trigger) and the service calls provided by this integration to match your own needs.

If you wish, you can also import these pre-built blueprints into your Home Assistant to get started quickly. Please make sure to specify the default Anylist list in integration options. It is required in order to use the below blueprints.

Adding an item:

[![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgist.github.com%2Fkevdliu%2F0c37c29173de949c1c49953ad2cea2ac)

Removing an item:

Getting items:

## Category Matching
By default, the integration will apply the "Other" category to added items. However, it also attempts to automatically apply categories to your added items by looking up the categories of recently added items stored on your Anylist account. As such, if you fix the category of added items manually, the integration will "learn" over time and apply the correct categories in the future. I guess you can call this machine learning :laughing:

## Options
The integration allows you to specify the name of the default Anylist list to use if none are specified in the service call. The default list name is also used for Home Assistant intents and blueprint automations.

hacs-anylist

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README