📡 Welcome I2C Relay to MQTT! 🔌

This repo can be used to control a Dockerpi relay hat for the Raspberry Pi over MQTT, but it might work for other I2C-type relays.

To get started, even before this repo, check this nice tutorial page.

Basic implementation:

Main functions

1. Fill in the config.yaml with your settings
2. The script listens on a predefined MQTT topic (command_topic) and forwards the requests to the relays on I2C protocol.
3. At the same time, if a relay state is changed, it updates the state_topic

Secondary functions

• Configure it as a service for autostart ⚙️
• Enable HomeAssistant discovery 🏡

Functionalities of the script 🧰

1. Change the state of the relays based on MQTT messages
2. Configurable settings for MQTT and I2C addresses
3. HomeAssistant discovery
4. Online state monitoring on MQTT -> could be enhanced
5. Configurable service template for autostart on boot -> could be enhanced
6. Last will messages on MQTT -> tbd

Get started 🚀

Are you interested? Cool, let's go:

1. Clone the repo -> git clone https://github.com/Andoramb/i2c_2_mqtt.git
2. Install prerequisites with pip install -r requirements.txt
3. Fill in config.yaml, according to your needs (explanation in the file itself)
4. Run python3 mqtt2i2c.py config.yamland check the output.
   1. Upon succsessful connect, it should output Connected with result code 0 👍
   2. The state topic should be online ✅
5. Check MQTT so the states are reported:
   1. Possible values for toggling to ON state: "on", "1", "true", "ON", "TRUE", "True"
   2. Possible values for toggling to OFF state: "off", "0", "false", "OFF", "FALSE", "False"
   3. However, the app will report "on" or "off" string only 💡
6. Optional: HomeAsisstant should register the relay based on device_name from config.yaml 🏡
7. Optional: copy the service template to /etc/systemd/system for autostart
   1. Replace username and /path/to/i2c_2_mqtt/ with your data ⚙️
   2. sudo systemctl daemon-reload
   3. sudo systemctl enable i2c_2_mqtt.service
   4. 👍

Future improvements 💭

Not sure yet, seems to be working 🤷‍♂️