Home Assistant add-on repository for Modbus <=> MQTT

This repository contains the Modbus <=> MQTT Addon.

Add-ons

This repository contains the following add-on(s)

Modbus<=>MQTT

Installation

1. If you don't have an 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/modbus2mqtt/hassio-addon-repository and click Add → Close or click the Add repository button below, click Add → Close (You might need to enter the internal IP address of your Home Assistant instance first).
   
3. Click on the addon and press Install and wait till the addon is installed.
4. Start the addon by going to Info and click Start
5. Wait till Modbus <=> MQTT starts and press OPEN WEB UI to verify modbus2MQTT started correctly.
   • If it shows 502: Bad Gateway wait a bit more and refresh the page.
   • If this takes too long (e.g. 2 minutes +) check the Log tab to see what went wrong.

For more information see the documentation.

Restoring data from a standalone installation

1. Ensure that both environments are running the same version
2. Backup your standalone environment data folder (possibly leaving out the logs/ folder)
3. Restore your data folder contents into /usr/share/hassio/homeassistant/modbus2mqtt
4. Start the add-on

Changelog

The format is based on Keep a Changelog.

All notable changes to this project will be documented in the CHANGELOG.md file.

Version for releases is based on modbus2MQTT format: X.Y.Z.

Any changes on the addon that do not require a new version of modbus2MQTT will use the format: X.Y.Z-A where X.Y.Z is fixed on the modbus2MQTT release version and A is related to the addon.

Issues

If you find any issues with the add-on, please check the issue tracker for similar issues before creating one.

Feel free to create a PR for fixes and enhancements.