Better support for publishing on a topic, include a simple debug method

Author: bloft

README.md

@@ -1,5 +1,5 @@
 # EasyMqtt
-Easy handling of Mqtt on esp6288
+Easy handling of Mqtt on esp8266
 
 This library is currentlly under heavy development.
 And shoud not be used at the moment.
@@ -19,7 +19,7 @@ void setup() {
 	mqtt.mqtt("host", 1883, "user", "pass");
 
 
-	mqtt["wifi"]["rssi"] << [](){ return String(WiFi.RSSI()); };
+	mqtt["foo"] << [](){ return "bar"; };
 }
 
 void loop() {

ToDo.md

@@ -5,18 +5,34 @@
 Change MqttMap to include reference to mqttclient
  * Change loop, publish, ... to not need mqttclient
 
-Add connected + will to indicate if device is online
+Add easyMqtt/$id/system/connected + will to indicate if device is online
 
-Add better debugging (remote ?)
+Add better debugging
+ * Add new EasyDebug class, extends Print (Print.h), and prints to easyMqtt/$id/system/debug if enabled
+ * Add getDebugger on EasyMqtt that returns the EasyDebug instance
 
 ## Future
 
+Add system info
+ * easyMqtt/$id/system/uptime
+ * easyMqtt/$id/system/mem
+ * easyMqtt/$id/system/reset
+ * easyMqtt/$id/system/debug   (see above)
+ * easyMqtt/$id/system/config
+
 Add support for filters
  * Don't send if value is the same as last.
  * Don't send if value is Nan
 
 Add support for float type (extend MqttMap)
 
 Add publish configured endpoints, to support openhab2 auto configure
-
-Add web interface
+something like
+easyMqtt/$id/system/config
+{
+  "id"="1dfasfa",
+  "ip"="192.168.1.79",
+  "endpoints"=["/temparatur", "/humidity"]
+}
+
+   Read / Write / String / Number / ...

src/EasyMqtt.h

@@ -10,7 +10,7 @@ class EasyMqtt : public MqttMap {
     WiFiClient wifiClient;
     PubSubClient mqttClient;
 
-    String deviceId = "EasyMqtt";
+    String deviceId = "deviceId";
     const char* mqtt_username = "N/A";
     const char* mqtt_password = "N/A";
 
@@ -19,19 +19,14 @@ class EasyMqtt : public MqttMap {
       return String("easyMqtt/") + deviceId;
     }
 
-    MqttMap & getDiag() {
-      return operator[]("diag");
-    }
-
     /**
        Handle connections to mqtt
     */
     void mqttReconnect() {
       while (!mqttClient.connected()) {
         if (mqttClient.connect(deviceId.c_str(), mqtt_username, mqtt_password)) {
-          Serial.println("MQTT connected");
-          subscribe(mqttClient);
-          getDiag()["log"].publish(mqttClient, "connected to MQTT");
+          debug("Connected to MQTT");
+          subscribe();
         } else {
           Serial.print("failed, rc=");
           Serial.print(mqttClient.state());
@@ -42,16 +37,24 @@ class EasyMqtt : public MqttMap {
     }
 
   public:
-    EasyMqtt() : MqttMap("easyMqtt") {
+    EasyMqtt() : MqttMap("easyMqtt", mqttClient) {
       deviceId = String(ESP.getChipId());
 
-      getDiag().setInterval(30);
-      getDiag()["mem"]["heap"] << []() {
+      get("system").setInterval(30);
+      get("system")["mem"]["heap"] << []() {
         return String(ESP.getFreeHeap());
       };
-      getDiag()["uptime"] << []() {
+      get("system")["uptime"] << []() {
         return String(millis());
       };
+      get("system")["reset"] >> [](String value) {
+        ESP.reset();
+      };
+    }
+
+    void debug(String msg) {
+      Serial.println(msg);
+      get("system")["debug"].publish(msg);
     }
 
     /**
@@ -73,12 +76,15 @@ class EasyMqtt : public MqttMap {
       Serial.println(ESP.getChipId());
 
       // Setup wifi diag
-      getDiag()["wifi"]["rssi"] << []() {
+      get("system")["wifi"]["rssi"] << []() {
         return String(WiFi.RSSI());
       };
-      getDiag()["wifi"]["ssid"] << []() {
+      get("system")["wifi"]["ssid"] << []() {
         return WiFi.SSID();
       };
+      get("system")["wifi"]["ip"] << []() {
+        return WiFi.localIP().toString();
+      };
     }
 
     /**
@@ -100,7 +106,7 @@ class EasyMqtt : public MqttMap {
     void loop() {
       mqttReconnect();
       mqttClient.loop();
-      MqttMap::loop(mqttClient);
+      MqttMap::loop();
     }
 };
 

src/MqttMap.h

@@ -13,17 +13,26 @@ class MqttMap {
     int interval = -1;
     unsigned long lastUpdate = 0; // Last read of data
 
+    PubSubClient* client = NULL;
+
     MqttMap* parent = NULL;
     MqttMap* next = NULL;
     MqttMap* children = NULL;
 
   protected:
-    MqttMap(const char* _name, MqttMap& _parent) {
+    MqttMap(const char* _name, PubSubClient& _mqttClient, MqttMap& _parent) {
       name = _name;
       parent = &_parent;
+      client = &_mqttClient;
       interval = -1;
     }
 
+    MqttMap(const char* _name, PubSubClient& _mqttClient) {
+      name = _name;
+      client = &_mqttClient;
+      interval = 5;
+    }
+
     virtual String getTopic() {
       if (parent) {
         return parent->getTopic() + "/" + name;
@@ -32,37 +41,13 @@ class MqttMap {
       }
     }
 
-  public:
-    MqttMap(const char* _name) {
-      name = _name;
-      interval = 5;
-    }
-
-    int getInterval() {
-      if (interval < 0) {
-        return parent->getInterval();
-      }
-      return interval;
-    }
-
-    void setInterval(int _interval) {
-      interval = _interval;
-    }
-
-    void publish(PubSubClient& client, String message) {
-      String topic = getTopic();
-      //      printf("publish[%s]: %s\n", topic.c_str(), message.c_str());
-      client.publish(topic.c_str(), message.c_str());
-    }
-
     void callback(const char* _topic, uint8_t* payload, unsigned int length) {
       if (strcmp(getTopic().c_str(), _topic) == 0) {
         if (outFunction != NULL) {
           String _payload = "";
           for (int i = 0; i < length; i++) {
             _payload += (char)payload[i];
           }
-          //        printf("Found callback, %s: %s\n", _topic, _payload.c_str());
           outFunction(_payload);
         }
       } else {
@@ -73,47 +58,69 @@ class MqttMap {
         }
       }
     }
-
+    
     /**
 
     */
-    void subscribe(PubSubClient& client) {
+    void subscribe() {
       if (outFunction != NULL) {
         String topic = getTopic();
-        printf("Subscribe: %s\n", topic.c_str());
-        client.subscribe(topic.c_str());
+        client->subscribe(topic.c_str());
       }
       MqttMap* child = children;
       while (child != NULL) {
-        child->subscribe(client);
+        child->subscribe();
         child = child->next;
       }
     }
 
     /**
 
     */
-    void loop(PubSubClient& client) {
+    void loop() {
       if (inFunction != NULL) {
         unsigned long time = millis();
         if (time >= (lastUpdate + (getInterval() * 1000))) {
           lastUpdate = time;
           String value = inFunction();
           if (value != "") {
-            publish(client, value);
+            publish(value);
           }
         }
       }
       MqttMap* child = children;
       while (child != NULL) {
-        child->loop(client);;
+        child->loop();
         child = child->next;
       }
     }
 
+  public:
+    int getInterval() {
+      if (interval < 0) {
+        return parent->getInterval();
+      }
+      return interval;
+    }
+
+    void setInterval(int _interval) {
+      interval = _interval;
+    }
+
+    void publish(String message) {
+      client->publish(getTopic().c_str(), message.c_str());
+    }
+
     /**
+     * Create or get the sub topic with the name {name}
+     */
+    MqttMap & get(const char* name) {
+      return operator[](name);
+    }
 
-    */
+    /**
+     * Create or get the sub topic with the name {name}
+     */
     MqttMap & operator[](const char* name) {
       MqttMap * child = children;
       while (child != NULL) {
@@ -123,21 +130,21 @@ class MqttMap {
         child = child->next;
       }
       MqttMap * oldChild = children;
-      children = new MqttMap(name, *this);
+      children = new MqttMap(name, *client, *this);
       children->next = oldChild;
       return *children;
     }
 
     /**
-       Read data from function and send it to mqtt
-    */
+     *  Read data from function and send it to mqtt
+     */
     void operator<<(String (*inFunction)()) {
       MqttMap::inFunction = inFunction;
     }
 
     /**
-       Handle data comming from mqtt
-    */
+     *  Handle data comming from mqtt
+     */
     void operator>>(void (*outFunction)(String payload)) {
       MqttMap::outFunction = outFunction;
     }