wip

include/config.h

@@ -8,8 +8,8 @@ inline constexpr uint8_t ledPinB = 18;
 inline constexpr uint8_t ledPinCW = 19;
 inline constexpr uint8_t ledPinWW = 21;
 
-inline constexpr std::string_view hostName = "smart-rgb-dev";
-inline constexpr std::string_view friendlyName = "Smart RGB Dev";
+inline constexpr std::string_view hostName = "smart-rgb";
+inline constexpr std::string_view friendlyName = "Smart RGB";
 inline constexpr uint32_t maxNumberOfStates = 10;
 
 inline constexpr std::string_view mqttBroker = "10.238.75.81";

include/debugutil.hpp

@@ -0,0 +1,30 @@
+#pragma once
+#include <Arduino.h>
+
+#ifndef ENABLE_SERIAL_DEBUG
+  #define ENABLE_SERIAL_DEBUG 0
+#endif
+
+struct Debug {
+    static constexpr bool enabled = static_cast<bool>(ENABLE_SERIAL_DEBUG);
+    static inline void begin(unsigned long baud) {
+        if constexpr (enabled) Serial.begin(baud);
+    }
+    template<typename... Args>
+    static inline void print(Args&&... args) {
+        if constexpr (enabled) { (Serial.print(std::forward<Args>(args)), ...); }
+    }
+    template<typename... Args>
+    static inline void println(Args&&... args) {
+        if constexpr (enabled) {
+            (Serial.print(std::forward<Args>(args)), ...);
+            Serial.println();
+        }
+    }
+    template<typename... Args>
+    static inline void printf(const char *fmt, Args&&... args) {
+        if constexpr (enabled) {
+            Serial.printf(fmt, std::forward<Args>(args)...);
+        }
+    }
+};

lib/communication/mqtt.cpp

@@ -1,5 +1,6 @@
 #include <PubSubClient.h>
 #include <WiFiClient.h>
+#include "debugutil.hpp"
 #include "mqtt.h"
 
 constexpr uint16_t BUFFER_SIZE = 2048;
@@ -26,12 +27,27 @@ void Mqtt::subscribe(const std::string& topic, MqttCallback callback) {
     if (mqttClient.connected()) {
         if (mqttClient.subscribe(topic.c_str())) {
             callbacks[topic] = callback;
-            Serial.printf("Subscribed to topic: %s\n", topic.c_str());
+            Debug::printf("Subscribed to topic: %s\n", topic.c_str());
         } else {
-            Serial.printf("Failed to subscribe to topic: %s\n", topic.c_str());
+            Debug::printf("Failed to subscribe to topic: %s\n", topic.c_str());
         }
     } else {
-        Serial.println("MQTT client is not connected. Cannot subscribe.");
+        Debug::println("MQTT client is not connected. Cannot subscribe.");
+    }
+}
+
+void Mqtt::unsubscribe(const std::string& topic) {
+    if (mqttClient.connected()) {
+        if (mqttClient.unsubscribe(topic.c_str())) {
+            Debug::printf("Unsubscribed from topic: %s\n", topic.c_str());
+        } else {
+            Debug::printf("Failed to unsubscribe from topic: %s\n", topic.c_str());
+        }
+    } else {
+        Debug::println("MQTT client is not connected. Unsubscribe skipped.");
+    }
+    if (callbacks.find(topic) != callbacks.end()) {
+        callbacks.erase(topic);
     }
 }
 
@@ -39,10 +55,10 @@ void Mqtt::publish(const std::string& topic, const std::string& payload, bool re
     if (mqttClient.connected()) {
         if (mqttClient.publish(topic.c_str(), payload.c_str(), retain)) {
         } else {
-            Serial.printf("Failed to publish to topic: %s\n", topic.c_str(), payload.c_str());
+            Debug::printf("Failed to publish to topic: %s\n", topic.c_str(), payload.c_str());
         }
     } else {
-        Serial.println("MQTT client is not connected. Cannot publish.");
+        Debug::println("MQTT client is not connected. Cannot publish.");
     }
 }
 
@@ -50,21 +66,21 @@ void Mqtt::poll() {
     if (mqttClient.connected()) {
         mqttClient.loop(); // Process incoming messages
     } else {
-        Serial.println("MQTT client is not connected. Polling skipped.");
+        Debug::println("MQTT client is not connected. Polling skipped.");
     }
 }
 
 void Mqtt::checkConnection() {
     if (!mqttClient.connected()) {
-        Serial.println("MQTT client is not connected. Attempting to reconnect...");
+        Debug::println("MQTT client is not connected. Attempting to reconnect...");
         if (mqttClient.connect(Mqtt::clientId.c_str(), Mqtt::username.c_str(), Mqtt::password.c_str())) {
-            Serial.println("Reconnected to MQTT broker successfully.");
+            Debug::println("Reconnected to MQTT broker successfully.");
             for (const auto& callback : Mqtt::callbacks) {
                 mqttClient.subscribe(callback.first.c_str());
             }
             Mqtt::isConnected = true;
         } else {
-            Serial.printf("Failed to reconnect to MQTT broker, rc=%d\n", mqttClient.state());
+            Debug::printf("Failed to reconnect to MQTT broker, rc=%d\n", mqttClient.state());
             Mqtt::isConnected = false;
         }
     }
@@ -82,10 +98,10 @@ void Mqtt::connect(std::string brokerIp, uint16_t brokerPort, std::string client
     mqttClient.setBufferSize(BUFFER_SIZE);
 
     if (mqttClient.connect(Mqtt::clientId.c_str(), Mqtt::username.c_str(), Mqtt::password.c_str())) {
-        Serial.println("Connected to MQTT broker");
+        Debug::println("Connected to MQTT broker");
         Mqtt::initialized = true;
         Mqtt::isConnected = true;
     } else {
-        Serial.printf("Failed to connect to MQTT broker, rc=%d\n", mqttClient.state());
+        Debug::printf("Failed to connect to MQTT broker, rc=%d\n", mqttClient.state());
     }
 }

lib/communication/mqtt.h

@@ -12,6 +12,7 @@ public:
     static void checkConnection();
     static void publish(const std::string& topic, const std::string& payload, bool retain = false);
     static void subscribe(const std::string& topic, MqttCallback callback);
+    static void unsubscribe(const std::string& topic);
     static void mqttCb(char* topic, uint8_t* payload, unsigned int length);
 
 private:

lib/light/light.cpp

@@ -1,4 +1,5 @@
 #include <ArduinoJson.h>
+#include "debugutil.hpp"
 #include "light.h"
 #include "mqtt.h"
 
@@ -20,8 +21,7 @@ Light::Light(Pin* pinR, Pin* pinG, Pin* pinB, std::string uniqueId)
     lightType = LightType::rgb;
     uint8_t bits = pinR->getLedResolutionBits();
     maxPwm = (bits >= 1 && bits <= 31) ? ((1u << bits) - 1u) : 255u;
-    publishInitialState();
-    subscribeToMqttTopics();
+    notifyOnline();
 }
 
 Light::Light(Pin* pinR, Pin* pinG, Pin* pinB, Pin* pinCW, Pin* pinWW, std::string uniqueId)
@@ -31,7 +31,7 @@ Light::Light(Pin* pinR, Pin* pinG, Pin* pinB, Pin* pinCW, Pin* pinWW, std::strin
     uint8_t bits = pinR->getLedResolutionBits();
     maxPwm = (bits >= 1 && bits <= 31) ? ((1u << bits) - 1u) : 255u;
     publishInitialState();
-    subscribeToMqttTopics();
+    notifyOnline();
 }
 
 void Light::publishInitialState() {
@@ -41,7 +41,7 @@ void Light::publishInitialState() {
     deviceInfo["name"] = this->deviceInfo.name;
     deviceInfo["model"] = this->deviceInfo.model;
     JsonArray identifiers = deviceInfo["identifiers"].to<JsonArray>();
-    identifiers.add(this->deviceInfo.identifier + this->lightInfo.uniqueId);
+    identifiers.add(this->lightInfo.uniqueId);
     deviceInfo["sw_version"] = this->deviceInfo.swVersion;
     deviceInfo["manufacturer"] = this->deviceInfo.manufacturer;
 
@@ -158,19 +158,29 @@ void Light::operatePin() {
     if (pinWW) pinWW->setLedLevel(wwSetpoint);
 }
 
-void Light::subscribeToMqttTopics() {
+void Light::notifyOnline() {
     Mqtt::subscribe(lightInfo.commandTopic, [this](uint8_t* payload, int length) {
         std::string command(reinterpret_cast<char*>(payload), length);
         handleCommand(command);
     });
+    publishInitialState();
+}
+
+void Light::notifyOffline() {
+    Mqtt::unsubscribe(lightInfo.commandTopic);
+    JsonDocument availabilityDoc;
+    availabilityDoc["availability"] = Availability.notAvailable;
+    std::string availabilityJson;
+    serializeJson(availabilityDoc, availabilityJson);
+    Mqtt::publish(lightInfo.availabilityTopic, availabilityJson);
 }
 
 void Light::handleCommand(const std::string& command) {
-    Serial.println("Received command: " + String(command.c_str()));
+    Debug::println("Received command: " + String(command.c_str()));
     JsonDocument commandJson;
     deserializeJson(commandJson, command);
     if (commandJson.isNull()) {
-        Serial.println("Invalid command JSON");
+        Debug::println("Invalid command JSON");
         return;
     }
     if (commandJson["state"].is<String>()) {
@@ -240,11 +250,11 @@ void Light::publishCurrentState() {
 
     std::string stateJson;
     serializeJson(stateInfo, stateJson);
-    Serial.println("Publishing current state: " + String(stateJson.c_str()));
+    Debug::println("Publishing current state: " + String(stateJson.c_str()));
     Mqtt::publish(lightInfo.stateTopic, stateJson);
     std::string attributeJson;
     serializeJson(attributeInfo, attributeJson);
-    Serial.println("Publishing current attributes: " + String(attributeJson.c_str()));
+    Debug::println("Publishing current attributes: " + String(attributeJson.c_str()));
     Mqtt::publish(lightInfo.jsonAttributesTopic, attributeJson);
 }
 

lib/light/light.h

@@ -7,35 +7,11 @@ struct LightInfo {
     std::string uniqueId;
     const std::string name = "Smart RGB Light";
     const std::string discoveryTopic = "homeassistant/light/smart_rgb_light/light/config";
-    const std::string baseTopic = "studiotj/smart-rgb/light";
     const std::string availabilityTopic = "studiotj/smart-rgb/light/status";
     const std::string stateTopic = "studiotj/smart-rgb/light/state";
     const std::string jsonAttributesTopic = "studiotj/smart-rgb/light/attributes";
     const std::string stateValueTemplate = "{{ value_json.state }}";
     const std::string commandTopic = "studiotj/smart-rgb/light/state/set";
-    const std::string brightnessCommandTopic = "studiotj/smart-rgb/light/brightness/set";
-    const std::string brightnessValueTemplate = "{{ value_json.brightness }}";
-    const std::string colorTempCommandTopic = "studiotj/smart-rgb/light/color_temp/set";
-    const std::string colorTempKelvinTopic = "studiotj/smart-rgb/light/color_temp_kelvin/set";
-    const std::string colorTempStateTopic = "studiotj/smart-rgb/light/color_temp/state";
-    const std::string colorTempValueTemplate = "{{ value_json.color_temp }}";
-    const std::string hsCommandTopic = "studiotj/smart-rgb/light/hs/set";
-    const std::string hsCommandTemplate = "{{ value_json.hs_cmd }}";
-    const std::string hsStateTopic = "studiotj/smart-rgb/light/hs/state";
-    const std::string hsValueTemplate = "   {{ value_json.hs_value }}";
-    const std::string rgbCommandTopic = "studiotj/smart-rgb/light/rgb/set";
-    const std::string rgbCommandTemplate = "{{ {'rgb': [red, green, blue]} | to_json }}";
-    const std::string rgbStateTopic = "studiotj/smart-rgb/light/rgb/state";
-    const std::string rgbValueTemplate = "{{ value_json.rgb | join(',') }}";
-    const std::string rgbwCommandTopic = "studiotj/smart-rgb/light/rgbw/set";
-    const std::string rgbwCommandTemplate = "{{ value_json.rgbw_cmd }}";
-    const std::string rgbwStateTopic = "studiotj/smart-rgb/light/rgbw/state";
-    const std::string rgbwValueTemplate = "{{ value_json.rgbw_value }}";
-    const std::string rgbwwCommandTopic = "studiotj/smart-rgb/light/rgbww/set";
-    const std::string rgbwwCommandTemplate = "{{ value_json.rgbww_cmd }}";
-    const std::string rgbwwStateTopic = "studiotj/smart-rgb/light/rgbww/state";
-    const std::string rgbwwValueTemplate = "{{ value_json.rgbww_value }}";
-    const std::string supportedColorModesTopic = "studiotj/smart-rgb/light/supported_color_modes";
     const std::string supportedColorModesValue = "['rgb', 'brightness']";
     const std::string availabilityTemplate = "{{ value_json.availability }}";
 };
@@ -67,7 +43,8 @@ public:
     Light(Pin* pinR, Pin* pinG, Pin* pinB, std::string uniqueId);
     Light(Pin* pinR, Pin* pinG, Pin* pinB, Pin* pinCW, std::string uniqueId);
     Light(Pin* pinR, Pin* pinG, Pin* pinB, Pin* pinCW, Pin* pinWW, std::string uniqueId);
-    void subscribeToMqttTopics();
+    void notifyOnline();
+    void notifyOffline();
     void publishInitialState();
     void publishCurrentState();
     void setHsl(uint8_t h, uint8_t s, uint8_t l);

lib/network/network.cpp

@@ -38,6 +38,17 @@ std::string Network::getHostname() const {
     return WiFi.getHostname();
 }
 
+const std::string Network::getMacAddress() const {
+    std::string mac = WiFi.macAddress().c_str(); // format: "AA:BB:CC:DD:EE:FF"
+    std::string hexMac = "0x";
+    for (size_t i = 0; i < mac.size(); ++i) {
+        if (mac[i] != ':') {
+            hexMac += mac[i];
+        }
+    }
+    return hexMac;
+}
+
 bool Network::setHostname(const std::string_view &hostname) {
     this->hostname = std::string(hostname);
     return WiFi.setHostname(this->hostname.c_str());

lib/network/network.h

@@ -9,6 +9,7 @@ public:
     void reconnect();
     bool isConnected() const;
     std::string getHostname() const;
+    const std::string getMacAddress() const;
     bool setHostname(const std::string_view &hostname);
     void registerMDNS();
 private:

lib/ota/ota.cpp

@@ -1,29 +1,30 @@
 #include <ArduinoOTA.h>
+#include "debugutil.hpp"
 #include "ota.h"
 
 OTAHandler::OTAHandler(std::string_view hostname) {
     ArduinoOTA.setHostname(hostname.data());
     ArduinoOTA.onStart([]() {
-        Serial.println("OTA Start");
+        Debug::println("OTA Start");
     });
     ArduinoOTA.onEnd([]() {
-        Serial.println("OTA End");
+        Debug::println("OTA End");
     });
     ArduinoOTA.onProgress([](unsigned int progress, unsigned int total) {
-        Serial.printf("OTA Progress: %u%%\n", (progress / (total / 100)));
+        Debug::printf("OTA Progress: %u%%\n", (progress / (total / 100)));
     });
     ArduinoOTA.onError([](ota_error_t error) {
-        Serial.printf("OTA Error[%u]: ", error);
+        Debug::printf("OTA Error[%u]: ", error);
         if (error == OTA_AUTH_ERROR) {
-            Serial.println("Auth Failed");
+            Debug::println("Auth Failed");
         } else if (error == OTA_BEGIN_ERROR) {
-            Serial.println("Begin Failed");
+            Debug::println("Begin Failed");
         } else if (error == OTA_CONNECT_ERROR) {
-            Serial.println("Connect Failed");
+            Debug::println("Connect Failed");
         } else if (error == OTA_RECEIVE_ERROR) {
-            Serial.println("Receive Failed");
+            Debug::println("Receive Failed");
         } else if (error == OTA_END_ERROR) {
-            Serial.println("End Failed");
+            Debug::println("End Failed");
         }
     });
     ArduinoOTA.begin();

platformio.ini

@@ -15,8 +15,8 @@ framework = arduino
 monitor_speed = 115200
 build_unflags = -std=gnu++11
 build_flags =
-	-std=c++17
 	-std=gnu++17
+	-I include
 lib_deps =
 	martinverges/ESP32 Wifi Manager@^1.5.0
 	esp32async/ESPAsyncWebServer@^3.7.10
@@ -25,7 +25,10 @@ lib_deps =
 	arkhipenko/TaskScheduler@^3.8.5
 
 [env:esp32dev-serial]
+build_flags =
+	${env.build_flags}
+	-D ENABLE_SERIAL_DEBUG=1
 
 [env:esp32dev-ota]
 upload_protocol = espota
-upload_port = smart-rgb-dev.local
+upload_port = smart-rgb.local

src/main.cpp

@@ -1,6 +1,7 @@
 #include <Arduino.h>
 #include "appcontext.hpp"
 #include "config.h"
+#include "debugutil.hpp"
 #include "light.h"
 #include "mqtt.h"
 #include "network.h"
@@ -41,9 +42,8 @@ Scheduler *scheduler = nullptr;
 void initializeScheduler();
 
 void setup() {
-    // put your setup code here, to run once:
-    Serial.begin(115200);
-    Serial.println("Starting Smart RGB ESP32...");
+    Debug::begin(115200);
+    Debug::println("Starting Smart RGB ESP32...");
     stateMachine = new StateMachine<maxNumberOfStates>();
     initializeScheduler();
     appContext->pinR = pinR;

src/states.hpp

@@ -1,6 +1,7 @@
 #include <Arduino.h>
 #include "appcontext.hpp"
 #include "config.h"
+#include "debugutil.hpp"
 #include "mqtt.h"
 #include "pin.h"
 #include "statemachine.hpp"
@@ -51,7 +52,7 @@ public:
     NetworkInitializeState(AppContext *appContext) : State("NetworkInitializeState", StateId::NetworkInitializeState), appContext(appContext) {}
 
     void onEnter(StateMachineBase &stateMachine) override {
-        Serial.println("Entering NetworkInitializeState");
+        Debug::println("Entering NetworkInitializeState");
         if (appContext && !appContext->network) {
             appContext->network = new Network(hostName, friendlyName);
         } else if (appContext && appContext->network) {
@@ -84,6 +85,14 @@ class RunningState : public State
 public:
     RunningState(AppContext *appContext) : State("RunningState", StateId::RunningState), appContext(appContext) {}
     void onEnter(StateMachineBase &stateMachine) override {
+        Debug::println("Entering RunningState");
+        if (appContext) {
+            if (!appContext->light) {
+                appContext->light = new Light(appContext->pinR, appContext->pinG, appContext->pinB, appContext->pinCW, appContext->pinWW, appContext->network->getMacAddress());
+            } else {
+                appContext->light->notifyOnline();
+            }
+        }
         lastOtaPollMs = millis();
         lastMqttPollMs = millis();
         lastMqttCheckConnectionPollSecond = millis() / 1000;
@@ -91,7 +100,10 @@ public:
     }
 
     void onExit(StateMachineBase &stateMachine) override {
-        Serial.println("Exiting RunningState");
+        Debug::println("Exiting RunningState");
+        if (appContext && appContext->light) {
+            appContext->light->notifyOffline();
+        }
     }
 
     void onUpdate(StateMachineBase &stateMachine) override {