Rfxcom2mqtt

Official Rfxcom2mqtt Home Assistant addon

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, then start it.
2. Go back to the Add-on store, click ⋮ → Repositories, fill in
   https://github.com/rfxcom2mqtt/hassio-addons 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. The repository includes add-ons:
   • Rfxcom2mqtt is the stable release that tracks the released versions of Rfxcom2mqtt.
4. Click on the addon and press Install and wait till the addon is installed.
5. Click on Configuration
   • If you are not using the Mosquitto broker addon fill in your MQTT details (leave empty when using the Mosquitto broker addon). Format can be found here, but skip the initial mqtt: indent. e.g.:
     

     server: mqtt://localhost:1883
     username: my_user
     password: "my_password"

     Note: If the password includes certain special characters (reserved by yaml specification), the enclosing quotes are required. So it is recommended to always quote it when in doubt.

   • Fill in the serial details (e.g. port of your USB coordinator). Format can be found here, but skip the initial rfxcom: indent. e.g.:
     

     usb_port: /dev/ttyUSB0

   • If you don't know the port and you have just one USB device connected to your machine try /dev/ttyUSB0. Else use the Home Assistant CLI and execute ha hardware info to find out.
   • Click Save
6. Start the addon by going to Info and click Start
7. Wait till Rfxcom2mqtt starts and press OPEN WEB UI to verify Rfxcom2mqtt 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.

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 Rfxcom2mqtt format: X.Y.Z.

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

DEV

npm install -g @devcontainers/cli

devcontainer up --workspace-folder ./

devcontainer exec --workspace-folder ./ supervisor_run