Installation

Installation

1. If you don't have a MQTT broker yet, in Home Assistant go to Settings → Add-ons → Add-on store and install the Mosquitto broker addon.
2. Go back to the Add-on store, click ⋮ → Repositories, fill in https://github.com/ChristopheHD/HA_enoceanmqtt-addon and click Add → Close.
   Or simply click the Add Add-on repository button below and follow the instructions.
   
3. Click on the addon (refresh the web page if the add-on is not displayed), press Install and wait until the addon is installed.

Configuration

1. Click on Configuration
   • Select the serial interface of your EnOcean transceiver in the list of detected serial ports.
   • If you want to connect to your EnOcean key via TCP, select an unused serial port and fill in the TCP connection information in the second field.
   • To define the device to manage, adapt the addon/enoceanmqtt.devices.sample and put it to your Home Assistant /config directory. You can use the Home Assistant File Editor.
     See Normal Usage for more details.
   • Indicate the location of this device file under the device_file entry.
   • Leave empty the mapping_file entry to use the default mapping file. If you want to use a custom mapping file, indicate the location of your mapping file. This can be useful for people wanting to add support for new devices or customize the existing ones. Refer to this wiki page for more details.
   • Leave empty the eep_file entry to use the default EEP.xml file. If you want to use a custom EEP.xml file, indicate the location of your EEP.xml file. This can be useful for people wanting to add support for new devices not yet supported by the Python EnOcean library. Refer to this wiki page for more details.
   • Indicate your preferred location for the log file under the log_file entry. It shall be in your Home Assistant /config directory.
   • If you are not using the Mosquitto broker addon, fill in your MQTT details. Otherwise, leave empty the MQTT broker configuration. The format is for example:

     host: localhost
     port: '1883'
     user: my_user
     pwd: my_password

   • Indicate the mqtt_discovery_prefix under the mqtt_discovery_prefix entry. This is the MQTT prefix used for MQTT Discovery mechanism from the MQTT integration. It defaults to homeassistant and can be configured in the Home Assistant MQTT integration as follow:

     mqtt:
       discovery_prefix: <prefix>

   If you have other HA integrations using MQTT discovery (e.g. zigbee2mqtt, etc.), mqtt_discovery_prefix should be set to homeassistant as it seems to be the one used in general.
   • Indicate the mqtt_prefix under the mqtt_prefix entry. This is the prefix which will be used to interact with your EnOcean devices.
     EnOceanMQTT will interact with EnOcean devices through the device root topic <mqtt_prefix>/<device_name>.
   • Turn on the debug switch if you want a very verbose log file.
   • Other settings can be kept to their default values.
   • Click Save
   • Tip: it is possible to refer to variables in the Home Assistant secrets.yaml file by using e.g. pwd: '!secret mqtt_pwd'
2. Start the addon by going to Info and click Start
3. Wait till HA_enoceanmqtt starts and press Log to verify HA_enoceanmqtt started correctly.