Compare commits

..

13 Commits
1.1.2 ... alive

Author SHA1 Message Date
hsaturn
4746abfc96 tests modified accordingly to unique_ptrs 2023-01-02 00:05:22 +01:00
hsaturn
ef24107169 make_unique.inc for EpoxyDuino 2023-01-01 23:33:29 +01:00
Francois BIOT
295e1a06d3 Removed std::make_unique that is not available everywhere 2023-01-01 23:27:45 +01:00
Francois BIOT
1a66d2c991 unique_ptr and more use of debug() macro 2022-12-29 18:17:45 +01:00
Francois BIOT
8162b4c35b Rename MqttBroker to remote_broker 2022-12-29 13:41:45 +01:00
hsaturn
9e578471f1 Try to fix alive problem 2022-12-29 13:10:03 +01:00
Francois BIOT
efa94cc4a4 MqttClient::client renamed to tcp_client 2022-12-29 13:06:56 +01:00
Francois BIOT
040568b478 fix erroneous sizeof multimap comment 2022-12-29 13:04:46 +01:00
hsaturn
a96b51d7f4 Remove useless comment 2022-12-29 12:55:38 +01:00
hsaturn
7ad63551d6 Added missing Makefile for unit test of MqttClassBinder 2022-12-29 12:55:30 +01:00
hsaturn
4627bcd109 AUnit uses ubuntu 20.04 2022-12-29 02:20:22 +01:00
hsaturn
f0af2b95e3 Simulated time for unit test
This change needs some modification in EpoxyDuino that are not yet accepted.
2022-12-29 00:54:18 +01:00
hsaturn
f348d82167 Try to fix alive problem 2022-12-28 23:02:26 +01:00
32 changed files with 703 additions and 1464 deletions

View File

@@ -18,9 +18,9 @@ jobs:
run: |
cd ..
git clone https://github.com/hsaturn/TinyConsole
git clone https://github.com/hsaturn/EpoxyDuino
git clone https://github.com/bxparks/EpoxyDuino
git clone https://github.com/bxparks/AceRoutine
git clone https://github.com/hsaturn/AUnit
git clone https://github.com/bxparks/AUnit
git clone https://github.com/bxparks/AceCommon
git clone https://github.com/hsaturn/EspMock
- name: Verify tests

View File

@@ -10,22 +10,8 @@
TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32 / Esp WROOM
### Statuses of all unit tests of TinyMqtt and its dependencies
| Project | Unit tests result |
| ----------- | ------------ |
| TinyMqtt | [![](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml) |
| Dependencies ||
| TinyConsole | [![](https://github.com/hsaturn/TinyConsole/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/TinyConsole/actions/workflows/aunit.yml) |
| EpoxyDuino | [![AUnit Tests](https://github.com/hsaturn/EpoxyDuino/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/hsaturn/EpoxyDuino/actions/workflows/aunit_tests.yml) |
| EspMock | [![AUnit Tests](https://github.com/hsaturn/EspMock/actions/workflows/aunit.yml/badge.svg)](https://github.com/hsaturn/EspMock/actions/workflows/aunit.yml) |
| AUnit | [![AUnit Tests](https://github.com/hsaturn/AUnit/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/hsaturn/AUnit/actions/workflows/aunit_tests.yml) |
| AceRoutine | [![AUnit Tests](https://github.com/bxparks/AceRoutine/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/bxparks/AceRoutine/actions/workflows/aunit_tests.yml) |
## Features
- Supports retained messages (not activated by default)
- Async Wifi compatible (me-no-dev/ESPAsyncTCP@^1.2.2)
- 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)
@@ -65,13 +51,6 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
- tinymqtt-test : This is a complex sketch with a terminal console
that allows to add clients publish, connect etc with interpreted commands.
## Retained messages
Qos 1 is not supported, but retained messages are. So a new subscription is able to send old messages.
This feature is disabled by default.
The default retain parameter of MqttBroker::MqttBroker takes an optional (0 by default) number of retained messages.
MqttBroker::retain(n) will also make the broker store n messages at max.
## Standalone mode (zeroconf)
-> The zeroconf mode is not yet implemented
zeroconf clients to connect to broker on local network.

View File

@@ -1,62 +0,0 @@
#!/bin/bash
current_version=$(git describe --tags --abbrev=0)
if [ "$1" == "-d" ]; then
do=0
shift
else
do=1
fi
if [ "$1" == "" ]; then
echo
echo "Syntax: $0 [-d] {new_version} [commit message]"
echo
echo " -d : dry run, generate json and update properties but do not run git commands"
echo ""
echo " Current version: $current_version"
echo
else
echo "Current version: ($current_version)"
echo "New version : ($1)"
echo "Take info from : library.properties"
echo -n "Do you want to proceed ? "
read a
if [ "$a" == "y" ]; then
echo "Doing this..."
grep $current_version library.properties
if [ "$?" == "0" ]; then
sed -i "s/$current_version/$1/" library.properties
cp library.json.skeleton library.json
while ifs= read -r line; do
name=$(echo "$line" | sed "s/=.*//g")
value=$(echo "$line" | cut -d= -f 2 | sed 's/"//g')
echo " Replacing $name in json"
if [ "$name" == "depends" ]; then
depends=$(echo "$value" | sed "s/,/ /g")
echo " Depends=$depends"
fi
sed -i "s@#$name@$value@g" library.json
done < library.properties
deps=""
for depend in $depends; do
if [ "$deps" != "" ]; then
deps="$deps, "
fi
deps="$deps'$depend' : '*'"
done
sed -i "s@#dependencies@$deps@g" library.json
sed -i "s/'/\"/g" library.json
if [ "$do" == "1" ]; then
echo "Pushing all"
git commit -m "Release $1 $2"
git tag $1
git add library.properties
git add library.json
git push
git push --tags
fi
else
echo "Current version does not match library.property version, aborting"
fi
fi
fi

View File

@@ -1,111 +0,0 @@
#include <SPI.h>
#include <Ethernet.h>
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
#define WIZRST D3 //Specify pin to use for reseting W5500
#define WIZCS D1 //Specify the pin for SPI CS
#define PORT 1883
MqttBroker broker(PORT);
unsigned long Time;
unsigned long freeRam;
/** 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
*
*/
#if defined(USE_ETHERNET)
byte mac[] = { 0x00, 0xAA, 0xBB, 0xE0, 0x01, 0x25 }; //MAC Address
//IPAddress ip = (192,168,0,88); //Fixed IP Address
#else
const char* ssid = "xxxxxxx";
const char* password = "xxxxxxxx";
#endif
void WizReset() {
Serial.print("Resetting Wiz W5500 Ethernet Board... ");
pinMode(WIZRST, OUTPUT);
digitalWrite(WIZRST, HIGH);
delay(250);
digitalWrite(WIZRST, LOW);
delay(50);
digitalWrite(WIZRST, HIGH);
delay(350);
Serial.println("Done.");
}
void setup()
{
Serial.begin(115200);
#if defined(USE_ETHERNET)
Ethernet.init(WIZCS); // SPI CS Pin
SPI.begin();
WizReset();
Console << TinyConsole::green << "Starting Ethernet...." << endl;
Ethernet.begin(mac); //Connect using DHCP
//Ethernet.begin(mac,ip); //Connect using Fixed IP
if (Ethernet.hardwareStatus() == EthernetNoHardware) {
Console << TinyConsole::red << "Ethernet shield was not found. Sorry, can't run without hardware. :(" << endl;
} else
if (Ethernet.linkStatus() == LinkOFF) {
Console << TinyConsole::red << "Ethernet cable is not connected." << endl;
}
Console << TinyConsole::green << "Local Ethernet IP address: " << Ethernet.localIP() << endl;
broker.begin();
Console << "Broker ready (eth) : " << Ethernet.localIP() << " on port " << PORT << endl;
#else
if (strlen(ssid)==0)
Console << TinyConsole::red << "****** PLEASE MODIFY ssid/password *************" << endl;
WiFi.disconnect(); //Remove previous SSID & Password
WiFi.begin(ssid, password); // Connect to the network
Console << TinyConsole::white << "WiFi Connecting to " << ssid << " ...";
int i = 0;
while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
delay(1000);
Console << TinyConsole::white << ".";
i++;
if (i > 20) break;
}
Console << endl << endl;
Console << TinyConsole::green << "Connected to " << ssid << " IP address: " << WiFi.localIP() << endl;
broker.begin();
Console << "Broker ready (wifi) : " << WiFi.localIP() << " on port " << PORT << endl;
#endif
}
void loop()
{
broker.loop();
if(millis()-Time>10000) {
Time=millis();
if(ESP.getFreeHeap()!=freeRam)
{
freeRam=ESP.getFreeHeap();
Serial.print("RAM:");
Serial.println(freeRam);
}
}
}

View File

@@ -1,117 +0,0 @@
#include <SPI.h>
#include <Ethernet.h>
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
#define WIZRST 20 //Specify pin to use for reseting W5500 = GPIO20
#define WIZCS 17 //Specify the pin for SPI CS = GPIO17 = D5
#define PORT 1883
MqttBroker broker(PORT);
unsigned long Time;
unsigned long freeRam;
/** 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
*
*/
#if defined(USE_ETHERNET)
byte mac[] = { 0x00, 0xAA, 0xBB, 0xE0, 0x01, 0x25 }; //MAC Address
//IPAddress ip = (192,168,0,88); //Fixed IP Address
#else
const char* ssid = "xxxxxxx";
const char* password = "xxxxxxxx";
#endif
void WizReset() {
Serial.print("Resetting Wiz W5500 Ethernet Board... ");
pinMode(WIZRST, OUTPUT);
digitalWrite(WIZRST, HIGH);
delay(250);
digitalWrite(WIZRST, LOW);
delay(50);
digitalWrite(WIZRST, HIGH);
delay(350);
Serial.println("Done.");
}
void setup()
{
Serial.begin(115200);
#if defined(USE_ETHERNET)
Ethernet.init(WIZCS);
SPI.begin();
WizReset();
Console << TinyConsole::green << "Starting Ethernet...." << endl;
Ethernet.begin(mac); //Connect using DHCP
//Ethernet.begin(mac,ip); //Connect using Fixed IP
if (Ethernet.hardwareStatus() == EthernetNoHardware) {
Console << TinyConsole::red << "Ethernet shield was not found. Sorry, can't run without hardware. :(" << endl;
} else
if (Ethernet.linkStatus() == LinkOFF) {
Console << TinyConsole::red << "Ethernet cable is not connected." << endl;
}
Console << TinyConsole::green << "Local Ethernet IP address: " << Ethernet.localIP() << endl;
broker.begin();
Console << "Broker ready (eth) : " << Ethernet.localIP() << " on port " << PORT << endl;
#else
if (strlen(ssid)==0)
Console << TinyConsole::red << "****** PLEASE MODIFY ssid/password *************" << endl;
WiFi.disconnect(); //Remove previous SSID & Password
WiFi.begin(ssid, password); // Connect to the network
Console << TinyConsole::white << "WiFi Connecting to " << ssid << " ...";
int i = 0;
while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
delay(1000);
Console << TinyConsole::white << ".";
i++;
if (i > 20) break;
}
Console << endl << endl;
Console << TinyConsole::green << "Connected to " << ssid << " IP address: " << WiFi.localIP() << endl;
broker.begin();
Console << "Broker ready (wifi) : " << WiFi.localIP() << " on port " << PORT << endl;
#endif
}
void loop()
{
broker.loop();
if(millis()-Time>10000) {
Time=millis();
#ifdef ARDUINO_ARCH_RP2040
if(rp2040.getFreeHeap()!=freeRam) {
freeRam=rp2040.getFreeHeap();
#else
if(ESP.getFreeHeap()!=freeRam) {
freeRam=ESP.getFreeHeap();
#endif
Serial.print("RAM:");
Serial.println(freeRam);
}
}
}

View File

@@ -1,5 +0,0 @@
In TinyString.h the operator
TinyString& operator +=(int);
may need to be added.

View File

@@ -1,9 +1,7 @@
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
const uint16_t PORT 1883;
const uint8_t RETAIN = 10; // Max retained messages
MqttBroker broker(PORT, RETAIN);
#define PORT 1883
MqttBroker broker(PORT);
/** Basic Mqtt Broker
*
@@ -18,8 +16,6 @@ MqttBroker broker(PORT, RETAIN);
* Your ESP will become a MqttBroker.
* You can test it with any client such as mqtt-spy for example
*
* Messages are retained *only* if retain > 0
*
*/
const char* ssid = "";

View File

@@ -1,7 +1,7 @@
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
#include "TinyStreaming.h" // https://github.com/hsaturn/TinyConsole
/** Simple Client (The simplest configuration, client only sends topics)
/** Simple Client (The simplest configuration)
*
*
* +--------+

View File

@@ -3,12 +3,12 @@
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
#include <TinyStreaming.h>
#if defined(ESP8266)
#include <ESP8266mDNS.h>
#include <ESP8266mDNS.h>
#elif defined(ESP32)
#include <WiFi.h>
#include <ESPmDNS.h>
#include <WiFi.h>
#include <ESPmDNS.h>
#else
#error Unsupported platform
#error Unsupported platform
#endif
#include <sstream>
@@ -26,25 +26,23 @@ auto save_cursor = TinyConsole::save_cursor;
auto restore_cursor = TinyConsole::restore_cursor;
auto erase_to_end = TinyConsole::erase_to_end;
const char *ssid = "Freebox-786A2F";
const char *password = "usurpavi8dalum64lumine?";
void onCommand(const string &command);
void eval(string &cmd);
const char* ssid = "";
const char* password = "";
struct free_broker
{
public:
free_broker(const char *s, uint16_t p, const char * /* comment */) : url(s), port(p) {}
public:
free_broker(const char* s, uint16_t p, const char* comment) : url(s), port(p) {}
string url;
std::string url;
uint16_t port;
};
const std::map<string, free_broker> list =
{
{"mqtthq", {"public.mqtthq.com", 8083, "publish/subscribe"}},
{"hivemq", {"broker.hivemq.com", 1883, ""}}};
const std::map<std::string, free_broker> list =
{
{ "mqtthq", { "public.mqtthq.com" , 8083, "publish/subscribe" }},
{ "hivemq", { "broker.hivemq.com", 1883, "" }}
};
/** Very complex example
* Console allowing to make any kind of test,
@@ -57,16 +55,16 @@ const std::map<string, free_broker> list =
* TODO examples of scripts
*/
void onPublish(const MqttClient *srce, const Topic &topic, const char *payload, size_t length)
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{
Console << cyan << "--> " << srce->id().c_str() << ": received " << topic.c_str() << white;
if (payload)
{
Console << ", payload[" << length << "]=[";
while (length--)
while(length--)
{
const char c = *payload++;
if (c < 32)
const char c=*payload++;
if (c<32)
Console << '?';
else
Console << c;
@@ -75,8 +73,8 @@ void onPublish(const MqttClient *srce, const Topic &topic, const char *payload,
}
}
std::map<string, MqttClient *> clients;
std::map<string, MqttBroker *> brokers;
std::map<std::string, MqttClient*> clients;
std::map<std::string, MqttBroker*> brokers;
void setup()
{
@@ -88,8 +86,7 @@ void setup()
delay(500);
Console.cls();
Console << endl
<< endl;
Console << endl << endl;
Console << yellow
<< "***************************************************************" << endl;
Console << "* Welcome to the TinyMqtt console" << endl;
@@ -97,11 +94,10 @@ void setup()
Console << "* Enter help to view the list of commands." << endl;
Console << "***************************************************************" << endl;
Console << endl;
if (strlen(ssid) == 0)
if (strlen(ssid)==0)
Console << red << "* ERROR: You must modify ssid/password in order" << endl
<< " to be able to connect to your Wifi network." << endl;
Console << endl
<< white;
Console << endl << white;
Console << "Connecting to '" << ssid << "' ";
@@ -111,234 +107,215 @@ void setup()
WiFi.begin(ssid, password);
while (WiFi.status() != WL_CONNECTED)
{
Console << '-';
delay(500);
}
{ Console << '-'; delay(500); }
Console << endl
<< "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
Console << endl << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
const char *name = "tinytest";
const char* name="tinytest";
Console << "Starting MDNS, name= " << name;
if (!MDNS.begin(name))
Console << " error, not available." << endl;
else
Console << " ok." << endl;
MqttBroker *broker = new MqttBroker(1883);
MqttBroker* broker = new MqttBroker(1883);
broker->begin();
brokers["broker"] = broker;
if (Console.isTerm())
onCommand("every 333 view");
Console.prompt();
if (Console.isTerm()) onCommand("every 333 view");
}
string getword(string &str, const char *if_empty = nullptr, char sep = ' ');
std::string getword(std::string& str, const char* if_empty=nullptr, char sep=' ');
int getint(string &str, const int if_empty = 0)
int getint(std::string& str, const int if_empty=0)
{
string str2 = str;
string sword = getword(str);
std::string str2=str;
std::string sword = getword(str);
if (sword[0] and isdigit(sword[0]))
{
int ret = atoi(sword.c_str());
while (isdigit(sword[0]) or sword[0] == ' ')
sword.erase(0, 1);
if (sword.length())
str = sword + ' ' + str;
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;
}
str = str2;
str=str2;
return if_empty;
}
string getword(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);
string sword;
while (str.length() and (str[0] != sep or quote))
char quote=(str[0]=='"' or str[0]=='\'' ? str[0] : 0);
if (quote) str.erase(0,1);
std::string sword;
while(str.length() and (str[0]!=sep or quote))
{
if (str[0] == quote)
if (str[0]==quote)
{
str.erase(0, 1);
str.erase(0,1);
break;
}
sword += str[0];
str.erase(0, 1);
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")
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] == '(')
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);
int from=getint(sword);
if (sword[0]==',')
{
sword.erase(0, 1);
sword.erase(0,1);
to = getint(sword);
if (sword[0] != ')')
Console << "Missing ')'" << endl;
if (sword[0]!=')') Console << "Missing ')'" << endl;
}
else
{
to = from;
from = 0;
to=from;
from=0;
}
return String(random(from, to)).c_str();
return String(random(from,to)).c_str();
}
else
{
Console << "Missing '('" << endl;
}
}
while (str[0] == ' ')
str.erase(0, 1);
while(str[0]==' ') str.erase(0,1);
return sword;
}
bool isaddr(string s)
bool isaddr(std::string s)
{
if (s.length() == 0 or s.length() > 3)
return false;
for (char c : s)
if (c < '0' or c > '9')
return false;
if (s.length()==0 or s.length()>3) return false;
for(char c: s)
if (c<'0' or c>'9') return false;
return true;
}
string getip(string &str, const char *if_empty = nullptr, char sep = ' ')
std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
{
string addr = getword(str, if_empty, sep);
string ip = addr;
std::vector<string> build;
while (ip.length())
std::string addr=getword(str, if_empty, sep);
std::string ip=addr;
std::vector<std::string> build;
while(ip.length())
{
string b = getword(ip, nullptr, '.');
if (isaddr(b) && build.size() < 4)
std::string b=getword(ip,nullptr,'.');
if (isaddr(b) && build.size()<4)
{
build.push_back(b);
}
else
return addr;
}
IPAddress local = WiFi.localIP();
IPAddress local=WiFi.localIP();
addr.clear();
while (build.size() != 4)
while(build.size()!=4)
{
std::stringstream b;
b << (int)local[3 - build.size()];
build.insert(build.begin(), b.str().c_str());
b << (int)local[3-build.size()];
build.insert(build.begin(), b.str());
}
for (string s : build)
for(std::string s: build)
{
if (addr.length())
addr += '.';
if (addr.length()) addr += '.';
addr += s;
}
Console << "connect address: " << addr << endl;
return addr;
}
std::map<string, string> vars;
std::map<std::string, std::string> vars;
std::set<string> commands = {
std::set<std::string> commands = {
"broker", "blink", "client", "connect",
"create", "delete", "debug", "help", "interval",
"list", "ls", "ip", "off", "on", "set",
"publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"};
"publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"
};
void convertToCommand(string &search)
void convertToCommand(std::string& search)
{
while (search[0] == ' ')
search.erase(0, 1);
if (search.length() == 0)
return;
string matches;
int count = 0;
for (string cmd : commands)
while(search[0]==' ') search.erase(0,1);
if (search.length()==0) return;
std::string matches;
int count=0;
for(std::string cmd: commands)
{
if (cmd.substr(0, search.length()) == search)
{
if (count)
matches += ", ";
if (count) matches +=", ";
count++;
matches += cmd;
}
}
if (count == 1)
if (count==1)
search = matches;
else if (count > 1)
else if (count>1)
{
Console << "Ambiguous command: " << matches << endl;
search.clear();
}
}
void replace(const char *d, string &str, string srch, string to)
void replace(const char* d, std::string& str, std::string srch, std::string to)
{
if (d[0] && d[1])
{
srch = d[0] + srch + d[1];
to = d[0] + to + d[1];
srch=d[0]+srch+d[1];
to=d[0]+to+d[1];
size_t pos = 0;
while ((pos = str.find(srch, pos)) != string::npos)
while((pos=str.find(srch, pos)) != std::string::npos)
{
str.erase(pos, srch.length());
str.insert(pos, to);
pos += to.length() - 1;
pos += to.length()-1;
}
}
}
void replaceVars(string &cmd)
void replaceVars(std::string& cmd)
{
cmd = ' ' + cmd + ' ';
cmd = ' '+cmd+' ';
for (auto it : vars)
for(auto it: vars)
{
replace("..", cmd, it.first, it.second);
replace(". ", cmd, it.first, it.second);
replace(" .", cmd, it.first, it.second);
replace(" ", cmd, it.first, it.second);
}
cmd.erase(0, cmd.find_first_not_of(' '));
cmd.erase(cmd.find_last_not_of(' ') + 1);
cmd.erase(0, cmd.find_first_not_of(" "));
cmd.erase(cmd.find_last_not_of(" ")+1);
}
bool compare(string s, const char *cmd)
bool compare(std::string s, const char* cmd)
{
uint8_t p = 0;
while (s[p++] == *cmd++)
uint8_t p=0;
while(s[p++]==*cmd++)
{
if (*cmd == 0 or s[p] == 0)
return true;
if (s[p] == ' ')
return true;
if (*cmd==0 or s[p]==0) return true;
if (s[p]==' ') return true;
}
return false;
}
using ClientFunction = void (*)(string &cmd, MqttClient *publish);
using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
struct Every
{
string cmd;
std::string cmd;
uint32_t ms;
uint32_t next;
uint32_t underrun = 0;
bool active = true;
uint32_t underrun=0;
bool active=true;
void dump()
{
@@ -347,12 +324,12 @@ struct Every
else
Console << red << "disabled";
auto mill = millis();
auto mill=millis();
Console << white << ms << "ms [" << cmd << "] next in ";
if (mill > next)
Console << "now";
else
Console << next - mill << "ms";
Console << next-mill << "ms";
}
};
@@ -364,49 +341,49 @@ int16_t blink;
std::vector<Every> everies;
void onCommand(const string &command)
void onCommand(const std::string& command)
{
Console << endl;
string cmd = command;
if (cmd.substr(0, 3) != "set")
replaceVars(cmd);
std::string cmd=command;
if (cmd.substr(0,3)!="set") replaceVars(cmd);
eval(cmd);
Console << endl;
Console.prompt();
}
void clientConnect(MqttClient *client, string &cmd)
void clientConnect(MqttClient* client, std::string& cmd)
{
string remote = getword(cmd);
std::string remote = getword(cmd);
uint16_t port;
auto it = list.find(remote);
auto it=list.find(remote);
if (it != list.end())
{
Console << "Connecting to free broker: " << remote << endl;
remote = it->second.url;
port = it->second.port;
port=it->second.port;
}
else
port = getint(cmd);
port=getint(cmd);
client->connect(remote.c_str(), port, getint(cmd, 60));
Console << (client->connected() ? "connected." : "not connected") << endl;
}
void eval(string &cmd)
void eval(std::string& cmd)
{
while (cmd.length())
while(cmd.length())
{
MqttError retval = MqttOk;
string s;
MqttBroker *broker = nullptr;
MqttClient *client = nullptr;
std::string s;
MqttBroker* broker = nullptr;
MqttClient* client = nullptr;
// client.function notation
if (cmd.find('.') != string::npos &&
if (cmd.find('.') != std::string::npos &&
cmd.find('.') < cmd.find(' '))
{
s = getword(cmd, nullptr, '.');
s=getword(cmd, nullptr, '.');
if (s.length())
{
@@ -427,26 +404,28 @@ void eval(string &cmd)
}
s = getword(cmd);
if (s.length())
convertToCommand(s);
if (s.length() == 0)
if (s.length()) convertToCommand(s);
if (s.length()==0)
{}
else if (compare(s, "debug"))
{
#if TINY_MQTT_DEBUG
TinyMqtt::debug = getint(cmd);
#else
Console << red << "TinyMqtt not compiled in debug" << endl;
#endif
}
else if (compare(s, "list"))
{
Console << "List of free servers" << endl;
for (const auto &fb : list)
for(const auto& fb: list)
{
Console << " " << fb.first << " : " << fb.second.url << ":" << fb.second.port << endl;
}
}
else if (compare(s, "free"))
{
Console << "Free memory: " << ESP.getFreeHeap() << endl;
}
else if (compare(s, "delete"))
{
if (client == nullptr && broker == nullptr)
if (client==nullptr && broker==nullptr)
{
s = getword(cmd);
if (clients.find(s) != clients.end())
@@ -462,10 +441,9 @@ void eval(string &cmd)
}
if (client)
{
for (auto it : clients)
for (auto it: clients)
{
if (it.second != client)
continue;
if (it.second != client) continue;
Console << "deleted" << endl;
delete (it.second);
clients.erase(it.first);
@@ -475,10 +453,9 @@ void eval(string &cmd)
}
else if (broker)
{
for (auto it : brokers)
for(auto it: brokers)
{
if (broker != it.second)
continue;
if (broker != it.second) continue;
Console << "deleted" << endl;
delete (it.second);
brokers.erase(it.first);
@@ -491,24 +468,9 @@ void eval(string &cmd)
}
else if (broker)
{
if (compare(s, "connect"))
if (compare(s,"connect"))
{
string remote = getword(cmd);
int port = getint(cmd);
if (port == 0) port=1883;
broker->connect(remote, port);
if (broker->connected())
Console << "Broker connected";
else
Console << red << "Unable to connect";
Console << " to " << remote << ':' << port << white << endl;
}
else if (compare(s, "retain"))
{
if (cmd.size())
broker->retain(getint(cmd));
Console << "retain=" << broker->retain() << ", retained msg=" << broker->retainCount() << endl;
Console << "NYI" << endl;
}
else if (compare(s, "view"))
{
@@ -522,19 +484,15 @@ void eval(string &cmd)
}
else if (client)
{
if (compare(s, "connect"))
if (compare(s,"connect"))
{
clientConnect(client, cmd);
}
else if (compare(s, "rpublish"))
{
retval = client->publish(getword(cmd), getword(cmd), true);
}
else if (compare(s, "publish"))
else if (compare(s,"publish"))
{
retval = client->publish(getword(cmd), getword(cmd));
}
else if (compare(s, "subscribe"))
else if (compare(s,"subscribe"))
{
client->subscribe(getword(cmd));
}
@@ -554,27 +512,27 @@ void eval(string &cmd)
}
else if (compare(s, "on"))
{
uint8_t pin = getint(cmd, 2);
uint8_t pin=getint(cmd, 2);
pinMode(pin, OUTPUT);
digitalWrite(pin, HIGH);
}
else if (compare(s, "off"))
{
uint8_t pin = getint(cmd, 2);
uint8_t pin=getint(cmd, 2);
pinMode(pin, OUTPUT);
digitalWrite(pin, LOW);
}
else if (compare(s, "echo"))
{
s = getword(cmd);
if (s == "on")
s=getword(cmd);
if (s=="on")
echo_on = true;
else if (s == "off")
else if (s=="off")
echo_on = false;
else
{
Console << s << ' ';
while (cmd.length())
while(cmd.length())
{
Console << getword(cmd) << ' ';
}
@@ -588,9 +546,9 @@ void eval(string &cmd)
if (cmd.length())
{
Every every;
every.ms = ms;
every.cmd = cmd;
every.next = millis() + ms;
every.ms=ms;
every.cmd=cmd;
every.next=millis()+ms;
everies.push_back(every);
every.dump();
Console << endl;
@@ -599,16 +557,16 @@ void eval(string &cmd)
}
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)
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 (count==ever or (ever==100))
{
if (every.active != active)
{
Console << "every #" << count << (active ? " on" : " off") << endl;
Console << "every #" << count << (active ? " on" :" off") << endl;
every.active = active;
every.underrun = 0;
}
@@ -616,12 +574,12 @@ void eval(string &cmd)
count++;
}
}
else if (compare(cmd, "list") or cmd.length() == 0)
else if (compare(cmd, "list") or cmd.length()==0)
{
getword(cmd);
Console << "List of everies (ms=" << millis() << ")" << endl;
uint8_t count = 0;
for (auto &every : everies)
uint8_t count=0;
for(auto& every: everies)
{
Console << count << ": ";
every.dump();
@@ -633,20 +591,20 @@ void eval(string &cmd)
{
Console << "Removing..." << endl;
getword(cmd);
int8_t every = getint(cmd, -1);
if (every == -1 and compare(cmd, "last") and everies.size())
int8_t every=getint(cmd, -1);
if (every==-1 and compare(cmd, "last") and everies.size())
{
getword(cmd);
everies.erase(everies.begin() + everies.size() - 1);
everies.erase(everies.begin()+everies.size()-1);
}
else if (every == -1 and compare(cmd, "all"))
else if (every==-1 and compare(cmd, "all"))
{
getword(cmd);
everies.clear();
}
else if (everies.size() > (uint8_t)every)
{
everies.erase(everies.begin() + every);
everies.erase(everies.begin()+every);
}
else
Console << "Bad colmmand" << endl;
@@ -659,33 +617,33 @@ void eval(string &cmd)
int8_t blink_nr = getint(cmd, -1);
if (blink_nr >= 0)
{
blink_ms_on[blink_nr] = getint(cmd, blink_ms_on[blink_nr]);
blink_ms_off[blink_nr] = getint(cmd, blink_ms_on[blink_nr]);
blink_ms_on[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
blink_ms_off[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
pinMode(blink_nr, OUTPUT);
blink_next[blink_nr] = millis();
Console << "Blink " << blink_nr << ' ' << (blink_ms_on[blink_nr] ? "on" : "off") << endl;
if (blink_ms_on[blink_nr])
blink |= 1 << blink_nr;
blink |= 1<< blink_nr;
else
{
blink &= ~(1 << blink_nr);
blink &= ~(1<< blink_nr);
}
}
}
else if (compare(s, "broker"))
{
string id = getword(cmd);
std::string id=getword(cmd);
if (clients.find(id) != clients.end())
{
Console << "A client already have that name" << endl;
cmd.clear();
}
else if (id.length() or brokers.find(id) != brokers.end())
else if (id.length() or brokers.find(id)!=brokers.end())
{
int port = getint(cmd, 0);
int port=getint(cmd, 0);
if (port)
{
MqttBroker *broker = new MqttBroker(port);
MqttBroker* broker = new MqttBroker(port);
broker->begin();
brokers[id] = broker;
@@ -705,26 +663,25 @@ void eval(string &cmd)
}
else if (compare(s, "client"))
{
string id = getword(cmd);
std::string id=getword(cmd);
if (brokers.find(id) != brokers.end())
{
Console << "A broker have that name" << endl;
cmd.clear();
}
else if (id.length() or clients.find(id) != clients.end())
else if (id.length() or clients.find(id)!=clients.end())
{
s = getword(cmd); // broker
if (s == "" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
s=getword(cmd); // broker
if (s=="" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
{
MqttBroker *broker = nullptr;
if (s.length())
broker = brokers[s];
MqttClient *client = new MqttClient(broker, id);
clients[id] = client;
MqttBroker* broker = nullptr;
if (s.length()) broker = brokers[s];
MqttClient* client = new MqttClient(broker, id);
clients[id]=client;
client->setCallback(onPublish);
if (list.find(s) != list.end())
{
cmd = s + ' ' + cmd;
cmd=s+' '+cmd;
clientConnect(client, cmd);
}
Console << "new client (" << id.c_str() << ", " << s.c_str() << ')' << endl;
@@ -743,10 +700,10 @@ void eval(string &cmd)
}
else if (compare(s, "set"))
{
string name(getword(cmd));
if (name.length() == 0)
std::string name(getword(cmd));
if (name.length()==0)
{
for (auto it : vars)
for(auto it: vars)
{
Console << " " << it.first << " -> " << it.second << endl;
}
@@ -773,19 +730,18 @@ void eval(string &cmd)
if (view)
{
Console << save_cursor << magenta;
Console.gotoxy(1, 1);
Console.gotoxy(1,1);
}
Console << "--< " << '/' << clients.size() << " client/s. >--" << erase_to_end;
Console << " (FreeMem: " << ESP.getFreeHeap() << ')' << endl;
for (auto it : clients)
Console << "--< " << '/' << clients.size() << " client/s. >--" << erase_to_end << endl;
for(auto it: clients)
{
it.second->dump(" ");
}
Console << "--< " << brokers.size() << " brokers/s. >--" << erase_to_end << endl;
for (auto it : brokers)
for(auto it: brokers)
{
Console << " +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s." << erase_to_end << endl;
Console << " +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s."<< erase_to_end << endl;
it.second->dump(" ");
}
if (view)
@@ -798,26 +754,23 @@ void eval(string &cmd)
ESP.restart();
else if (compare(s, "ip"))
Console << "IP: " << WiFi.localIP() << endl;
else if (compare(s, "help"))
else if (compare(s,"help"))
{
Console << "syntax:" << endl;
Console << " MqttBroker:" << endl;
Console << " broker {name} {port} : create a new broker" << endl;
Console << " name can be one of 'list'" << endl;
Console << " name.delete : delete a broker (buggy)" << endl;
Console << " name.retain [#] : show/set retain value" << endl;
Console << " name.view : dump a broker" << endl;
Console << " broker {broker_name} {port} : create a new broker" << endl;
Console << " broker_name can be one of 'list'" << endl;
Console << " broker_name.delete : delete a broker (buggy)" << endl;
Console << " broker_name.view : dump a broker" << endl;
Console << endl;
Console << " MqttClient:" << endl;
Console << " client {name} {broker} : create a client then" << endl;
Console << " name.connect [ip] [port] [alive]" << endl;
Console << " name.[un]subscribe topic" << endl;
Console << " name.publish topic [payload]" << endl;
Console << " name.rpublish topic [payload] : publish a retained message" << endl;
Console << " name.view" << endl;
Console << " name.delete" << endl;
Console << endl;
Console << " free : view free mem" << endl;
Console << " list : list of free brokers (debug 1 advised)" << endl;
Console << " debug #" << endl;
Console << " list : get list of free brokers" << endl;
@@ -835,8 +788,7 @@ void eval(string &cmd)
}
else
{
while (s[0] == ' ')
s.erase(0, 1);
while(s[0]==' ') s.erase(0,1);
if (s.length())
Console << "Unknown command (" << s.c_str() << ")" << endl;
}
@@ -850,32 +802,30 @@ void eval(string &cmd)
void loop()
{
auto ms = millis();
int8_t out = 0;
auto ms=millis();
int8_t out=0;
int16_t blink_bits = blink;
uint8_t e = 0;
uint8_t e=0;
for (auto &every : everies)
for(auto& every: everies)
{
if (not every.active)
continue;
if (not every.active) continue;
if (every.ms && every.cmd.length() && ms > every.next)
{
string cmd(every.cmd);
std::string cmd(every.cmd);
eval(cmd);
every.next += every.ms;
if (ms > every.next and ms > every.underrun)
{
every.next += every.ms;
Console << yellow << "Underrun every #" << e << ", " << (ms - every.next) << "ms late" << endl;
Console.fg(white);
every.underrun = ms + 5000;
every.underrun = ms+5000;
}
}
e++;
}
while (blink_bits)
while(blink_bits)
{
if (blink_ms_on[out] and ms > blink_next[out])
{
@@ -891,18 +841,19 @@ void loop()
}
blink_state[out] = not blink_state[out];
}
blink_bits >>= 1;
blink_bits >>=1;
out++;
}
static long count;
#if defined(ESP9266)
MDNS.update();
#endif
for (auto it : brokers)
for(auto it: brokers)
it.second->loop();
for (auto it : clients)
for(auto it: clients)
it.second->loop();
Console.loop();

View File

@@ -1,20 +0,0 @@
{
"name": "TinyMqtt",
"keywords": [ "ethernet, mqtt, m2m, iot" ],
"description": "A lightweight MQTT library for ESP8266 and ESP32, supporting MQTT 3.1.1 with QoS and allowing to create a Mqtt broker",
"repository": {
"type": "git",
"url": "https://github.com/hsaturn/TinyMqtt.git"
},
"dependencies":
{ "hsaturn/TinyConsole" : "*" },
"version": "1.1.0",
"exclude": "",
"examples": "examples/*/*.ino",
"frameworks": "arduino",
"platforms": [
"atmelavr",
"espressif8266",
"espressif32"
]
}

View File

@@ -1,20 +0,0 @@
{
"name": "#name",
"keywords": [ "ethernet, mqtt, m2m, iot" ],
"description": "#paragraph",
"repository": {
"type": "git",
"url": "https://github.com/hsaturn/TinyMqtt.git"
},
"dependencies":
{ #dependencies },
"version": "#version",
"exclude": "",
"examples": "examples/*/*.ino",
"frameworks": "arduino",
"platforms": [
"atmelavr",
"espressif8266",
"espressif32"
]
}

View File

@@ -1,11 +1,11 @@
name=TinyMqtt
version=1.1.0
version=0.9.11
author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
maintainer=Francois BIOT <hsaturn@gmail.com>
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
sentence=A tiny broker and client library for MQTT messaging.
paragraph=A lightweight MQTT library for ESP8266 and ESP32, supporting MQTT 3.1.1 with QoS and allowing to create a Mqtt broker
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=*
depends=hsaturn/TinyConsole
depends=TinyConsole
includes=TinyMqtt.h

View File

@@ -1,4 +1,3 @@
#include "StringIndexer.h"
StringIndexer::Strings StringIndexer::strings;
std::map<StringIndexer::index_t, StringIndexer::StringCounter> StringIndexer::strings;

View File

@@ -1,25 +1,18 @@
// vim: ts=2 sw=2 expandtab
#pragma once
#include <assert.h>
#include <map>
#include <unordered_map>
#include "TinyConsole.h"
#include <string>
#include <string.h>
using string = TinyConsole::string;
/***
* Allows to store up to 255 different strings with one byte class
* very memory efficient when one string is used many times.
*/
class StringIndexer
{
private:
class StringCounter
{
string str;
std::string str;
uint8_t used=0;
friend class StringIndexer;
@@ -36,9 +29,9 @@ class StringIndexer
public:
using index_t = uint8_t;
static const string& str(const index_t& index)
static const std::string& str(const index_t& index)
{
static string dummy;
static std::string dummy;
const auto& it=strings.find(index);
if (it == strings.end()) return dummy;
return it->second.str;
@@ -84,7 +77,7 @@ class StringIndexer
{
if (strings.find(index)==strings.end())
{
strings[index].str = string(str, len);
strings[index].str = std::string(str, len);
strings[index].used++;
// Serial << "Creating index " << index << " for (" << strings[index].str.c_str() << ") len=" << len << endl;
return index;
@@ -93,9 +86,7 @@ class StringIndexer
return 0; // TODO out of indexes
}
using Strings = std::unordered_map<index_t, StringCounter>;
static Strings strings;
static std::map<index_t, StringCounter> strings;
};
class IndexedString
@@ -107,14 +98,12 @@ class IndexedString
index = source.index;
}
IndexedString(IndexedString&& i) : index(i.index) {}
IndexedString(const char* str, uint8_t len)
{
index=StringIndexer::strToIndex(str, len);
}
IndexedString(const string& str) : IndexedString(str.c_str(), str.length()) {};
IndexedString(const std::string& str) : IndexedString(str.c_str(), str.length()) {};
~IndexedString() { StringIndexer::release(index); }
@@ -135,7 +124,7 @@ class IndexedString
return i1.index == i2.index;
}
const string& str() const { return StringIndexer::str(index); }
const std::string& str() const { return StringIndexer::str(index); }
const StringIndexer::index_t& getIndex() const { return index; }

View File

@@ -9,53 +9,24 @@ static auto red = TinyConsole::red;
static auto yellow = TinyConsole::yellow;
int TinyMqtt::debug=2;
#endif
#ifdef EPOXY_DUINO
std::map<MqttMessage::Type, int> MqttClient::counters;
int MqttBroker::instances = 0;
int MqttClient::instances = 0;
#endif
MqttBroker::MqttBroker(uint16_t port, uint8_t max_retain_size)
MqttBroker::MqttBroker(uint16_t port)
{
debug("New broker" << port);
retain_size = max_retain_size;
server = new TcpServer(port);
server = std::unique_ptr<TcpServer>(new TcpServer(port));
#ifdef TINY_MQTT_ASYNC
server->onClient(onClient, this);
#endif
#ifdef EPOXY_DUINO
instances++;
#endif
}
MqttBroker::~MqttBroker()
{
#ifdef EPOXY_DUINO
instances--;
#endif
closeRemoteBroker();
while(clients.size())
{
auto client = clients[0];
client->local_broker = nullptr;
if (client->cltFlags & MqttClient::CltFlags::CltFlagToDelete)
{
// std::cout << "Deleting client" << std::endl;
delete client;
}
clients.erase(clients.begin());
}
delete server;
}
// private constructor used by broker only
MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
: local_broker(local_broker)
{
connect(local_broker);
debug("MqttClient private with broker");
#ifdef TINY_MQTT_ASYNC
tcp_client = new_client;
@@ -63,42 +34,29 @@ MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
// client->onConnect() TODO
// client->onDisconnect() TODO
#else
tcp_client = new TcpClient(*new_client);
#endif
#ifdef EPOXY_DUINO
alive = millis()+500000;
instances++;
#else
alive = millis()+5000; // TODO MAGIC client expires after 5s if no CONNECT msg
tcp_client.reset(new WiFiClient(*new_client));
#endif
alive = millis()+5000;
}
MqttClient::MqttClient(MqttBroker* local_broker, const string& id)
MqttClient::MqttClient(MqttBroker* local_broker, const std::string& id)
: local_broker(local_broker), clientId(id)
{
alive = 0;
keep_alive = 0;
if (local_broker) local_broker->addClient(this);
#ifdef EPOXY_DUINO
instances++;
#endif
}
MqttClient::~MqttClient()
{
#ifdef EPOXY_DUINO
instances--;
#endif
close();
delete tcp_client;
debug("*** MqttClient delete()");
}
void MqttClient::close(bool bSendDisconnect)
{
debug("close " << id().c_str());
resetFlag(CltFlagConnected);
mqtt_flags &= ~FlagConnected;
if (tcp_client) // connected to a remote broker
{
if (bSendDisconnect and tcp_client->connected())
@@ -120,28 +78,28 @@ void MqttClient::close(bool bSendDisconnect)
void MqttClient::connect(MqttBroker* local)
{
debug("MqttClient::connect_local");
alive = 0;
close();
local_broker = local;
local_broker->addClient(this);
clientAlive();
}
void MqttClient::connect(string broker, uint16_t port, uint16_t ka)
void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
{
debug("MqttClient::connect_to_host " << broker << ':' << port);
keep_alive = ka;
close();
if (tcp_client) delete tcp_client;
tcp_client = new TcpClient;
tcp_client.reset(new TcpClient);
#ifdef TINY_MQTT_ASYNC
tcp_client->onData(onData, this);
tcp_client->onConnect(onConnect, this);
tcp_client->connect(broker.c_str(), port);
tcp_client->connect(broker.c_str(), port, ka);
#else
if (tcp_client->connect(broker.c_str(), port))
{
debug("link established");
onConnect(this, tcp_client);
onConnect(this, tcp_client.get());
}
else
{
@@ -150,51 +108,23 @@ void MqttClient::connect(string broker, uint16_t port, uint16_t ka)
#endif
}
void MqttBroker::addClient(MqttClient* client)
void MqttBroker::addClient(TcpClient* client)
{
debug("MqttBroker::addClient");
clients.push_back(client);
clients.insert(std::unique_ptr<MqttClient>(new MqttClient(this, client)));
}
void MqttBroker::closeRemoteBroker()
{
if (remote_broker)
{
delete remote_broker;
remote_broker = nullptr;
}
}
void MqttBroker::connect(const string& host, uint16_t port)
void MqttBroker::connect(const std::string& host, uint16_t port)
{
debug("MqttBroker::connect");
closeRemoteBroker();
if (remote_broker == nullptr) remote_broker = new MqttClient;
remote_broker->connect(host, port);
remote_broker->local_broker = this; // Because connect removed the link
// TODO shouldn't we resubscribe to all client subscriptions ?
}
void MqttBroker::removeClient(MqttClient* remove)
{
debug("removeClient");
for(auto it=clients.begin(); it!=clients.end(); it++)
{
auto client=*it;
if (client==remove)
{
// TODO if this broker is connected to an external broker
// we have to unsubscribe remove's topics.
// (but doing this, check that other clients are not subscribed...)
// Unless -> we could receive useless messages
// -> we are using (memory) one IndexedString plus its string for nothing.
debug("Remove " << clients.size());
clients.erase(it);
debug("Client removed " << clients.size());
return;
}
}
debug(red << "Error cannot remove client"); // TODO should not occur
local_clients.erase(remove);
}
void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
@@ -202,16 +132,14 @@ void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
debug("MqttBroker::onClient");
MqttBroker* broker = static_cast<MqttBroker*>(broker_ptr);
MqttClient* mqtt = new MqttClient(broker, client);
mqtt->setFlag(MqttClient::CltFlags::CltFlagToDelete);
broker->addClient(mqtt);
broker->addClient(client);
debug("New client");
}
void MqttBroker::loop()
{
#ifndef TINY_MQTT_ASYNC
TcpClient client = server->accept();
WiFiClient client = server->available();
if (client)
{
@@ -225,38 +153,23 @@ void MqttBroker::loop()
remote_broker->loop();
}
for(size_t i=0; i<clients.size(); i++)
// 200 bytes shorter than for(auto& client: clients) !
for(auto it=clients.begin(); it!=clients.end(); it++)
{
MqttClient* client = clients[i];
if (client->connected())
it->get()->loop();
if (not it->get()->connected())
{
client->loop();
}
else
{
debug("Client " << client->id().c_str() << " Disconnected, local_broker=" << (dbg_ptr)client->local_broker);
// Note: deleting a client not added by the broker itself will probably crash later.
delete client;
clients.erase(it);
break;
}
}
for(const auto& client: local_clients)
client->loop();
}
// Obvioulsy called when the broker is connected to another broker.
MqttError MqttBroker::subscribe(MqttClient* client, const Topic& topic, uint8_t qos)
MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
{
debug("MqttBroker::subscribe to " << topic.str() << ", retained=" << retained.size() );
for(auto& retainItem: retained)
{
auto &retained_topic = retainItem.first;
auto &retain = retainItem.second;
debug(" retained: " << retained_topic.str());
if (topic.matches(retained_topic))
{
debug(" -> sending");
client->publishIfSubscribed(retained_topic, retain.msg);
}
}
debug("MqttBroker::subscribe");
if (remote_broker && remote_broker->connected())
{
return remote_broker->subscribe(topic, qos);
@@ -264,21 +177,18 @@ MqttError MqttBroker::subscribe(MqttClient* client, const Topic& topic, uint8_t
return MqttNowhereToSend;
}
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg)
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const
{
MqttError retval = MqttOk;
retain(topic, msg);
debug("MqttBroker::publish");
int i=0;
for(auto client: clients)
int clt_num = 0;
for(auto& client: clients)
{
i++;
#if TINY_MQTT_DEBUG
Console << __LINE__ << " broker:" << (remote_broker && remote_broker->connected() ? "linked" : "alone") <<
" srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
#endif
debug (" broker:" << (remote_broker && remote_broker->connected() ? "linked" : "alone")
<< " srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << ++clt_num
<< ", local=" << client->isLocal() << ", con=" << client->connected());
bool doit = false;
if (remote_broker && remote_broker->connected()) // this (MqttBroker) is connected (to a external broker)
{
@@ -296,9 +206,8 @@ MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, Mqtt
{
doit = true;
}
#if TINY_MQTT_DEBUG
Console << ", doit=" << doit << ' ';
#endif
debug(" doit=" << doit << ' ');
if (doit) retval = client->publishIfSubscribed(topic, msg);
debug("");
@@ -322,16 +231,12 @@ void MqttMessage::getString(const char* &buff, uint16_t& len)
buff+=2;
}
void MqttClient::clientAlive(uint32_t more_seconds)
void MqttClient::clientAlive()
{
debug("MqttClient::clientAlive");
if (keep_alive)
{
#ifdef EPOXY_DUINO
alive=millis()+500000+0*more_seconds;
#else
alive=millis()+1000*(keep_alive+more_seconds);
#endif
alive=millis()+1000*(keep_alive+(local_broker ? TINY_MQTT_CLIENT_ALIVE_TOLERANCE : 0));
}
else
alive=0;
@@ -339,26 +244,26 @@ void MqttClient::clientAlive(uint32_t more_seconds)
void MqttClient::loop()
{
if (keep_alive && (millis() >= alive))
if (alive && (millis() >= alive))
{
if (tcp_client && tcp_client->connected())
if (local_broker)
{
Serial << "timeout client " << clientId << endl;
close();
debug(red << "closed");
}
else if (tcp_client && tcp_client->connected())
{
debug("pingreq");
static MqttMessage pingreq(MqttMessage::Type::PingReq);
pingreq.sendTo(this);
clientAlive(0);
uint16_t pingreq = MqttMessage::Type::PingReq;
tcp_client->write((const char*)(&pingreq), 2);
clientAlive();
// TODO when many MqttClient passes through a local broker
// there is no need to send one PingReq per instance.
}
else if (local_broker)
{
debug(red << "timeout client");
close();
debug(red << "closed");
}
}
#ifndef TINY_MQTT_ASYNC
while(tcp_client && tcp_client->available()>0)
{
@@ -389,7 +294,7 @@ void MqttClient::onConnect(void *mqttclient_ptr, TcpClient*)
msg.reset();
debug("cnx: mqtt sent " << (dbg_ptr)mqtt->local_broker);
mqtt->clientAlive(0);
mqtt->clientAlive();
}
#ifdef TINY_MQTT_ASYNC
@@ -421,7 +326,7 @@ void MqttClient::resubscribe()
msg.add(0);
msg.add(0);
for(auto topic: subscriptions)
for(const auto& topic: subscriptions)
{
msg.add(topic);
msg.add(0); // TODO qos
@@ -437,13 +342,13 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
subscriptions.insert(topic);
if (local_broker==nullptr) // connected to a remote broker
if (local_broker==nullptr) // remote broker
{
return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
}
else
{
return local_broker->subscribe(this, topic, qos);
return local_broker->subscribe(topic, qos);
}
return ret;
}
@@ -496,13 +401,14 @@ void MqttClient::processMessage(MqttMessage* mesg)
switch(mesg->type())
{
case MqttMessage::Type::Connect:
if (mqtt_connected())
if (mqtt_flags & FlagConnected)
{
debug("already connected");
break;
}
payload = header+10;
mqtt_flags = header[7];
// Todo should check that reserved == 0 (spec)
mqtt_flags = header[7] & ~FlagConnected;
keep_alive = MqttMessage::getSize(header+8);
if (strncmp("MQTT", header+2,4))
{
@@ -511,13 +417,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
}
if (header[6]!=0x04)
{
debug("Unsupported MQTT version (" << (int) header[6] << "), only version=4 supported" << endl);
debug("unknown level");
break; // Level 3.1.1
}
// ClientId
mesg->getString(payload, len);
clientId = string(payload, len);
clientId = std::string(payload, len);
payload += len;
if (mqtt_flags & FlagWill) // Will topic
@@ -542,11 +448,10 @@ void MqttClient::processMessage(MqttMessage* mesg)
payload += len;
}
#if TINY_MQTT_DEBUG
Console << yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white << endl;
#endif
debug(yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white);
bclose = false;
setFlag(CltFlagConnected);
mqtt_flags |= FlagConnected;
{
MqttMessage msg(MqttMessage::Type::ConnAck);
msg.add(0); // Session present (not implemented)
@@ -556,14 +461,14 @@ void MqttClient::processMessage(MqttMessage* mesg)
break;
case MqttMessage::Type::ConnAck:
setFlag(CltFlagConnected);
mqtt_flags |= FlagConnected;
bclose = false;
resubscribe();
break;
case MqttMessage::Type::SubAck:
case MqttMessage::Type::PubAck:
if (not mqtt_connected()) break;
if (not (mqtt_flags & FlagConnected)) break;
// Ignore acks
bclose = false;
break;
@@ -574,7 +479,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
break;
case MqttMessage::Type::PingReq:
if (not mqtt_connected()) break;
if (not (mqtt_flags & FlagConnected)) break;
if (tcp_client)
{
uint16_t pingreq = MqttMessage::Type::PingResp;
@@ -591,15 +496,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
case MqttMessage::Type::Subscribe:
case MqttMessage::Type::UnSubscribe:
{
if (not mqtt_connected()) break;
if (not (mqtt_flags & FlagConnected)) break;
payload = header+2;
debug("un/subscribe loop");
string qoss;
std::string qoss;
while(payload < mesg->end())
{
mesg->getString(payload, len); // Topic
debug( " topic (" << string(payload, len) << ')');
debug( " topic (" << std::string(payload, len) << ')');
// subscribe(Topic(payload, len));
Topic topic(payload, len);
@@ -614,7 +519,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
}
else
qoss.push_back(qos);
subscribe(topic);
subscriptions.insert(topic);
}
else
{
@@ -635,39 +540,23 @@ void MqttClient::processMessage(MqttMessage* mesg)
break;
case MqttMessage::Type::UnSuback:
if (not mqtt_connected()) break;
if (not (mqtt_flags & FlagConnected)) break;
bclose = false;
break;
case MqttMessage::Type::Publish:
#if TINY_MQTT_DEBUG
Console << "publish " << mqtt_connected() << '/' << (long) tcp_client << endl;
#endif
if (mqtt_connected() or tcp_client == nullptr)
debug("publish " << (mqtt_flags & FlagConnected) << '/' << (long) tcp_client.get());
if ((mqtt_flags & FlagConnected) or tcp_client == nullptr)
{
uint8_t qos = mesg->flags();
qos = (qos / 2) & 3;
payload = header;
mesg->getString(payload, len);
Topic published(payload, len);
payload += len;
#if TINY_MQTT_DEBUG
Console << "Received Publish (" << published.str().c_str() << ") size=" << (int)len << endl;
#endif
const char* ID; // remove PublishID() to avoid misuse
if (qos) {
ID = payload;
payload+=2; // ignore packet identifier if any
}
debug("Received Publish (" << published.str().c_str() << ") size=" << (int)len);
// << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl;
if (qos) payload+=2; // ignore packet identifier if any
len=mesg->end()-payload;
if (qos == 1)
{
MqttMessage msg(MqttMessage::Type::PubAck);
msg.add(ID[0]); // MessageID high
msg.add(ID[1]); // MessageID low
msg.sendTo(this);
}
// TODO reset DUP
// TODO reset RETAIN
@@ -676,13 +565,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
#if TINY_MQTT_DEBUG
if (TinyMqtt::debug >= 2)
{
Console << (isSubscribedTo(published) ? "not" : "") << " subscribed.\r\n";
Console << "has " << (callback ? "" : "no ") << " callback.\r\n";
Console << (isSubscribedTo(published) ? "not" : "") << " subscribed.\n";
Console << "has " << (callback ? "" : "no ") << " callback.\n";
}
#endif
if (callback and isSubscribedTo(published))
{
callback(this, published, payload, len);
callback(this, published, payload, len); // TODO send the real payload
}
}
else if (local_broker) // from outside to inside
@@ -696,8 +585,8 @@ void MqttClient::processMessage(MqttMessage* mesg)
case MqttMessage::Type::Disconnect:
// TODO should discard any will msg
if (not mqtt_connected()) break;
resetFlag(CltFlagConnected);
if (not (mqtt_flags & FlagConnected)) break;
mqtt_flags &= ~FlagConnected;
close(false);
bclose=false;
break;
@@ -718,7 +607,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
}
else
{
clientAlive(local_broker ? 5 : 0);
clientAlive();
}
}
@@ -786,9 +675,9 @@ bool Topic::matches(const Topic& topic) const
// publish from local client
MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pay_length, bool retain)
MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pay_length)
{
MqttMessage msg(MqttMessage::Publish, retain ? 1 : 0);
MqttMessage msg(MqttMessage::Publish);
msg.add(topic);
msg.add(payload, pay_length, false);
msg.complete();
@@ -797,7 +686,7 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
{
return local_broker->publish(this, topic, msg);
}
else if (tcp_client and connected())
else if (tcp_client)
return msg.sendTo(this);
else
return MqttNowhereToSend;
@@ -816,10 +705,7 @@ MqttError MqttClient::publishIfSubscribed(const Topic& topic, MqttMessage& msg)
else
{
processMessage(&msg);
#if TINY_MQTT_DEBUG
Console << "Should call the callback ?\n";
#endif
debug("Should call the callback ?");
// callback(this, topic, nullptr, 0); // TODO Payload
}
}
@@ -952,46 +838,12 @@ MqttError MqttMessage::sendTo(MqttClient* client)
return MqttOk;
}
void MqttBroker::retainDrop()
{
if (retained.size() >= retain_size)
{
std::map<Topic, Retain>::iterator oldest = retained.begin();
auto it = oldest;
while(++it != retained.end())
{
if (oldest->second.timestamp > it->second.timestamp)
oldest = it;
}
retained.erase(oldest);
}
}
void MqttBroker::retain(const Topic& topic, const MqttMessage& msg)
{
debug("MqttBroker::retain msg_type=" << _HEX(msg.type()) << ", retain_size=" << retain_size);
if (retain_size==0 or msg.type() != MqttMessage::Publish) return;
if (msg.flags() & 1) // flag RETAIN
{
debug(" retaining " << topic.str());
auto old = retained.find(topic);
if (old == retained.end())
retainDrop();
else
retained.erase(old);
// FIXME if payload size == 0 remove message from retained
Retain r(micros(), msg);
r.msg.retained();
retained.insert({ topic, std::move(r)});
}
}
void MqttMessage::hexdump(const char* prefix) const
{
(void)prefix;
#if TINY_MQTT_DEBUG
if (TinyMqtt::debug<2) return;
static std::map<Type, string> tts={
static std::map<Type, std::string> tts={
{ Connect, "Connect" },
{ ConnAck, "Connack" },
{ Publish, "Publish" },
@@ -1004,7 +856,7 @@ void MqttMessage::hexdump(const char* prefix) const
{ PingResp, "Pingresp" },
{ Disconnect, "Disconnect" }
};
string t("Unknown");
std::string t("Unknown");
Type typ=static_cast<Type>(buffer[0] & 0xF0);
if (tts.find(typ) != tts.end())
t=tts[typ];
@@ -1021,7 +873,7 @@ void MqttMessage::hexdump(const char* prefix) const
const char* hex_to_str = " | ";
const char* separator = hex_to_str;
const char* half_sep = " - ";
string ascii;
std::string ascii;
Console << prefix << " size(" << buffer.size() << "), state=" << state << endl;

View File

@@ -4,14 +4,15 @@
#ifndef TINY_MQTT_DEBUG
#define TINY_MQTT_DEBUG 0
#endif
#ifndef TINY_MQTT_DEFAULT_ALIVE
#define TINY_MQTT_DEFAULT_ALIVE 10
#endif
#define TINY_MQTT_CLIENT_ALIVE_TOLERANCE 5
// TODO Should add a AUnit with both TINY_MQTT_ASYNC and not TINY_MQTT_ASYNC
// #define TINY_MQTT_ASYNC // Uncomment this to use ESPAsyncTCP instead of normal cnx
#if defined(TINY_MQTT_ETHERNET)
#include <Ethernet.h>
#elif defined(ESP8266) || defined(EPOXY_DUINO)
#if defined(ESP8266) || defined(EPOXY_DUINO)
#ifdef TINY_MQTT_ASYNC
#include <ESPAsyncTCP.h>
#else
@@ -22,8 +23,6 @@
#ifdef TINY_MQTT_ASYNC
#include <AsyncTCP.h> // https://github.com/me-no-dev/AsyncTCP
#endif
#elif defined(ARDUINO_ARCH_RP2040)
#include <WiFi.h> // works with Raspberry Pi Pico W, earlephilhower
#endif
#ifdef EPOXY_DUINO
#define dbg_ptr uint64_t
@@ -38,7 +37,7 @@
#include <rpcWiFi.h>
#endif
#include <vector>
#include <memory>
#include <set>
#include <string>
#include "StringIndexer.h"
@@ -53,22 +52,17 @@
static int debug;
};
#define debug(what) { if (TinyMqtt::debug>=1) Console << (int)__LINE__ << ' ' << what << TinyConsole::white << endl; delay(100); }
#define debug(what) { if (TinyMqtt::debug>=1) Console << (int)__LINE__ << ' ' << what << TinyConsole::white << endl; delay(10); }
#else
#define debug(what) {}
#endif
#if defined(TINY_MQTT_ETHERNET)
using TcpClient = EthernetClient;
using TcpServer = EthernetServer;
#else
#ifdef TINY_MQTT_ASYNC
#ifdef TINY_MQTT_ASYNC
using TcpClient = AsyncClient;
using TcpServer = AsyncServer;
#else
#else
using TcpClient = WiFiClient;
using TcpServer = WiFiServer;
#endif
#endif
enum __attribute__((packed)) MqttError
@@ -78,15 +72,12 @@ enum __attribute__((packed)) MqttError
MqttInvalidMessage=2,
};
using string = TinyConsole::string;
class Topic : public IndexedString
{
public:
Topic(const string& m) : IndexedString(m){}
Topic(const char* s, uint8_t len) : IndexedString(s,len){}
Topic(const char* s) : Topic(s, strlen(s)) {}
// Topic(const string s) : Topic(s.c_str(), s.length()){};
Topic(const std::string s) : Topic(s.c_str(), s.length()){};
const char* c_str() const { return str().c_str(); }
@@ -131,19 +122,15 @@ class MqttMessage
return (*bun << 8) | bun[1]; }
MqttMessage() { reset(); }
MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= (bits_d3_d0 & 0xF); }
MqttMessage(const MqttMessage& m)
: buffer(m.buffer), vheader(m.vheader), size(m.size), state(m.state) {}
MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= bits_d3_d0; }
void incoming(char byte);
void add(char byte) { incoming(byte); }
void add(const char* p, size_t len, bool addLength=true );
void add(const string& s) { add(s.c_str(), s.length()); }
void add(const std::string& s) { add(s.c_str(), s.length()); }
void add(const Topic& t) { add(t.str()); }
const char* end() const { return &buffer[0]+buffer.size(); }
const char* getVHeader() const { return &buffer[vheader]; }
void complete() { encodeLength(); }
void retained() { if ((buffer[0] & 0xF)==Publish) buffer[0] |= 1; }
void reset();
@@ -170,19 +157,10 @@ class MqttMessage
MqttError sendTo(MqttClient*);
void hexdump(const char* prefix=nullptr) const;
MqttMessage& operator = (MqttMessage&& m)
{
buffer = std::move(m.buffer);
vheader = m.vheader;
size = m.size;
state = m.state;
return *this;
}
private:
void encodeLength();
string buffer;
std::string buffer;
uint8_t vheader;
uint16_t size; // bytes left to receive
State state;
@@ -199,14 +177,9 @@ class MqttClient
FlagWillQos = 16 | 8, // unsupported
FlagWill = 4, // unsupported
FlagCleanSession = 2, // unsupported
FlagReserved = 1
};
enum __attribute__((packed)) CltFlags
{
CltFlagNone = 0,
CltFlagConnected = 1,
CltFlagToDelete = 2
FlagReserved = 1, // use reserved as connected (save 1 byte)
FlagConnected = 1
};
public:
@@ -214,15 +187,13 @@ class MqttClient
/** Constructor. Broker is the adress of a local broker if not null
If you want to connect elsewhere, leave broker null and use connect() **/
MqttClient(MqttBroker* broker = nullptr, const string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
MqttClient(const string& id) : MqttClient(nullptr, id){}
MqttClient(MqttBroker* broker = nullptr, const std::string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
MqttClient(const std::string& id) : MqttClient(nullptr, id){}
~MqttClient();
void connect(MqttBroker* local_broker);
void connect(string broker, uint16_t port = 1883, uint16_t keep_alive = 10);
void connect(const IPAddress& ip, uint16_t port = 1883, uint16_t keep_alive = 10)
{ connect(ip.toString().c_str(), port, keep_alive); }
void connect(std::string broker, uint16_t port, uint16_t keep_alive = TINY_MQTT_DEFAULT_ALIVE);
// TODO it seems that connected returns true in tcp mode even if
// no negociation occurred
@@ -237,8 +208,8 @@ class MqttClient
if (tcp_client) tcp_client->write(buf, length);
}
const string& id() const { return clientId; }
void id(const string& new_id) { clientId = new_id; }
const std::string& id() const { return clientId; }
void id(const std::string& new_id) { clientId = new_id; }
/** Should be called in main loop() */
void loop();
@@ -253,11 +224,11 @@ class MqttClient
};
// Publish from client to the world
MqttError publish(const Topic&, const char* payload, size_t pay_length, bool retain=false);
MqttError publish(const Topic& t, const char* payload, bool retain=false) { return publish(t, payload, strlen(payload), retain); }
MqttError publish(const Topic& t, const String& s, bool retain=false) { return publish(t, s.c_str(), s.length(), retain); }
MqttError publish(const Topic& t, const string& s, bool retain=false) { return publish(t,s.c_str(),s.length(), retain);}
MqttError publish(const Topic& t, bool retain=false) { return publish(t, nullptr, 0, retain);};
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);};
MqttError subscribe(Topic topic, uint8_t qos=0);
MqttError unsubscribe(Topic topic);
@@ -267,7 +238,7 @@ class MqttClient
// TODO seems to be useless
bool isLocal() const { return tcp_client == nullptr; }
void dump(string indent="")
void dump(std::string indent="")
{
(void)indent;
#if TINY_MQTT_DEBUG
@@ -300,14 +271,10 @@ class MqttClient
#ifdef EPOXY_DUINO
static std::map<MqttMessage::Type, int> counters; // Number of processed messages
static int instances;
#endif
uint32_t keepAlive() const { return keep_alive; }
private:
bool mqtt_connected() const { return cltFlags & CltFlagConnected; }
void setFlag(CltFlags f) { cltFlags |= f; }
void resetFlag(CltFlags f) { cltFlags &= ~f; }
// event when tcp/ip link established (real or fake)
static void onConnect(void * client_ptr, TcpClient*);
@@ -322,55 +289,59 @@ class MqttClient
// republish a received publish if topic matches any in subscriptions
MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
void clientAlive(uint32_t more_seconds);
void clientAlive();
void processMessage(MqttMessage* message);
uint8_t cltFlags = CltFlagNone;
char mqtt_flags;
uint32_t keep_alive = 30;
uint32_t alive;
char mqtt_flags = 0;
uint16_t keep_alive = 30;
// for client connected to remote broker, PingReq is sent when millis() >= alive
// for a client managed by a broker, disconnect it if millis() >= alive
uint32_t alive; // PingReq if millis() > alive,
MqttMessage message;
// connection to local broker, or link to the parent
// when MqttBroker uses MqttClient for each external connexion
MqttBroker* local_broker=nullptr;
TcpClient* tcp_client=nullptr; // connection to remote broker
std::unique_ptr<TcpClient> tcp_client; // connection to remote broker
std::set<Topic> subscriptions;
string clientId;
std::string clientId;
CallBack callback = nullptr;
};
class MqttBroker
{
enum __attribute__((packed)) State
{
Disconnected, // Also the initial state
Connecting, // connect and sends a fake publish to avoid circular cnx
Connected, // this->broker is connected and circular cnx avoided
};
public:
// TODO limit max number of clients
MqttBroker(uint16_t port, uint8_t retain_size=0);
~MqttBroker();
MqttBroker(uint16_t port);
void begin() { server->begin(); }
void loop();
/** Connect the broker to a parent broker */
void connect(const string& host, uint16_t port=1883);
/** returns true if connected to another broker */
bool connected() const { return remote_broker ? remote_broker->connected() : false; }
void connect(const std::string& host, uint16_t port=1883);
bool connected() const { return state == Connected; }
size_t clientsCount() const { return clients.size(); }
uint8_t retain() { return retain_size; }
void retain(uint8_t size) { retain_size = size; if (size==0) retained.clear(); }
uint8_t retainCount() const { return retained.size(); }
void dump(string indent="")
void dump(std::string indent="")
{
for(auto client: clients)
for(const auto& client: clients)
client->dump(indent);
}
const std::vector<MqttClient*> getClients() const { return clients; }
#ifdef EPOXY_DUINO
static int instances;
#endif
using Clients = std::set<std::unique_ptr<MqttClient>>;
using LocalClients = std::set<MqttClient*>;
const Clients& getClients() const { return clients; }
const LocalClients& getLocalClients() const { return local_clients; }
size_t clientsCount() const { return clients.size(); }
size_t localClientsCount() const { return local_clients.size(); }
private:
friend class MqttClient;
@@ -382,45 +353,26 @@ class MqttBroker
bool checkPassword(const char* password, uint8_t len) const
{ return compareString(auth_password, password, len); }
MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg);
MqttError subscribe(MqttClient*, const Topic& topic, uint8_t qos);
MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const;
// For clients that are added not by the broker itself (local clients)
void addClient(MqttClient* client);
void removeClient(MqttClient* client);
MqttError subscribe(const Topic& topic, uint8_t qos);
void addClient(MqttClient* local) { local_clients.insert(local); }
void addClient(TcpClient* client);
void removeClient(MqttClient* local);
bool compareString(const char* good, const char* str, uint8_t str_len) const;
std::vector<MqttClient*> clients;
Clients clients;
LocalClients local_clients;
private:
TcpServer* server = nullptr;
std::unique_ptr<TcpServer> server;
const char* auth_user = "guest";
const char* auth_password = "guest";
MqttClient* remote_broker = nullptr;
void closeRemoteBroker();
void retain(const Topic& topic, const MqttMessage& msg);
void retainDrop();
struct Retain
{
Retain(unsigned long ts, const MqttMessage& m) : timestamp(ts), msg(m) {}
Retain(Retain&& r) : timestamp(r.timestamp), msg(std::move(r.msg)) {}
Retain& operator=(Retain&& r)
{
timestamp = r.timestamp;
msg = std::move(r.msg);
return *this;
}
unsigned long timestamp;
MqttMessage msg;
};
std::map<Topic, Retain> retained;
uint8_t retain_size;
State state = Disconnected;
};

142
src/make_unique.inc Normal file
View File

@@ -0,0 +1,142 @@
// Implementation of C++14's make_unique for C++11 compilers.
//
// This has been tested with:
// - MSVC 11.0 (Visual Studio 2012)
// - gcc 4.6.3
// - Xcode 4.4 (with clang "4.0")
//
// It is based off an implementation proposed by Stephan T. Lavavej for
// inclusion in the C++14 standard:
// http://isocpp.org/files/papers/N3656.txt
// Where appropriate, it borrows the use of MSVC's _VARIADIC_EXPAND_0X macro
// machinery to compensate for lack of variadic templates.
//
// This file injects make_unique into the std namespace, which I acknowledge is
// technically forbidden ([C++11: 17.6.4.2.2.1/1]), but is necessary in order
// to have syntax compatibility with C++14.
//
// I perform compiler version checking for MSVC, gcc, and clang to ensure that
// we don't add make_unique if it is already there (instead, we include
// <memory> to get the compiler-provided one). You can override the compiler
// version checking by defining the symbol COMPILER_SUPPORTS_MAKE_UNIQUE.
//
//
// ===============================================================================
// This file is released into the public domain. See LICENCE for more information.
// ===============================================================================
#pragma once
// If user hasn't specified COMPILER_SUPPORTS_MAKE_UNIQUE then try to figure out
// based on compiler version if std::make_unique is provided.
#if !defined(COMPILER_SUPPORTS_MAKE_UNIQUE)
#if defined(_MSC_VER)
// std::make_unique was added in MSVC 12.0
#if _MSC_VER >= 1800 // MSVC 12.0 (Visual Studio 2013)
#define COMPILER_SUPPORTS_MAKE_UNIQUE
#endif
#elif defined(__clang__)
// std::make_unique was added in clang 3.4, but not until Xcode 6.
// Annoyingly, Apple makes the clang version defines match the version
// of Xcode, not the version of clang.
#define CLANG_VERSION (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__)
#if defined(__APPLE__) && CLANG_VERSION >= 60000
#define COMPILER_SUPPORTS_MAKE_UNIQUE
#elif !defined(__APPLE__) && CLANG_VERSION >= 30400
#define COMPILER_SUPPORTS_MAKE_UNIQUE
#endif
#elif defined(__GNUC__)
// std::make_unique was added in gcc 4.9, for standards versions greater
// than -std=c++11.
#define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
#if GCC_VERSION >= 40900 && __cplusplus > 201103L
#define COMPILER_SUPPORTS_MAKE_UNIQUE
#endif
#endif
#endif
#if defined(COMPILER_SUPPORTS_MAKE_UNIQUE)
// If the compiler supports std::make_unique, then pull in <memory> to get it.
#include <memory>
#else
// Otherwise, the compiler doesn't provide it, so implement it ourselves.
#include <cstddef>
#include <memory>
#include <type_traits>
#include <utility>
namespace std {
template<class _Ty> struct _Unique_if {
typedef unique_ptr<_Ty> _Single_object;
};
template<class _Ty> struct _Unique_if<_Ty[]> {
typedef unique_ptr<_Ty[]> _Unknown_bound;
};
template<class _Ty, size_t N> struct _Unique_if<_Ty[N]> {
typedef void _Known_bound;
};
//
// template< class T, class... Args >
// unique_ptr<T> make_unique( Args&&... args);
//
#if defined(_MSC_VER) && (_MSC_VER < 1800)
// Macro machinery because MSVC 11.0 doesn't support variadic templates.
// The _VARIADIC_EXPAND_0X stuff is defined in <xstddef>
#define _MAKE_UNIQUE( \
TEMPLATE_LIST, PADDING_LIST, LIST, COMMA, X1, X2, X3, X4) \
template<class _Ty COMMA LIST(_CLASS_TYPE)> inline \
typename _Unique_if<_Ty>::_Single_object make_unique(LIST(_TYPE_REFREF_ARG)) \
{ \
return unique_ptr<_Ty>(new _Ty(LIST(_FORWARD_ARG))); \
} \
_VARIADIC_EXPAND_0X(_MAKE_UNIQUE, , , , )
#undef _MAKE_UNIQUE
#else // not MSVC 11.0 or earlier
template<class _Ty, class... Args>
typename _Unique_if<_Ty>::_Single_object
make_unique(Args&&... args) {
return unique_ptr<_Ty>(new _Ty(std::forward<Args>(args)...));
}
#endif
// template< class T >
// unique_ptr<T> make_unique( std::size_t size );
template<class _Ty>
typename _Unique_if<_Ty>::_Unknown_bound
make_unique(size_t n) {
typedef typename remove_extent<_Ty>::type U;
return unique_ptr<_Ty>(new U[n]());
}
// template< class T, class... Args >
// /* unspecified */ make_unique( Args&&... args ) = delete;
// MSVC 11.0 doesn't support deleted functions, so the best we can do
// is simply not define the function.
#if !(defined(_MSC_VER) && (_MSC_VER < 1800))
template<class T, class... Args>
typename _Unique_if<T>::_Known_bound
make_unique(Args&&...) = delete;
#endif
} // namespace std
#endif // !COMPILER_SUPPORTS_MAKE_UNIQUE

View File

@@ -1,40 +1,30 @@
SUB=
all:runtests
SUB=n
tests:
@set -e; \
for i in $(SUB)*-tests/Makefile; do \
set -e; \
for i in ${SUB}*-tests/Makefile; do \
echo '==== Making:' $$(dirname $$i); \
$(MAKE) -C $$(dirname $$i) -j; \
done
$(MAKE) -C compile-test
valgrind:
@set -e; \
$(MAKE) tests; \
for i in $(SUB)*-tests/Makefile; do \
echo '==== Running:' $$(dirname $$i); \
valgrind $$(dirname $$i)/$$(dirname $$i).out; \
done
debugtest:
@set -e; \
set -e; \
$(MAKE) clean; \
$(MAKE) -C debug-mode -j; \
debug-mode/debug-tests.out
runtests:
@set -e; \
$(MAKE) tests; \
for i in $(SUB)*-tests/Makefile; do \
runtests: debugtest
$(MAKE) clean
$(MAKE) tests
set -e; \
for i in ${SUB}*-tests/Makefile; do \
echo '==== Running:' $$(dirname $$i); \
$$(dirname $$i)/$$(dirname $$i).out; \
done
clean:
@set -e; \
for i in $(SUB)*-tests/Makefile; do \
set -e; \
for i in ${SUB}*-tests/Makefile; do \
echo '==== Cleaning:' $$(dirname $$i); \
$(MAKE) -C $$(dirname $$i) clean; \
done

View File

@@ -1,11 +0,0 @@
# GCC
# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
EXTRA_CXXFLAGS=-g3 -O0 -std=c++17
CXXFLAGS=-D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0
# CLANG SANITIZE
# CXX=clang
# EXTRA_CXXFLAGS=-g3 -O0 -fsanitize=memory
# LDFLAGS = -lpthread -lstdc++

View File

@@ -3,6 +3,9 @@
EXTRA_CXXFLAGS=-g3 -O0 -DTINY_MQTT_TESTS
# Remove flto flag from EpoxyDuino (too many <optimized out>)
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
APP_NAME := classbind-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
ARDUINO_LIB_DIRS := ../../../EspMock/libraries

View File

@@ -17,10 +17,9 @@ class TestReceiver : public MqttClassBinder<TestReceiver>
public:
TestReceiver(const char* name) : MqttClassBinder(), name_(name) {}
void onPublish(const MqttClient* /* source */, const Topic& topic, const char* /* payload */, size_t /* length */)
void onPublish(const MqttClient* /* source */, const Topic& topic, const char* payload, size_t /* length */)
{
(void) topic;
// Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
messages[name_]++;
}
@@ -36,8 +35,7 @@ std::map<std::string, int> TestReceiver::messages;
static int unrouted = 0;
void onUnrouted(const MqttClient*, const Topic& topic, const char*, size_t)
{
(void) topic;
// Serial << "--> unrouted: " << topic.c_str() << endl;
Serial << "--> unrouted: " << topic.c_str() << endl;
unrouted++;
}
@@ -340,7 +338,7 @@ void setup() {
while(!Serial);
*/
Serial.println("=============[ TinyMqtt class-bind TESTS ]========================");
Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS ]========================");
WiFi.mode(WIFI_STA);
WiFi.begin("network", "password");

View File

@@ -1,23 +0,0 @@
# vim: noexpandtab
APP_NAME := compile-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync ESP8266mDNS TinyConsole
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
DUMMY := 1
RUN = no
APP_SRCS_COMP += $(shell find ../../examples -name "*.ino")
APP_SRCS_CPP += $(APP_SRCS_COMP:%.ino=%.o)
CXXFLAGS = -D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0 -DEPOXY_DUINO
include ../Makefile.opts
all:
compile-tests.out: $(OBJS)
run:
@echo "No run for compile tests"
exit 0

View File

@@ -1,7 +1,10 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
include ../Makefile.opts
EXTRA_CXXFLAGS=-g3 -O0 -DTINY_MQTT_DEFAULT_ALIVE=1
# 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 ESP8266WiFi ESPAsyncTCP TinyConsole

View File

@@ -12,107 +12,73 @@
* Also, this will allow to mock and thus run Action on github
**/
using string = TinyConsole::string;
using namespace std;
MqttBroker broker(1883);
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
std::string lastPayload;
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 = std::string(payload, length);
lastPayload = payload;
lastLength = length;
}
test(local_not_connected_by_default)
{
MqttClient client;
assertEqual(client.connected(), false);
MqttBroker broker(1883);
assertEqual(broker.connected(), false);
}
test(local_client_should_unregister_when_destroyed)
{
assertEqual(broker.clientsCount(), (size_t)0);
{
assertEqual(broker.clientsCount(), (size_t)0); // Ensure client is not yet connected
MqttClient client(&broker);
assertEqual(broker.clientsCount(), (size_t)1); // Ensure client is now connected
}
assertEqual(broker.clientsCount(), (size_t)0);
}
test(local_client_do_not_disconnect_after_publishing_and_long_inactivity)
{
published.clear();
EpoxyTest::set_millis(0);
MqttBroker broker(1883);
MqttClient client(&broker, "client");
MqttClient sender(&broker, "sender");
broker.loop();
client.subscribe("#");
client.subscribe("test");
client.setCallback(onPublish);
assertEqual(broker.clientsCount(), (size_t)2);
sender.publish("test", "value");
broker.loop();
EpoxyTest::add_seconds(600);
client.loop();
sender.loop();
broker.loop();
sender.publish("test", "value");
broker.loop();
sender.loop();
broker.loop();
assertEqual(broker.clientsCount(), (size_t)2);
assertEqual(sender.connected(), true);
assertEqual(client.connected(), true);
assertEqual(published.size(), (size_t)1); // client has received something
assertEqual(broker.localClientsCount(), (size_t)0);
{
assertEqual(broker.localClientsCount(), (size_t)0); // Ensure client is not yet connected
MqttClient client(&broker);
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is now connected
}
assertEqual(broker.localClientsCount(), (size_t)0);
}
test(local_client_alive)
{
set_millis(0);
MqttBroker broker(1883);
MqttClient client(&broker);
broker.loop();
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is now connected
add_millis(TINY_MQTT_DEFAULT_ALIVE*1000/2);
broker.loop();
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is still connected
add_seconds(TINY_MQTT_DEFAULT_ALIVE*5);
broker.loop();
assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is still connected
}
#if 0
test(local_connect)
{
assertEqual(broker.clientsCount(), (size_t)0);
assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient client(&broker);
MqttClient client;
assertTrue(client.connected());
assertEqual(broker.clientsCount(), (size_t)1);
}
test(local_publish_to_nowhere)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher;
MqttError status = publisher.publish("a/b");
assertEqual(status, MqttError::MqttNowhereToSend);
assertEqual(broker.localClientsCount(), (size_t)1);
}
test(local_publish_should_be_dispatched)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient subscriber(&broker, "");
MqttClient subscriber;
subscriber.subscribe("a/b");
subscriber.subscribe("a/c");
subscriber.setCallback(onPublish);
MqttClient publisher(&broker);
MqttClient publisher;
publisher.publish("a/b");
publisher.publish("a/c");
publisher.publish("a/c");
@@ -122,40 +88,21 @@ test(local_publish_should_be_dispatched)
assertEqual(published[""]["a/c"], 2);
}
test(hudge_payload)
{
published.clear();
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);
assertEqual(broker.clientsCount(), (size_t)1);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b"); // Note -> this does not send any byte .... (nowhere to send)
MqttClient publisher(&broker);
publisher.publish("a/b", payload); // This publish is received
// onPublish should have filled lastPayload and lastLength
assertEqual(payload, lastPayload.c_str());
assertEqual(lastLength, strlen(payload));
assertEqual(strncmp(payload, lastPayload.c_str(), lastLength), 0);
}
test(local_publish_should_be_dispatched_to_local_clients)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient subscriber_a(&broker, "A");
MqttClient subscriber_a("A");
subscriber_a.setCallback(onPublish);
subscriber_a.subscribe("a/b");
subscriber_a.subscribe("a/c");
MqttClient subscriber_b(&broker, "B");
MqttClient subscriber_b("B");
subscriber_b.setCallback(onPublish);
subscriber_b.subscribe("a/b");
MqttClient publisher(&broker);
MqttClient publisher;
publisher.publish("a/b");
publisher.publish("a/c");
@@ -169,13 +116,13 @@ test(local_publish_should_be_dispatched_to_local_clients)
test(local_unsubscribe)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient subscriber(&broker, "");
MqttClient subscriber;
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
MqttClient publisher(&broker);
MqttClient publisher;
publisher.publish("a/b");
subscriber.unsubscribe("a/b");
@@ -189,11 +136,11 @@ test(local_unsubscribe)
test(local_nocallback_when_destroyed)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient publisher(&broker);
MqttClient publisher;
{
MqttClient subscriber(&broker);
MqttClient subscriber;
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b");
publisher.publish("a/b");
@@ -203,6 +150,7 @@ test(local_nocallback_when_destroyed)
assertEqual(published.size(), (size_t)1); // Only one publish has been received
}
#endif
//----------------------------------------------------------------------------
// setup() and loop()

View File

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

View File

@@ -16,8 +16,6 @@
* Checks with a local broker. Clients must connect to the local broker
**/
using string = TinyConsole::string;
// if ascii_pos = 0, no ascii dump, else ascii dump starts after column ascii_pos
std::string bufferToHexa(const uint8_t* buffer, size_t length, char sep = 0, size_t ascii_pos = 0)
{
@@ -80,12 +78,12 @@ String toString(const IPAddress& ip)
MqttBroker broker(1883);
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
char* lastPayload = nullptr;
size_t lastLength;
void start_many_wifi_esp(int n, bool early_accept = true)
void start_servers(int n, bool early_accept = true)
{
ESP8266WiFiClass::resetInstances();
ESP8266WiFiClass::earlyAccept = early_accept;
@@ -107,7 +105,7 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
lastLength = length;
}
test(single_broker_begin)
test(network_single_broker_begin)
{
assertEqual(WiFi.status(), WL_CONNECTED);
@@ -119,7 +117,7 @@ test(single_broker_begin)
test(suback)
{
start_many_wifi_esp(2, true);
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
@@ -144,97 +142,59 @@ test(suback)
assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
}
test(remote_client_deletion)
uint32_t getClientKeepAlive(MqttBroker& broker)
{
assertEqual(MqttClient::instances, 0);
{
start_many_wifi_esp(3, true);
if (broker.getClients().size() == 1)
for (auto& it : broker.getClients())
return it->keepAlive();
return 9999;
}
test(network_client_alive)
{
const uint32_t keep_alive=1;
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
set_millis(0); // Enter simulated time
MqttBroker broker(1883);
broker.begin();
IPAddress broker_ip = WiFi.localIP();
// A first remote client
ESP8266WiFiClass::selectInstance(2);
MqttClient remote_client;
assertEqual(MqttClient::instances, 1);
MqttClient client;
client.connect(broker_ip.toString().c_str(), 1883, keep_alive);
broker.loop();
client.loop();
remote_client.connect(broker_ip.toString().c_str());
broker.loop(); remote_client.loop();
assertEqual(MqttClient::instances, 2); // broker creates a client to manage remote_client
assertTrue(broker.clientsCount() == 1);
assertTrue(client.connected());
// A second remote client
ESP8266WiFiClass::selectInstance(3);
MqttClient secund_client;
assertEqual(MqttClient::instances, 3);
uint32_t ka = getClientKeepAlive(broker);
assertEqual(ka, keep_alive);
assertEqual(broker.clientsCount(), (size_t)1);
secund_client.connect(broker_ip.toString().c_str());
broker.loop(); remote_client.loop();
assertEqual(MqttClient::instances, 4);
// All is going well if we call client.loop()
// The client is able to send PingReq to the broker
add_seconds(keep_alive);
client.loop();
broker.loop();
assertEqual(broker.clientsCount(), (size_t)1);
// Now disconnect remote clients
remote_client.close();
broker.loop(); remote_client.loop();
assertEqual(MqttClient::instances, 3);
// Now simulate that the client is frozen for
// a too long time
add_seconds(TINY_MQTT_CLIENT_ALIVE_TOLERANCE*2);
broker.loop();
assertEqual(broker.clientsCount(), (size_t)0);
secund_client.close();
broker.loop(); remote_client.loop();
assertEqual(MqttClient::instances, 2); // These instances are in this scope
// Now simulate that the external client is dead without disconnecting
secund_client.connect(broker_ip.toString().c_str());
broker.loop(); remote_client.loop();
assertEqual(MqttClient::instances, 3);
WiFi.disconnect();
broker.loop(); remote_client.loop();
broker.loop(); remote_client.loop();
assertEqual(MqttClient::instances, 2);
}
assertEqual(MqttClient::instances, 0);
set_real_time();
}
test(broker_connect_and_client_deletion)
{
assertEqual(MqttClient::instances, 0);
{
start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
ESP8266WiFiClass::selectInstance(2);
MqttBroker remote_broker(1883);
remote_broker.begin();
IPAddress remote_broker_ip = WiFi.localIP();
assertEqual(MqttClient::instances, 0);
ESP8266WiFiClass::selectInstance(1);
broker.connect(remote_broker_ip.toString().c_str());
remote_broker.loop();
assertEqual(remote_broker.clientsCount(), (size_t)1);
// Here, we have two MqttClient
// The client that connects broker to remote_broker
// The client created by remote_broker
assertEqual(MqttClient::instances, 2);
broker.connect("");
remote_broker.loop(); broker.loop();
remote_broker.loop(); broker.loop();
assertEqual(remote_broker.clientsCount(), (size_t)0);
}
assertEqual(MqttClient::instances, 0);
}
test(client_keep_alive_high)
test(network_client_keep_alive_high)
{
const uint32_t keep_alive=1000;
start_many_wifi_esp(2, true);
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
@@ -261,158 +221,13 @@ test(client_keep_alive_high)
uint32_t sz = broker.getClients().size();
assertEqual(sz , (uint32_t)1);
uint32_t ka = broker.getClients()[0]->keepAlive();
uint32_t ka = getClientKeepAlive(broker);
assertEqual(ka, keep_alive);
}
test(retained_message)
test(network_client_to_broker_connexion)
{
published.clear();
start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
broker.retain(10);
IPAddress broker_ip = WiFi.localIP();
MqttClient local_client(&broker, "sender");
// Send a retained message
// No remote client connected
local_client.publish("topic", "retained once", true);
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
// Send a second message on the same topic (issue 86)
local_client.publish("topic", "retained once", true);
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
// Send a second message on the same topic (issue 86)
local_client.publish("topic", "retained last", true);
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
// No connect a client from 2nd Esp
ESP8266WiFiClass::selectInstance(2);
MqttClient remote_client("receiver");
remote_client.connect(broker_ip, 1883);
remote_client.setCallback(onPublish);
assertTrue(remote_client.connected());
for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 2);
// Should not have received anything yet
assertEqual(published.size(), (size_t)0);
// Now, remote client subscribes to topic
remote_client.subscribe("#");
for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
// Check that the retained message is published once
assertEqual(published.size(), (size_t)1);
assertEqual(published["receiver"]["topic"], 1);
// FIXME we should check that
// 1 - Retained message has the retain flag set
// 2 - Published retained messages that are send normally have their retain flag off
// The next part of this test does not pass yet (due to remote_client.close()
// that does not work well.
return;
// Now remove the retained message
remote_client.close();
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertFalse(remote_client.connected());
assertEqual(broker.clientsCount(), (size_t) 1);
// Disconnect / reconnect the remote clien that should receive again the message
remote_client.connect(broker_ip, 1883);
remote_client.subscribe("topic");
assertTrue(remote_client.connected());
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 2);
assertEqual(published.size(), (size_t)2);
// Remove the retained message now
local_client.publish("topic", "", true);
assertEqual(published.size(), (size_t)1);
// And reconnect the remote client
remote_client.connect(broker_ip, 1883);
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 2);
// check that the message was received
assertEqual(published.size(), (size_t)2);
}
test(retained_payload) // # issue #84
{
published.clear();
start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
broker.retain(10);
IPAddress broker_ip = WiFi.localIP();
MqttClient local_client(&broker, "sender");
// Send a retained message
// No remote client connected
local_client.publish("topic", "retained", true);
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
// No connect a client from 2nd Esp
ESP8266WiFiClass::selectInstance(2);
MqttClient remote_client("receiver");
remote_client.connect(broker_ip, 1883);
remote_client.setCallback(onPublish);
remote_client.subscribe("#");
assertTrue(remote_client.connected());
for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
// Check that the retained message is published
assertEqual(lastPayload, "retained");
}
test(remote_client_disconnect_reconnect)
{
published.clear();
start_many_wifi_esp(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, 1883);
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 1);
// Disconnect the client
client.close();
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 0);
// Reconnect the client
client.connect(broker_ip, 1883);
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 1);
}
test(client_to_broker_connexion)
{
start_many_wifi_esp(2, true);
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
@@ -428,9 +243,9 @@ test(client_to_broker_connexion)
assertTrue(client.connected());
}
test(one_client_one_broker_publish_and_subscribe)
test(network_one_client_one_broker_publish_and_subscribe_through_network)
{
start_many_wifi_esp(2, true);
start_servers(2, true);
published.clear();
assertEqual(WiFi.status(), WL_CONNECTED);
@@ -459,9 +274,9 @@ test(one_client_one_broker_publish_and_subscribe)
assertEqual((int)lastLength, (int)2); // sizeof(ab)
}
test(one_client_one_broker_hudge_payload)
test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
{
start_many_wifi_esp(2, true);
start_servers(2, true);
published.clear();
assertEqual(WiFi.status(), WL_CONNECTED);
@@ -478,8 +293,8 @@ test(one_client_one_broker_hudge_payload)
std::string sent;
for(int i=0; i<400; i++)
sent += char('a'+i%26);
for(int i=0; i<200; i++)
sent += char('0'+i%10);
client.setCallback(onPublish);
client.subscribe("a/b");
@@ -495,7 +310,7 @@ test(one_client_one_broker_hudge_payload)
assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
}
test(client_should_unregister_when_destroyed)
test(network_client_should_unregister_when_destroyed)
{
assertEqual(broker.clientsCount(), (size_t)0);
{
@@ -509,7 +324,7 @@ test(client_should_unregister_when_destroyed)
// THESE TESTS ARE IN LOCAL MODE
// WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link)
test(connect)
test(network_connect)
{
assertEqual(broker.clientsCount(), (size_t)0);
@@ -518,7 +333,7 @@ test(connect)
assertEqual(broker.clientsCount(), (size_t)1);
}
test(publish_should_be_dispatched)
test(network_publish_should_be_dispatched)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
@@ -538,7 +353,7 @@ test(publish_should_be_dispatched)
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/c"], 2);
}
test(publish_should_be_dispatched_to_clients)
test(network_publish_should_be_dispatched_to_clients)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
@@ -563,7 +378,7 @@ test(publish_should_be_dispatched_to_clients)
assertEqual(published["B"]["a/c"], 0);
}
test(unsubscribe)
test(network_unsubscribe)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
@@ -583,7 +398,7 @@ test(unsubscribe)
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1); // Only one publish has been received
}
test(nocallback_when_destroyed)
test(network_nocallback_when_destroyed)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
@@ -602,7 +417,7 @@ test(nocallback_when_destroyed)
assertEqual(published.size(), (size_t)1); // Only one publish has been received
}
test(small_payload)
test(network_small_payload)
{
published.clear();
@@ -620,7 +435,7 @@ test(small_payload)
assertEqual(lastLength, (size_t)4);
}
test(hudge_payload)
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 !";
@@ -637,20 +452,6 @@ test(hudge_payload)
assertEqual(strcmp(payload, lastPayload), 0);
}
test(disconnected_when_broker_is_deleted)
{
MqttBroker* broker = new MqttBroker(1883);
broker->begin();
MqttClient client;
client.connect(broker);
assertEqual(client.connected(), true);
client.publish("a", "b");
delete broker;
assertEqual(client.connected(), false);
}
test(connack)
{
const bool view = false;
@@ -667,7 +468,7 @@ test(connack)
}
);
start_many_wifi_esp(2, true);
start_servers(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
@@ -700,7 +501,7 @@ void setup() {
while(!Serial);
*/
Serial.println("=============[ NETWORK TinyMqtt TESTS ]========================");
Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS ]========================");
WiFi.mode(WIFI_STA);
WiFi.begin("network", "password");
@@ -710,5 +511,4 @@ void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
published.clear(); // Avoid crash in unit tests due to exit handlers
}

View File

@@ -1,7 +1,10 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
include ../Makefile.opts
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 ESP8266WiFi ESPAsyncTCP TinyConsole

View File

@@ -11,11 +11,11 @@
* Checks with a local broker. Clients must connect to the local broker
**/
using string = TinyConsole::string;
using namespace std;
MqttBroker broker(1883);
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
char* lastPayload = nullptr;
size_t lastLength;
@@ -279,5 +279,4 @@ void loop() {
aunit::TestRunner::run();
if (Serial.available()) ESP.reset();
published.clear(); // Avoid crash at exit handlers
}

View File

@@ -1,7 +1,7 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
include ../Makefile.opts
EXTRA_CXXFLAGS=-g3 -O0
APP_NAME := string-indexer-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync TinyConsole

View File

@@ -9,7 +9,7 @@
*
**/
using string = TinyConsole::string;
using namespace std;
test(indexer_empty)
{
@@ -84,7 +84,7 @@ test(indexer_indexed_operator_eq)
test(indexer_get_string)
{
string sone("one");
std::string sone("one");
IndexedString one(sone);
assertTrue(sone==one.str());

View File

@@ -1,7 +1,7 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
include ../Makefile.opts
EXTRA_CXXFLAGS=-g3 -O0
APP_NAME := topic-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync TinyConsole

View File

@@ -5,22 +5,26 @@
#include <map>
#include <iostream>
#define endl "\n"
/**
* TinyMqtt / StringIndexer unit tests.
*
**/
using namespace std;
bool testTopicMatch(const char* a, const char* b, bool expected)
{
Topic ta(a);
Topic tb(b);
bool match(ta.matches(tb));
std::cout << " " << ta.c_str() << ' ';
cout << " " << ta.c_str() << ' ';
if (match != expected)
std::cout << (expected ? " should match " : " should not match ");
cout << (expected ? " should match " : " should not match ");
else
std::cout << (expected ? " matches " : " unmatches ");
std::cout << tb.c_str() << std::endl;
cout << (expected ? " matches " : " unmatches ");
cout << tb.c_str() << endl;
return expected == match;
}