HA_Addon_Instructions.md

Quick Start for Home Assistant users

Prerequisites

These instructions assume that you:

• Have a Home Assistant installation with Home Assistant Supervisor up and running. Installing using the instructions in the Home Assistant Getting Started Guide or the slightly more advanced Recommened Installation Methods will work. The advanced Home Assistant Supervised installation should also work as well.

• Have a working MQTT broker up and running. Mosquitto is good choice, and there is an add-on for Home Assistant that makes installation simple.

• Have an Insteon PLM modem (serial or USB) or an Insteon HUB on a fixed IP address.

Installation

1. Navigate in Home Assistant frontend to Supervisor -> Add-on Store
2. Select the menu in the top right and click Repositories
3. Paste the following URL into the Add Repository field: https://github.com/TD22057/insteon-mqtt
4. Click ADD
5. Scroll to find the Insteon MQTT Repository
6. Click on the Insteon MQTT Add on
7. Click Install
8. Click Start to start the Add-on, this will create your initial config files.
9. Edit /config/insteon-mqtt/config.yaml as appropriate. See configuration for detailed instructions.
10. Enable the Discovery Platform

Alternatively, if you choose to define your entities in Home Assistant manually instead of using the Discovery Platform, see Home Assistant yaml config

11. Restart the insteon-mqtt addon to pick up the changes to the config.yaml file.
12. If you navigate in Home Assistant to Configuration -> Integrations -> MQTT you should see your devices and entities.
13. Initialize your devices as discussed in initializing.
14. See the device documentation for additional commands.

Backing up your Data

The default settings in the config.yaml file will save all user data to the /config/insteon-mqtt directory. So you only need to backup and save this data, you do not need to make a snapshot of the Insteon-MQTT add-on. This directory may also contain a log file if you have enabled logging, be careful, this can get quite large.

Updating

Check the supervisor page periodically for updates to Insteon-MQTT

Additional Resources

• User Interfaces for information on how to interact with Insteon-MQTT

• Debugging for information on how to diagnose problems.

• Device documentation for information on device configuration and available MQTT commands and options.