Hi Ladies and Gents,
Sharing my simple project back to the Community.
I added simple Relay Switches to my HASS setup, using an Arduino Clone with builtin ESP8266 connected to a 4 Relay Switch Module.
My intention is to use these switches controlling my Sprinklers, and any free relay will be used for controlling the garden lights.
My Baseline:
- Raspberry Pi (1) - yeah, my old trusted Pi, could not really let it go
- Arduino Clone with built-in ESP8266 (WEMOS D1 R2 https://www.wemos.cc/product/d1.html)
- HASSBIAN 1.1 (https://home-assistant.io/docs/hassbian/installation/)
- installed MQTT using the script that came with HASSBIAN (https://home-assistant.io/docs/hassbian/customization/)
To install:
pi@hassbian:~ $ cd /home/pi/hassbian-scripts/
pi@hassbian:~/hassbian-scripts $ sudo ./install_mosquitto.sh
Jot down the username and password you have entered when doing the MQTT installation, you will need that for the Sketch and YAML portion. You will need to replace the mqtt_username and mqtt_password respectively.
My Arduino Sketch as follows:
//EJ: 4 Relay Switch over WIFI using MQTT and Home Assistant with OTA Support
//EJ: The only way I know how to contribute to the HASS Community... you guys ROCK!!!!!
//EJ: Erick Joaquin :-) Australia
// Original sketch courtesy of ItKindaWorks
//ItKindaWorks - Creative Commons 2016
//github.com/ItKindaWorks
//
//Requires PubSubClient found here: https://github.com/knolleary/pubsubclient
//
//ESP8266 Simple MQTT switch controller
#include <PubSubClient.h>
#include <ESP8266WiFi.h>
#include <ArduinoOTA.h>
void callback(char* topic, byte* payload, unsigned int length);
//EDIT THESE LINES TO MATCH YOUR SETUP
#define MQTT_SERVER "xxx.xxx.xxx.xxx" //you MQTT IP Address
const char* ssid = "YOUESSID";
const char* password = "WIFI_PASSWORD";
//EJ: Data PIN Assignment on WEMOS D1 R2 https://www.wemos.cc/product/d1.html
// if you are using Arduino UNO, you will need to change the "D1 ~ D4" with the corresponding UNO DATA pin number
const int switchPin1 = D1;
const int switchPin2 = D2;
const int switchPin3 = D3;
const int switchPin4 = D5;
//EJ: These are the MQTT Topic that will be used to manage the state of Relays 1 ~ 4
//EJ: Refer to my YAML component entry
//EJ: feel free to replicate the line if you have more relay switch to control, but dont forget to increment the number suffix so as increase switch logics in loop()
char const* switchTopic1 = "/house/switch1/";
char const* switchTopic2 = "/house/switch2/";
char const* switchTopic3 = "/house/switch3/";
char const* switchTopic4 = "/house/switch4/";
WiFiClient wifiClient;
PubSubClient client(MQTT_SERVER, 1883, callback, wifiClient);
void setup() {
//initialize the switch as an output and set to LOW (off)
pinMode(switchPin1, OUTPUT); // Relay Switch 1
digitalWrite(switchPin1, LOW);
pinMode(switchPin2, OUTPUT); // Relay Switch 2
digitalWrite(switchPin2, LOW);
pinMode(switchPin3, OUTPUT); // Relay Switch 3
digitalWrite(switchPin3, LOW);
pinMode(switchPin4, OUTPUT); // Relay Switch 4
digitalWrite(switchPin4, LOW);
ArduinoOTA.setHostname("My Arduino WEMO"); // A name given to your ESP8266 module when discovering it as a port in ARDUINO IDE
ArduinoOTA.begin(); // OTA initialization
//start the serial line for debugging
Serial.begin(115200);
delay(100);
//start wifi subsystem
WiFi.begin(ssid, password);
//attempt to connect to the WIFI network and then connect to the MQTT server
reconnect();
//wait a bit before starting the main loop
delay(2000);
}
void loop(){
//reconnect if connection is lost
if (!client.connected() && WiFi.status() == 3) {reconnect();}
//maintain MQTT connection
client.loop();
//MUST delay to allow ESP8266 WIFI functions to run
delay(10);
ArduinoOTA.handle();
}
void callback(char* topic, byte* payload, unsigned int length) {
//convert topic to string to make it easier to work with
String topicStr = topic;
//EJ: Note: the "topic" value gets overwritten everytime it receives confirmation (callback) message from MQTT
//Print out some debugging info
Serial.println("Callback update.");
Serial.print("Topic: ");
Serial.println(topicStr);
if (topicStr == "/house/switch1/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '1'){
digitalWrite(switchPin1, HIGH);
client.publish("/house/switchConfirm1/", "1");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '0'){
digitalWrite(switchPin1, LOW);
client.publish("/house/switchConfirm1/", "0");
}
}
// EJ: copy and paste this whole else-if block, should you need to control more switches
else if (topicStr == "/house/switch2/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '1'){
digitalWrite(switchPin2, HIGH);
client.publish("/house/switchConfirm2/", "1");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '0'){
digitalWrite(switchPin2, LOW);
client.publish("/house/switchConfirm2/", "0");
}
}
else if (topicStr == "/house/switch3/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '1'){
digitalWrite(switchPin3, HIGH);
client.publish("/house/switchConfirm3/", "1");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '0'){
digitalWrite(switchPin3, LOW);
client.publish("/house/switchConfirm3/", "0");
}
}
else if (topicStr == "/house/switch4/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '1'){
digitalWrite(switchPin4, HIGH);
client.publish("/house/switchConfirm4/", "1");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '0'){
digitalWrite(switchPin4, LOW);
client.publish("/house/switchConfirm4/", "0");
}
}
}
void reconnect() {
//attempt to connect to the wifi if connection is lost
if(WiFi.status() != WL_CONNECTED){
//debug printing
Serial.print("Connecting to ");
Serial.println(ssid);
//loop while we wait for connection
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
//print out some more debug once connected
Serial.println("");
Serial.println("WiFi connected");
Serial.println("IP address: ");
Serial.println(WiFi.localIP());
}
//make sure we are connected to WIFI before attemping to reconnect to MQTT
if(WiFi.status() == WL_CONNECTED){
// Loop until we're reconnected to the MQTT server
while (!client.connected()) {
Serial.print("Attempting MQTT connection...");
// Generate client name based on MAC address and last 8 bits of microsecond counter
String clientName;
clientName += "esp8266-";
uint8_t mac[6];
WiFi.macAddress(mac);
clientName += macToStr(mac);
//if connected, subscribe to the topic(s) we want to be notified about
//EJ: Delete "mqtt_username", and "mqtt_password" here if you are not using any
if (client.connect((char*) clientName.c_str(),"mqtt_username", "mqtt_password")) { //EJ: Update accordingly with your MQTT account
Serial.print("\tMQTT Connected");
client.subscribe(switchTopic1);
client.subscribe(switchTopic2);
client.subscribe(switchTopic3);
client.subscribe(switchTopic4);
//EJ: Do not forget to replicate the above line if you will have more than the above number of relay switches
}
//otherwise print failed for debugging
else{Serial.println("\tFailed."); abort();}
}
}
}
//generate unique name from MAC addr
String macToStr(const uint8_t* mac){
String result;
for (int i = 0; i < 6; ++i) {
result += String(mac[i], 16);
if (i < 5){
result += ':';
}
}
return result;
}
Supported by (working alongside) the following entry in YAML
mqtt:
broker: YOUR_MQTT_IPADDRESS
port: 1883
client_id: home-assistant-1
keepalive: 60
username: mqtt_username
password: mqtt_password
protocol: 3.1
switch 1:
- platform: mqtt
name: "MQTT Switch 1"
state_topic: "/house/switchConfirm1/"
command_topic: "/house/switch1/"
payload_on: "1"
payload_off: "0"
qos: 0
retain: true
switch 2:
- platform: mqtt
name: "MQTT Switch 2"
state_topic: "/house/switchConfirm2/"
command_topic: "/house/switch2/"
payload_on: "1"
payload_off: "0"
qos: 0
retain: true
switch 3:
- platform: mqtt
name: "MQTT Switch 3"
state_topic: "/house/switchConfirm3/"
command_topic: "/house/switch3/"
payload_on: "1"
payload_off: "0"
qos: 0
retain: true
switch 4:
- platform: mqtt
name: "MQTT Switch 4"
state_topic: "/house/switchConfirm4/"
command_topic: "/house/switch4/"
payload_on: "1"
payload_off: "0"
qos: 0
retain: true
Once ALL loaded in, restarted my HASS Server, and…
This showed up:
( I also created a group so I could control all of them in one go)
Some Hardware Pictures, showing the wiring between the two boards
D1 wire to Relay Switch IN1 (see third Picture)
D2 wire to Relay Switch IN2
D3 wire to Relay Switch IN3
D5 wire to Relay Switch IN4 (I use D4 for on-board LED checking)
WEMOS D1 R2 with Built in ESP8266
5V connector to Relay Switch VCC Pin
GND to Relay Switch GND
4 Relay Switch Module (5V, be careful when buying this as it also comes in 12V VCC Supply version)
- I had chosen this one as it can be triggered by 3.3V . (which is what WEMOS I/O supports)
I uploaded a Video demo as well to see it action:
https://youtu.be/ted-apmywZo
Working perfectly for me!
Cheers
Erick
ps. I’m not a coder, just following amazing guides from Ben (www.bruhautomation.com, https://www.youtube.com/watch?v=tCGlQSsQ-Mc ), Itkindaworks (https://www.youtube.com/watch?v=gCgr1vwsJFA), and from this great chap whose videos gave me a good insight on programming (https://www.youtube.com/watch?v=LW8Rfh6TzGg) now i know a bit how to read the codes.