{"id":22691337,"url":"https://github.com/egguy/grott-ha-plugin","last_synced_at":"2025-08-21T20:08:14.531Z","repository":{"id":142968034,"uuid":"605307138","full_name":"egguy/grott-ha-plugin","owner":"egguy","description":"Plugin to interface Home Assistant and grott. Allow auto discoververy of the devices","archived":false,"fork":false,"pushed_at":"2024-04-30T00:07:44.000Z","size":1124,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T16:55:13.172Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/egguy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"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},"funding":{"github":"egguy","ko_fi":"egguy"}},"created_at":"2023-02-22T22:08:12.000Z","updated_at":"2024-03-09T18:10:02.000Z","dependencies_parsed_at":"2023-11-12T09:24:49.164Z","dependency_job_id":"8d42226a-7162-44b2-b99b-beb796610f2f","html_url":"https://github.com/egguy/grott-ha-plugin","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egguy%2Fgrott-ha-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egguy%2Fgrott-ha-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egguy%2Fgrott-ha-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/egguy%2Fgrott-ha-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/egguy","download_url":"https://codeload.github.com/egguy/grott-ha-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248643048,"owners_count":21138353,"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":[],"created_at":"2024-12-10T01:10:14.398Z","updated_at":"2025-04-12T22:54:46.245Z","avatar_url":"https://github.com/egguy.png","language":"Python","funding_links":["https://github.com/sponsors/egguy","https://ko-fi.com/egguy"],"categories":[],"sub_categories":[],"readme":"# grott-ha-plugin\n\n\n[![ci](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge\u0026logo=githubactions\u0026logoColor=white)](https://github.com/egguy/grott-ha-plugin/actions/workflows/ci.yml)\n[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://egguy.github.io/grott-ha-plugin/)\n[![pypi version](https://img.shields.io/pypi/v/grott-ha-plugin.svg)](https://pypi.org/project/grott-ha-plugin/)\n\n[//]: # ([![gitpod]\u0026#40;https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat\u0026#41;]\u0026#40;https://gitpod.io/#https://github.com/egguy/grott-ha-plugin\u0026#41;)\n\nPlugin to interface Home Assistant and Grott. Allow auto discovery of the devices on Home Assistant.\n\nCompatibility:\n\n- Python:\n    - 3.8\n    - 3.9\n    - 3.10\n    - 3.11\n- Grott:\n    - 2.7.X\n    - 2.8.X\n\nThis plugin is tested on linux (and best effort support for macOS and Windows)\n\n## Installation\n\n```bash\npip install grott-ha-plugin\n```\n\n## Usage\n\nOnce installed you need to add the plugin to the Grott configuration file, `grott.ini`, here an example:\n\n```ini\n[extension]\nextension=True\nextname = grottext.ha\nextvar = {\"ha_mqtt_host\": \"192.168.20.2\", \"ha_mqtt_port\": \"1883\", \"ha_mqtt_user\": \"XXXXX\", \"ha_mqtt_password\": \"XXXX\"}\n```\n\n## Configuration\n\nThe extension name (extname) is `grottext.ha`\n\nThe extension variable (extvar) is a json string with the following keys:\n\n- `ha_mqtt_host`: the mqtt host of the server used by Home Assistant\n- `ha_mqtt_port`: the mqtt port of the server used by Home Assistant\n- `ha_mqtt_user`: the mqtt user\n- `ha_mqtt_password`: the mqtt password\n\n## Home assistant configuration\n\nOn home assistant you need to have the MQTT integration enabled\n(docs: https://www.home-assistant.io/integrations/mqtt/) and configured.\n\nYou also need a MQTT broker, the recommended one is the mosquitto add-on you can install from the add-on store.\n\nThe MQTT broker needs to have a user to allow Grott to connect to it.\n(This can be configured in the mosquitto add-on configuration page if you are using it)\n\n## Home assistant add-on\n\nThere is a pre-packaged add-on existing for Home Assistant running in Home Assistant Operating System (HAOS).\n\nIf you use the mosquitto add-on, the addon will automatically configure Grott and the plugin to use the mosquitto broker.\nIt's a lot easier.\n\nThe add-on is available at:\n- [egguy HA addons - stable](https://github.com/egguy/ha-addons): The stable version (**recommended**)\n- [egguy HA addons - beta](https://github.com/egguy/ha-addons-beta): The beta version (includes the latest changes in testing)\n- [egguy HA addons - edge](https://github.com/egguy/ha-addons-edge/): The edge version (includes the latest changes - **Not recommended for day-to-day usage**)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fegguy%2Fgrott-ha-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fegguy%2Fgrott-ha-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fegguy%2Fgrott-ha-plugin/lists"}