Release 0.7.5

Modify dump() functions

.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: "CI"
+on:
+  
+jobs:
+  ci:
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout this repository
+      uses: actions/checkout@v2.3.4
+    - name: Cache for arduino-ci
+      uses: actions/cache@v2.1.3
+      with:
+        path: |
+          ~/.arduino15
+        key: ${{ runner.os }}-arduino
+    - name: Install nix
+      uses: cachix/install-nix-action@v12
+    - run: nix-shell -I nixpkgs=channel:nixpkgs-unstable -p arduino-ci --run "arduino-ci"

README.md

@@ -4,15 +4,16 @@
 [![AUnit Tests](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml)
 ![Issues](https://img.shields.io/github/issues/hsaturn/TinyMqtt)
 ![Esp8266](https://img.shields.io/badge/platform-ESP8266-green)
+![Esp32](https://img.shields.io/badge/platform-ESP32-green)
 ![Gpl 3.0](https://img.shields.io/github/license/hsaturn/TinyMqtt)
 ![Mqtt 3.1.1](https://img.shields.io/badge/Mqtt-%203.1.1-yellow)
 
-ESP 8266 is a small, fast and capable Mqtt Broker and Client
+TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32 / Esp WROOM
 
 ## Features
 
 - Very (very !!) fast broker I saw it re-sent 1000 topics per second for two
-  clients that had subscribed (payload ~15 bytes). No topic lost.
+  clients that had subscribed (payload ~15 bytes ESP8266). No topic lost.
   The max I've seen was 2k msg/s (1 client 1 subscription)
 - Act as as a mqtt broker and/or a mqtt client
 - Mqtt 3.1.1 / Qos 0 supported

examples/client-with-wifi/client-with-wifi.ino

@@ -1,6 +1,8 @@
 #include <TinyMqtt.h>   // https://github.com/hsaturn/TinyMqtt
 
 /** 
+  * Local broker that accept connections and two local clients
+  *
   * 
   *  +-----------------------------+
   *  | ESP                         |
@@ -9,11 +11,12 @@
   *  |       |         +--------+  |
   *  |       |             ^       |
   *  |       |             |       |
-  *  |       v             v       |
-  *  | +----------+  +----------+  |
-  *  | | internal |  | internal |  |
-  *  | | client   |  | client   |  |
-  *  | +----------+  +----------+  |
+  *  |       |             |       |     -----
+  *  |       v             v       |      ---  
+  *  | +----------+  +----------+  |       -  
+  *  | | internal |  | internal |  +-------*  Wifi
+  *  | | client   |  | client   |  |          
+  *  | +----------+  +----------+  |          
   *  |                             |
   *  +-----------------------------+
   * 

examples/client-without-wifi/client-without-wifi.ino

@@ -1,12 +1,30 @@
 #include <TinyMqtt.h>   // https://github.com/hsaturn/TinyMqtt
 
 /** TinyMQTT allows a disconnected mode:
- * 
- *  In this example, local clients A and B are talking together, no need to be connected.
- *  A single ESP can use this to be able to comunicate with itself with the power
- *  of MQTT, and once connected still continue to work with others.
- *  
- */
+  * 
+  *  +-----------------------------+
+  *  | ESP                         |
+  *  |                 +--------+  |
+  *  |       +-------->| broker |  |
+  *  |       |         +--------+  |
+  *  |       |             ^       |
+  *  |       |             |       |
+  *  |       v             v       |
+  *  | +----------+  +----------+  |
+  *  | | internal |  | internal |  |
+  *  | | client   |  | client   |  |          
+  *  | +----------+  +----------+  |          
+  *  |                             |
+  *  +-----------------------------+
+  *
+  *  In this example, local clients A and B are talking together, no need to be connected.
+  *
+  *  A single ESP can use this to be able to comunicate with itself with the power
+  *  of MQTT, and once connected still continue to work with others.
+  *
+  *  The broker may still be conected if wifi is on.
+  *  
+  */
 
 std::string topic="sensor/temperature";
 

examples/simple-broker/simple-broker.ino

@@ -5,6 +5,16 @@
 #define PORT 1883
 MqttBroker broker(PORT);
 
+/** Basic Mqtt Broker
+  *
+  *  +-----------------------------+
+  *  | ESP                         |
+  *  |       +--------+            | 
+  *  |       | broker |            | 1883 <--- External client/s
+  *  |       +--------+            |
+  *  |                             |
+  *  +-----------------------------+
+  */
 void setup() 
 {
   Serial.begin(115200);

examples/simple-client/simple-client.ino

@@ -1,9 +1,21 @@
 #include "TinyMqtt.h"   // https://github.com/hsaturn/TinyMqtt
 
-/** Simple Client
+/** Simple Client (The simplest configuration)
   *
-	* This is the simplest Mqtt client configuration
-	*
+  *                             
+  *                   +--------+       
+  *           +------>| broker |<--- <  Other client
+  *           |       +--------+       
+  *           |                               
+  *   +-----------------+
+  *   | ESP   |         |           
+  *   | +----------+    |          
+  *   | | internal |    |              
+  *   | | client   |    |          
+  *   | +----------+    |          
+  *   |                 |
+  *   +-----------------+
+  * 
 	* 1 - edit my_credentials.h to setup wifi essid/password
 	* 2 - change BROKER values (or keep emqx.io test broker)
 	*

examples/tinymqtt-test/tinymqtt-test.ino

@@ -1,22 +1,24 @@
 #include <TinyMqtt.h>       // https://github.com/hsaturn/TinyMqtt
 #include <MqttStreaming.h>
-#include <ESP8266mDNS.h>
+#if defined(ESP8266)
+  #include <ESP8266mDNS.h>
+#elif defined(ESP32)
+  #include <ESPmDNS.h>
+#else
+  #error Unsupported platform
+#endif
 
 #include <sstream>
 #include <map>
 
-/**
+/** Very complex example
   * Console allowing to make any kind of test.
   *
-  * pros - Reduces internal latency (when publish is received by the same ESP)
-  *      - Reduces wifi traffic
-  *      - No need to have an external broker
-	*      - can still report to a 'main' broker (TODO see documentation that have to be written)
-	*      - accepts external clients
-  *
-  * cons - Takes more memory
-	*      - a bit hard to understand
+	* Upload the sketch, the use the terminal.
+	* Press H for mini help.
 	*
+  * tested with mqtt-spy-0.5.4
+	* TODO examples of scripts
   */
 
 #include <my_credentials.h>
@@ -117,7 +119,7 @@ std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
 			return addr;
 	}
 	IPAddress local=WiFi.localIP();
-	addr="";
+	addr.clear();
 	while(build.size()!=4)
 	{
 		std::stringstream b;
@@ -141,7 +143,7 @@ std::set<std::string> commands = {
 	"publish", "reset", "subscribe", "unsubscribe", "view", "every"
 };
 
-void getCommand(std::string& search)
+void convertToCommand(std::string& search)
 {
 	while(search[0]==' ') search.erase(0,1);
 	if (search.length()==0) return;
@@ -161,7 +163,7 @@ void getCommand(std::string& search)
 	else if (count>1)
 	{
 		Serial << "Ambiguous command: " << matches << endl;
-		search="";
+		search.clear();
 	}
 }
 
@@ -332,9 +334,12 @@ struct Every
 	std::string cmd;
 	uint32_t ms;
 	uint32_t next;
+	uint32_t underrun=0;
+	bool active=true;
 
 	void dump()
 	{
+		Serial << (active ? "enabled  " : "disabled ");
 		auto mill=millis();
 		Serial << ms << "ms [" << cmd << "] next in ";
 		if (mill > next)
@@ -363,7 +368,6 @@ void eval(std::string& cmd)
 		MqttClient* client = nullptr;
 
 		// client.function notation
-		// ("a.fun " becomes "fun a ")
 		if (cmd.find('.') != std::string::npos &&
 				cmd.find('.') < cmd.find(' '))
 		{
@@ -382,13 +386,13 @@ void eval(std::string& cmd)
 				else
 				{
 					Serial << "Unknown class (" << s.c_str() << ")" << endl;
-					cmd="";
+					cmd.clear();
 				}
 			}
 		}
 
 		s = getword(cmd);
-		if (s.length()) getCommand(s);
+		if (s.length()) convertToCommand(s);
 		if (s.length()==0)
 		{}
 		else if (compare(s, "delete"))
@@ -444,6 +448,11 @@ void eval(std::string& cmd)
 			{
 				broker->dump();
 			}
+			else
+			{
+				Serial << "Unknown broker command (" << s << ")" << endl;
+				s.clear();
+			}
 		}
 		else if (client)
 		{
@@ -456,7 +465,7 @@ void eval(std::string& cmd)
 			{
 				while (cmd[0]==' ') cmd.erase(0,1);
 				retval = client->publish(getword(cmd, topic.c_str()), cmd.c_str(), cmd.length());
-				cmd="";	// remove payload
+				cmd.clear();	// remove payload
 			}
 			else if (compare(s,"subscribe"))
 			{
@@ -470,6 +479,11 @@ void eval(std::string& cmd)
 			{
 				client->dump();
 			}
+			else
+			{
+				Serial << "Unknown client command (" << s << ")" << endl;
+				s.clear();
+			}
 		}
 		else if (compare(s, "on"))
 		{
@@ -486,18 +500,56 @@ void eval(std::string& cmd)
 		else if (compare(s, "every"))
 		{
 			uint32_t ms = getint(cmd, 0);
-			if (ms and cmd.length())
+			if (ms)
 			{
-				Every every;
-				every.ms=ms;
-				every.cmd=cmd;
-				every.next=millis()+ms;
-				everies.push_back(every);
-				every.dump();
-				Serial << endl;
-				cmd="";
+				if (cmd.length())
+				{
+					Every every;
+					every.ms=ms;
+					every.cmd=cmd;
+					every.next=millis()+ms;
+					everies.push_back(every);
+					every.dump();
+					Serial << endl;
+					cmd.clear();
+				}
 			}
-			else if (ms==0 and compare(cmd, "list"))
+			else if (compare(cmd, "off") or compare(cmd, "on"))
+			{
+				bool active=getword(cmd)=="on";
+				uint8_t ever;
+				if (compare(cmd, "all"))
+					ever=100;
+				else
+					ever=getint(cmd, 99);
+				uint8_t count=0;
+				if (ever == 99)
+				{
+					Serial << "Missing every number" << endl;
+				}
+				else
+				{
+					for(auto& every: everies)
+					{
+						if (count==ever or (ever==100))
+						{
+							if (every.active != active)
+							{
+								every.active = active;
+								every.underrun = 0;
+							}
+							ever = 99;
+							break;
+						}
+						count++;
+					}
+					if (ever != 99)
+					{
+						Serial << "Every not found" << endl;
+					}
+				}
+			}
+			else if (compare(cmd, "list") or cmd.length()==0)
 			{
 				getword(cmd);
 				Serial << "List of everies (ms=" << millis() << ")" << endl;
@@ -510,11 +562,17 @@ void eval(std::string& cmd)
 					count++;
 				}
 			}
-			else if (ms==0 and compare(cmd, "remove"))
+			else if (compare(cmd, "remove"))
 			{
+				Serial << "Removing..." << endl;
 				getword(cmd);
 				int8_t every=getint(cmd, -1);
-				if (every==-1 and compare(cmd, "all"))
+				if (every==-1 and compare(cmd, "last") and everies.size())
+				{
+					getword(cmd);
+					everies.erase(everies.begin()+everies.size()-1);
+				}
+				else if (every==-1 and compare(cmd, "all"))
 				{
 					getword(cmd);
 					everies.clear();
@@ -523,7 +581,11 @@ void eval(std::string& cmd)
 				{
 					everies.erase(everies.begin()+every);
 				}
+				else
+					Serial << "Bad colmmand" << endl;
 			}
+			else
+				Serial << "Bad command" << endl;
 		}
 		else if (compare(s, "blink"))
 		{
@@ -627,14 +689,14 @@ void eval(std::string& cmd)
 			Serial << "--< " << clients.size() << " client/s. >--" << endl;
 			for(auto it: clients)
 			{
-				Serial << "  "; it.second->dump();
+				it.second->dump("  ");
 			}
 
 			Serial << "--< " << brokers.size() << " brokers/s. >--" << endl;
 			for(auto it: brokers)
 			{
-				Serial << " ==[ Broker: " << it.first.c_str() << " ]== ";
-				it.second->dump();
+				Serial << "  +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s."<< endl;
+				it.second->dump("     ");
 			}
 		}
 		else if (compare(s, "reset"))
@@ -663,7 +725,7 @@ void eval(std::string& cmd)
 			Serial << "    set [name][value]" << endl;
 			Serial << "    !  repeat last command" << endl;
 			Serial << endl;
-			Serial << "  every ms [command]; every list; every remove [nr|all]" << endl;
+			Serial << "  every ms [command]; every list; every remove [nr|all], every [on|off] #" << endl;
 			Serial << "  on {output}; off {output}" << endl;
 			Serial << "  $id : name of the client." << endl;
 			Serial << "  default topic is '" << topic.c_str() << "'" << endl;
@@ -678,7 +740,7 @@ void eval(std::string& cmd)
 
 		if (retval != MqttOk)
 		{
-			Serial << "## ERROR " << retval << endl;
+			Serial << "# MQTT ERROR " << retval << endl;
 		}
 	}
 }
@@ -688,15 +750,23 @@ void loop()
 	auto ms=millis();
 	int8_t out=0;
 	int16_t blink_bits = blink;
+	uint8_t e=0;
 
 	for(auto& every: everies)
 	{
+		if (not every.active) continue;
 		if (every.ms && every.cmd.length() && ms > every.next)
 		{
 			std::string cmd(every.cmd);
 			eval(cmd);
 			every.next += every.ms;
+			if (ms > every.next and ms > every.underrun)
+			{
+				Serial << "Underrun every #" << e << ", " <<  (ms - every.next) << "ms late" << endl;
+				every.underrun = ms+5000;
+			}
 		}
+		e++;
 	}
 
 	while(blink_bits)
@@ -720,7 +790,9 @@ void loop()
 	}
 
 	static long count;
+  #if defined(ESP9266)
   MDNS.update();
+  #endif
 
 	if (MqttClient::counter != count)
 	{

library.json

@@ -1,12 +1,12 @@
 {
     "name": "TinyMqtt",
     "keywords": "ethernet, mqtt, m2m, iot",
-    "description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages. It does support MQTT 3.1.1 with QOS=0.",
+    "description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive and host a broker for MQTT. It does support MQTT 3.1.1 with QOS=0 on ESP8266 and ESP32 WROOM platfrms.",
     "repository": {
         "type": "git",
         "url": "https://github.com/hsaturn/TinyMqtt.git"
     },
-    "version": "0.7.3",
+    "version": "0.7.5",
     "exclude": "",
     "examples": "examples/*/*.ino",
     "frameworks": "arduino",

library.properties

@@ -1,9 +1,9 @@
 name=TinyMqtt
-version=0.7.3
+version=0.7.5
 author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
 maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
 sentence=A tiny broker and client library for MQTT messaging.
-paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages and to host a broker in your ESP. It does support MQTT 3.1.1 with QoS=0.
+paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages and to host a broker in your ESP 8266 and 32 WROOM. It does support MQTT 3.1.1 with QoS=0.
 category=Communication
 url=https://github.com/hsaturn/TinyMqtt
 architectures=*

src/TinyMqtt.h

@@ -15,8 +15,6 @@
     #else
 	    #include <WiFi.h>
     #endif
-#else
-	#error "Unsupported platform"
 #endif
 #ifdef EPOXY_DUINO
   #define dbg_ptr uint64_t
@@ -191,23 +189,25 @@ class MqttClient
 		// TODO seems to be useless
 		bool isLocal() const { return client == nullptr; }
 
-		void dump()
+		void dump(std::string indent="")
 		{
 			uint32_t ms=millis();
-			Serial << "MqttClient (" << clientId.c_str() << ") " << (connected() ? " ON " : " OFF");
-			Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive;
+			Serial << indent << "+-- " << '\'' << clientId.c_str() << "' " << (connected() ? " ON " : " OFF");
+			Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive << ' ';
 			Serial << (client && client->connected() ? "" : "dis") << "connected";
-            message.hexdump("entrant msg");
-			bool c=false;
-			Serial << " [";
-			for(auto s: subscriptions)
+			if (subscriptions.size())
 			{
-				Serial << (c?", ": "")<< s.str().c_str();
-				c=true;
+				bool c = false;
+				Serial << " [";
+				for(auto s: subscriptions)
+				{
+					if (c) Serial << ", ";
+					Serial << s.str().c_str();
+					c=true;
+				}
+				Serial << ']';
 			}
-
-			
-			Serial << "]" << endl;
+			Serial << endl;
 		}
 
 		/** Count the number of messages that have been sent **/
@@ -267,14 +267,10 @@ class MqttBroker
 
 		size_t clientsCount() const { return clients.size(); }
 
-		void dump()
+		void dump(std::string indent="")
 		{
-			Serial << clients.size() << " client/s" << endl;
 			for(auto client: clients)
-			{
-				Serial << "  ";
-				client->dump();
-			}
+				client->dump(indent);
 		}
 
 	private: