How to replace Home Assistant’s default shopping list with Bring!

Disclosure: This post contains affiliate links. If you click through and make a purchase, I’ll earn a commission, at no additional cost to you. Read my full disclosure here.
Advertisement

I have never even given the default shopping list in Home Assistant a look-in. Why? Because I use Bring!, an Android, iOS, and web app, as my digital shopping list. Bring! allows me to easily share a shopping list with my partner and also supports numerous smartwatches (namely the Apple Watch and those running Wear OS) as well as the Google Assistant and Amazon Alexa. It also has the option to store loyalty cards, which makes my wallet a lot thinner.

Advertisement

What I never thought about was integrating Bring! with Home Assistant and whether it was even possible. By integrating the two services, I wouldn’t have to open a web app just to check if an item has already been added or not, and I could potentially have items added automatically or as part of a script.

Table of Contents

No API means no official Home Assistant integration with Bring!

As Bring! doesn’t offer an official and open API, there isn’t an official integration available. Workarounds, web scraping and reverse engineering are not allowed in those. Luckily though, the API Bring uses has been reverse engineered, allowing willing developers to use it for their applications. That is exactly what Vincent Le Bourlot on GitHub did and his creation is something many have been asking for: A custom component for integrating Bring! with Home Assistant.

Advertisement

Please keep in mind that by using an unofficial API, this custom component could break at any time. The developers behind the Bring! app have shown no interest in offering an official API and if they don’t change their minds on the matter, we will never see an official Home Assistant integration with Bring!.

How to install the Bring! custom compoment

As with just about every other custom component, the Bring! integration with Home Assistant can be installed using HACS (Home Assistant Community Store). Using HACS not only makes the installation easier, but it has the added benefit of notifying you whenever an update has been released.

Advertisement
The three-dot-menu in HACS
The Bring! custom component in Home Assistant

Once you have HACS up and running you can add the repository for the custom component by clicking on the three-dot-menu. From there, add the following repository and select the category ‘integration’. Once done, you should be able to install the ‘Shopping List’ custom component:

https://github.com/vlebourl/shopping_list

Setting up the Bring! integration

You will have to restart Home Assistant to finish off the setup of the Bring! custom component and once done, you should be able to add the ‘Shopping List’ integration from Home Assistant’s web dashboard. When selected you will be prompted to enter your Bring! username and password. After clicking the submit button you will be able to choose your desired list and the integration is complete.

Advertisement
The Bring! shopping list in the list of Home Assistant integrations
Setting up the username and password for Bring! in Home Assistant

Viewing Bring! in Home Assistant

You have two options to view Bring! inside of Home Assistant. As this custom comment replaces the default shopping, you can access it from the menu, or you can add a shopping list card to your Lovelace dashboard.

The items of a Bring! shopping list displayed in Home Assistant
My Bring! shopping list (in German)

Using the Bring! integration with Home Assistant

Home Assistant allows you to manipulate your shopping list in two ways: You can add and remove individual items. As a service, these functions can be used in any script or automation. You can also have a notification offering to show your Bring! shopping list as soon as you enter a certain zone.

Control your Windows PC with HASS Workstation Service

A Home Assistant card for 3D printers using OctoPrint

Advertisement
Liam Alexander Colman, the author and maintainer of Home Assistant Guides.

About Liam Alexander Colman

Liam Alexander Colman has been using Home Assistant for various projects for quite some time. What started of with a Raspberry Pi quickly became three Raspberry Pis and eventually a full-blown server. I now use Unraid as my operating system, and Home Assistant happily runs in a Docker container. My personal setup includes many Zigbee devices as well as integrations with existing products such as my Android TV box. Read on to find out more on how I got started with Home Assistant.

Leave a comment

Advertisement