INFO
The integration supports Grocy version 3.2 and above.
At least Home Assistant version 2021.12 is required for the integration from v4.3.3 and above.
You have to have the Grocy software already installed and running, this integration only communicates with an existing installation of Grocy. You can install the software with the Grocy add-on or another installation method, found at Grocy website.
The configuration is slightly different for those who use the official Grocy add-on from the add-on store.
9192
in the Network port field - see screenshot. Save your changes and restart the add-on.Future integration updates will appear automatically within Home Assistant via HACS.
All entities are disabled from the start. You have to manually enable the entities you want to use in Home Assistant. You get a sensor each for chores, meal plan, shopping list, stock, tasks and batteries. You get a binary sensor each for overdue, expired, expiring and missing products and for overdue tasks, overdue chores and overdue batteries.
The following services come with the integration. For all available options check the Developer Tools: Services within Home Assistant.
Adds a single object of the given entity type.
Adds a given amount of a product to the stock.
Opens a given amount of a product in stock.
Tracks the given battery.
Completes the given task.
Consumes a given amount of a product from the stock.
Executes the given chore with an optional timestamp and executor.
Consumes the given recipe.
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.grocy_api_client: 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 beta 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.
The Grocy url should be in the form below (start with http://
or https://
) and point to your Grocy instance. If you use a SSL certificate you should have https
and also check the "Verify SSL Certificate" box. Do not enter a port in the url field. Subdomains are also supported, fill out the full url in the field.
Go to your Grocy instance. Navigate via the wrench icon in the top right corner to "Manage API keys" and add a new API key. Copy and paste the generated key.
It should work with for example a Duck DNS address as well, but you still have to access it via a port, and the above instructions for the url still apply.