Home Assistant v2023.12.0 will add ourgroceries integration so this repo is archived.

Home Assistant Our Groceries Sensor

Allows you to manage lists held on OurGroceries.com.

This component adds a sensor to Home Assistant which can be used in your own scripts to add/delete items.

You can also edit your lists in Home Assistant using out companion Our Groceries Card

Note that OurGroceries.com also have companion iOS and Android apps which can access the same lists, although these apps display adverts whereas the Our Groceries Card for Home Assistant does not.

---

Installation through HACS

Use HACS to install the Our Groceries integration.

Manual Installation

Use this route only if you do not want to use HACS and love the pain of manually installing regular updates.

• Add the ourgroceries folder in your custom_components folder

Usage

Before you can configure this sensor, you must sign up for an account at OurGroceries.com.

Options

Name	Type	Requirement	default Description
username	string	Required	your our groceries username
password	string	Required	your our groceries password

In your configuration.yaml file add:

ourgroceries:
  username: !secret our_groceries_username
  password: !secret our_groceries_password

Scriptable Services

Add to list

Adds one or more items to a list.

Name	Type	Requirement	default Description
list_id	string	Required	name or ID of the OurGroceries list
items	string OR string[]	Required	item(s) to be added to the list

service: ourgroceries.add_to_list
data:
  list_id: "My List"
  items:
    - "Milk"
    - "Eggs"

Remove from list

Removes one or more items from a list.

Name	Type	Requirement	default Description
list_id	string	Required	name or ID of the OurGroceries list
items	string OR string[]	Required	item(s) to be removed from the list

service: ourgroceries.remove_from_list
data:
  list_id: "My List"
  items:
    - "Milk"
    - "Eggs"

Copy to list

Copies all items from one list to another.

Name	Type	Requirement	default Description
list_id	string	Required	name or ID of the destination OurGroceries list
from_list_id	string	Required	name or ID of the source OurGroceries list
unique_only	boolean	Optional	false When true, only copies items that are not already on the destination list

service: ourgroceries.copy_to_list
data:
  list_id: "My List"
  from_list_id: "Source List"
  unique_only: true

---

Enjoy my card? Help me out for a couple of 🍻 or a ☕!