{"id":13579561,"url":"https://github.com/custom-components/grocy","last_synced_at":"2025-12-29T23:26:20.906Z","repository":{"id":37990784,"uuid":"182915754","full_name":"custom-components/grocy","owner":"custom-components","description":"Custom Grocy integration for Home Assistant","archived":false,"fork":false,"pushed_at":"2025-01-28T13:36:45.000Z","size":416,"stargazers_count":177,"open_issues_count":48,"forks_count":60,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-01-28T14:33:04.408Z","etag":null,"topics":["grocy","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/custom-components.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-23T02:59:07.000Z","updated_at":"2025-01-28T13:36:04.000Z","dependencies_parsed_at":"2024-03-17T07:43:05.338Z","dependency_job_id":"7029c2af-d07f-44b8-b5ae-4fc9275ea5c8","html_url":"https://github.com/custom-components/grocy","commit_stats":null,"previous_names":[],"tags_count":81,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fgrocy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fgrocy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fgrocy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/custom-components%2Fgrocy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/custom-components","download_url":"https://codeload.github.com/custom-components/grocy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415783,"owners_count":20935383,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grocy","hacktoberfest"],"created_at":"2024-08-01T15:01:40.575Z","updated_at":"2025-12-29T23:26:20.901Z","avatar_url":"https://github.com/custom-components.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration)\n\n---\n**INFO**\n\n**The integration supports Grocy version 3.2 and above.**\n\n**At least Home Assistant version 2021.12 is required for the integration from v4.3.3 and above.**\n\nYou 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](https://github.com/hassio-addons/addon-grocy) or another installation method, found at [Grocy website](https://grocy.info/).\n\n---\n\n# Adding the integration\n\n## First steps \u003ca name=\"addon\"\u003e\u003c/a\u003efor Grocy add-on\nThe configuration is slightly different for those who use the [official Grocy add-on](https://github.com/hassio-addons/addon-grocy) from the add-on store.\n\n1. If you haven't already done so, install Grocy from the add-on store.\n2. In the 'Configuration' section of the add-on config, input `9192` in the Network port field - see [screenshot](#screenshot-addon-config). Save your changes and restart the add-on.\n3. Now continue with the instructions below.\n\n## HACS\nThe easiest way to install this integration is with [HACS][hacs]. First, install [HACS][hacs-download] if you don't have it yet. In Home Assistant, go to `HACS`, click on 3 dot menu at the right top, choose \"Custom repositories\", and in fields below put a link to this repo \"https://github.com/custom-components/grocy\", and type select \"Integration\".\n\nNew repository should appear in the list \"Grocy custom component\". Click on it, then press button at the bottom right \"Download\", then press \"Download\" in a new window, and finally restart Home Assistant (you should also get a \"repair\" notification in your Home Assistant Settings menu). \n\nInstall the [Grocy integration](https://my.home-assistant.io/redirect/config_flow_start/?domain=grocy). \nFill out the information according to [this instruction](#integration-configuration).\n\nFuture integration updates will appear automatically within Home Assistant via HACS.\n\nYou will now have a new integration for Grocy. All entities are disabled from start, manually enable the entities you want to use.\n\n[hacs]: https://hacs.xyz\n[hacs-download]: https://hacs.xyz/docs/setup/download\n[hacsbadge]: https://img.shields.io/badge/HACS-Default-blue.svg?style=flat\n\n### Manual installation\n1. Update Home Assistant to version 2025.02 or newer.\n2. Clone this repository.\n3. Copy the `custom_components/grocy` folder into your Home Assistant's `custom_components` folder.\n4. Restart Home Assistant\n\n\n# Entities\n\n**All entities are disabled from the start. You have to manually enable the entities you want to use in Home Assistant.**\nYou get a sensor each for chores, meal plan, shopping list, stock, tasks and batteries.\nYou get a binary sensor each for overdue, expired, expiring and missing products and for overdue tasks, overdue chores and overdue batteries.\n\n\n# Services\n\nThe following services come with the integration. For all available options check the [Developer Tools: Services](https://my.home-assistant.io/redirect/developer_services/) within Home Assistant.\n\n- **Grocy: Add Generic** (_grocy.add_generic_)\n\nAdds a single object of the given entity type.\n\n- **Grocy: Add Product To Stock** (_grocy.add_product_to_stock_)\n\nAdds a given amount of a product to the stock.\n\n- **Grocy: Open Product** (_grocy.open_product_)\n\nOpens a given amount of a product in stock.\n\n- **Grocy: Track Battery** (_grocy.track_battery_)\n\nTracks the given battery.\n\n- **Grocy: Complete Task** (_grocy.complete_task_)\n\nCompletes the given task.\n\n- **Grocy: Consume Product From Stock** (_grocy.consume_product_from_stock_)\n\nConsumes a given amount of a product from the stock.\n\n- **Grocy: Execute Chore** (_grocy.execute_chore_)\n\nExecutes the given chore with an optional timestamp and executor.\n\n- **Grocy: Consume Recipe** (_grocy.consume_recipe_)\n\nConsumes the given recipe.\n\n- **Grocy: Add Missing Products to Shopping List** (_grocy.add_missing_products_to_shopping_list_)\n\nAdds currently missing products to a given shopping list.\n\n- **Grocy: Remove Product in Shopping List** (_grocy.remove_product_in_shopping_list_)\n\nRemoves a product in the given shopping list.\n\n# Translations\n\nTranslations are done via [Lokalise](https://app.lokalise.com/public/260939135f7593a05f2b79.75475372/). If you want to translate into your native language, please [join the team](https://app.lokalise.com/public/260939135f7593a05f2b79.75475372/).\n\n\n# Troubleshooting\n\nIf you have problems with the integration you can add debug prints to the log.\n\n```yaml\nlogger:\n  default: info\n  logs:\n    pygrocy.grocy_api_client: debug\n    custom_components.grocy: debug\n```\n\nIf 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.\n\nYou can ask for help [in the forums](https://community.home-assistant.io/t/grocy-custom-component-and-card-s/218978), or [make an issue with all of the relevant information here](https://github.com/custom-components/grocy/issues/new?assignees=\u0026labels=\u0026template=bug_report.md\u0026title=).\n\n\n# \u003ca name=\"integration-configuration\"\u003e\u003c/a\u003eIntegration configuration\n\n## URL\nThe 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.\n\n## API key\nGo 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.\n\n## Port\nIt 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.\n- If you have configured the [Grocy add-on](#addon) as described, use port 9192 (without https). Either be sure the port is open in your router or use your internal Home Assistant address.\n- If you have configured an [external Grocy](#both) instance and not sure, use port 80 for http or port 443 for https. Unless you have set a custom port for Grocy.\n\n![alt text](grocy-integration-config.png)\n\n\n# \u003ca name=\"screenshot-addon-config\"\u003e\u003c/a\u003eAdd-on port configuration\n\n![alt text](grocy-addon-config.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustom-components%2Fgrocy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcustom-components%2Fgrocy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustom-components%2Fgrocy/lists"}