Add support for MDNS (#4)

* Add standardized names for the functions enabling different elements of the framework
* Add returning this instance on set* functions, allowing to chain methods (BREAKING CHANGE)
* Add support for MDNS
* Add getting generated hostname and MQTT prefix
* Fix examples

Author: ktos

examples/ErrorBasic/ErrorBasic.ino

@@ -4,7 +4,7 @@ Mokosh m;
 
 void setup() {
     // will automatically reboot if error is met
-    m.enableRebootOnError();
+    m.setRebootOnError(true);
     m.begin("Mokosh");    
 }
 

examples/WifiMqtt/WifiMqtt.ino

@@ -9,7 +9,7 @@ void setup() {
     // static configuration to be used: Wifi with yourssid and yourpassword password
     // mqtt broker at 192.168.1.10, port 1883
 
-    mokosh.disableLoadingConfigFile();
+    mokosh.setConfigFile(false);
     mokosh.config.set(mokosh.config.key_ssid, "yourssid");
     mokosh.config.set(mokosh.config.key_wifi_password, "yourpassword");
     mokosh.config.set(mokosh.config.key_broker, "192.168.1.10");

src/Mokosh.cpp

@@ -96,8 +96,9 @@ void Mokosh::setupWiFiClient() {
     this->client = new WiFiClient();
 }
 
-void Mokosh::setupCustomClient(Client& client) {
+Mokosh* Mokosh::setCustomClient(Client& client) {
     this->client = &client;
+    return this;
 }
 
 void Mokosh::setupMqttClient() {
@@ -111,6 +112,16 @@ void Mokosh::setupMqttClient() {
     }
 }
 
+void Mokosh::setupMDNS() {
+    if (!MDNS.begin(this->hostNameC)) {
+        mdebugE("MDNS couldn't be enabled");
+        return;
+    }
+
+    this->addMDNSService("mokosh", "tcp", 23);
+    this->addMDNSServiceProps("mokosh", "tcp", "version", this->version.c_str());
+}
+
 void Mokosh::setupOta() {
     uint16_t otaPort = 3232;
 #if defined(ESP8266)
@@ -241,6 +252,10 @@ void Mokosh::begin(String prefix, bool autoconnect) {
             this->setupWiFiClient();
             this->setupMqttClient();
 
+            if (this->isMDNSEnabled) {
+                this->setupMDNS();
+            }
+
             if (this->isOTAEnabled) {
                 this->setupOta();
             }
@@ -274,8 +289,9 @@ void Mokosh::publishIP() {
     }
 }
 
-void Mokosh::disableLoadingConfigFile() {
-    this->isFSEnabled = false;
+Mokosh* Mokosh::setConfigFile(bool value) {
+    this->isFSEnabled = value;
+    return this;
 }
 
 bool Mokosh::reconnect() {
@@ -348,12 +364,14 @@ bool Mokosh::isWifiConnected() {
     return WiFi.status() == WL_CONNECTED;
 }
 
-void Mokosh::setForceWiFiReconnect(bool value) {
+Mokosh* Mokosh::setForceWiFiReconnect(bool value) {
     this->isForceWifiReconnect = value;
+    return this;
 }
 
-void Mokosh::setHeartbeatEnabled(bool value) {
+Mokosh* Mokosh::setHeartbeat(bool value) {
     this->isHeartbeatEnabled = value;
+    return this;
 }
 
 wl_status_t Mokosh::connectWifi() {
@@ -410,12 +428,14 @@ Mokosh* Mokosh::getInstance() {
     return _instance;
 }
 
-void Mokosh::setDebugLevel(DebugLevel level) {
+Mokosh* Mokosh::setDebugLevel(DebugLevel level) {
     this->debugLevel = level;
 
     if (this->debugReady) {
         mdebugW("Setting mdebug level should be before begin(), ignoring for internals.");
     }
+
+    return this;
 }
 
 void Mokosh::loop() {
@@ -728,19 +748,53 @@ void Mokosh::error(int code) {
     }
 }
 
-void Mokosh::enableRebootOnError() {
-    this->isRebootOnError = true;
+Mokosh* Mokosh::setRebootOnError(bool value) {
+    this->isRebootOnError = value;
+    return this;
 }
 
-void Mokosh::setBuildMetadata(String version, String buildDate) {
+Mokosh* Mokosh::setBuildMetadata(String version, String buildDate) {
     this->version = version;
     this->buildDate = buildDate;
+    return this;
 }
 
-void Mokosh::enableOTA() {
-    this->isOTAEnabled = true;
+Mokosh* Mokosh::setOta(bool value) {
+    this->isOTAEnabled = value;
+
+    if (this->isOTAEnabled)
+        this->isMDNSEnabled = true;
+
+    return this;
 }
 
-void Mokosh::setIgnoreConnectionErrors(bool value) {
+Mokosh* Mokosh::setIgnoreConnectionErrors(bool value) {
     this->isIgnoringConnectionErrors = value;
+    return this;
+}
+
+Mokosh* Mokosh::setMDNS(bool value) {
+    this->isMDNSEnabled = value;
+    return this;
+}
+
+void Mokosh::addMDNSService(const char* service, const char* proto, uint16_t port) {
+    MDNS.addService(service, proto, port);
+}
+
+void Mokosh::addMDNSServiceProps(const char* service, const char* proto, const char* property, const char* value) {
+    MDNS.addServiceTxt(service, proto, property, value);
+}
+
+String Mokosh::getPrefix() {
+    return this->prefix;
+}
+
+String Mokosh::getHostName() {
+    return this->hostName;
+}
+
+String Mokosh::getMqttPrefix() {
+    String result = this->prefix + "_" + this->hostName + "/";
+    return result;
 }

src/Mokosh.hpp

@@ -6,12 +6,14 @@
 #if defined(ESP8266)
 #include <ESP8266WiFi.h>
 #include <LittleFS.h>
+#include <ESP8266mDNS.h>
 #endif
 
 #if defined(ESP32)
 #include <ESPmDNS.h>
 #include <SPIFFS.h>
 #define LittleFS SPIFFS
+#include <ESPmDNS.h>
 #endif
 
 #include <ArduinoOTA.h>
@@ -71,7 +73,7 @@ class Mokosh {
    public:
     Mokosh();
     // sets debug level verbosity, must be called before begin()
-    void setDebugLevel(DebugLevel level);
+    Mokosh* setDebugLevel(DebugLevel level);
 
     // starts Mokosh system, connects to the Wi-Fi and MQTT
     // using the provided device prefix
@@ -84,7 +86,20 @@ class Mokosh {
     // sets build information (SemVer and build date) used in the
     // responses to getv and getfullver commands and hello message
     // must be called before begin()
-    void setBuildMetadata(String version, String buildDate);
+    Mokosh* setBuildMetadata(String version, String buildDate);
+
+    // enables MDNS service (default false, unless OTA is enabled)
+    Mokosh* setMDNS(bool value);
+
+    // sets up the MDNS responder -- ran automatically unless custom
+    // client is used
+    void setupMDNS();
+
+    // adds broadcasted MDNS service
+    void addMDNSService(const char* service, const char* proto, uint16_t port);
+
+    // adds broadcasted MDNS service props
+    void addMDNSServiceProps(const char* service, const char* proto, const char* property, const char* value);
 
     // publishes a new message on a Prefix_ABCDE/subtopic topic with
     // a given payload
@@ -111,20 +126,20 @@ class Mokosh {
     // use rather mdebug() macros instead
     static void debug(DebugLevel level, const char* func, const char* fmt, ...);
 
-    // enables ArduinoOTA subsystem
+    // enables ArduinoOTA subsystem (disabled by default)
     // must be called before begin()
-    void enableOTA();
+    Mokosh* setOta(bool value);
 
-    // disables LittleFS and config.json support
+    // disables LittleFS and config.json support (enabled by default)
     // must be called before begin()
-    void disableLoadingConfigFile();
+    Mokosh* setConfigFile(bool value);
 
-    // enables FirstRun subsystem if there is no config.json
-    void enableFirstRun();
+    // enables FirstRun subsystem if there is no config.json (disabled by default)
+    Mokosh* setFirstRun(bool value);
 
     // enables automatic reboot on error - by default there will be
     // an inifinite loop instead
-    void enableRebootOnError();
+    Mokosh* setRebootOnError(bool value);
 
     // defines callback to be run when command not handled by internal
     // means is received
@@ -182,13 +197,13 @@ class Mokosh {
     // sets ignoring connection errors - useful in example of deep sleep
     // so the device is going to sleep again if wifi networks/mqtt are not
     // available
-    void setIgnoreConnectionErrors(bool value);
+    Mokosh* setIgnoreConnectionErrors(bool value);
 
     // sets if the Wi-Fi should be reconnected on MQTT reconnect if needed
-    void setForceWiFiReconnect(bool value);
+    Mokosh* setForceWiFiReconnect(bool value);
 
     // sets if the heartbeat messages should be send    
-    void setHeartbeatEnabled(bool value);
+    Mokosh* setHeartbeat(bool value);
 
     // returns if the RemoteDebug is ready
     bool isDebugReady();
@@ -219,10 +234,19 @@ class Mokosh {
     // sets up communication using the custom Client instance (e.g. GSM)
     // remember to use at least setupMqttClient() and hello() after using
     // this, autoconnect should be disabled
-    void setupCustomClient(Client& client);
+    Mokosh* setCustomClient(Client& client);
 
     // a configuration object to set and read configs
     MokoshConfig config;
+
+    // returns defined device prefix
+    String getPrefix();
+
+    // returns automatically generated device hostname
+    String getHostName();
+
+    // gets prefix for MQTT topics for the current device
+    String getMqttPrefix();
    private:
     bool debugReady;
     String hostName;
@@ -238,6 +262,7 @@ class Mokosh {
     bool isFSEnabled = true;
     bool isRebootOnError = false;
     bool isOTAEnabled = false;
+    bool isMDNSEnabled = false;
     bool isOTAInProgress = false;
     bool isMqttConfigured = false;
     bool isIgnoringConnectionErrors = false;