Version 1.24

Added encrypting messages.

README.md

@@ -4,41 +4,43 @@ Gateway for data exchange between ESP-NOW devices and MQTT broker via WiFi.
 
 ## Features
 
-1. Creates an access point named "ESP-NOW Gateway XXXXXXXXXXXX" with password "12345678" (IP 192.168.4.1).
+1. Creates an access point named "ESP-NOW gateway XXXXXXXXXXXX" with password "12345678" (IP 192.168.4.1).
 2. Possibility a device search through the Windows Network Environment via SSDP.
 3. Periodically transmission of system information to the MQTT broker (every 60 seconds) and availability status to the ESP-NOW network and to the MQTT broker (every 10 seconds).
 4. Automatically adds gateway configuration to Home Assistan via MQTT discovery as a binary_sensor.
-5. Possibility firmware update over OTA.
+5. Automatically adds supported ESP-NOW devices configurations to Home Assistan via MQTT discovery.
-6. Web interface for settings.
+6. Possibility firmware update over OTA.
+7. Web interface for settings.
   
 ## Notes
 
 1. ESP-NOW mesh network based on the library [ZHNetwork](https://github.com/aZholtikov/ZHNetwork).
 2. Regardless of the status of connections to WiFi or MQTT the device perform ESP-NOW node function.
-3. For restart the device (without using the Web interface and only if MQTT connection established) send an "restart" command to the device's root topic (example - "homeassistant/gateway/70039F44BEF7").
+3. For restart the device (without using the Web interface and only if MQTT connection established) send an "restart" command to the device's root topic (example - "homeassistant/espnow_gateway/70039F44BEF7").
 
 ## Attention
 
 1. ESP-NOW network name must be set same of all another ESP-NOW devices in network.
-2. Upload the "data" folder (with web interface) into the filesystem before flashing.
+2. If encryption is used, the key must be set same of all another ESP-NOW devices in network.
-3. WiFi router must be set on channel 1.
+3. Upload the "data" folder (with web interface) into the filesystem before flashing.
+4. WiFi router must be set on channel 1.
 
 ## Tested on
 
-1. NodeMCU 1.0 (ESP-12E Module). Unstable work.
+1. NodeMCU 1.0 (ESP-12E Module). ESP-NOW + WiFi mode. Unstable work.
-2. AZ-Delivery ESP-32 Dev Kit C V4. Stable work.
+2. AZ-Delivery ESP-32 Dev Kit C V4. ESP-NOW + WiFi mode. Stable work.
 
 ## Supported devices
 
-1. [RF - Gateway](https://github.com/aZholtikov/RF-Gateway) (coming soon)
+1. [RF Gateway](https://github.com/aZholtikov/RF-Gateway) (coming soon)
-2. [ESP-NOW Switch](https://github.com/aZholtikov/ESP-NOW-Switch) (coming soon)
+2. [ESP-NOW Switch](https://github.com/aZholtikov/ESP-NOW-Switch)
-3. [ESP-NOW Led Light/Strip](https://github.com/aZholtikov/ESP-NOW-Led-Light-Strip) (coming soon)
+3. [ESP-NOW Light/Led Strip](https://github.com/aZholtikov/ESP-NOW-Light-Led-Strip)
-4. [ESP-NOW Window/Door Sensor](https://github.com/aZholtikov/ESP-NOW-Window-Door-Sensor) (coming soon)
+4. [ESP-NOW Window/Door Sensor](https://github.com/aZholtikov/ESP-NOW-Window-Door-Sensor)
-5. [ESP-NOW Water Leakage Sensor](https://github.com/aZholtikov/ESP-NOW-Water-Leakage-Sensor) (coming soon)
+5. [ESP-NOW Water Leakage Sensor](https://github.com/aZholtikov/ESP-NOW-Water-Leakage-Sensor)
 
 ## To Do
 
-- [ ] Automatically add ESP-NOW devices configurations to Home Assistan via MQTT discovery.
+- [X] Automatically add ESP-NOW devices configurations to Home Assistan via MQTT discovery.
 - [ ] LAN connection support.
 - [ ] nRF24 device support (in current time uses "RF Gateway").
 - [ ] BLE device support (for ESP32).

data/index.htm

@@ -31,20 +31,20 @@
 
         <p class="text">WiFi settings</p>
         <div class="wrapper">
-            <input id="ssid" value="{{ssid}}" placeholder="SSID" label title="WiFi network name" />
+            <input class="text-inp" id="ssid" value="{{ssid}}" placeholder="SSID" label title="WiFi network name" />
             <input id="password" value="{{password}}" onfocus="this.type='text'" type="password" placeholder="Password"
                 autocomplete="off" label title="WiFi password" />
         </div>
 
         <p class="text">MQTT settings</p>
         <div class="wrapper">
-            <input id="mqttHostName" value="{{mqttHostName}}" placeholder="URL or IP" label
+            <input class="text-inp" id="mqttHostName" value="{{mqttHostName}}" placeholder="URL or IP" label
                 title="MQTT server URL or IP" />
             <input id="mqttHostPort" value="{{mqttHostPort}}" placeholder="Port" label title="MQTT server port" />
         </div>
 
         <div class="wrapper">
-            <input id="mqttUserLogin" value="{{mqttUserLogin}}" placeholder="Login" label
+            <input class="text-inp" id="mqttUserLogin" value="{{mqttUserLogin}}" placeholder="Login" label
                 title="MQTT server user login" />
             <input id="mqttUserPassword" value="{{mqttUserPassword}}" onfocus="this.type='text'" type="password"
                 placeholder="Password" autocomplete="off" label title="MQTT server user password" />

data/style.css

@@ -1,3 +1,7 @@
+p{
+    margin: 0 0;
+}
+
 body {
     font-family: "Gill Sans", sans-serif;
     background: rgb(255, 255, 255);
@@ -21,6 +25,21 @@ h1 {
     font-weight: 600;
     flex-shrink: 0;
     margin-right: 10px;
+    margin-left: 10px;
+    margin: 10px 0;
+}
+
+.text-inp {
+    width: 48%;
+    min-height: 30px;
+    border-radius: 5px;
+    border: none;
+    margin-bottom: 10px;
+    padding: 0 10px;
+    color: rgb(0, 0, 0);
+    background: #a3e0f1;
+    transition: .5s;
+    margin-left: 0;
 }
 
 .wrapper {
@@ -39,6 +58,7 @@ input {
     color: rgb(0, 0, 0);
     background: #a3e0f1;
     transition: .5s;
+    margin-left: 10px;
 }
 
 input:hover {
@@ -51,6 +71,8 @@ input:hover {
     background: rgb(65, 125, 238);
     color: white;
     transition: .5s;
+    margin-left: 0;
+    margin-top: 8px;
 }
 
 .btn:hover {
@@ -65,6 +87,10 @@ input:hover {
     width: 100%;
 }
 
+#espnowNetName {
+    margin-bottom: 10px;
+}
+
 .wrapper.wrapper--end {
     align-items: baseline;
 }

platformio.ini

@@ -1,4 +1,4 @@
-[env:esp8266]
+[env:ESP8266]
 platform = espressif8266
 board = nodemcuv2
 framework = arduino
@@ -9,7 +9,7 @@ lib_deps =
 	me-no-dev/ESP Async WebServer@^1.2.3
 	marvinroger/AsyncMqttClient@^0.9.0
 
-[env:esp8266-ota]
+[env:ESP8266-OTA]
 platform = espressif8266
 board = nodemcuv2
 framework = arduino
@@ -22,7 +22,7 @@ lib_deps =
 	me-no-dev/ESP Async WebServer@^1.2.3
 	marvinroger/AsyncMqttClient@^0.9.0
 
-[env:esp32]
+[env:ESP32]
 platform = espressif32
 board = az-delivery-devkit-v4
 framework = arduino
@@ -34,11 +34,11 @@ lib_deps =
 	marvinroger/AsyncMqttClient@^0.9.0
 	luc-github/ESP32SSDP@^1.2.0
 
-[env:esp32-ota]
+[env:ESP32-OTA]
 platform = espressif32
 board = az-delivery-devkit-v4
 framework = arduino
-upload_port = 192.168.1.144
+upload_port = 192.168.1.110
 upload_protocol = espota
 lib_deps = 
 	https://github.com/aZholtikov/ZHNetwork

src/main.cpp

@@ -34,11 +34,16 @@ void setupWebServer(void);
 
 void connectToMqtt(void);
 
-const String firmware{"1.01"};
+const String firmware{"1.24"};
 
 String espnowNetName{"DEFAULT"};
 
-String deviceName{"ESP-NOW gateway"};
+#if defined(ESP8266)
+String deviceName = "ESP-NOW gateway " + String(ESP.getChipId(), HEX);
+#endif
+#if defined(ESP32)
+String deviceName = "ESP-NOW gateway " + String(ESP.getEfuseMac(), HEX);
+#endif
 
 String ssid{"SSID"};
 String password{"PASSWORD"};
@@ -72,6 +77,7 @@ void setup()
     loadConfig();
 
     WiFi.onEvent(onWifiEvent);
+
 #if defined(ESP8266)
     WiFi.setSleepMode(WIFI_NONE_SLEEP);
 #endif
@@ -84,11 +90,18 @@ void setup()
     WiFi.setAutoReconnect(true);
 
     myNet.begin(espnowNetName.c_str(), true);
+    // myNet.setCryptKey("VERY_LONG_CRYPT_KEY"); // If encryption is used, the key must be set same of all another ESP-NOW devices in network.
 
     myNet.setOnBroadcastReceivingCallback(onEspnowMessage);
     myNet.setOnUnicastReceivingCallback(onEspnowMessage);
 
-    WiFi.softAP(("ESP-NOW Gateway " + myNet.getNodeMac()).c_str(), "12345678");
+#if defined(ESP8266)
+    WiFi.softAP(("ESP-NOW gateway " + String(ESP.getChipId(), HEX)).c_str(), "12345678");
+#endif
+#if defined(ESP32)
+    WiFi.softAP(("ESP-NOW gateway " + String(ESP.getEfuseMac(), HEX)).c_str(), "12345678");
+#endif
+
     uint8_t scan = WiFi.scanNetworks(false, false, 1);
     String name;
     int32_t rssi;
@@ -157,6 +170,7 @@ void onEspnowMessage(const char *data, const uint8_t *sender)
     if (incomingData.payloadsType == ENPT_STATE)
         mqttClient.publish((topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/" + getValueName(incomingData.payloadsType)).c_str(), 2, true, incomingData.message);
     if (incomingData.payloadsType == ENPT_CONFIG)
+    {
         if (incomingData.deviceType == ENDT_SWITCH)
         {
             esp_now_payload_data_t configData;
@@ -164,25 +178,96 @@ void onEspnowMessage(const char *data, const uint8_t *sender)
             StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
             deserializeJson(json, configData.message);
             uint8_t unit = json["unit"].as<uint8_t>();
-            String type = json["type"];
+            ha_component_type_t type = json["type"].as<ha_component_type_t>();
-            StaticJsonDocument<1024> jsonConfig;
+            StaticJsonDocument<2048> jsonConfig;
             jsonConfig["platform"] = "mqtt";
             jsonConfig["name"] = json["name"];
             jsonConfig["unique_id"] = myNet.macToString(sender) + "-" + unit;
-            jsonConfig["device_class"] = json["class"];
+            jsonConfig["device_class"] = getValueName(json["class"].as<ha_switch_device_class_t>());
             jsonConfig["state_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/state";
-            jsonConfig["value_template"] = "{{ value_json.state }}";
+            jsonConfig["value_template"] = "{{ value_json." + json["template"].as<String>() + " }}";
             jsonConfig["command_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/set";
             jsonConfig["json_attributes_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/attributes";
             jsonConfig["availability_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/status";
-            jsonConfig["payload_on"] = json["reverse"] == "true" ? "OFF" : "ON";
+            jsonConfig["payload_on"] = json["payload_on"];
-            jsonConfig["payload_off"] = json["reverse"] == "true" ? "ON" : "OFF";
+            jsonConfig["payload_off"] = json["payload_off"];
             jsonConfig["optimistic"] = "false";
             jsonConfig["qos"] = 2;
             jsonConfig["retain"] = "true";
-            char buffer[1024]{0};
+            char buffer[2048]{0};
             serializeJsonPretty(jsonConfig, buffer);
-            mqttClient.publish((topicPrefix + "/" + type + "/" + myNet.macToString(sender) + "-" + unit + "/config").c_str(), 2, true, buffer);
+            mqttClient.publish((topicPrefix + "/" + getValueName(type) + "/" + myNet.macToString(sender) + "-" + unit + "/config").c_str(), 2, true, buffer);
+        }
+        if (incomingData.deviceType == ENDT_LED)
+        {
+            esp_now_payload_data_t configData;
+            memcpy(&configData.message, &incomingData.message, sizeof(esp_now_payload_data_t::message));
+            StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
+            deserializeJson(json, configData.message);
+            uint8_t unit = json["unit"].as<uint8_t>();
+            ha_component_type_t type = json["type"].as<ha_component_type_t>();
+            esp_now_led_type_t ledClass = json["class"];
+            StaticJsonDocument<2048> jsonConfig;
+            jsonConfig["platform"] = "mqtt";
+            jsonConfig["name"] = json["name"];
+            jsonConfig["unique_id"] = myNet.macToString(sender) + "-" + unit;
+            jsonConfig["state_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/state";
+            jsonConfig["state_value_template"] = "{{ value_json.state }}";
+            jsonConfig["command_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/set";
+            jsonConfig["brightness_state_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/state";
+            jsonConfig["brightness_value_template"] = "{{ value_json.brightness }}";
+            jsonConfig["brightness_command_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/brightness";
+            if (ledClass == ENLT_RGB || ledClass == ENLT_RGBW || ledClass == ENLT_RGBWW)
+            {
+                jsonConfig["rgb_state_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/state";
+                jsonConfig["rgb_value_template"] = "{{ value_json.rgb | join(',') }}";
+                jsonConfig["rgb_command_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/rgb";
+            }
+            if (ledClass == ENLT_WW || ledClass == ENLT_RGBWW)
+            {
+                jsonConfig["color_temp_state_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/state";
+                jsonConfig["color_temp_value_template"] = "{{ value_json.temperature }}";
+                jsonConfig["color_temp_command_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/temperature";
+            }
+            jsonConfig["json_attributes_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/attributes";
+            jsonConfig["availability_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/status";
+            jsonConfig["payload_on"] = json["payload_on"];
+            jsonConfig["payload_off"] = json["payload_off"];
+            jsonConfig["optimistic"] = "false";
+            jsonConfig["qos"] = 2;
+            jsonConfig["retain"] = "true";
+            char buffer[2048]{0};
+            serializeJsonPretty(jsonConfig, buffer);
+            mqttClient.publish((topicPrefix + "/" + getValueName(type) + "/" + myNet.macToString(sender) + "-" + unit + "/config").c_str(), 2, true, buffer);
+        }
+        if (incomingData.deviceType == ENDT_SENSOR)
+        {
+            esp_now_payload_data_t configData;
+            memcpy(&configData.message, &incomingData.message, sizeof(esp_now_payload_data_t::message));
+            StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
+            deserializeJson(json, configData.message);
+            uint8_t unit = json["unit"].as<uint8_t>();
+            ha_component_type_t type = json["type"].as<ha_component_type_t>();
+            StaticJsonDocument<2048> jsonConfig;
+            jsonConfig["platform"] = "mqtt";
+            jsonConfig["name"] = json["name"];
+            jsonConfig["unique_id"] = myNet.macToString(sender) + "-" + unit;
+            jsonConfig["state_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/state";
+            jsonConfig["value_template"] = "{{ value_json." + json["template"].as<String>() + " }}";
+            jsonConfig["json_attributes_topic"] = topicPrefix + "/" + getValueName(incomingData.deviceType) + "/" + myNet.macToString(sender) + "/attributes";
+            jsonConfig["force_update"] = "true";
+            jsonConfig["qos"] = 2;
+            jsonConfig["retain"] = "true";
+            if (type == HACT_BINARY_SENSOR)
+            {
+                jsonConfig["device_class"] = getValueName(json["class"].as<ha_binary_sensor_device_class_t>());
+                jsonConfig["payload_on"] = json["payload_on"];
+                jsonConfig["payload_off"] = json["payload_off"];
+            }
+            char buffer[2048]{0};
+            serializeJsonPretty(jsonConfig, buffer);
+            mqttClient.publish((topicPrefix + "/" + getValueName(type) + "/" + myNet.macToString(sender) + "-" + unit + "/config").c_str(), 2, true, buffer);
+        }
     }
     if (incomingData.payloadsType == ENPT_FORWARD)
     {
@@ -251,7 +336,7 @@ void onMqttMessage(char *topic, char *payload, AsyncMqttClientMessageProperties
     if (String(topic) == topicPrefix + "/espnow_switch/" + mac + "/set" || String(topic) == topicPrefix + "/espnow_led/" + mac + "/set")
     {
         flag = true;
-        json["set"] = message == "ON" ? "ON" : "OFF";
+        json["set"] = message;
     }
     if (String(topic) == topicPrefix + "/espnow_led/" + mac + "/brightness")
     {
@@ -295,6 +380,7 @@ void sendKeepAliveMessage()
     outgoingData.payloadsType = ENPT_KEEP_ALIVE;
     StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
     json["MQTT"] = mqttClient.connected() ? "online" : "offline";
+    json["frequency"] = 10; // For compatibility with the previous version. Will be removed in future releases.
     char buffer[sizeof(esp_now_payload_data_t::message)]{0};
     serializeJsonPretty(json, buffer);
     memcpy(&outgoingData.message, &buffer, sizeof(esp_now_payload_data_t::message));
@@ -311,7 +397,7 @@ void sendAttributesMessage()
     uint32_t hours = mins / 60;
     uint32_t days = hours / 24;
     StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
-    json["Type"] = "ESP-NOW Gateway";
+    json["Type"] = "ESP-NOW gateway";
 #if defined(ESP8266)
     json["MCU"] = "ESP8266";
 #endif
@@ -404,7 +490,7 @@ void setupWebServer()
         ssdpDescription += xmlNode("friendlyName", deviceName);
         ssdpDescription += xmlNode("presentationURL", "/");
         ssdpDescription += xmlNode("serialNumber", "0000000" + String(random(1000)));
-        ssdpDescription += xmlNode("modelName", "ESP-NOW Gateway");
+        ssdpDescription += xmlNode("modelName", "ESP-NOW gateway");
         ssdpDescription += xmlNode("modelNumber", firmware);
         ssdpDescription += xmlNode("modelURL", "https://github.com/aZholtikov/ESP-NOW-Gateway");
         ssdpDescription += xmlNode("manufacturer", "Alexey Zholtikov");