Skip to content

Custom Grocy integration for Home Assistant

Notifications You must be signed in to change notification settings

towo/grocy-1

 
 

Repository files navigation

hacs_badge

Installation


INFO

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


for Grocy add-on

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.

for existing external Grocy install

  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.)

Entities

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.

Translation

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

Troubleshooting

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.

Add-on port configuration

alt text

About

Custom Grocy integration for Home Assistant

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%