Minor changes

Fixed one bug
Version 1.21
2023-03-07 11:58:34 +03:00 · 2023-03-06 00:44:59 +03:00 · 2023-03-05 07:53:22 +03:00 · 2023-03-04 08:13:12 +03:00 · 2023-02-26 14:20:48 +03:00 · 2023-02-26 09:33:13 +03:00
5 changed files with 161 additions and 119 deletions
--- a/README.md
+++ b/README.md
@ -1,4 +1,4 @@
-# Light/led strip controller for ESP8266
+# ESP-NOW light/led strip controller for ESP8266

 ESP-NOW based light/led strip controller for ESP8266. Alternate firmware for Tuya/SmartLife WiFi light/led strip controllers.

@ -28,3 +28,5 @@ See [here](https://github.com/aZholtikov/ESP-NOW-Light-Led-Strip/tree/main/hardw
 3. If encryption is used, the key must be set same of all another ESP-NOW devices in network.
 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).
--- a/data/function.js
+++ b/data/function.js
@ -10,7 +10,7 @@ function createXmlHttpObject() {

 function load() {
    if (xmlHttp.readyState == 0 || xmlHttp.readyState == 4) {
-        xmlHttp.open('PUT', '/config.json', true);
+        xmlHttp.open('GET', '/config', true);
        xmlHttp.send(null);
        xmlHttp.onload = function () {
            jsonResponse = JSON.parse(xmlHttp.responseText);
--- a/data/index.htm
+++ b/data/index.htm
@ -10,7 +10,7 @@

 <body onload="load();">
    <form class="box">
-        <h1>ESP-NOW Light </h1>
+        <h1>ESP-NOW Light</h1>
        <div class="wrapper">
            <p class="text">Firmware:</p>
            <p class="text" id="version"></p>
--- a/platformio.ini
+++ b/platformio.ini
@ -2,8 +2,9 @@
 platform = espressif8266
 board = esp12e
 framework = arduino
+build_flags = -D PIO_FRAMEWORK_ARDUINO_ESPRESSIF_SDK305
 board_build.filesystem = littlefs
-board_build.ldscript = eagle.flash.4m2m.ld
+board_build.ldscript = eagle.flash.4m1m.ld
 lib_deps = 
 	https://github.com/aZholtikov/ZHNetwork
 	https://github.com/aZholtikov/ZHConfig
@ -14,8 +15,9 @@ lib_deps =
 platform = espressif8266
 board = esp12e
 framework = arduino
+build_flags = -D PIO_FRAMEWORK_ARDUINO_ESPRESSIF_SDK305
 board_build.filesystem = littlefs
-board_build.ldscript = eagle.flash.4m2m.ld
+board_build.ldscript = eagle.flash.4m1m.ld
 upload_port = 192.168.4.1
 upload_protocol = espota
 lib_deps = 
--- a/src/main.cpp
+++ b/src/main.cpp
@ -2,6 +2,7 @@
 #include "ArduinoOTA.h"
 #include "ESPAsyncWebServer.h" // https://github.com/aZholtikov/Async-Web-Server
 #include "LittleFS.h"
+#include "EEPROM.h"
 #include "Ticker.h"
 #include "ZHNetwork.h"
 #include "ZHConfig.h"
@ -12,6 +13,8 @@ void onConfirmReceiving(const uint8_t *target, const uint16_t id, const bool sta

 void loadConfig(void);
 void saveConfig(void);
+void loadStatus(void);
+void saveStatus(void);
 void setupWebServer(void);

 void sendAttributesMessage(void);
@ -29,22 +32,23 @@ typedef struct
  char message[200]{0};
 } espnow_message_t;

+struct deviceConfig
+{
+  String espnowNetName{"DEFAULT"};
+  String deviceName = "ESP-NOW light " + String(ESP.getChipId(), HEX);
+  uint8_t ledType{ENLT_NONE};
+  uint8_t coldWhitePin{0};
+  uint8_t warmWhitePin{0};
+  uint8_t redPin{0};
+  uint8_t greenPin{0};
+  uint8_t bluePin{0};
+} config;
+
 std::vector<espnow_message_t> espnowMessage;

-const String firmware{"1.14"};
+const String firmware{"1.21"};

-String espnowNetName{"DEFAULT"};
-
-String deviceName = "ESP-NOW light " + String(ESP.getChipId(), HEX);
-
-uint8_t ledType{ENLT_NONE};
 bool ledStatus{false};
-uint8_t coldWhitePin{0};
-uint8_t warmWhitePin{0};
-uint8_t redPin{0};
-uint8_t greenPin{0};
-uint8_t bluePin{0};
-
 uint8_t brightness{255};
 uint16_t temperature{255};
 uint8_t red{255};
@ -55,9 +59,6 @@ bool wasMqttAvailable{false};

 uint8_t gatewayMAC[6]{0};

-const String payloadOn{"ON"};
-const String payloadOff{"OFF"};
-
 ZHNetwork myNet;
 AsyncWebServer webServer(80);

@ -87,22 +88,23 @@ void setup()
  LittleFS.begin();

  loadConfig();
+  loadStatus();

-  if (coldWhitePin)
-    pinMode(coldWhitePin, OUTPUT);
-  if (warmWhitePin)
-    pinMode(warmWhitePin, OUTPUT);
-  if (redPin)
-    pinMode(redPin, OUTPUT);
-  if (greenPin)
-    pinMode(greenPin, OUTPUT);
-  if (bluePin)
-    pinMode(bluePin, OUTPUT);
+  if (config.coldWhitePin)
+    pinMode(config.coldWhitePin, OUTPUT);
+  if (config.warmWhitePin)
+    pinMode(config.warmWhitePin, OUTPUT);
+  if (config.redPin)
+    pinMode(config.redPin, OUTPUT);
+  if (config.greenPin)
+    pinMode(config.greenPin, OUTPUT);
+  if (config.bluePin)
+    pinMode(config.bluePin, OUTPUT);

  changeLedState();

  WiFi.setSleepMode(WIFI_NONE_SLEEP);
-  myNet.begin(espnowNetName.c_str());
+  myNet.begin(config.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);
@ -145,14 +147,18 @@ void onBroadcastReceiving(const char *data, const uint8_t *sender)
  if (myNet.macToString(gatewayMAC) == myNet.macToString(sender) && incomingData.payloadsType == ENPT_KEEP_ALIVE)
  {
    isGatewayAvailable = true;
-    StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
+    DynamicJsonDocument json(sizeof(esp_now_payload_data_t::message));
    deserializeJson(json, incomingData.message);
    bool temp = json["MQTT"] == "online" ? true : false;
    if (wasMqttAvailable != temp)
    {
      wasMqttAvailable = temp;
      if (temp)
+      {
        sendConfigMessage();
+        sendAttributesMessage();
+        sendStatusMessage();
+      }
    }
    gatewayAvailabilityCheckTimer.once(15, gatewayAvailabilityCheckTimerCallback);
  }
@ -164,12 +170,12 @@ void onUnicastReceiving(const char *data, const uint8_t *sender)
  memcpy(&incomingData, data, sizeof(esp_now_payload_data_t));
  if (incomingData.deviceType != ENDT_GATEWAY || myNet.macToString(gatewayMAC) != myNet.macToString(sender))
    return;
-  StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
+  DynamicJsonDocument json(sizeof(esp_now_payload_data_t::message));
  if (incomingData.payloadsType == ENPT_SET)
  {
    deserializeJson(json, incomingData.message);
    if (json["set"])
-      ledStatus = json["set"] == payloadOn ? true : false;
+      ledStatus = json["set"] == "ON" ? true : false;
    if (json["brightness"])
      brightness = json["brightness"];
    if (json["temperature"])
@ -213,51 +219,69 @@ void onConfirmReceiving(const uint8_t *target, const uint16_t id, const bool sta

 void loadConfig()
 {
-  if (!LittleFS.exists("/config.json"))
+  ETS_GPIO_INTR_DISABLE();
+  EEPROM.begin(4096);
+  if (EEPROM.read(4095) == 254)
+  {
+    EEPROM.get(0, config);
+    EEPROM.end();
+  }
+  else
+  {
+    EEPROM.end();
    saveConfig();
-  File file = LittleFS.open("/config.json", "r");
+  }
+  delay(50);
+  ETS_GPIO_INTR_ENABLE();
+}
+
+void saveConfig()
+{
+  ETS_GPIO_INTR_DISABLE();
+  EEPROM.begin(4096);
+  EEPROM.write(4095, 254);
+  EEPROM.put(0, config);
+  EEPROM.end();
+  delay(50);
+  ETS_GPIO_INTR_ENABLE();
+}
+
+void loadStatus()
+{
+  ETS_GPIO_INTR_DISABLE();
+  if (!LittleFS.exists("/status.json"))
+    saveStatus();
+  File file = LittleFS.open("/status.json", "r");
  String jsonFile = file.readString();
-  StaticJsonDocument<512> json;
+  DynamicJsonDocument json(192); // To calculate the buffer size uses https://arduinojson.org/v6/assistant.
  deserializeJson(json, jsonFile);
-  espnowNetName = json["espnowNetName"].as<String>();
-  deviceName = json["deviceName"].as<String>();
-  ledType = json["ledType"];
-  ledStatus = json["ledStatus"];
-  coldWhitePin = json["coldWhitePin"];
-  warmWhitePin = json["warmWhitePin"];
-  redPin = json["redPin"];
-  greenPin = json["greenPin"];
-  bluePin = json["bluePin"];
+  ledStatus = json["status"];
  brightness = json["brightness"];
  temperature = json["temperature"];
  red = json["red"];
  green = json["green"];
  blue = json["blue"];
  file.close();
+  delay(50);
+  ETS_GPIO_INTR_ENABLE();
 }

-void saveConfig()
+void saveStatus()
 {
-  StaticJsonDocument<512> json;
-  json["firmware"] = firmware;
-  json["espnowNetName"] = espnowNetName;
-  json["deviceName"] = deviceName;
-  json["ledType"] = ledType;
-  json["ledStatus"] = ledStatus;
-  json["coldWhitePin"] = coldWhitePin;
-  json["warmWhitePin"] = warmWhitePin;
-  json["redPin"] = redPin;
-  json["greenPin"] = greenPin;
-  json["bluePin"] = bluePin;
+  ETS_GPIO_INTR_DISABLE();
+  DynamicJsonDocument json(128); // To calculate the buffer size uses https://arduinojson.org/v6/assistant.
+  json["status"] = ledStatus;
  json["brightness"] = brightness;
  json["temperature"] = temperature;
  json["red"] = red;
  json["green"] = green;
  json["blue"] = blue;
  json["system"] = "empty";
-  File file = LittleFS.open("/config.json", "w");
+  File file = LittleFS.open("/status.json", "w");
  serializeJsonPretty(json, file);
  file.close();
+  delay(50);
+  ETS_GPIO_INTR_ENABLE();
 }

 void setupWebServer()
@ -265,32 +289,48 @@ void setupWebServer()
  webServer.on("/", HTTP_GET, [](AsyncWebServerRequest *request)
               { request->send(LittleFS, "/index.htm"); });

+  webServer.on("/function.js", HTTP_GET, [](AsyncWebServerRequest *request)
+               { request->send(LittleFS, "/function.js"); });
+
+  webServer.on("/style.css", HTTP_GET, [](AsyncWebServerRequest *request)
+               { request->send(LittleFS, "/style.css"); });
+
  webServer.on("/setting", HTTP_GET, [](AsyncWebServerRequest *request)
               {
-        ledType = request->getParam("ledType")->value().toInt();
-        coldWhitePin = request->getParam("coldWhitePin")->value().toInt();
-        warmWhitePin = request->getParam("warmWhitePin")->value().toInt();
-        redPin = request->getParam("redPin")->value().toInt();
-        greenPin = request->getParam("greenPin")->value().toInt();
-        bluePin = request->getParam("bluePin")->value().toInt();
-        deviceName = request->getParam("deviceName")->value();
-        espnowNetName = request->getParam("espnowNetName")->value();
+        config.ledType = request->getParam("ledType")->value().toInt();
+        config.coldWhitePin = request->getParam("coldWhitePin")->value().toInt();
+        config.warmWhitePin = request->getParam("warmWhitePin")->value().toInt();
+        config.redPin = request->getParam("redPin")->value().toInt();
+        config.greenPin = request->getParam("greenPin")->value().toInt();
+        config.bluePin = request->getParam("bluePin")->value().toInt();
+        config.deviceName = request->getParam("deviceName")->value();
+        config.espnowNetName = request->getParam("espnowNetName")->value();
        request->send(200);
        saveConfig(); });

+  webServer.on("/config", HTTP_GET, [](AsyncWebServerRequest *request)
+               {
+        String configJson;
+        DynamicJsonDocument json(384); // To calculate the buffer size uses https://arduinojson.org/v6/assistant.
+        json["firmware"] = firmware;
+        json["espnowNetName"] = config.espnowNetName;
+        json["deviceName"] = config.deviceName;
+        json["ledType"] = config.ledType;
+        json["coldWhitePin"] = config.coldWhitePin;
+        json["warmWhitePin"] = config.warmWhitePin;
+        json["redPin"] = config.redPin;
+        json["greenPin"] = config.greenPin;
+        json["bluePin"] = config.bluePin;
+        serializeJsonPretty(json, configJson);
+        request->send(200, "application/json", configJson); });
+
  webServer.on("/restart", HTTP_GET, [](AsyncWebServerRequest *request)
               {
        request->send(200);
        ESP.restart(); });

  webServer.onNotFound([](AsyncWebServerRequest *request)
-                       { 
-        if (LittleFS.exists(request->url()))
-        request->send(LittleFS, request->url());
-        else
-        {
-        request->send(404, "text/plain", "File Not Found");
-        } });
+                       { request->send(404, "text/plain", "File Not Found"); });

  webServer.begin();
 }
@ -306,7 +346,7 @@ void sendAttributesMessage()
  uint32_t days = hours / 24;
  esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_ATTRIBUTES};
  espnow_message_t message;
-  StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
+  DynamicJsonDocument json(sizeof(esp_now_payload_data_t::message));
  json["Type"] = "ESP-NOW light";
  json["MCU"] = "ESP8266";
  json["MAC"] = myNet.getNodeMac();
@ -339,13 +379,11 @@ void sendConfigMessage()
    return;
  esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_CONFIG};
  espnow_message_t message;
-  StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
-  json["name"] = deviceName;
-  json["unit"] = 1;
-  json["type"] = HACT_LIGHT;
-  json["class"] = ledType;
-  json["payload_on"] = payloadOn;
-  json["payload_off"] = payloadOff;
+  DynamicJsonDocument json(sizeof(esp_now_payload_data_t::message));
+  json[MCMT_DEVICE_NAME] = config.deviceName;
+  json[MCMT_DEVICE_UNIT] = 1;
+  json[MCMT_COMPONENT_TYPE] = HACT_LIGHT;
+  json[MCMT_DEVICE_CLASS] = config.ledType;
  serializeJsonPretty(json, outgoingData.message);
  memcpy(&message.message, &outgoingData, sizeof(esp_now_payload_data_t));
  message.id = myNet.sendUnicastMessage(message.message, gatewayMAC, true);
@ -360,8 +398,8 @@ void sendStatusMessage()
  statusMessageTimerSemaphore = false;
  esp_now_payload_data_t outgoingData{ENDT_LED, ENPT_STATE};
  espnow_message_t message;
-  StaticJsonDocument<sizeof(esp_now_payload_data_t::message)> json;
-  json["state"] = ledStatus ? payloadOn : payloadOff;
+  DynamicJsonDocument json(sizeof(esp_now_payload_data_t::message));
+  json["state"] = ledStatus ? "ON" : "OFF";
  json["brightness"] = brightness;
  json["temperature"] = temperature;
  json["rgb"] = String(red) + "," + String(green) + "," + String(blue);
@ -393,61 +431,61 @@ void changeLedState(void)
  {
    if (red == 255 && green == 255 && blue == 255)
    {
-      if (ledType == ENLT_W || ledType == ENLT_RGBW)
-        analogWrite(coldWhitePin, brightness);
-      if (ledType == ENLT_WW || ledType == ENLT_RGBWW)
+      if (config.ledType == ENLT_W || config.ledType == ENLT_RGBW)
+        analogWrite(config.coldWhitePin, brightness);
+      if (config.ledType == ENLT_WW || config.ledType == ENLT_RGBWW)
      {
-        analogWrite(coldWhitePin, map(brightness, 0, 255, 0, map(temperature, 500, 153, 0, 255)));
-        analogWrite(warmWhitePin, map(brightness, 0, 255, 0, map(temperature, 153, 500, 0, 255)));
+        analogWrite(config.coldWhitePin, map(brightness, 0, 255, 0, map(temperature, 500, 153, 0, 255)));
+        analogWrite(config.warmWhitePin, map(brightness, 0, 255, 0, map(temperature, 153, 500, 0, 255)));
      }
-      if (ledType == ENLT_RGB)
+      if (config.ledType == ENLT_RGB)
      {
-        analogWrite(redPin, map(red, 0, 255, 0, brightness));
-        analogWrite(greenPin, map(green, 0, 255, 0, brightness));
-        analogWrite(bluePin, map(blue, 0, 255, 0, brightness));
+        analogWrite(config.redPin, map(red, 0, 255, 0, brightness));
+        analogWrite(config.greenPin, map(green, 0, 255, 0, brightness));
+        analogWrite(config.bluePin, map(blue, 0, 255, 0, brightness));
      }
-      if (ledType == ENLT_RGBW || ledType == ENLT_RGBWW)
+      if (config.ledType == ENLT_RGBW || config.ledType == ENLT_RGBWW)
      {
-        digitalWrite(redPin, LOW);
-        digitalWrite(greenPin, LOW);
-        digitalWrite(bluePin, LOW);
+        digitalWrite(config.redPin, LOW);
+        digitalWrite(config.greenPin, LOW);
+        digitalWrite(config.bluePin, LOW);
      }
    }
    else
    {
-      if (ledType == ENLT_W)
-        analogWrite(coldWhitePin, brightness);
-      if (ledType == ENLT_WW)
+      if (config.ledType == ENLT_W)
+        analogWrite(config.coldWhitePin, brightness);
+      if (config.ledType == ENLT_WW)
      {
-        analogWrite(coldWhitePin, map(brightness, 0, 255, 0, map(temperature, 500, 153, 0, 255)));
-        analogWrite(warmWhitePin, map(brightness, 0, 255, 0, map(temperature, 153, 500, 0, 255)));
+        analogWrite(config.coldWhitePin, map(brightness, 0, 255, 0, map(temperature, 500, 153, 0, 255)));
+        analogWrite(config.warmWhitePin, map(brightness, 0, 255, 0, map(temperature, 153, 500, 0, 255)));
      }
-      if (ledType == ENLT_RGBW || ledType == ENLT_RGBWW)
-        digitalWrite(coldWhitePin, LOW);
-      if (ledType == ENLT_RGBWW)
-        digitalWrite(warmWhitePin, LOW);
-      if (ledType == ENLT_RGB || ledType == ENLT_RGBW || ledType == ENLT_RGBWW)
+      if (config.ledType == ENLT_RGBW || config.ledType == ENLT_RGBWW)
+        digitalWrite(config.coldWhitePin, LOW);
+      if (config.ledType == ENLT_RGBWW)
+        digitalWrite(config.warmWhitePin, LOW);
+      if (config.ledType == ENLT_RGB || config.ledType == ENLT_RGBW || config.ledType == ENLT_RGBWW)
      {
-        analogWrite(redPin, map(red, 0, 255, 0, brightness));
-        analogWrite(greenPin, map(green, 0, 255, 0, brightness));
-        analogWrite(bluePin, map(blue, 0, 255, 0, brightness));
+        analogWrite(config.redPin, map(red, 0, 255, 0, brightness));
+        analogWrite(config.greenPin, map(green, 0, 255, 0, brightness));
+        analogWrite(config.bluePin, map(blue, 0, 255, 0, brightness));
      }
    }
  }
  else
  {
-    if (ledType == ENLT_W || ledType == ENLT_WW || ledType == ENLT_RGBW || ledType == ENLT_RGBWW)
-      digitalWrite(coldWhitePin, LOW);
-    if (ledType == ENLT_WW || ledType == ENLT_RGBWW)
-      digitalWrite(warmWhitePin, LOW);
-    if (ledType == ENLT_RGB || ledType == ENLT_RGBW || ledType == ENLT_RGBWW)
+    if (config.ledType == ENLT_W || config.ledType == ENLT_WW || config.ledType == ENLT_RGBW || config.ledType == ENLT_RGBWW)
+      digitalWrite(config.coldWhitePin, LOW);
+    if (config.ledType == ENLT_WW || config.ledType == ENLT_RGBWW)
+      digitalWrite(config.warmWhitePin, LOW);
+    if (config.ledType == ENLT_RGB || config.ledType == ENLT_RGBW || config.ledType == ENLT_RGBWW)
    {
-      digitalWrite(redPin, LOW);
-      digitalWrite(greenPin, LOW);
-      digitalWrite(bluePin, LOW);
+      digitalWrite(config.redPin, LOW);
+      digitalWrite(config.greenPin, LOW);
+      digitalWrite(config.bluePin, LOW);
    }
  }
-  saveConfig();
+  saveStatus();
 }

 void gatewayAvailabilityCheckTimerCallback()
Author	SHA1	Message	Date
Alexey Zholtikov	fda640e713	Minor changes	2023-03-07 11:58:34 +03:00
Alexey Zholtikov	648a19775e	Fixed one bug	2023-03-06 00:44:59 +03:00
Alexey Zholtikov	b500582cb8	Version 1.21 Changed config data storage location to EEPROM.	2023-03-05 07:53:22 +03:00
Alexey Zholtikov	ed9cba4bff	Minor changes	2023-03-04 08:13:12 +03:00
Alexey Zholtikov	00576355ff	Fixed one bug	2023-02-26 14:20:48 +03:00
Alexey Zholtikov	17db726612	Changed SDK version for 3.0.5	2023-02-26 09:33:13 +03:00
Alexey Zholtikov	6fffb45489	Version 1.2 Minimized of config message size.	2023-02-25 14:40:32 +03:00
Alexey Zholtikov	3347c4d097	Minor changes	2023-02-19 09:25:22 +03:00
Alexey Zholtikov	ed42021c9b	Version 1.15 Minor changes.	2023-02-12 18:42:57 +03:00
Alexey Zholtikov	02b8326b80	Minor changes	2023-02-11 08:42:57 +03:00
Alexey Zholtikov	0795911f7a	Minor changes	2023-02-09 21:28:56 +03:00