12 Commits
v1.11 ... v1.2

Author SHA1 Message Date
00576355ff Fixed one bug 2023-02-26 14:20:48 +03:00
17db726612 Changed SDK version for 3.0.5 2023-02-26 09:33:13 +03:00
6fffb45489 Version 1.2
Minimized of config message size.
2023-02-25 14:40:32 +03:00
3347c4d097 Minor changes 2023-02-19 09:25:22 +03:00
ed42021c9b Version 1.15
Minor changes.
2023-02-12 18:42:57 +03:00
02b8326b80 Minor changes 2023-02-11 08:42:57 +03:00
0795911f7a Minor changes 2023-02-09 21:28:56 +03:00
dc9f08e82c Version 1.14
Changed FS from SPIFFS to LittleFS.
2023-02-04 10:57:34 +03:00
4d8146e64b Changed FS from SPIFFS to LittleFS 2023-02-02 20:31:16 +03:00
39a13599c3 Minor changes 2023-01-28 14:52:38 +03:00
bcda1c9ea5 Version 1.13
Added encrypting messages.
2023-01-22 12:38:53 +03:00
7f51f05eb8 Version 1.12
Main code refactoring.
2023-01-14 10:57:25 +03:00
3 changed files with 92 additions and 95 deletions

View File

@ -4,7 +4,7 @@ ESP-NOW based light/led strip controller for ESP8266. Alternate firmware for Tuy
## Features ## Features
1. After turn on (or after rebooting) creates an access point named "ESP-NOW Light XXXXXXXXXXXX" with password "12345678" (IP 192.168.4.1). Access point will be shown during 5 minutes. The rest of the time access point is a hidden. 1. After turn on (or after rebooting) creates an access point named "ESP-NOW light XXXXXXXXXXXX" with password "12345678" (IP 192.168.4.1). Access point will be shown during 5 minutes. The rest of the time access point is a hidden.
2. Periodically transmission of system information (every 60 seconds), availability status (every 10 seconds) and state status (every 300 seconds) to the gateway. 2. Periodically transmission of system information (every 60 seconds), availability status (every 10 seconds) and state status (every 300 seconds) to the gateway.
3. Saves the last state when the power is turned off. Goes to the last state when the power is turned on. 3. Saves the last state when the power is turned off. Goes to the last state when the power is turned on.
4. Automatically adds light/led strip configuration to Home Assistan via MQTT discovery as a light. 4. Automatically adds light/led strip configuration to Home Assistan via MQTT discovery as a light.
@ -25,5 +25,8 @@ See [here](https://github.com/aZholtikov/ESP-NOW-Light-Led-Strip/tree/main/hardw
1. A gateway is required. For details see [ESP-NOW Gateway](https://github.com/aZholtikov/ESP-NOW-Gateway). 1. A gateway is required. For details see [ESP-NOW Gateway](https://github.com/aZholtikov/ESP-NOW-Gateway).
2. ESP-NOW network name must be set same of all another ESP-NOW devices in network. 2. ESP-NOW network name must be set same of all another ESP-NOW devices in network.
3. Upload the "data" folder (with web interface) into the filesystem before flashing. 3. If encryption is used, the key must be set same of all another ESP-NOW devices in network.
4. For using this firmware on Tuya/SmartLife WiFi light/led strip controllers, the WiFi module must be replaced with an ESP8266 compatible module (if necessary). 4. Upload the "data" folder (with web interface) into the filesystem before flashing.
5. For using this firmware on Tuya/SmartLife WiFi light/led strip controllers, the WiFi module must be replaced with an ESP8266 compatible module (if necessary).
Any feedback via [e-mail](mailto:github@zh.com.ru) would be appreciated. Or... [Buy me a coffee](https://paypal.me/aZholtikov).

View File

@ -2,20 +2,26 @@
platform = espressif8266 platform = espressif8266
board = esp12e board = esp12e
framework = arduino framework = arduino
build_flags = -D PIO_FRAMEWORK_ARDUINO_ESPRESSIF_SDK305
board_build.filesystem = littlefs
board_build.ldscript = eagle.flash.4m1m.ld
lib_deps = lib_deps =
https://github.com/aZholtikov/ZHNetwork https://github.com/aZholtikov/ZHNetwork
https://github.com/aZholtikov/ZHConfig https://github.com/aZholtikov/ZHConfig
bblanchon/ArduinoJson@^6.19.4 https://github.com/aZholtikov/Async-Web-Server
me-no-dev/ESP Async WebServer@^1.2.3 https://github.com/bblanchon/ArduinoJson
[env:ESP-12E-OTA] [env:ESP-12E-OTA]
platform = espressif8266 platform = espressif8266
board = esp12e board = esp12e
framework = arduino framework = arduino
build_flags = -D PIO_FRAMEWORK_ARDUINO_ESPRESSIF_SDK305
board_build.filesystem = littlefs
board_build.ldscript = eagle.flash.4m1m.ld
upload_port = 192.168.4.1 upload_port = 192.168.4.1
upload_protocol = espota upload_protocol = espota
lib_deps = lib_deps =
https://github.com/aZholtikov/ZHNetwork https://github.com/aZholtikov/ZHNetwork
https://github.com/aZholtikov/ZHConfig https://github.com/aZholtikov/ZHConfig
bblanchon/ArduinoJson@^6.19.4 https://github.com/aZholtikov/Async-Web-Server
me-no-dev/ESP Async WebServer@^1.2.3 https://github.com/bblanchon/ArduinoJson

View File

@ -1,13 +1,14 @@
#include "ArduinoJson.h" #include "ArduinoJson.h"
#include "ArduinoOTA.h" #include "ArduinoOTA.h"
#include "ESPAsyncWebServer.h" #include "ESPAsyncWebServer.h" // https://github.com/aZholtikov/Async-Web-Server
#include "LittleFS.h"
#include "Ticker.h" #include "Ticker.h"
#include "ZHNetwork.h" #include "ZHNetwork.h"
#include "ZHConfig.h" #include "ZHConfig.h"
void onBroadcastReceiving(const char *data, const uint8_t *sender); void onBroadcastReceiving(const char *data, const uint8_t *sender);
void onUnicastReceiving(const char *data, const uint8_t *sender); void onUnicastReceiving(const char *data, const uint8_t *sender);
void onConfirmReceiving(const uint8_t *target, const bool status); void onConfirmReceiving(const uint8_t *target, const uint16_t id, const bool status);
void loadConfig(void); void loadConfig(void);
void saveConfig(void); void saveConfig(void);
@ -18,24 +19,32 @@ void sendKeepAliveMessage(void);
void sendConfigMessage(void); void sendConfigMessage(void);
void sendStatusMessage(void); void sendStatusMessage(void);
String getValue(String data, char separator, byte index); String getValue(String data, char separator, uint8_t index);
void changeLedState(void); void changeLedState(void);
const String firmware{"1.11"}; typedef struct
{
uint16_t id{0};
char message[200]{0};
} espnow_message_t;
std::vector<espnow_message_t> espnowMessage;
const String firmware{"1.2"};
String espnowNetName{"DEFAULT"}; String espnowNetName{"DEFAULT"};
String deviceName = "ESP-NOW light " + String(ESP.getChipId(), HEX); String deviceName = "ESP-NOW light " + String(ESP.getChipId(), HEX);
uint8_t ledType{ENLT_NONE}; uint8_t ledType{ENLT_NONE};
bool ledStatus{false};
uint8_t coldWhitePin{0}; uint8_t coldWhitePin{0};
uint8_t warmWhitePin{0}; uint8_t warmWhitePin{0};
uint8_t redPin{0}; uint8_t redPin{0};
uint8_t greenPin{0}; uint8_t greenPin{0};
uint8_t bluePin{0}; uint8_t bluePin{0};
bool ledStatus{false};
uint8_t brightness{255}; uint8_t brightness{255};
uint16_t temperature{255}; uint16_t temperature{255};
uint8_t red{255}; uint8_t red{255};
@ -46,9 +55,6 @@ bool wasMqttAvailable{false};
uint8_t gatewayMAC[6]{0}; uint8_t gatewayMAC[6]{0};
const String payloadOn{"ON"};
const String payloadOff{"OFF"};
ZHNetwork myNet; ZHNetwork myNet;
AsyncWebServer webServer(80); AsyncWebServer webServer(80);
@ -62,29 +68,20 @@ void apModeHideTimerCallback(void);
Ticker attributesMessageTimer; Ticker attributesMessageTimer;
bool attributesMessageTimerSemaphore{true}; bool attributesMessageTimerSemaphore{true};
void attributesMessageTimerCallback(void); void attributesMessageTimerCallback(void);
Ticker attributesMessageResendTimer;
bool attributesMessageResendTimerSemaphore{false};
Ticker keepAliveMessageTimer; Ticker keepAliveMessageTimer;
bool keepAliveMessageTimerSemaphore{true}; bool keepAliveMessageTimerSemaphore{true};
void keepAliveMessageTimerCallback(void); void keepAliveMessageTimerCallback(void);
Ticker keepAliveMessageResendTimer;
bool keepAliveMessageResendTimerSemaphore{false};
Ticker configMessageResendTimer;
bool configMessageResendTimerSemaphore{false};
Ticker statusMessageTimer; Ticker statusMessageTimer;
bool statusMessageTimerSemaphore{true}; bool statusMessageTimerSemaphore{true};
void statusMessageTimerCallback(void); void statusMessageTimerCallback(void);
Ticker statusMessageResendTimer;
bool statusMessageResendTimerSemaphore{false};
void setup() void setup()
{ {
analogWriteRange(255); analogWriteRange(255);
SPIFFS.begin(); LittleFS.begin();
loadConfig(); loadConfig();
@ -103,6 +100,7 @@ void setup()
WiFi.setSleepMode(WIFI_NONE_SLEEP); WiFi.setSleepMode(WIFI_NONE_SLEEP);
myNet.begin(espnowNetName.c_str()); myNet.begin(espnowNetName.c_str());
// 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(onBroadcastReceiving); myNet.setOnBroadcastReceivingCallback(onBroadcastReceiving);
myNet.setOnUnicastReceivingCallback(onUnicastReceiving); myNet.setOnUnicastReceivingCallback(onUnicastReceiving);
@ -133,14 +131,14 @@ void loop()
ArduinoOTA.handle(); ArduinoOTA.handle();
} }
void onBroadcastReceiving(const char *data, const byte *sender) void onBroadcastReceiving(const char *data, const uint8_t *sender)
{ {
esp_now_payload_data_t incomingData; esp_now_payload_data_t incomingData;
memcpy(&incomingData, data, sizeof(esp_now_payload_data_t)); memcpy(&incomingData, data, sizeof(esp_now_payload_data_t));
if (incomingData.deviceType != ENDT_GATEWAY) if (incomingData.deviceType != ENDT_GATEWAY)
return; return;
if (myNet.macToString(gatewayMAC) != myNet.macToString(sender) && incomingData.payloadsType == ENPT_KEEP_ALIVE) if (myNet.macToString(gatewayMAC) != myNet.macToString(sender) && incomingData.payloadsType == ENPT_KEEP_ALIVE)
memcpy(gatewayMAC, sender, 6); memcpy(&gatewayMAC, sender, 6);
if (myNet.macToString(gatewayMAC) == myNet.macToString(sender) && incomingData.payloadsType == ENPT_KEEP_ALIVE) if (myNet.macToString(gatewayMAC) == myNet.macToString(sender) && incomingData.payloadsType == ENPT_KEEP_ALIVE)
{ {
isGatewayAvailable = true; isGatewayAvailable = true;
@ -151,13 +149,17 @@ void onBroadcastReceiving(const char *data, const byte *sender)
{ {
wasMqttAvailable = temp; wasMqttAvailable = temp;
if (temp) if (temp)
{
sendConfigMessage(); sendConfigMessage();
sendAttributesMessage();
sendStatusMessage();
}
} }
gatewayAvailabilityCheckTimer.once(15, gatewayAvailabilityCheckTimerCallback); gatewayAvailabilityCheckTimer.once(15, gatewayAvailabilityCheckTimerCallback);
} }
} }
void onUnicastReceiving(const char *data, const byte *sender) void onUnicastReceiving(const char *data, const uint8_t *sender)
{ {
esp_now_payload_data_t incomingData; esp_now_payload_data_t incomingData;
memcpy(&incomingData, data, sizeof(esp_now_payload_data_t)); memcpy(&incomingData, data, sizeof(esp_now_payload_data_t));
@ -168,7 +170,7 @@ void onUnicastReceiving(const char *data, const byte *sender)
{ {
deserializeJson(json, incomingData.message); deserializeJson(json, incomingData.message);
if (json["set"]) if (json["set"])
ledStatus = json["set"] == payloadOn ? true : false; ledStatus = json["set"] == "ON" ? true : false;
if (json["brightness"]) if (json["brightness"])
brightness = json["brightness"]; brightness = json["brightness"];
if (json["temperature"]) if (json["temperature"])
@ -192,38 +194,30 @@ void onUnicastReceiving(const char *data, const byte *sender)
ESP.restart(); ESP.restart();
} }
void onConfirmReceiving(const uint8_t *target, const bool status) void onConfirmReceiving(const uint8_t *target, const uint16_t id, const bool status)
{ {
if (status) for (uint16_t i{0}; i < espnowMessage.size(); ++i)
{ {
if (attributesMessageResendTimerSemaphore) espnow_message_t message = espnowMessage[i];
if (message.id == id)
{ {
attributesMessageResendTimerSemaphore = false; if (status)
attributesMessageResendTimer.detach(); espnowMessage.erase(espnowMessage.begin() + i);
} else
if (keepAliveMessageResendTimerSemaphore) {
{ message.id = myNet.sendUnicastMessage(message.message, gatewayMAC, true);
keepAliveMessageResendTimerSemaphore = false; espnowMessage.at(i) = message;
keepAliveMessageResendTimer.detach(); }
}
if (configMessageResendTimerSemaphore)
{
configMessageResendTimerSemaphore = false;
configMessageResendTimer.detach();
}
if (statusMessageResendTimerSemaphore)
{
statusMessageResendTimerSemaphore = false;
statusMessageResendTimer.detach();
} }
} }
} }
void loadConfig() void loadConfig()
{ {
if (!SPIFFS.exists("/config.json")) ETS_GPIO_INTR_DISABLE();
if (!LittleFS.exists("/config.json"))
saveConfig(); saveConfig();
File file = SPIFFS.open("/config.json", "r"); File file = LittleFS.open("/config.json", "r");
String jsonFile = file.readString(); String jsonFile = file.readString();
StaticJsonDocument<512> json; StaticJsonDocument<512> json;
deserializeJson(json, jsonFile); deserializeJson(json, jsonFile);
@ -242,10 +236,13 @@ void loadConfig()
green = json["green"]; green = json["green"];
blue = json["blue"]; blue = json["blue"];
file.close(); file.close();
delay(50);
ETS_GPIO_INTR_ENABLE();
} }
void saveConfig() void saveConfig()
{ {
ETS_GPIO_INTR_DISABLE();
StaticJsonDocument<512> json; StaticJsonDocument<512> json;
json["firmware"] = firmware; json["firmware"] = firmware;
json["espnowNetName"] = espnowNetName; json["espnowNetName"] = espnowNetName;
@ -263,15 +260,17 @@ void saveConfig()
json["green"] = green; json["green"] = green;
json["blue"] = blue; json["blue"] = blue;
json["system"] = "empty"; json["system"] = "empty";
File file = SPIFFS.open("/config.json", "w"); File file = LittleFS.open("/config.json", "w");
serializeJsonPretty(json, file); serializeJsonPretty(json, file);
file.close(); file.close();
delay(50);
ETS_GPIO_INTR_ENABLE();
} }
void setupWebServer() void setupWebServer()
{ {
webServer.on("/", HTTP_GET, [](AsyncWebServerRequest *request) webServer.on("/", HTTP_GET, [](AsyncWebServerRequest *request)
{ request->send(SPIFFS, "/index.htm"); }); { request->send(LittleFS, "/index.htm"); });
webServer.on("/setting", HTTP_GET, [](AsyncWebServerRequest *request) webServer.on("/setting", HTTP_GET, [](AsyncWebServerRequest *request)
{ {
@ -293,8 +292,8 @@ void setupWebServer()
webServer.onNotFound([](AsyncWebServerRequest *request) webServer.onNotFound([](AsyncWebServerRequest *request)
{ {
if (SPIFFS.exists(request->url())) if (LittleFS.exists(request->url()))
request->send(SPIFFS, request->url()); request->send(LittleFS, request->url());
else else
{ {
request->send(404, "text/plain", "File Not Found"); request->send(404, "text/plain", "File Not Found");
@ -313,6 +312,7 @@ void sendAttributesMessage()
uint32_t hours = mins / 60; uint32_t hours = mins / 60;
uint32_t days = hours / 24; uint32_t days = hours / 24;
esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_ATTRIBUTES}; esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_ATTRIBUTES};
espnow_message_t message;
StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json; StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
json["Type"] = "ESP-NOW light"; json["Type"] = "ESP-NOW light";
json["MCU"] = "ESP8266"; json["MCU"] = "ESP8266";
@ -320,15 +320,11 @@ void sendAttributesMessage()
json["Firmware"] = firmware; json["Firmware"] = firmware;
json["Library"] = myNet.getFirmwareVersion(); json["Library"] = myNet.getFirmwareVersion();
json["Uptime"] = "Days:" + String(days) + " Hours:" + String(hours - (days * 24)) + " Mins:" + String(mins - (hours * 60)); json["Uptime"] = "Days:" + String(days) + " Hours:" + String(hours - (days * 24)) + " Mins:" + String(mins - (hours * 60));
char buffer[sizeof(esp_now_payload_data_t::message)]{0}; serializeJsonPretty(json, outgoingData.message);
serializeJsonPretty(json, buffer); memcpy(&message.message, &outgoingData, sizeof(esp_now_payload_data_t));
memcpy(outgoingData.message, buffer, sizeof(esp_now_payload_data_t::message)); message.id = myNet.sendUnicastMessage(message.message, gatewayMAC, true);
char temp[sizeof(esp_now_payload_data_t)]{0};
memcpy(&temp, &outgoingData, sizeof(esp_now_payload_data_t));
myNet.sendUnicastMessage(temp, gatewayMAC, true);
attributesMessageResendTimerSemaphore = true; espnowMessage.push_back(message);
attributesMessageResendTimer.once(1, sendAttributesMessage);
} }
void sendKeepAliveMessage() void sendKeepAliveMessage()
@ -337,12 +333,11 @@ void sendKeepAliveMessage()
return; return;
keepAliveMessageTimerSemaphore = false; keepAliveMessageTimerSemaphore = false;
esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_KEEP_ALIVE}; esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_KEEP_ALIVE};
char temp[sizeof(esp_now_payload_data_t)]{0}; espnow_message_t message;
memcpy(&temp, &outgoingData, sizeof(esp_now_payload_data_t)); memcpy(&message.message, &outgoingData, sizeof(esp_now_payload_data_t));
myNet.sendUnicastMessage(temp, gatewayMAC, true); message.id = myNet.sendUnicastMessage(message.message, gatewayMAC, true);
keepAliveMessageResendTimerSemaphore = true; espnowMessage.push_back(message);
keepAliveMessageResendTimer.once(1, sendKeepAliveMessage);
} }
void sendConfigMessage() void sendConfigMessage()
@ -350,22 +345,17 @@ void sendConfigMessage()
if (!isGatewayAvailable) if (!isGatewayAvailable)
return; return;
esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_CONFIG}; esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_CONFIG};
espnow_message_t message;
StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json; StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
json["name"] = deviceName; json[MCMT_DEVICE_NAME] = deviceName;
json["unit"] = 1; json[MCMT_DEVICE_UNIT] = 1;
json["type"] = HACT_LIGHT; json[MCMT_COMPONENT_TYPE] = HACT_LIGHT;
json["class"] = ledType; json[MCMT_DEVICE_CLASS] = ledType;
json["payload_on"] = payloadOn; serializeJsonPretty(json, outgoingData.message);
json["payload_off"] = payloadOff; memcpy(&message.message, &outgoingData, sizeof(esp_now_payload_data_t));
char buffer[sizeof(esp_now_payload_data_t::message)]{0}; message.id = myNet.sendUnicastMessage(message.message, gatewayMAC, true);
serializeJsonPretty(json, buffer);
memcpy(outgoingData.message, buffer, sizeof(esp_now_payload_data_t::message));
char temp[sizeof(esp_now_payload_data_t)]{0};
memcpy(&temp, &outgoingData, sizeof(esp_now_payload_data_t));
myNet.sendUnicastMessage(temp, gatewayMAC, true);
configMessageResendTimerSemaphore = true; espnowMessage.push_back(message);
configMessageResendTimer.once(1, sendConfigMessage);
} }
void sendStatusMessage() void sendStatusMessage()
@ -374,28 +364,25 @@ void sendStatusMessage()
return; return;
statusMessageTimerSemaphore = false; statusMessageTimerSemaphore = false;
esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_STATE}; esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_STATE};
espnow_message_t message;
StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json; StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
json["state"] = ledStatus ? payloadOn : payloadOff; json["state"] = ledStatus ? "ON" : "OFF";
json["brightness"] = brightness; json["brightness"] = brightness;
json["temperature"] = temperature; json["temperature"] = temperature;
json["rgb"] = String(red) + "," + String(green) + "," + String(blue); json["rgb"] = String(red) + "," + String(green) + "," + String(blue);
char buffer[sizeof(esp_now_payload_data_t::message)]{0}; serializeJsonPretty(json, outgoingData.message);
serializeJsonPretty(json, buffer); memcpy(&message.message, &outgoingData, sizeof(esp_now_payload_data_t));
memcpy(&outgoingData.message, &buffer, sizeof(esp_now_payload_data_t::message)); message.id = myNet.sendUnicastMessage(message.message, gatewayMAC, true);
char temp[sizeof(esp_now_payload_data_t)]{0};
memcpy(&temp, &outgoingData, sizeof(esp_now_payload_data_t));
myNet.sendUnicastMessage(temp, gatewayMAC, true);
statusMessageResendTimerSemaphore = true; espnowMessage.push_back(message);
statusMessageResendTimer.once(1, sendStatusMessage);
} }
String getValue(String data, char separator, byte index) String getValue(String data, char separator, uint8_t index)
{ {
byte found{0}; uint8_t found{0};
int strIndex[]{0, -1}; int strIndex[]{0, -1};
int maxIndex = data.length() - 1; int maxIndex = data.length() - 1;
for (byte i{0}; i <= maxIndex && found <= index; i++) for (uint8_t i{0}; i <= maxIndex && found <= index; i++)
if (data.charAt(i) == separator || i == maxIndex) if (data.charAt(i) == separator || i == maxIndex)
{ {
found++; found++;
@ -471,7 +458,8 @@ void changeLedState(void)
void gatewayAvailabilityCheckTimerCallback() void gatewayAvailabilityCheckTimerCallback()
{ {
isGatewayAvailable = false; isGatewayAvailable = false;
memset(gatewayMAC, 0, 6); memset(&gatewayMAC, 0, 6);
espnowMessage.clear();
} }
void apModeHideTimerCallback() void apModeHideTimerCallback()