//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: GitHub - knolleary/pubsubclient: A client library for the Arduino Ethernet Shield that provides support for MQTT.
//
//ESP8266 Simple MQTT switch controller
#include <PubSubClient.h>
#include <ESP8266WiFi.h>
#include <ArduinoOTA.h>
// Mapping NodeMCU Ports to Arduino GPIO Pins
// Allows use of NodeMCU Port nomenclature in config.h
#define D0 16
#define D1 5
#define D2 4
#define D3 0
#define D4 2
#define D5 14
#define D6 12
#define D7 13
#define D8 15
void callback(char* topic, byte* payload, unsigned int length);
//EDIT THESE LINES TO MATCH YOUR SETUP
#define MQTT_SERVER “192.168.168.168” //you MQTT IP Address
const char* ssid = “SSID”;
const char* password = “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 = D4;
const int switchPin5 = D5;
const int switchPin6 = D6;
const int switchPin7 = D7;
const int switchPin8 = D8;
//EJ: These are the MQTT Topic that will be used to manage the state of Relays 1 ~ 8
//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/”;
char const* switchTopic5 = “/house/switch5/”;
char const* switchTopic6 = “/house/switch6/”;
char const* switchTopic7 = “/house/switch7/”;
char const* switchTopic8 = “/house/switch8/”;
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);
pinMode(switchPin5, OUTPUT); // Relay Switch 5
digitalWrite(switchPin5, LOW);
pinMode(switchPin6, OUTPUT); // Relay Switch 6
digitalWrite(switchPin6, LOW);
pinMode(switchPin7, OUTPUT); // Relay Switch 7
digitalWrite(switchPin7, LOW);
pinMode(switchPin8, OUTPUT); // Relay Switch 8
digitalWrite(switchPin8, LOW);
ArduinoOTA.setHostname(“Garage_Control”); // 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] == '0'){
digitalWrite(switchPin1, HIGH);
client.publish("/house/switchConfirm1/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin1, LOW);
client.publish("/house/switchConfirm1/", "1");
}
}
// 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] == '0'){
digitalWrite(switchPin2, HIGH);
client.publish("/house/switchConfirm2/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin2, LOW);
client.publish("/house/switchConfirm2/", "1");
}
}
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] == '0'){
digitalWrite(switchPin3, HIGH);
client.publish("/house/switchConfirm3/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin3, LOW);
client.publish("/house/switchConfirm3/", "1");
}
}
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] == '0'){
digitalWrite(switchPin4, HIGH);
client.publish("/house/switchConfirm4/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin4, LOW);
client.publish("/house/switchConfirm4/", "1");
}
}
else if (topicStr == "/house/switch5/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '0'){
digitalWrite(switchPin5, HIGH);
client.publish("/house/switchConfirm5/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin5, LOW);
client.publish("/house/switchConfirm5/", "1");
}
}
else if (topicStr == "/house/switch6/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '0'){
digitalWrite(switchPin6, HIGH);
client.publish("/house/switchConfirm6/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin6, LOW);
client.publish("/house/switchConfirm6/", "1");
}
}
else if (topicStr == "/house/switch7/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '0'){
digitalWrite(switchPin7, HIGH);
client.publish("/house/switchConfirm7/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin7, LOW);
client.publish("/house/switchConfirm7/", "1");
}
}
else if (topicStr == "/house/switch8/")
{
//turn the switch on if the payload is '1' and publish to the MQTT server a confirmation message
if(payload[0] == '0'){
digitalWrite(switchPin8, HIGH);
client.publish("/house/switchConfirm8/", "0");
}
//turn the switch off if the payload is '0' and publish to the MQTT server a confirmation message
else if (payload[0] == '1'){
digitalWrite(switchPin8, LOW);
client.publish("/house/switchConfirm8/", "1");
}
}
}
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(),"USERNAME", "PASSWORD")) { //EJ: Update accordingly with your MQTT account
Serial.print("\tMQTT Connected");
client.subscribe(switchTopic1);
client.subscribe(switchTopic2);
client.subscribe(switchTopic3);
client.subscribe(switchTopic4);
client.subscribe(switchTopic5);
client.subscribe(switchTopic6);
client.subscribe(switchTopic7);
client.subscribe(switchTopic8);
//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 < 10){
result += ':';
}
}
return result;
}