Compare commits

...

46 Commits

Author SHA1 Message Date
hsaturn
da3ec41d71 Update network-tests.ino
Remove useless code
2022-01-10 05:27:15 +01:00
hsaturn
5f7b4537c8 Enhance PR#22 2022-01-05 02:03:42 +01:00
hsaturn
cce4fecac6 Fix test local_client_should_unregister_when_destroyed 2022-01-05 02:02:18 +01:00
hsaturn
737e217172 fix type return value 2022-01-05 02:01:22 +01:00
hsaturn
8fe3517894 added packed attribute for enums 2022-01-05 02:00:02 +01:00
hsaturn
710503663a better type management 2022-01-05 01:59:16 +01:00
hsaturn
a5b8afc0bd Added some ifdef for debugging purposes 2022-01-05 01:56:45 +01:00
terror
f1d3a15498 added reply to message subscribe and unsubscribe 2021-09-25 15:44:09 +03:00
hsaturn
dfd5983715 Rewrite comments and added hudge payload test 2021-09-20 01:57:40 +02:00
hsaturn
4dcc6a6cf4 Minor changes 2021-09-19 12:40:04 +02:00
hsaturn
b58f3e3d67 Merge branch 'issue_2_broken_large_payloads' into main 2021-09-17 22:35:28 +02:00
hsaturn
a6b3540cb8 Fix issue_2 : Broken large payloads 2021-09-17 22:32:00 +02:00
hsaturn
ccbf42f81b howto added for building and running tests 2021-09-17 19:58:24 +02:00
hsaturn
d39c58d8f5 Fix issue_2 broken payload 2021-09-17 19:51:32 +02:00
hsaturn
36dde2c063 Fix for debugging for other platform than ESP 2021-08-09 11:24:27 +02:00
hsaturn
64a05bb60b Release 0.7.9 2021-08-09 10:47:18 +02:00
hsaturn
bb89fc5284 Release 0.7.8 2021-08-09 10:45:17 +02:00
hsaturn
c1fd1bc907 Remove pending length test 2021-08-09 10:44:19 +02:00
hsaturn
d919188eb0 Merge pull request #15 from bxparks/epoxyfix
Fix unit tests for EpoxyDuino
2021-08-09 10:39:26 +02:00
hsaturn
9c7f3b6b8e Fix of decode length 2021-08-09 10:37:46 +02:00
Brian Park
88c7d552cb Fix unit tests for EpoxyDuino 2021-08-08 19:37:04 -07:00
hsaturn
fab242e212 Version 0.7.6 2021-08-09 03:04:21 +02:00
hsaturn
56a2be621f Fix message length error 2021-08-09 03:00:28 +02:00
hsaturn
c4cf39ab68 Fix aunit tests 2021-08-09 02:33:01 +02:00
hsaturn
90dea36ab0 Attempt to write more readable examples 2021-05-13 03:21:03 +02:00
hsaturn
25a721e06a Attempt to write more readable examples 2021-05-13 03:21:03 +02:00
hsaturn
b228d35ab0 Attempt to write more readable examples 2021-05-13 03:21:03 +02:00
hsaturn
c70716a595 Attempt to write more readable examples 2021-05-13 03:21:03 +02:00
hsaturn
8d5cad5fec Added overload of Client::publish, fix compilation 2021-05-13 03:21:03 +02:00
hsaturn
d5430228e5 Fix cr/lf bug
Added echo on|off for later vt100 terminal
Added rnd(min,max) function
Simplied every function
Better parsing for getword (accept strings)
Fix for blink command
2021-05-13 03:21:03 +02:00
hsaturn
91c1f96146 Update README.md
links updates
2021-05-08 15:14:59 +02:00
hsaturn
f04a2a07c0 Fix aunit.yml 2021-04-28 21:22:07 +00:00
hsaturn
38f306c170 Fix compilation esp8266 esp32 2021-04-28 23:16:33 +02:00
hsaturn
024e80c9dc Perpare for future ESP32 aunit tests 2021-04-28 21:00:31 +00:00
hsaturn
2249ddef7f Release 0.7.5 2021-04-28 18:57:24 +02:00
hsaturn
e193929f8f changed every command 2021-04-28 18:56:17 +02:00
hsaturn
e00e31de33 Fix build in Esp8266 mode
Modify dump() functions
2021-04-28 18:55:57 +02:00
hsaturn
20292b7b7b Fix example syntax 2021-04-28 08:24:44 +02:00
hsaturn
26de3befa8 TinyTest Esp32 port
Update library definition
2021-04-28 08:19:55 +02:00
hsaturn
1098466055 Update README.md 2021-04-28 08:14:46 +02:00
hsaturn
2d3663e78c Update README.md 2021-04-28 07:32:56 +02:00
hsaturn
5e16282ad0 Disable ci.yml 2021-04-21 01:10:35 +02:00
hsaturn
e35a43c4a4 Trying to remove unsupported platform that break ci.yml 2021-04-21 01:05:31 +02:00
hsaturn
087a203ba0 Create ci.yml 2021-04-21 00:56:49 +02:00
hsaturn
5d313bbf5e Rewrite examples 2021-04-12 00:27:25 +02:00
hsaturn
ce896f02c4 Merge pull request #6 from hsaturn/AsyncAndWifi
AsyncTcp can be activated by removing the command on TCP_ASYNC in TinyMqtt.h
But the code is not bug free yet.
2021-04-11 23:33:29 +02:00
24 changed files with 978 additions and 242 deletions

View File

@@ -24,5 +24,11 @@ jobs:
git clone https://github.com/hsaturn/EspMock
- name: Verify tests
run: |
make -C tests
# Run tests for ESP8266
make -C tests ESP_LIBS="ESP8266WiFi ESPAsyncTCP" tests
make -C tests runtests
make -C tests clean
# Run tests for ESP32
#make -C tests ESP_LIBS="ESP8266WiFi ESPAsyncTCP" tests
#make -C tests runtests
#make -C tests clean

18
.github/workflows/ci.yml vendored Normal file
View File

@@ -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"

View File

@@ -1,18 +1,19 @@
# TinyMqtt
![Release](https://img.shields.io/github/v/release/hsaturn/TinyMqtt)
[![Release](https://img.shields.io/github/v/release/hsaturn/TinyMqtt)](https://github.com/hsaturn/TinyMqtt/releases)
[![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)
![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)
[![Issues](https://img.shields.io/github/issues/hsaturn/TinyMqtt)](https://github.com/hsaturn/TinyMqtt/issues)
[![Esp8266](https://img.shields.io/badge/platform-ESP8266-green)](https://www.espressif.com/en/products/socs/esp8266)
[![Esp32](https://img.shields.io/badge/platform-ESP32-green)](https://www.espressif.com/en/products/socs/esp32)
[![Gpl 3.0](https://img.shields.io/github/license/hsaturn/TinyMqtt)](https://www.gnu.org/licenses/gpl-3.0.fr.html)
[![Mqtt 3.1.1](https://img.shields.io/badge/Mqtt-%203.1.1-yellow)](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/errata01/os/mqtt-v3.1.1-errata01-os-complete.html#_Toc442180822)
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.
- Very fast broker I saw it re-sent 1000 topics per second for two
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

View File

@@ -1,6 +1,8 @@
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
/**
* Local broker that accept connections and two local clients
*
*
* +-----------------------------+
* | ESP |
@@ -9,9 +11,10 @@
* | | +--------+ |
* | | ^ |
* | | | |
* | v v |
* | +----------+ +----------+ |
* | | internal | | internal | |
* | | | | -----
* | v v | ---
* | +----------+ +----------+ | -
* | | internal | | internal | +-------* Wifi
* | | client | | client | |
* | +----------+ +----------+ |
* | |
@@ -28,7 +31,8 @@
*
*/
#include <my_credentials.h>
const char *ssid = "";
const char *password = "";
std::string topic="sensor/temperature";
@@ -37,11 +41,11 @@ MqttBroker broker(1883);
MqttClient mqtt_a(&broker);
MqttClient mqtt_b(&broker);
void onPublishA(const MqttClient* source, const Topic& topic, const char* payload, size_t length)
{ Serial << endl << "---------> A Received " << topic.c_str() << endl; }
void onPublishA(const MqttClient* /* source */, const Topic& topic, const char* payload, size_t /* length */)
{ Serial << "--> client A received " << topic.c_str() << ", " << payload << endl; }
void onPublishB(const MqttClient* source, const Topic& topic, const char* payload, size_t length)
{ Serial << endl << "---------> B Received " << topic.c_str() << endl; }
void onPublishB(const MqttClient* /* source */, const Topic& topic, const char* payload, size_t /* length */)
{ Serial << "--> client B Received " << topic.c_str() << ", " << payload << endl; }
void setup()
{
@@ -49,6 +53,9 @@ void setup()
delay(500);
Serial << "Clients with wifi " << endl;
if (strlen(ssid)==0)
Serial << "****** PLEASE EDIT THE EXAMPLE AND MODIFY ssid/password *************" << endl;
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
@@ -73,14 +80,14 @@ void loop()
mqtt_b.loop();
// ============= client A publish ================
static const int intervalA = 5000; // publishes every 5s
static const int intervalA = 5000; // publishes every 5s (please avoid usage of delay())
static uint32_t timerA = millis() + intervalA;
if (millis() > timerA)
{
Serial << "A is publishing " << topic.c_str() << endl;
timerA += intervalA;
mqtt_a.publish(topic);
mqtt_a.publish(topic, " sent by A");
}
// ============= client B publish ================
@@ -89,8 +96,9 @@ void loop()
if (millis() > timerB)
{
static int temperature;
Serial << "B is publishing " << topic.c_str() << endl;
timerB += intervalB;
mqtt_b.publish(topic, std::string(String(15+millis()%10).c_str()));
mqtt_b.publish(topic, " sent by B: "+std::string(String(16+temperature++%6).c_str()));
}
}

View File

@@ -1,11 +1,29 @@
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
/** TinyMQTT allows a disconnected mode:
*
* +-----------------------------+
* | 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";
@@ -14,11 +32,11 @@ MqttBroker broker(1883);
MqttClient mqtt_a(&broker);
MqttClient mqtt_b(&broker);
void onPublishA(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{ Serial << "--> A Received " << topic.c_str() << endl; }
void onPublishA(const MqttClient* /* srce */, const Topic& topic, const char* payload, size_t /* length */)
{ Serial << "--> Client A received msg on topic " << topic.c_str() << ", " << payload << endl; }
void onPublishB(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{ Serial << "--> B Received " << topic.c_str() << endl; }
void onPublishB(const MqttClient* /* srce */, const Topic& topic, const char* payload, size_t /* length */)
{ Serial << "--> Client B received msg on topic " << topic.c_str() << ", " << payload << endl; }
void setup()
{
@@ -35,7 +53,7 @@ void setup()
void loop()
{
broker.loop();
broker.loop(); // Don't forget to call loop() for all brokers and clients
mqtt_a.loop();
mqtt_b.loop();
@@ -47,7 +65,7 @@ void loop()
{
Serial << "A is publishing " << topic.c_str() << endl;
timerA += intervalA;
mqtt_a.publish(topic);
mqtt_a.publish(topic, "sent by A");
}
// ============= client B publish ================
@@ -58,6 +76,6 @@ void loop()
{
Serial << "B is publishing " << topic.c_str() << endl;
timerB += intervalB;
mqtt_b.publish(topic);
mqtt_b.publish(topic, "sent by B");
}
}

View File

@@ -1,14 +1,33 @@
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
#include <my_credentials.h>
#define PORT 1883
MqttBroker broker(PORT);
/** Basic Mqtt Broker
*
* +-----------------------------+
* | ESP |
* | +--------+ |
* | | broker | | 1883 <--- External client/s
* | +--------+ |
* | |
* +-----------------------------+
*
* Your ESP will become a MqttBroker.
* You can test it with any client such as mqtt-spy for example
*
*/
const char* ssid = "";
const char* password = "";
void setup()
{
Serial.begin(115200);
if (strlen(ssid)==0)
Serial << "****** PLEASE MODIFY ssid/password *************" << endl;
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);

View File

@@ -1,11 +1,25 @@
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
/** Simple Client
/** Simple Client (The simplest configuration)
*
* This is the simplest Mqtt client configuration
*
* 1 - edit my_credentials.h to setup wifi essid/password
* +--------+
* +------>| broker |<--- < Other client
* | +--------+
* |
* +-----------------+
* | ESP | |
* | +----------+ |
* | | internal | |
* | | client | |
* | +----------+ |
* | |
* +-----------------+
*
* 1 - change the ssid/password
* 2 - change BROKER values (or keep emqx.io test broker)
* 3 - you can use mqtt-spy to connect to the same broker and
* see the sensor/temperature updated by the client.
*
* pro - small memory footprint (both ram and flash)
* - very simple to setup and use
@@ -18,7 +32,8 @@
const char* BROKER = "broker.emqx.io";
const uint16_t BROKER_PORT = 1883;
#include <my_credentials.h>
const char* ssid = "";
const char* password = "";
static float temp=19;
static MqttClient client;
@@ -27,7 +42,10 @@ void setup()
{
Serial.begin(115200);
delay(500);
Serial << "Simple clients with wifi " << endl;
if (strlen(ssid)==0)
Serial << "****** PLEASE MODIFY ssid/password *************" << endl;
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
@@ -42,15 +60,28 @@ void setup()
void loop()
{
client.loop();
client.loop(); // Don't forget to call loop() for each broker and client
delay(1000);
// delay(1000); please avoid usage of delay (see below how this done using next_send and millis())
static auto next_send = millis();
if (millis() > next_send)
{
next_send += 1000;
if (not client.connected())
{
Serial << millis() << ": Not connected to broker" << endl;
return;
}
auto rnd=random(100);
if (rnd > 66) temp += 0.1;
else if (rnd < 33) temp -= 0.1;
client.publish("sensor/temperature", String(temp));
Serial << "--> Publishing a new sensor/temperature value: " << temp << endl;
client.publish("sensor/temperature", String(temp));
}
}

View File

@@ -1,25 +1,32 @@
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
#include <MqttStreaming.h>
#if defined(ESP8266)
#include <ESP8266mDNS.h>
#elif defined(ESP32)
#include <WiFi.h>
#include <ESPmDNS.h>
#else
#error Unsupported platform
#endif
#include <sstream>
#include <map>
/**
* Console allowing to make any kind of test.
bool echo_on = true;
/** Very complex example
* Console allowing to make any kind of test,
* even some stress tests.
*
* 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>
const char* ssid = "";
const char* password = "";
std::string topic="sensor/temperature";
@@ -44,17 +51,32 @@ void setup()
WiFi.persistent(false); // https://github.com/esp8266/Arduino/issues/1054
Serial.begin(115200);
delay(500);
Serial << endl << endl << endl
<< "Connecting to '" << ssid << "' ";
Serial << endl << endl;
Serial << "***************************************************************" << endl;
Serial << "* Welcome to the TinyMqtt console" << endl;
Serial << endl;
Serial << "* The console allows to test all features of the libraries." << endl;
Serial << endl;
if (strlen(ssid)==0)
Serial << "* WARNING: You may want to modify ssid/password in order" << endl
<< " to reflect your Wifi configuration." << endl;
Serial << endl;
Serial << "* Enter help to view the list of commands." << endl;
Serial << "***************************************************************" << endl;
Serial << endl;
Serial << "Connecting to '" << ssid << "' ";
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
while (WiFi.status() != WL_CONNECTED)
{ Serial << '-'; delay(500); }
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
Serial << "Type help for more..." << endl;
Serial << endl << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
const char* name="tinytest";
Serial << "Starting MDNS, name= " << name;
@@ -69,27 +91,67 @@ void setup()
brokers["broker"] = broker;
}
std::string getword(std::string& str, const char* if_empty=nullptr, char sep=' ');
int getint(std::string& str, const int if_empty=0)
{
std::string sword;
while(str.length() && str[0]>='0' && str[0]<='9')
std::string str2=str;
std::string sword = getword(str);
if (sword[0] and isdigit(sword[0]))
{
sword += str[0]; str.erase(0,1);
int ret=atoi(sword.c_str());
while(isdigit(sword[0]) or sword[0]==' ') sword.erase(0,1);
if (sword.length()) str = sword+' '+str;
return ret;
}
while(str[0]==' ') str.erase(0,1);
if (if_empty and sword.length()==0) return if_empty;
return atoi(sword.c_str());
str=str2;
return if_empty;
}
std::string getword(std::string& str, const char* if_empty=nullptr, char sep=' ')
std::string getword(std::string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/)
{
char quote=(str[0]=='"' or str[0]=='\'' ? str[0] : 0);
if (quote) str.erase(0,1);
std::string sword;
while(str.length() && str[0]!=sep)
while(str.length() and (str[0]!=sep or quote))
{
sword += str[0]; str.erase(0,1);
if (str[0]==quote)
{
str.erase(0,1);
break;
}
sword += str[0];
str.erase(0,1);
}
while(str[0]==sep) str.erase(0,1);
if (if_empty and sword.length()==0) return if_empty;
if (quote==false and sword.length()>=4 and sword.substr(0,3)=="rnd")
{
sword.erase(0,3);
if (sword[0]=='(')
{
int to = 100;
sword.erase(0,1);
int from=getint(sword);
if (sword[0]==',')
{
sword.erase(0,1);
to = getint(sword);
if (sword[0]!=')') Serial << "Missing ')'" << endl;
}
else
{
to=from;
from=0;
}
return String(random(from,to)).c_str();
}
else
{
Serial << "Missing '('" << endl;
}
}
while(str[0]==' ') str.erase(0,1);
return sword;
}
@@ -117,7 +179,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;
@@ -138,10 +200,10 @@ std::set<std::string> commands = {
"auto", "broker", "blink", "client", "connect",
"create", "delete", "help", "interval",
"ls", "ip", "off", "on", "set",
"publish", "reset", "subscribe", "unsubscribe", "view", "every"
"publish", "reset", "subscribe", "unsubscribe", "view", "echo", "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 +223,7 @@ void getCommand(std::string& search)
else if (count>1)
{
Serial << "Ambiguous command: " << matches << endl;
search="";
search.clear();
}
}
@@ -177,7 +239,7 @@ void replace(const char* d, std::string& str, std::string srch, std::string to)
{
str.erase(pos, srch.length());
str.insert(pos, to);
pos += to.length();
pos += to.length()-1;
}
}
}
@@ -195,6 +257,7 @@ void replaceVars(std::string& cmd)
}
cmd.erase(0, cmd.find_first_not_of(" "));
cmd.erase(cmd.find_last_not_of(" ")+1);
}
// publish at regular interval
@@ -332,9 +395,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 +429,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 +447,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 +509,11 @@ void eval(std::string& cmd)
{
broker->dump();
}
else
{
Serial << "Unknown broker command (" << s << ")" << endl;
s.clear();
}
}
else if (client)
{
@@ -454,9 +524,7 @@ void eval(std::string& cmd)
}
else if (compare(s,"publish"))
{
while (cmd[0]==' ') cmd.erase(0,1);
retval = client->publish(getword(cmd, topic.c_str()), cmd.c_str(), cmd.length());
cmd=""; // remove payload
retval = client->publish(getword(cmd, topic.c_str()), getword(cmd));
}
else if (compare(s,"subscribe"))
{
@@ -470,6 +538,11 @@ void eval(std::string& cmd)
{
client->dump();
}
else
{
Serial << "Unknown client command (" << s << ")" << endl;
s.clear();
}
}
else if (compare(s, "on"))
{
@@ -483,10 +556,28 @@ void eval(std::string& cmd)
pinMode(pin, OUTPUT);
digitalWrite(pin, LOW);
}
else if (compare(s, "echo"))
{
s=getword(cmd);
if (s=="on")
echo_on = true;
else if (s=="off")
echo_on = false;
else
{
Serial << s << ' ';
while(cmd.length())
{
Serial << getword(cmd) << ' ';
}
}
}
else if (compare(s, "every"))
{
uint32_t ms = getint(cmd, 0);
if (ms and cmd.length())
if (ms)
{
if (cmd.length())
{
Every every;
every.ms=ms;
@@ -495,9 +586,29 @@ void eval(std::string& cmd)
everies.push_back(every);
every.dump();
Serial << endl;
cmd="";
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=getint(cmd, 100);
uint8_t count=0;
for(auto& every: everies)
{
if (count==ever or (ever==100))
{
if (every.active != active)
{
Serial << "every #" << count << (active ? " on" :" off") << endl;
every.active = active;
every.underrun = 0;
}
}
count++;
}
}
else if (compare(cmd, "list") or cmd.length()==0)
{
getword(cmd);
Serial << "List of everies (ms=" << millis() << ")" << endl;
@@ -510,11 +621,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 +640,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 +748,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,9 +784,11 @@ 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 << " echo [on|off] or strings" << 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 << " rnd[(min[,max])] random number." << endl;
Serial << " default topic is '" << topic.c_str() << "'" << endl;
Serial << endl;
}
@@ -678,7 +801,7 @@ void eval(std::string& cmd)
if (retval != MqttOk)
{
Serial << "## ERROR " << retval << endl;
Serial << "# MQTT ERROR " << retval << endl;
}
}
}
@@ -688,16 +811,24 @@ 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 +851,9 @@ void loop()
}
static long count;
#if defined(ESP9266)
MDNS.update();
#endif
if (MqttClient::counter != count)
{
@@ -739,8 +872,10 @@ void loop()
{
static std::string cmd;
char c=Serial.read();
if (echo_on)
Serial << c;
if (c==10 or c==14)
if (c==10 or c==13)
{
Serial << "----------------[ " << cmd.c_str() << " ]--------------" << endl;
static std::string last_cmd;

View File

@@ -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.8.0",
"exclude": "",
"examples": "examples/*/*.ino",
"frameworks": "arduino",

View File

@@ -1,9 +1,9 @@
name=TinyMqtt
version=0.7.3
version=0.8.0
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=*

View File

@@ -38,11 +38,12 @@
4. Simple _FMT mechanism ala printf, but without the typeunsafetyness
and no internal buffers for replaceable stream printing
*/
#pragma once
#ifndef ARDUINO_STREAMING
#define ARDUINO_STREAMING
#if defined(ARDUINO) && ARDUINO >= 100
#if (defined(ARDUINO) && ARDUINO >= 100) || defined(EPOXY_DUINO)
#include "Arduino.h"
#else
#ifndef STREAMING_CONSOLE
@@ -154,7 +155,7 @@ template<typename T>
inline Print &operator <<(Print &obj, const _BASED<T> &arg)
{ obj.print(arg.val, arg.base); return obj; }
#if ARDUINO >= 18
#if ARDUINO >= 18 || defined(EPOXY_DUINO)
// Specialization for class _FLOAT
// Thanks to Michael Margolis for suggesting a way
// to accommodate Arduino 0018's floating point precision

View File

@@ -1,13 +1,9 @@
#include "TinyMqtt.h"
#include <sstream>
void outstring(const char* prefix, const char*p, uint16_t len)
{
return;
Serial << prefix << "='";
while(len--) Serial << (char)*p++;
Serial << '\'' << endl;
}
#ifdef EPOXY_DUINO
std::map<MqttMessage::Type, int> MqttClient::counters;
#endif
MqttBroker::MqttBroker(uint16_t port)
{
@@ -38,7 +34,11 @@ MqttClient::MqttClient(MqttBroker* parent, TcpClient* new_client)
#else
client = new WiFiClient(*new_client);
#endif
alive = millis()+5000; // client expires after 5s if no CONNECT msg
#ifdef EPOXY_DUINO
alive = millis()+500000;
#else
alive = millis()+5000; // TODO MAGIC client expires after 5s if no CONNECT msg
#endif
}
MqttClient::MqttClient(MqttBroker* parent, const std::string& id)
@@ -59,7 +59,7 @@ void MqttClient::close(bool bSendDisconnect)
{
debug("close " << id().c_str());
mqtt_connected = false;
if (client)
if (client) // connected to a remote broker
{
if (bSendDisconnect and client->connected())
{
@@ -76,9 +76,15 @@ void MqttClient::close(bool bSendDisconnect)
}
}
void MqttClient::connect(MqttBroker* parentBroker)
{
close();
parent = parentBroker;
}
void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
{
debug("cnx: closing");
debug("MqttClient::connect");
keep_alive = ka;
close();
if (client) delete client;
@@ -184,7 +190,7 @@ MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
return MqttNowhereToSend;
}
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const
{
MqttError retval = MqttOk;
@@ -244,7 +250,11 @@ void MqttClient::clientAlive(uint32_t more_seconds)
{
if (keep_alive)
{
#ifdef EPOXY_DUINO
alive=millis()+500000;
#else
alive=millis()+1000*(keep_alive+more_seconds);
#endif
}
else
alive=0;
@@ -389,16 +399,18 @@ MqttError MqttClient::sendTopic(const Topic& topic, MqttMessage::Type type, uint
return msg.sendTo(this);
}
long MqttClient::counter=0;
void MqttClient::processMessage(const MqttMessage* mesg)
void MqttClient::processMessage(MqttMessage* mesg)
{
counter++;
#ifdef TINY_MQTT_DEBUG
if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::Type::PingResp)
{
#ifdef NOT_ESP_CORE
Serial << "---> INCOMING " << _HEX(mesg->type()) << " client(" << (dbg_ptr)client << ':' << clientId << ") mem=" << " ESP.getFreeHeap() "<< endl;
#else
Serial << "---> INCOMING " << _HEX(mesg->type()) << " client(" << (dbg_ptr)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
#endif
// mesg->hexdump("Incoming");
mesg->hexdump("Incoming");
}
#endif
auto header = mesg->getVHeader();
@@ -406,7 +418,11 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
uint16_t len;
bool bclose=true;
switch(mesg->type() & 0XF0)
#ifdef EPOXY_DUINO
counters[mesg->type()]++;
#endif
switch(mesg->type())
{
case MqttMessage::Type::Connect:
if (mqtt_connected)
@@ -436,11 +452,9 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
if (mqtt_flags & FlagWill) // Will topic
{
mesg->getString(payload, len); // Will Topic
outstring("WillTopic", payload, len);
payload += len;
mesg->getString(payload, len); // Will Message
outstring("WillMessage", payload, len);
payload += len;
}
// FIXME forgetting credential is allowed (security hole)
@@ -457,7 +471,9 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
payload += len;
}
#ifdef TINY_MQTT_DEBUG
Serial << "Connected client:" << clientId.c_str() << ", keep alive=" << keep_alive << '.' << endl;
#endif
bclose = false;
mqtt_connected=true;
{
@@ -507,18 +523,25 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
payload = header+2;
debug("un/subscribe loop");
std::string qoss;
while(payload < mesg->end())
{
mesg->getString(payload, len); // Topic
debug( " topic (" << std::string(payload, len) << ')');
outstring(" un/subscribes", payload, len);
// subscribe(Topic(payload, len));
Topic topic(payload, len);
payload += len;
if ((mesg->type() & 0XF0) == MqttMessage::Type::Subscribe)
if (mesg->type() == MqttMessage::Type::Subscribe)
{
uint8_t qos = *payload++;
if (qos != 0) debug("Unsupported QOS" << qos << endl);
if (qos != 0)
{
debug("Unsupported QOS" << qos << endl);
qoss.push_back(0x80);
}
else
qoss.push_back(qos);
subscriptions.insert(topic);
}
else
@@ -530,7 +553,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
}
debug("end loop");
bclose = false;
// TODO SUBACK
MqttMessage ack(mesg->type() == MqttMessage::Type::Subscribe ? MqttMessage::Type::SubAck : MqttMessage::Type::UnSuback);
ack.add(header[0]);
ack.add(header[1]);
ack.add(qoss.c_str(), qoss.size(), false);
ack.sendTo(this);
}
break;
@@ -540,9 +568,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
break;
case MqttMessage::Type::Publish:
#ifdef TINY_MQTT_DEBUG
Serial << "publish " << mqtt_connected << '/' << (long) client << endl;
#endif
if (mqtt_connected or client == nullptr)
{
uint8_t qos = mesg->type() & 0x6;
uint8_t qos = mesg->flags();
payload = header;
mesg->getString(payload, len);
Topic published(payload, len);
@@ -554,8 +585,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
// TODO reset DUP
// TODO reset RETAIN
if (client==nullptr) // internal MqttClient receives publish
if (parent==nullptr or client==nullptr) // internal MqttClient receives publish
{
#ifdef TINY_MQTT_DEBUG
Serial << (isSubscribedTo(published) ? "not" : "") << " subscribed.\n";
Serial << "has " << (callback ? "" : "no ") << " callback.\n";
#endif
if (callback and isSubscribedTo(published))
{
callback(this, published, payload, len); // TODO send the real payload
@@ -584,10 +619,12 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
};
if (bclose)
{
#ifdef TINY_MQTT_DEBUG
Serial << "*************** Error msg 0x" << _HEX(mesg->type());
mesg->hexdump("-------ERROR ------");
dump();
Serial << endl;
#endif
close();
}
else
@@ -610,6 +647,7 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
msg.add(topic);
msg.add(payload, pay_length, false);
msg.complete();
if (parent)
{
return parent->publish(this, topic, msg);
@@ -621,7 +659,7 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
}
// republish a received publish if it matches any in subscriptions
MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage& msg)
MqttError MqttClient::publishIfSubscribed(const Topic& topic, MqttMessage& msg)
{
MqttError retval=MqttOk;
@@ -633,6 +671,10 @@ MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage&
else
{
processMessage(&msg);
#ifdef TINY_MQTT_DEBUG
Serial << "Should call the callback ?\n";
#endif
// callback(this, topic, nullptr, 0); // TODO Payload
}
}
@@ -661,24 +703,23 @@ void MqttMessage::incoming(char in_byte)
switch(state)
{
case FixedHeader:
size=0;
size=MaxBufferLength;
state = Length;
break;
case Length:
size = (size<<7) + (in_byte & 0x3F);
if (size==MaxBufferLength)
size = in_byte & 0x7F;
else
size += static_cast<uint16_t>(in_byte & 0x7F)<<7;
if (size > MaxBufferLength)
{
state = Error;
}
else if ((in_byte & 0x80) == 0)
{
vheader = buffer.length();
if (size==0)
state = Complete;
else if (size > 500) // TODO magic
{
state = Error;
}
else
{
buffer.reserve(size);
@@ -700,12 +741,14 @@ void MqttMessage::incoming(char in_byte)
break;
case Complete:
default:
#ifdef TINY_MQTT_DEBUG
Serial << "Spurious " << _HEX(in_byte) << endl;
hexdump("spurious");
#endif
reset();
break;
}
if (buffer.length() > MaxBufferLength) // TODO magic 256 ?
if (buffer.length() > MaxBufferLength)
{
debug("Too long " << state);
reset();
@@ -716,36 +759,33 @@ void MqttMessage::add(const char* p, size_t len, bool addLength)
{
if (addLength)
{
buffer.reserve(buffer.length()+addLength+2);
buffer.reserve(buffer.length()+2);
incoming(len>>8);
incoming(len & 0xFF);
}
while(len--) incoming(*p++);
}
void MqttMessage::encodeLength(char* msb, int length) const
void MqttMessage::encodeLength()
{
do
if (state != Complete)
{
uint8_t encoded(length & 0x7F);
length >>=7;
if (length) encoded |= 0x80;
*msb++ = encoded;
} while (length);
};
int length = buffer.size()-3; // 3 = 1 byte for header + 2 bytes for pre-reserved length field.
buffer[1] = 0x80 | (length & 0x7F);
buffer[2] = (length >> 7);
vheader = 3;
void MqttMessage::complete()
{
encodeLength(&buffer[1], buffer.size()-2);
// We could check that buffer[2] < 128 (end of length encoding)
state = Complete;
}
};
MqttError MqttMessage::sendTo(MqttClient* client) const
MqttError MqttMessage::sendTo(MqttClient* client)
{
if (buffer.size())
{
debug("sending " << buffer.size() << " bytes");
encodeLength(&buffer[1], buffer.size()-2);
encodeLength();
// hexdump("snd");
client->write(&buffer[0], buffer.size());
}
@@ -759,6 +799,8 @@ MqttError MqttMessage::sendTo(MqttClient* client) const
void MqttMessage::hexdump(const char* prefix) const
{
(void)prefix;
#ifdef TINY_MQTT_DEBUG
uint16_t addr=0;
const int bytes_per_row = 8;
const char* hex_to_str = " | ";
@@ -794,4 +836,5 @@ void MqttMessage::hexdump(const char* prefix) const
}
Serial << endl;
#endif
}

View File

@@ -10,13 +10,10 @@
#include <ESP8266WiFi.h>
#endif
#elif defined(ESP32)
#include <WiFi.h>
#ifdef TCP_ASYNC
#include <AsyncTCP.h> // https://github.com/me-no-dev/AsyncTCP
#else
#include <WiFi.h>
#endif
#else
#error "Unsupported platform"
#endif
#ifdef EPOXY_DUINO
#define dbg_ptr uint64_t
@@ -32,7 +29,7 @@
// #define TINY_MQTT_DEBUG
#ifdef TINY_MQTT_DEBUG
#define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); }
#define debug(what) { Serial << (int)__LINE__ << ' ' << what << endl; delay(100); }
#else
#define debug(what) {}
#endif
@@ -45,7 +42,7 @@
using TcpServer = WiFiServer;
#endif
enum MqttError
enum __attribute__((packed)) MqttError
{
MqttOk = 0,
MqttNowhereToSend=1,
@@ -67,9 +64,9 @@ class Topic : public IndexedString
class MqttClient;
class MqttMessage
{
const uint16_t MaxBufferLength = 255;
const uint16_t MaxBufferLength = 4096; //hard limit: 16k due to size decoding
public:
enum Type
enum __attribute__((packed)) Type
{
Unknown = 0,
Connect = 0x10,
@@ -84,7 +81,7 @@ class MqttMessage
PingResp = 0xD0,
Disconnect = 0xE0
};
enum State
enum __attribute__((packed)) State
{
FixedHeader=0,
Length=1,
@@ -104,8 +101,7 @@ class MqttMessage
void add(const Topic& t) { add(t.str()); }
const char* end() const { return &buffer[0]+buffer.size(); }
const char* getVHeader() const { return &buffer[vheader]; }
uint16_t length() const { return buffer.size(); }
void complete();
void complete() { encodeLength(); }
void reset();
@@ -115,24 +111,27 @@ class MqttMessage
Type type() const
{
return state == Complete ? static_cast<Type>(buffer[0]) : Unknown;
return state == Complete ? static_cast<Type>(buffer[0] & 0xF0) : Unknown;
}
uint8_t flags() const { return static_cast<uint8_t>(buffer[0] & 0x0F); }
void create(Type type)
{
buffer=(char)type;
buffer+='\0'; // reserved for msg length
vheader=2;
buffer=(decltype(buffer)::value_type)type;
buffer+='\0'; // reserved for msg length byte 1/2
buffer+='\0'; // reserved for msg length byte 2/2 (fixed)
vheader=3; // Should never change
size=0;
state=Create;
}
MqttError sendTo(MqttClient*) const;
MqttError sendTo(MqttClient*);
void hexdump(const char* prefix=nullptr) const;
private:
void encodeLength(char* msb, int length) const;
void encodeLength();
mutable std::string buffer; // mutable -> sendTo()
std::string buffer;
uint8_t vheader;
uint16_t size; // bytes left to receive
State state;
@@ -142,7 +141,7 @@ class MqttBroker;
class MqttClient
{
using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length);
enum Flags
enum __attribute__((packed)) Flags
{
FlagUserName = 128,
FlagPassword = 64,
@@ -163,6 +162,8 @@ class MqttClient
void connect(MqttBroker* parent);
void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10);
// TODO it seems that connected returns true in tcp mode even if
// no negociation occured (only if tcp link is established)
bool connected() { return
(parent!=nullptr and client==nullptr) or
(client and client->connected()); }
@@ -175,10 +176,18 @@ class MqttClient
/** Should be called in main loop() */
void loop();
void close(bool bSendDisconnect=true);
void setCallback(CallBack fun) {callback=fun; };
void setCallback(CallBack fun)
{
callback=fun;
#ifdef TINY_MQTT_DEBUG
Serial << "Callback set to " << (long)fun << endl;
if (callback) callback(this, "test/topic", "value", 5);
#endif
};
// Publish from client to the world
MqttError publish(const Topic&, const char* payload, size_t pay_length);
MqttError publish(const Topic& t, const char* payload) { return publish(t, payload, strlen(payload)); }
MqttError publish(const Topic& t, const String& s) { return publish(t, s.c_str(), s.length()); }
MqttError publish(const Topic& t, const std::string& s) { return publish(t,s.c_str(),s.length());}
MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
@@ -191,29 +200,38 @@ class MqttClient
// TODO seems to be useless
bool isLocal() const { return client == nullptr; }
void dump()
void dump(std::string indent="")
{
(void)indent;
#ifdef TINY_MQTT_DEBUG
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");
if (subscriptions.size())
{
bool c = false;
Serial << " [";
for(auto s: subscriptions)
(void)indent;
{
Serial << (c?", ": "")<< s.str().c_str();
if (c) Serial << ", ";
Serial << s.str().c_str();
c=true;
}
Serial << "]" << endl;
Serial << ']';
}
Serial << endl;
#endif
}
/** Count the number of messages that have been sent **/
static long counter;
#ifdef EPOXY_DUINO
static std::map<MqttMessage::Type, int> counters; // Number of processed messages
#endif
private:
// event when tcp/ip link established (real or fake)
static void onConnect(void * client_ptr, TcpClient*);
#ifdef TCP_ASYNC
static void onData(void* client_ptr, TcpClient*, void* data, size_t len);
@@ -224,10 +242,10 @@ class MqttClient
friend class MqttBroker;
MqttClient(MqttBroker* parent, TcpClient* client);
// republish a received publish if topic matches any in subscriptions
MqttError publishIfSubscribed(const Topic& topic, const MqttMessage& msg);
MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
void clientAlive(uint32_t more_seconds);
void processMessage(const MqttMessage* message);
void processMessage(MqttMessage* message);
bool mqtt_connected = false;
char mqtt_flags;
@@ -240,7 +258,7 @@ class MqttClient
// (this is the case when MqttBroker isn't used except here)
MqttBroker* parent=nullptr; // connection to local broker
TcpClient* client=nullptr; // connection to mqtt client or to remote broker
TcpClient* client=nullptr; // connection to remote broker
std::set<Topic> subscriptions;
std::string clientId;
CallBack callback = nullptr;
@@ -248,7 +266,7 @@ class MqttClient
class MqttBroker
{
enum State
enum __attribute__((packed)) State
{
Disconnected, // Also the initial state
Connecting, // connect and sends a fake publish to avoid circular cnx
@@ -267,14 +285,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:
@@ -288,7 +302,7 @@ class MqttBroker
{ return compareString(auth_password, password, len); }
MqttError publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const;
MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const;
MqttError subscribe(const Topic& topic, uint8_t qos);

7
tests/howto Normal file
View File

@@ -0,0 +1,7 @@
cd TinyMqtt/tests/../..
git clone https://github.com/hsaturn/EspMock.git
git clone https://github.com/bxparks/AUnit.git
git clone https://github.com/bxparks/EpoxyDuino.git
cd TinyMqtt/tests
make
make runtests

View File

@@ -0,0 +1,8 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
APP_NAME := length-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -0,0 +1,53 @@
#include <AUnit.h>
#include <TinyMqtt.h>
#include <map>
/**
* TinyMqtt local unit tests.
*
* Clients are connected to pseudo remote broker
* The remote should be 127.0.0.1:1883 <--- But this does not work due to Esp network limitations
* We are using 127.0.0.1 because this is simpler to test with a single ESP
* Also, this will allow to mock and thus run Action on github
**/
using namespace std;
MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
const char* lastPayload;
size_t lastLength;
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{
if (srce)
published[srce->id()][topic]++;
lastPayload = payload;
lastLength = length;
}
test(length_decode_greater_than_127)
{
// TODO WRITE THIS TEST
// The test should verify than a mqtt message with more than 127 bytes is correctly decoded
assertEqual(1,2);
}
//----------------------------------------------------------------------------
// setup() and loop()
void setup() {
delay(1000);
Serial.begin(115200);
while(!Serial);
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
}
void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
}

View File

@@ -1,7 +1,13 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
EXTRA_CXXFLAGS=-g3 -O0
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := local-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
ESP_LIBS = ESP8266WiFi ESPAsyncTCP
include ../../../EspMock/EspMock.mk
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -1,3 +1,4 @@
#include <Arduino.h>
#include <AUnit.h>
#include <TinyMqtt.h>
#include <map>
@@ -30,12 +31,10 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
test(local_client_should_unregister_when_destroyed)
{
return;
assertEqual(broker.clientsCount(), (size_t)0);
{
MqttClient client;
assertEqual(broker.clientsCount(), (size_t)0); // Ensure client is not yet connected
client.connect("127.0.0.1", 1883);
MqttClient client(&broker);
assertEqual(broker.clientsCount(), (size_t)1); // Ensure client is now connected
}
assertEqual(broker.clientsCount(), (size_t)0);
@@ -67,8 +66,8 @@ test(local_publish_should_be_dispatched)
publisher.publish("a/c");
assertEqual(published.size(), (size_t)1); // 1 client has received something
assertTrue(published[""]["a/b"] == 1);
assertTrue(published[""]["a/c"] == 2);
assertEqual(published[""]["a/b"], 1);
assertEqual(published[""]["a/c"], 2);
}
test(local_publish_should_be_dispatched_to_local_clients)
@@ -90,10 +89,10 @@ test(local_publish_should_be_dispatched_to_local_clients)
publisher.publish("a/c");
assertEqual(published.size(), (size_t)2); // 2 clients have received something
assertTrue(published["A"]["a/b"] == 1);
assertTrue(published["A"]["a/c"] == 1);
assertTrue(published["B"]["a/b"] == 1);
assertTrue(published["B"]["a/c"] == 0);
assertEqual(published["A"]["a/b"], 1);
assertEqual(published["A"]["a/c"], 1);
assertEqual(published["B"]["a/b"], 1);
assertEqual(published["B"]["a/c"], 0);
}
test(local_unsubscribe)
@@ -113,7 +112,7 @@ test(local_unsubscribe)
publisher.publish("a/b");
publisher.publish("a/b");
assertTrue(published[""]["a/b"] == 1); // Only one publish has been received
assertEqual(published[""]["a/b"], 1); // Only one publish has been received
}
test(local_nocallback_when_destroyed)
@@ -142,7 +141,7 @@ void setup() {
Serial.begin(115200);
while(!Serial);
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
Serial.println("=============[ LOCAL TinyMqtt TESTS ]========================");
}
void loop() {

View File

@@ -0,0 +1,13 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
EXTRA_CXXFLAGS=-g3 -O0
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := network-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -0,0 +1,331 @@
#include <Arduino.h>
#include <AUnit.h>
#include <TinyMqtt.h>
#include <map>
/**
* TinyMqtt network unit tests.
*
* No wifi connection unit tests.
* Checks with a local broker. Clients must connect to the local broker
**/
using namespace std;
String toString(const IPAddress& ip)
{
return String(ip[0])+'.'+String(ip[1])+'.'+String(ip[2])+'.'+String(ip[3]);
}
MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
char* lastPayload = nullptr;
size_t lastLength;
void start_servers(int n, bool early_accept = true)
{
ESP8266WiFiClass::resetInstances();
ESP8266WiFiClass::earlyAccept = early_accept;
while(n)
{
ESP8266WiFiClass::selectInstance(n--);
WiFi.mode(WIFI_STA);
WiFi.begin("fake_ssid", "fake_pwd");
}
}
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{
if (srce)
published[srce->id()][topic]++;
if (lastPayload) free(lastPayload);
lastPayload = strdup(payload);
lastLength = length;
}
test(network_single_broker_begin)
{
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
// TODO Nothing is tested here !
}
test(suback)
{
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress broker_ip = WiFi.localIP();
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(broker_ip.toString().c_str(), 1883);
broker.loop();
assertTrue(broker.clientsCount() == 1);
assertTrue(client.connected());
MqttClient::counters[MqttMessage::Type::SubAck] = 0;
client.subscribe("a/b");
// TODO how to avoid these loops ???
broker.loop();
client.loop();
assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
}
test(network_client_to_broker_connexion)
{
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress broker_ip = WiFi.localIP();
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(broker_ip.toString().c_str(), 1883);
broker.loop();
assertTrue(broker.clientsCount() == 1);
assertTrue(client.connected());
}
test(network_one_client_one_broker_publish_and_subscribe_through_network)
{
start_servers(2, true);
published.clear();
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress ip_broker = WiFi.localIP();
// We have a 2nd ESP in order to test through wifi (opposed to local)
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(ip_broker.toString().c_str(), 1883);
broker.loop();
assertTrue(client.connected());
client.setCallback(onPublish);
client.subscribe("a/b");
client.publish("a/b", "ab");
for (int i =0; i<2; i++)
{
client.loop();
broker.loop();
}
assertEqual(published.size(), (size_t)1);
assertEqual((int)lastLength, (int)2); // sizeof(ab)
}
test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
{
start_servers(2, true);
published.clear();
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress ip_broker = WiFi.localIP();
// We have a 2nd ESP in order to test through wifi (opposed to local)
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(ip_broker.toString().c_str(), 1883);
broker.loop();
assertTrue(client.connected());
std::string sent;
for(int i=0; i<200; i++)
sent += char('0'+i%10);
client.setCallback(onPublish);
client.subscribe("a/b");
client.publish("a/b", sent.c_str());
for (int i =0; i<2; i++)
{
client.loop();
broker.loop();
}
assertEqual(published.size(), (size_t)1);
assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
}
test(network_client_should_unregister_when_destroyed)
{
assertEqual(broker.clientsCount(), (size_t)0);
{
MqttClient client(&broker);
assertEqual(broker.clientsCount(), (size_t)1);
}
assertEqual(broker.clientsCount(), (size_t)0);
}
// THESE TESTS ARE IN LOCAL MODE
// WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link)
test(network_connect)
{
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient client(&broker);
assertTrue(client.connected());
assertEqual(broker.clientsCount(), (size_t)1);
}
test(network_publish_should_be_dispatched)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker);
subscriber.subscribe("a/b");
subscriber.subscribe("a/c");
subscriber.setCallback(onPublish);
MqttClient publisher(&broker);
publisher.publish("a/b");
publisher.publish("a/c");
publisher.publish("a/c");
assertEqual(published.size(), (size_t)1); // 1 client has received something
assertEqual(published[""]["a/b"], 1);
assertEqual(published[""]["a/c"], 2);
}
test(network_publish_should_be_dispatched_to_clients)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber_a(&broker, "A");
subscriber_a.setCallback(onPublish);
subscriber_a.subscribe("a/b");
subscriber_a.subscribe("a/c");
MqttClient subscriber_b(&broker, "B");
subscriber_b.setCallback(onPublish);
subscriber_b.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b"); // A and B should receive this
publisher.publish("a/c"); // A should receive this
assertEqual(published.size(), (size_t)2); // 2 clients have received something
assertEqual(published["A"]["a/b"], 1);
assertEqual(published["A"]["a/c"], 1);
assertEqual(published["B"]["a/b"], 1);
assertEqual(published["B"]["a/c"], 0);
}
test(network_unsubscribe)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b"); // This publish is received
subscriber.unsubscribe("a/b");
publisher.publish("a/b"); // Those one, no (unsubscribed)
publisher.publish("a/b");
assertEqual(published[""]["a/b"], 1); // Only one publish has been received
}
test(network_nocallback_when_destroyed)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher(&broker);
{
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
publisher.publish("a/b");
}
publisher.publish("a/b");
assertEqual(published.size(), (size_t)1); // Only one publish has been received
}
test(network_small_payload)
{
published.clear();
const char* payload="abcd";
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b", payload, strlen(payload)); // This publish is received
// coming from MqttClient::publish(...)
assertEqual(payload, lastPayload);
assertEqual(lastLength, (size_t)4);
}
test(network_hudge_payload)
{
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b", payload); // This publish is received
// onPublish should have filled lastPayload and lastLength
assertEqual(payload, lastPayload);
assertEqual(lastLength, strlen(payload));
assertEqual(strcmp(payload, lastPayload), 0);
}
//----------------------------------------------------------------------------
// setup() and loop()
void setup() {
/* delay(1000);
Serial.begin(115200);
while(!Serial);
*/
Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS ]========================");
WiFi.mode(WIFI_STA);
WiFi.begin("network", "password");
}
void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
}

View File

@@ -1,7 +1,13 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
EXTRA_CXXFLAGS=-g3 -O0
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := nowifi-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
ESP_LIBS = ESP8266WiFi ESPAsyncTCP
include ../../../EspMock/EspMock.mk
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -1,3 +1,4 @@
#include <Arduino.h>
#include <AUnit.h>
#include <TinyMqtt.h>
#include <map>
@@ -131,7 +132,7 @@ test(nowifi_nocallback_when_destroyed)
assertEqual(published.size(), (size_t)1); // Only one publish has been received
}
test(nowifi_payload_nullptr)
test(nowifi_small_payload)
{
published.clear();
@@ -149,6 +150,22 @@ test(nowifi_payload_nullptr)
assertEqual(lastLength, (size_t)4);
}
test(nowifi_hudge_payload)
{
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
MqttClient subscriber(&broker);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
publisher.publish("a/b", payload); // This publish is received
// onPublish should have filled lastPayload and lastLength
assertEqual(payload, lastPayload);
assertEqual(lastLength, strlen(payload));
}
//----------------------------------------------------------------------------
// setup() and loop()
void setup() {

View File

@@ -2,6 +2,7 @@
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
APP_NAME := string-indexer-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
ESP_LIBS = ESP8266WiFi ESPAsyncTCP
include ../../../EspMock/EspMock.mk
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -1,3 +1,4 @@
#include <Arduino.h>
#include <AUnit.h>
#include <StringIndexer.h>
#include <map>
@@ -105,5 +106,5 @@ void setup() {
void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
// if (Serial.available()) ESP.reset();
}