Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.69 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.69 KB
Raw

grott-ha-plugin

ci documentation pypi version

Plugin to interface Home Assistant and Grott. Allow auto discovery of the devices on Home Assistant.

Compatibility:

  • Python:
    • 3.8
    • 3.9
    • 3.10
    • 3.11
  • Grott:
    • 2.7.X
    • 2.8.X

This plugin is tested on linux (and best effort support for macOS and Windows)

Installation

pip install grott-ha-plugin

Usage

Once installed you need to add the plugin to the Grott configuration file, grott.ini, here an example:

[extension]
extension=True
extname = grottext.ha
extvar = {"ha_mqtt_host": "192.168.20.2", "ha_mqtt_port": "1883", "ha_mqtt_user": "XXXXX", "ha_mqtt_password": "XXXX"}

Configuration

The extension name (extname) is grottext.ha

The extension variable (extvar) is a json string with the following keys:

  • ha_mqtt_host: the mqtt host of the server used by Home Assistant
  • ha_mqtt_port: the mqtt port of the server used by Home Assistant
  • ha_mqtt_user: the mqtt user
  • ha_mqtt_password: the mqtt password

Home assistant configuration

On home assistant you need to have the MQTT integration enabled (docs: https://www.home-assistant.io/integrations/mqtt/) and configured.

You also need a MQTT broker, the recommended one is the mosquitto add-on you can install from the add-on store.

The MQTT broker needs to have a user to allow Grott to connect to it. (This can be configured in the mosquitto add-on configuration page if you are using it)

Home assistant add-on

There is a pre-packaged add-on existing for Home Assistant running in Home Assistant Operating System (HAOS).

If you use the mosquitto add-on, the addon will automatically configure Grott and the plugin to use the mosquitto broker. It's a lot easier.

The add-on is available at: