WARNING

If you still use Grocy v 2.x the last release of this component you can use is v2.2.2. For the add-on Grocy 3 was introduced in add-on version 0.10.0.

INFO

You have to have the Grocy software already installed, this integration only communicates with an existing installation of Grocy.

The configuration is slightly different for those who use the official Grocy addon from the add-on store.

1. If you haven't already done so, install Grocy from the add-on store
2. In the 'Configuration' section of the add-on config, input 9192 in the host field - see screenshot. Save your changes and restart the add-on.
3. Install HACS
4. Go to Community > Store > Grocy
5. Install the Grocy integration
6. Restart Home Assistant
7. Go to Grocy > Wrench icon > Manage API keys > Add
8. Copy resulting API key
9. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Grocy"
10. You will now have a new integration for Grocy. Some or all of the entities might be disabled from the start.

1. Install HACS
2. Go to Community > Store > Grocy
3. Install the Grocy integration
4. Restart Home Assistant
5. Go to Grocy > Wrench icon > Manage API keys > Add
6. Copy resulting API key
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Grocy"
8. You will now have a new integration for Grocy. Some or all of the entities might be disabled from the start.

(This component will not currently work if you have an install where you don't use a port, due to this issue.)

Some or all of the entities might be disabled from the start. You get a sensor each for chores, meal plan, shopping list, stock and tasks. You get a binary sensor each for expired, expiring and missing products and overdue tasks and chores.

Translations are done via Lokalise. If you want to translate into your native language, please join the team.

If you have problems with the integration you can add debug prints to the log.

logger:
  default: info
  logs:
    pygrocy: debug
    custom_components.grocy: debug

If you are having issues and want to report a problem, always start with making sure that you're on the latest version of the integration, Grocy and Home Assistant.

You can ask for help in the forums, or make an issue with all of the relevant information here.