Compare commits

..

13 Commits

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
28 changed files with 665 additions and 1678 deletions

View File

@@ -18,9 +18,9 @@ jobs:
run: | run: |
cd .. cd ..
git clone https://github.com/hsaturn/TinyConsole 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/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/bxparks/AceCommon
git clone https://github.com/hsaturn/EspMock git clone https://github.com/hsaturn/EspMock
- name: Verify tests - name: Verify tests

View File

@@ -10,21 +10,8 @@
TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32 / Esp WROOM 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 ## Features
- Async Wifi compatible (me-no-dev/ESPAsyncTCP@^1.2.2)
- Very fast broker I saw it re-sent 1000 topics per second for two - 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. clients that had subscribed (payload ~15 bytes ESP8266). No topic lost.
The max I've seen was 2k msg/s (1 client 1 subscription) The max I've seen was 2k msg/s (1 client 1 subscription)

View File

@@ -1,61 +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}"
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 -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
echo " " sed -i "s@#$name@$value@g" library.json
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
git tag $1
git add library.properties
git add library.json
git commit -m "Release $1"
git push
git push --tags
fi
else
echo "Current version does not match library.property version, aborting"
fi
fi
fi

View File

@@ -26,25 +26,23 @@ auto save_cursor = TinyConsole::save_cursor;
auto restore_cursor = TinyConsole::restore_cursor; auto restore_cursor = TinyConsole::restore_cursor;
auto erase_to_end = TinyConsole::erase_to_end; auto erase_to_end = TinyConsole::erase_to_end;
const char *ssid = "Freebox-786A2F"; const char* ssid = "";
const char *password = "usurpavi8dalum64lumine?"; const char* password = "";
void onCommand(const string &command);
void eval(string &cmd);
struct free_broker struct free_broker
{ {
public: public:
free_broker(const char *s, uint16_t p, const char * /* comment */) : url(s), port(p) {} free_broker(const char* s, uint16_t p, const char* comment) : url(s), port(p) {}
string url; std::string url;
uint16_t port; uint16_t port;
}; };
const std::map<string, free_broker> list = const std::map<std::string, free_broker> list =
{ {
{ "mqtthq", { "public.mqtthq.com" , 8083, "publish/subscribe" }}, { "mqtthq", { "public.mqtthq.com" , 8083, "publish/subscribe" }},
{"hivemq", {"broker.hivemq.com", 1883, ""}}}; { "hivemq", { "broker.hivemq.com", 1883, "" }}
};
/** Very complex example /** Very complex example
* Console allowing to make any kind of test, * Console allowing to make any kind of test,
@@ -75,8 +73,8 @@ void onPublish(const MqttClient *srce, const Topic &topic, const char *payload,
} }
} }
std::map<string, MqttClient *> clients; std::map<std::string, MqttClient*> clients;
std::map<string, MqttBroker *> brokers; std::map<std::string, MqttBroker*> brokers;
void setup() void setup()
{ {
@@ -88,8 +86,7 @@ void setup()
delay(500); delay(500);
Console.cls(); Console.cls();
Console << endl Console << endl << endl;
<< endl;
Console << yellow Console << yellow
<< "***************************************************************" << endl; << "***************************************************************" << endl;
Console << "* Welcome to the TinyMqtt console" << endl; Console << "* Welcome to the TinyMqtt console" << endl;
@@ -100,8 +97,7 @@ void setup()
if (strlen(ssid)==0) if (strlen(ssid)==0)
Console << red << "* ERROR: You must modify ssid/password in order" << endl Console << red << "* ERROR: You must modify ssid/password in order" << endl
<< " to be able to connect to your Wifi network." << endl; << " to be able to connect to your Wifi network." << endl;
Console << endl Console << endl << white;
<< white;
Console << "Connecting to '" << ssid << "' "; Console << "Connecting to '" << ssid << "' ";
@@ -111,13 +107,9 @@ void setup()
WiFi.begin(ssid, password); WiFi.begin(ssid, password);
while (WiFi.status() != WL_CONNECTED) while (WiFi.status() != WL_CONNECTED)
{ { Console << '-'; delay(500); }
Console << '-';
delay(500);
}
Console << endl Console << endl << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
<< "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
const char* name="tinytest"; const char* name="tinytest";
Console << "Starting MDNS, name= " << name; Console << "Starting MDNS, name= " << name;
@@ -126,41 +118,36 @@ void setup()
else else
Console << " ok." << endl; Console << " ok." << endl;
MqttBroker* broker = new MqttBroker(1883); MqttBroker* broker = new MqttBroker(1883);
broker->begin(); broker->begin();
brokers["broker"] = broker; brokers["broker"] = broker;
if (Console.isTerm()) if (Console.isTerm()) onCommand("every 333 view");
onCommand("every 333 view");
Console.prompt();
} }
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; std::string str2=str;
string sword = getword(str); std::string sword = getword(str);
if (sword[0] and isdigit(sword[0])) if (sword[0] and isdigit(sword[0]))
{ {
int ret=atoi(sword.c_str()); int ret=atoi(sword.c_str());
while (isdigit(sword[0]) or sword[0] == ' ') while(isdigit(sword[0]) or sword[0]==' ') sword.erase(0,1);
sword.erase(0, 1); if (sword.length()) str = sword+' '+str;
if (sword.length())
str = sword + ' ' + str;
return ret; return ret;
} }
str=str2; str=str2;
return if_empty; 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); char quote=(str[0]=='"' or str[0]=='\'' ? str[0] : 0);
if (quote) if (quote) str.erase(0,1);
str.erase(0, 1); std::string sword;
string sword;
while(str.length() and (str[0]!=sep or quote)) while(str.length() and (str[0]!=sep or quote))
{ {
if (str[0]==quote) if (str[0]==quote)
@@ -171,10 +158,8 @@ string getword(string &str, const char *if_empty /*=nullptr*/, char sep /*=' '*/
sword += str[0]; sword += str[0];
str.erase(0,1); str.erase(0,1);
} }
while (str[0] == sep) while(str[0]==sep) str.erase(0,1);
str.erase(0, 1); if (if_empty and sword.length()==0) return if_empty;
if (if_empty and sword.length() == 0)
return if_empty;
if (quote==false and sword.length()>=4 and sword.substr(0,3)=="rnd") if (quote==false and sword.length()>=4 and sword.substr(0,3)=="rnd")
{ {
sword.erase(0,3); sword.erase(0,3);
@@ -187,8 +172,7 @@ string getword(string &str, const char *if_empty /*=nullptr*/, char sep /*=' '*/
{ {
sword.erase(0,1); sword.erase(0,1);
to = getint(sword); to = getint(sword);
if (sword[0] != ')') if (sword[0]!=')') Console << "Missing ')'" << endl;
Console << "Missing ')'" << endl;
} }
else else
{ {
@@ -202,29 +186,26 @@ string getword(string &str, const char *if_empty /*=nullptr*/, char sep /*=' '*/
Console << "Missing '('" << endl; Console << "Missing '('" << endl;
} }
} }
while (str[0] == ' ') while(str[0]==' ') str.erase(0,1);
str.erase(0, 1);
return sword; return sword;
} }
bool isaddr(string s) bool isaddr(std::string s)
{ {
if (s.length() == 0 or s.length() > 3) if (s.length()==0 or s.length()>3) return false;
return false;
for(char c: s) for(char c: s)
if (c < '0' or c > '9') if (c<'0' or c>'9') return false;
return false;
return true; 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); std::string addr=getword(str, if_empty, sep);
string ip = addr; std::string ip=addr;
std::vector<string> build; std::vector<std::string> build;
while(ip.length()) while(ip.length())
{ {
string b = getword(ip, nullptr, '.'); std::string b=getword(ip,nullptr,'.');
if (isaddr(b) && build.size()<4) if (isaddr(b) && build.size()<4)
{ {
build.push_back(b); build.push_back(b);
@@ -238,40 +219,37 @@ string getip(string &str, const char *if_empty = nullptr, char sep = ' ')
{ {
std::stringstream b; std::stringstream b;
b << (int)local[3-build.size()]; b << (int)local[3-build.size()];
build.insert(build.begin(), b.str().c_str()); build.insert(build.begin(), b.str());
} }
for (string s : build) for(std::string s: build)
{ {
if (addr.length()) if (addr.length()) addr += '.';
addr += '.';
addr += s; addr += s;
} }
Console << "connect address: " << addr << endl; Console << "connect address: " << addr << endl;
return addr; 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", "broker", "blink", "client", "connect",
"create", "delete", "debug", "help", "interval", "create", "delete", "debug", "help", "interval",
"list", "ls", "ip", "off", "on", "set", "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] == ' ') while(search[0]==' ') search.erase(0,1);
search.erase(0, 1); if (search.length()==0) return;
if (search.length() == 0) std::string matches;
return;
string matches;
int count=0; int count=0;
for (string cmd : commands) for(std::string cmd: commands)
{ {
if (cmd.substr(0, search.length()) == search) if (cmd.substr(0, search.length()) == search)
{ {
if (count) if (count) matches +=", ";
matches += ", ";
count++; count++;
matches += cmd; matches += cmd;
} }
@@ -285,7 +263,7 @@ void convertToCommand(string &search)
} }
} }
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]) if (d[0] && d[1])
{ {
@@ -293,7 +271,7 @@ void replace(const char *d, string &str, string srch, string to)
to=d[0]+to+d[1]; to=d[0]+to+d[1];
size_t pos = 0; 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.erase(pos, srch.length());
str.insert(pos, to); str.insert(pos, to);
@@ -302,7 +280,7 @@ void replace(const char *d, string &str, string srch, string to)
} }
} }
void replaceVars(string &cmd) void replaceVars(std::string& cmd)
{ {
cmd = ' '+cmd+' '; cmd = ' '+cmd+' ';
@@ -313,28 +291,27 @@ void replaceVars(string &cmd)
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(0, cmd.find_first_not_of(" "));
cmd.erase(cmd.find_last_not_of(' ') + 1); 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; uint8_t p=0;
while(s[p++]==*cmd++) while(s[p++]==*cmd++)
{ {
if (*cmd == 0 or s[p] == 0) if (*cmd==0 or s[p]==0) return true;
return true; if (s[p]==' ') return true;
if (s[p] == ' ')
return true;
} }
return false; return false;
} }
using ClientFunction = void (*)(string &cmd, MqttClient *publish); using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
struct Every struct Every
{ {
string cmd; std::string cmd;
uint32_t ms; uint32_t ms;
uint32_t next; uint32_t next;
uint32_t underrun=0; uint32_t underrun=0;
@@ -364,19 +341,19 @@ int16_t blink;
std::vector<Every> everies; std::vector<Every> everies;
void onCommand(const string &command) void onCommand(const std::string& command)
{ {
Console << endl; Console << endl;
string cmd = command; std::string cmd=command;
if (cmd.substr(0, 3) != "set") if (cmd.substr(0,3)!="set") replaceVars(cmd);
replaceVars(cmd);
eval(cmd); eval(cmd);
Console << endl; 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; uint16_t port;
auto it=list.find(remote); auto it=list.find(remote);
if (it != list.end()) if (it != list.end())
@@ -392,18 +369,18 @@ void clientConnect(MqttClient *client, string &cmd)
Console << (client->connected() ? "connected." : "not connected") << endl; 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; MqttError retval = MqttOk;
string s; std::string s;
MqttBroker* broker = nullptr; MqttBroker* broker = nullptr;
MqttClient* client = nullptr; MqttClient* client = nullptr;
// client.function notation // client.function notation
if (cmd.find('.') != string::npos && if (cmd.find('.') != std::string::npos &&
cmd.find('.') < cmd.find(' ')) cmd.find('.') < cmd.find(' '))
{ {
s=getword(cmd, nullptr, '.'); s=getword(cmd, nullptr, '.');
@@ -427,11 +404,9 @@ void eval(string &cmd)
} }
s = getword(cmd); s = getword(cmd);
if (s.length()) if (s.length()) convertToCommand(s);
convertToCommand(s);
if (s.length()==0) if (s.length()==0)
{ {}
}
else if (compare(s, "debug")) else if (compare(s, "debug"))
{ {
#if TINY_MQTT_DEBUG #if TINY_MQTT_DEBUG
@@ -468,8 +443,7 @@ void eval(string &cmd)
{ {
for (auto it: clients) for (auto it: clients)
{ {
if (it.second != client) if (it.second != client) continue;
continue;
Console << "deleted" << endl; Console << "deleted" << endl;
delete (it.second); delete (it.second);
clients.erase(it.first); clients.erase(it.first);
@@ -481,8 +455,7 @@ void eval(string &cmd)
{ {
for(auto it: brokers) for(auto it: brokers)
{ {
if (broker != it.second) if (broker != it.second) continue;
continue;
Console << "deleted" << endl; Console << "deleted" << endl;
delete (it.second); delete (it.second);
brokers.erase(it.first); brokers.erase(it.first);
@@ -659,7 +632,7 @@ void eval(string &cmd)
} }
else if (compare(s, "broker")) else if (compare(s, "broker"))
{ {
string id = getword(cmd); std::string id=getword(cmd);
if (clients.find(id) != clients.end()) if (clients.find(id) != clients.end())
{ {
Console << "A client already have that name" << endl; Console << "A client already have that name" << endl;
@@ -690,7 +663,7 @@ void eval(string &cmd)
} }
else if (compare(s, "client")) else if (compare(s, "client"))
{ {
string id = getword(cmd); std::string id=getword(cmd);
if (brokers.find(id) != brokers.end()) if (brokers.find(id) != brokers.end())
{ {
Console << "A broker have that name" << endl; Console << "A broker have that name" << endl;
@@ -702,8 +675,7 @@ void eval(string &cmd)
if (s=="" or brokers.find(s) != brokers.end() or list.find(s) != list.end()) if (s=="" or brokers.find(s) != brokers.end() or list.find(s) != list.end())
{ {
MqttBroker* broker = nullptr; MqttBroker* broker = nullptr;
if (s.length()) if (s.length()) broker = brokers[s];
broker = brokers[s];
MqttClient* client = new MqttClient(broker, id); MqttClient* client = new MqttClient(broker, id);
clients[id]=client; clients[id]=client;
client->setCallback(onPublish); client->setCallback(onPublish);
@@ -728,7 +700,7 @@ void eval(string &cmd)
} }
else if (compare(s, "set")) else if (compare(s, "set"))
{ {
string name(getword(cmd)); std::string name(getword(cmd));
if (name.length()==0) if (name.length()==0)
{ {
for(auto it: vars) for(auto it: vars)
@@ -816,8 +788,7 @@ void eval(string &cmd)
} }
else else
{ {
while (s[0] == ' ') while(s[0]==' ') s.erase(0,1);
s.erase(0, 1);
if (s.length()) if (s.length())
Console << "Unknown command (" << s.c_str() << ")" << endl; Console << "Unknown command (" << s.c_str() << ")" << endl;
} }
@@ -838,18 +809,16 @@ void loop()
for(auto& every: everies) for(auto& every: everies)
{ {
if (not every.active) if (not every.active) continue;
continue;
if (every.ms && every.cmd.length() && ms > every.next) if (every.ms && every.cmd.length() && ms > every.next)
{ {
string cmd(every.cmd); std::string cmd(every.cmd);
eval(cmd); eval(cmd);
every.next += every.ms; every.next += every.ms;
if (ms > every.next and ms > every.underrun) if (ms > every.next and ms > every.underrun)
{ {
every.next += every.ms; every.next += every.ms;
Console << yellow << "Underrun every #" << e << ", " << (ms - every.next) << "ms late" << endl; Console << yellow << "Underrun every #" << e << ", " << (ms - every.next) << "ms late" << endl;
Console.fg(white);
every.underrun = ms+5000; every.underrun = ms+5000;
} }
} }
@@ -876,6 +845,7 @@ void loop()
out++; out++;
} }
static long count;
#if defined(ESP9266) #if defined(ESP9266)
MDNS.update(); MDNS.update();
#endif #endif

View File

@@ -1,20 +0,0 @@
{
"name": "TinyMqtt",
"keywords": "ethernet, mqtt, m2m, iot",
"description": "MQTT is a lightweight messaging protocol. This library allows to host a broker or to use a mqtt client in your ESP 8266 or 32 WROOM. It does support MQTT 3.1.1 with QoS",
"repository": {
"type": "git",
"url": "https://github.com/hsaturn/TinyMqtt.git"
},
"dependencies":
{ "hsaturn/TinyConsole" : "*" },
"version": "0.9.19",
"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 name=TinyMqtt
version=0.9.19 version=0.9.11
author=Francois BIOT, HSaturn, <hsaturn@gmail.com> 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. sentence=A tiny broker and client library for MQTT messaging.
paragraph=MQTT is a lightweight messaging protocol. This library allows to host a broker or to use a mqtt client in your ESP 8266 or 32 WROOM. It does support MQTT 3.1.1 with QoS=0, and is intented to be as smallest as possible, keeping a good efficiency (about 1k msg per second on ESP8266 12F). 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 category=Communication
url=https://github.com/hsaturn/TinyMqtt url=https://github.com/hsaturn/TinyMqtt
architectures=* architectures=*
depends=hsaturn/TinyConsole depends=TinyConsole
includes=TinyMqtt.h includes=TinyMqtt.h

View File

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

View File

@@ -15,36 +15,18 @@ int TinyMqtt::debug=2;
std::map<MqttMessage::Type, int> MqttClient::counters; std::map<MqttMessage::Type, int> MqttClient::counters;
#endif #endif
MqttBroker::MqttBroker(uint16_t port, uint8_t max_retain_size) MqttBroker::MqttBroker(uint16_t port)
{ {
debug("New broker" << port); server = std::unique_ptr<TcpServer>(new TcpServer(port));
retain_size = max_retain_size;
server = new TcpServer(port);
#ifdef TINY_MQTT_ASYNC #ifdef TINY_MQTT_ASYNC
server->onClient(onClient, this); server->onClient(onClient, this);
#endif #endif
} }
MqttBroker::~MqttBroker()
{
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 // private constructor used by broker only
MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client) MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
: local_broker(local_broker)
{ {
connect(local_broker);
debug("MqttClient private with broker"); debug("MqttClient private with broker");
#ifdef TINY_MQTT_ASYNC #ifdef TINY_MQTT_ASYNC
tcp_client = new_client; tcp_client = new_client;
@@ -52,20 +34,15 @@ MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
// client->onConnect() TODO // client->onConnect() TODO
// client->onDisconnect() TODO // client->onDisconnect() TODO
#else #else
tcp_client = new WiFiClient(*new_client); tcp_client.reset(new WiFiClient(*new_client));
#endif
#ifdef EPOXY_DUINO
alive = millis()+500000;
#else
alive = millis()+5000; // TODO MAGIC client expires after 5s if no CONNECT msg
#endif #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) : local_broker(local_broker), clientId(id)
{ {
alive = 0; alive = 0;
keep_alive = 0;
if (local_broker) local_broker->addClient(this); if (local_broker) local_broker->addClient(this);
} }
@@ -73,14 +50,13 @@ MqttClient::MqttClient(MqttBroker* local_broker, const string& id)
MqttClient::~MqttClient() MqttClient::~MqttClient()
{ {
close(); close();
delete tcp_client;
debug("*** MqttClient delete()"); debug("*** MqttClient delete()");
} }
void MqttClient::close(bool bSendDisconnect) void MqttClient::close(bool bSendDisconnect)
{ {
debug("close " << id().c_str()); debug("close " << id().c_str());
resetFlag(CltFlagConnected); mqtt_flags &= ~FlagConnected;
if (tcp_client) // connected to a remote broker if (tcp_client) // connected to a remote broker
{ {
if (bSendDisconnect and tcp_client->connected()) if (bSendDisconnect and tcp_client->connected())
@@ -102,28 +78,28 @@ void MqttClient::close(bool bSendDisconnect)
void MqttClient::connect(MqttBroker* local) void MqttClient::connect(MqttBroker* local)
{ {
debug("MqttClient::connect_local"); debug("MqttClient::connect_local");
alive = 0;
close(); close();
local_broker = local; 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); debug("MqttClient::connect_to_host " << broker << ':' << port);
keep_alive = ka; keep_alive = ka;
close(); close();
if (tcp_client) delete tcp_client; tcp_client.reset(new TcpClient);
tcp_client = new TcpClient;
#ifdef TINY_MQTT_ASYNC #ifdef TINY_MQTT_ASYNC
tcp_client->onData(onData, this); tcp_client->onData(onData, this);
tcp_client->onConnect(onConnect, this); tcp_client->onConnect(onConnect, this);
tcp_client->connect(broker.c_str(), port); tcp_client->connect(broker.c_str(), port, ka);
#else #else
if (tcp_client->connect(broker.c_str(), port)) if (tcp_client->connect(broker.c_str(), port))
{ {
debug("link established"); debug("link established");
onConnect(this, tcp_client); onConnect(this, tcp_client.get());
} }
else else
{ {
@@ -132,41 +108,23 @@ void MqttClient::connect(string broker, uint16_t port, uint16_t ka)
#endif #endif
} }
void MqttBroker::addClient(MqttClient* client) void MqttBroker::addClient(TcpClient* client)
{ {
debug("MqttBroker::addClient"); debug("MqttBroker::addClient");
clients.push_back(client); clients.insert(std::unique_ptr<MqttClient>(new MqttClient(this, client)));
} }
void MqttBroker::connect(const string& host, uint16_t port) void MqttBroker::connect(const std::string& host, uint16_t port)
{ {
debug("MqttBroker::connect"); debug("MqttBroker::connect");
if (remote_broker == nullptr) remote_broker = new MqttClient; if (remote_broker == nullptr) remote_broker = new MqttClient;
remote_broker->connect(host, port); remote_broker->connect(host, port);
remote_broker->local_broker = this; // Because connect removed the link remote_broker->local_broker = this; // Because connect removed the link
// TODO shouldn't we resubscribe to all client subscriptions ?
} }
void MqttBroker::removeClient(MqttClient* remove) void MqttBroker::removeClient(MqttClient* remove)
{ {
debug("removeClient"); local_clients.erase(remove);
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
} }
void MqttBroker::onClient(void* broker_ptr, TcpClient* client) void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
@@ -174,16 +132,14 @@ void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
debug("MqttBroker::onClient"); debug("MqttBroker::onClient");
MqttBroker* broker = static_cast<MqttBroker*>(broker_ptr); MqttBroker* broker = static_cast<MqttBroker*>(broker_ptr);
MqttClient* mqtt = new MqttClient(broker, client); broker->addClient(client);
mqtt->setFlag(MqttClient::CltFlags::CltFlagToDelete);
broker->addClient(mqtt);
debug("New client"); debug("New client");
} }
void MqttBroker::loop() void MqttBroker::loop()
{ {
#ifndef TINY_MQTT_ASYNC #ifndef TINY_MQTT_ASYNC
WiFiClient client = server->accept(); WiFiClient client = server->available();
if (client) if (client)
{ {
@@ -197,36 +153,23 @@ void MqttBroker::loop()
remote_broker->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]; it->get()->loop();
if (client->connected()) if (not it->get()->connected())
{ {
client->loop(); clients.erase(it);
}
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;
break; break;
} }
} }
for(const auto& client: local_clients)
client->loop();
} }
// Obvioulsy called when the broker is connected to another broker. MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
MqttError MqttBroker::subscribe(MqttClient* client, const Topic& topic, uint8_t qos)
{ {
debug("MqttBroker::subscribe to " << topic.str() << ", retained=" << retained.size() ); debug("MqttBroker::subscribe");
for(auto& [retained_topic, retain]: retained)
{
debug(" retained: " << retained_topic.str());
if (topic.matches(retained_topic))
{
debug(" -> sending");
client->publishIfSubscribed(retained_topic, retain.msg);
}
}
if (remote_broker && remote_broker->connected()) if (remote_broker && remote_broker->connected())
{ {
return remote_broker->subscribe(topic, qos); return remote_broker->subscribe(topic, qos);
@@ -234,21 +177,18 @@ MqttError MqttBroker::subscribe(MqttClient* client, const Topic& topic, uint8_t
return MqttNowhereToSend; 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; MqttError retval = MqttOk;
retain(topic, msg);
debug("MqttBroker::publish"); debug("MqttBroker::publish");
int i=0; int clt_num = 0;
for(auto client: clients) for(auto& client: clients)
{ {
i++; debug (" broker:" << (remote_broker && remote_broker->connected() ? "linked" : "alone")
#if TINY_MQTT_DEBUG << " srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << ++clt_num
Console << __LINE__ << " broker:" << (remote_broker && remote_broker->connected() ? "linked" : "alone") << << ", local=" << client->isLocal() << ", con=" << client->connected());
" srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
#endif
bool doit = false; bool doit = false;
if (remote_broker && remote_broker->connected()) // this (MqttBroker) is connected (to a external broker) if (remote_broker && remote_broker->connected()) // this (MqttBroker) is connected (to a external broker)
{ {
@@ -266,9 +206,8 @@ MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, Mqtt
{ {
doit = true; doit = true;
} }
#if TINY_MQTT_DEBUG
Console << ", doit=" << doit << ' '; debug(" doit=" << doit << ' ');
#endif
if (doit) retval = client->publishIfSubscribed(topic, msg); if (doit) retval = client->publishIfSubscribed(topic, msg);
debug(""); debug("");
@@ -292,16 +231,12 @@ void MqttMessage::getString(const char* &buff, uint16_t& len)
buff+=2; buff+=2;
} }
void MqttClient::clientAlive(uint32_t more_seconds) void MqttClient::clientAlive()
{ {
debug("MqttClient::clientAlive"); debug("MqttClient::clientAlive");
if (keep_alive) if (keep_alive)
{ {
#ifdef EPOXY_DUINO alive=millis()+1000*(keep_alive+(local_broker ? TINY_MQTT_CLIENT_ALIVE_TOLERANCE : 0));
alive=millis()+500000+0*more_seconds;
#else
alive=millis()+1000*(keep_alive+more_seconds);
#endif
} }
else else
alive=0; alive=0;
@@ -309,26 +244,26 @@ void MqttClient::clientAlive(uint32_t more_seconds)
void MqttClient::loop() void MqttClient::loop()
{ {
if (keep_alive && (millis() >= alive - 5000)) 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"); debug("pingreq");
static MqttMessage pingreq(MqttMessage::Type::PingReq); uint16_t pingreq = MqttMessage::Type::PingReq;
pingreq.sendTo(this);
clientAlive(0); tcp_client->write((const char*)(&pingreq), 2);
clientAlive();
// TODO when many MqttClient passes through a local broker // TODO when many MqttClient passes through a local broker
// there is no need to send one PingReq per instance. // 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 #ifndef TINY_MQTT_ASYNC
while(tcp_client && tcp_client->available()>0) while(tcp_client && tcp_client->available()>0)
{ {
@@ -359,7 +294,7 @@ void MqttClient::onConnect(void *mqttclient_ptr, TcpClient*)
msg.reset(); msg.reset();
debug("cnx: mqtt sent " << (dbg_ptr)mqtt->local_broker); debug("cnx: mqtt sent " << (dbg_ptr)mqtt->local_broker);
mqtt->clientAlive(0); mqtt->clientAlive();
} }
#ifdef TINY_MQTT_ASYNC #ifdef TINY_MQTT_ASYNC
@@ -391,7 +326,7 @@ void MqttClient::resubscribe()
msg.add(0); msg.add(0);
msg.add(0); msg.add(0);
for(auto topic: subscriptions) for(const auto& topic: subscriptions)
{ {
msg.add(topic); msg.add(topic);
msg.add(0); // TODO qos msg.add(0); // TODO qos
@@ -407,13 +342,13 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
subscriptions.insert(topic); 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); return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
} }
else else
{ {
return local_broker->subscribe(this, topic, qos); return local_broker->subscribe(topic, qos);
} }
return ret; return ret;
} }
@@ -466,13 +401,14 @@ void MqttClient::processMessage(MqttMessage* mesg)
switch(mesg->type()) switch(mesg->type())
{ {
case MqttMessage::Type::Connect: case MqttMessage::Type::Connect:
if (mqtt_connected()) if (mqtt_flags & FlagConnected)
{ {
debug("already connected"); debug("already connected");
break; break;
} }
payload = header+10; 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); keep_alive = MqttMessage::getSize(header+8);
if (strncmp("MQTT", header+2,4)) if (strncmp("MQTT", header+2,4))
{ {
@@ -481,13 +417,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
} }
if (header[6]!=0x04) if (header[6]!=0x04)
{ {
debug("Unsupported MQTT version (" << (int) header[6] << "), only version=4 supported" << endl); debug("unknown level");
break; // Level 3.1.1 break; // Level 3.1.1
} }
// ClientId // ClientId
mesg->getString(payload, len); mesg->getString(payload, len);
clientId = string(payload, len); clientId = std::string(payload, len);
payload += len; payload += len;
if (mqtt_flags & FlagWill) // Will topic if (mqtt_flags & FlagWill) // Will topic
@@ -512,11 +448,10 @@ void MqttClient::processMessage(MqttMessage* mesg)
payload += len; payload += len;
} }
#if TINY_MQTT_DEBUG debug(yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white);
Console << yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white << endl;
#endif
bclose = false; bclose = false;
setFlag(CltFlagConnected); mqtt_flags |= FlagConnected;
{ {
MqttMessage msg(MqttMessage::Type::ConnAck); MqttMessage msg(MqttMessage::Type::ConnAck);
msg.add(0); // Session present (not implemented) msg.add(0); // Session present (not implemented)
@@ -526,14 +461,14 @@ void MqttClient::processMessage(MqttMessage* mesg)
break; break;
case MqttMessage::Type::ConnAck: case MqttMessage::Type::ConnAck:
setFlag(CltFlagConnected); mqtt_flags |= FlagConnected;
bclose = false; bclose = false;
resubscribe(); resubscribe();
break; break;
case MqttMessage::Type::SubAck: case MqttMessage::Type::SubAck:
case MqttMessage::Type::PubAck: case MqttMessage::Type::PubAck:
if (not mqtt_connected()) break; if (not (mqtt_flags & FlagConnected)) break;
// Ignore acks // Ignore acks
bclose = false; bclose = false;
break; break;
@@ -544,7 +479,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
break; break;
case MqttMessage::Type::PingReq: case MqttMessage::Type::PingReq:
if (not mqtt_connected()) break; if (not (mqtt_flags & FlagConnected)) break;
if (tcp_client) if (tcp_client)
{ {
uint16_t pingreq = MqttMessage::Type::PingResp; uint16_t pingreq = MqttMessage::Type::PingResp;
@@ -561,15 +496,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
case MqttMessage::Type::Subscribe: case MqttMessage::Type::Subscribe:
case MqttMessage::Type::UnSubscribe: case MqttMessage::Type::UnSubscribe:
{ {
if (not mqtt_connected()) break; if (not (mqtt_flags & FlagConnected)) break;
payload = header+2; payload = header+2;
debug("un/subscribe loop"); debug("un/subscribe loop");
string qoss; std::string qoss;
while(payload < mesg->end()) while(payload < mesg->end())
{ {
mesg->getString(payload, len); // Topic mesg->getString(payload, len); // Topic
debug( " topic (" << string(payload, len) << ')'); debug( " topic (" << std::string(payload, len) << ')');
// subscribe(Topic(payload, len)); // subscribe(Topic(payload, len));
Topic topic(payload, len); Topic topic(payload, len);
@@ -584,7 +519,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
} }
else else
qoss.push_back(qos); qoss.push_back(qos);
subscribe(topic); subscriptions.insert(topic);
} }
else else
{ {
@@ -605,25 +540,21 @@ void MqttClient::processMessage(MqttMessage* mesg)
break; break;
case MqttMessage::Type::UnSuback: case MqttMessage::Type::UnSuback:
if (not mqtt_connected()) break; if (not (mqtt_flags & FlagConnected)) break;
bclose = false; bclose = false;
break; break;
case MqttMessage::Type::Publish: case MqttMessage::Type::Publish:
#if TINY_MQTT_DEBUG debug("publish " << (mqtt_flags & FlagConnected) << '/' << (long) tcp_client.get());
Console << "publish " << mqtt_connected() << '/' << (long) tcp_client << endl; if ((mqtt_flags & FlagConnected) or tcp_client == nullptr)
#endif
if (mqtt_connected() or tcp_client == nullptr)
{ {
uint8_t qos = mesg->flags(); uint8_t qos = mesg->flags();
payload = header; payload = header;
mesg->getString(payload, len); mesg->getString(payload, len);
Topic published(payload, len); Topic published(payload, len);
payload += len; payload += len;
#if TINY_MQTT_DEBUG debug("Received Publish (" << published.str().c_str() << ") size=" << (int)len);
Console << "Received Publish (" << published.str().c_str() << ") size=" << (int)len << endl; // << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl;
#endif
// << '(' << string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl;
if (qos) payload+=2; // ignore packet identifier if any if (qos) payload+=2; // ignore packet identifier if any
len=mesg->end()-payload; len=mesg->end()-payload;
// TODO reset DUP // TODO reset DUP
@@ -634,8 +565,8 @@ void MqttClient::processMessage(MqttMessage* mesg)
#if TINY_MQTT_DEBUG #if TINY_MQTT_DEBUG
if (TinyMqtt::debug >= 2) if (TinyMqtt::debug >= 2)
{ {
Console << (isSubscribedTo(published) ? "not" : "") << " subscribed.\r\n"; Console << (isSubscribedTo(published) ? "not" : "") << " subscribed.\n";
Console << "has " << (callback ? "" : "no ") << " callback.\r\n"; Console << "has " << (callback ? "" : "no ") << " callback.\n";
} }
#endif #endif
if (callback and isSubscribedTo(published)) if (callback and isSubscribedTo(published))
@@ -654,8 +585,8 @@ void MqttClient::processMessage(MqttMessage* mesg)
case MqttMessage::Type::Disconnect: case MqttMessage::Type::Disconnect:
// TODO should discard any will msg // TODO should discard any will msg
if (not mqtt_connected()) break; if (not (mqtt_flags & FlagConnected)) break;
resetFlag(CltFlagConnected); mqtt_flags &= ~FlagConnected;
close(false); close(false);
bclose=false; bclose=false;
break; break;
@@ -676,7 +607,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
} }
else else
{ {
clientAlive(local_broker ? 5 : 0); clientAlive();
} }
} }
@@ -744,9 +675,9 @@ bool Topic::matches(const Topic& topic) const
// publish from local client // 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(topic);
msg.add(payload, pay_length, false); msg.add(payload, pay_length, false);
msg.complete(); msg.complete();
@@ -774,10 +705,7 @@ MqttError MqttClient::publishIfSubscribed(const Topic& topic, MqttMessage& msg)
else else
{ {
processMessage(&msg); processMessage(&msg);
debug("Should call the callback ?");
#if TINY_MQTT_DEBUG
Console << "Should call the callback ?\n";
#endif
// callback(this, topic, nullptr, 0); // TODO Payload // callback(this, topic, nullptr, 0); // TODO Payload
} }
} }
@@ -910,41 +838,12 @@ MqttError MqttMessage::sendTo(MqttClient* client)
return MqttOk; 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()));
if (retain_size==0 or msg.type() != MqttMessage::Publish) return;
if (msg.flags() & 1) // flag RETAIN
{
debug(" retaining " << topic.str());
if (retained.find(topic) == retained.end()) retainDrop();
// FIXME if payload size == 0 remove message from retained
Retain r(micros(), msg);
retained.insert({ topic, std::move(r)});
}
}
void MqttMessage::hexdump(const char* prefix) const void MqttMessage::hexdump(const char* prefix) const
{ {
(void)prefix; (void)prefix;
#if TINY_MQTT_DEBUG #if TINY_MQTT_DEBUG
if (TinyMqtt::debug<2) return; if (TinyMqtt::debug<2) return;
static std::map<Type, string> tts={ static std::map<Type, std::string> tts={
{ Connect, "Connect" }, { Connect, "Connect" },
{ ConnAck, "Connack" }, { ConnAck, "Connack" },
{ Publish, "Publish" }, { Publish, "Publish" },
@@ -957,7 +856,7 @@ void MqttMessage::hexdump(const char* prefix) const
{ PingResp, "Pingresp" }, { PingResp, "Pingresp" },
{ Disconnect, "Disconnect" } { Disconnect, "Disconnect" }
}; };
string t("Unknown"); std::string t("Unknown");
Type typ=static_cast<Type>(buffer[0] & 0xF0); Type typ=static_cast<Type>(buffer[0] & 0xF0);
if (tts.find(typ) != tts.end()) if (tts.find(typ) != tts.end())
t=tts[typ]; t=tts[typ];
@@ -974,7 +873,7 @@ void MqttMessage::hexdump(const char* prefix) const
const char* hex_to_str = " | "; const char* hex_to_str = " | ";
const char* separator = hex_to_str; const char* separator = hex_to_str;
const char* half_sep = " - "; const char* half_sep = " - ";
string ascii; std::string ascii;
Console << prefix << " size(" << buffer.size() << "), state=" << state << endl; Console << prefix << " size(" << buffer.size() << "), state=" << state << endl;

View File

@@ -4,6 +4,10 @@
#ifndef TINY_MQTT_DEBUG #ifndef TINY_MQTT_DEBUG
#define TINY_MQTT_DEBUG 0 #define TINY_MQTT_DEBUG 0
#endif #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 // 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 // #define TINY_MQTT_ASYNC // Uncomment this to use ESPAsyncTCP instead of normal cnx
@@ -33,7 +37,7 @@
#include <rpcWiFi.h> #include <rpcWiFi.h>
#endif #endif
#include <vector> #include <memory>
#include <set> #include <set>
#include <string> #include <string>
#include "StringIndexer.h" #include "StringIndexer.h"
@@ -48,7 +52,7 @@
static int debug; 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 #else
#define debug(what) {} #define debug(what) {}
#endif #endif
@@ -68,15 +72,12 @@ enum __attribute__((packed)) MqttError
MqttInvalidMessage=2, MqttInvalidMessage=2,
}; };
using string = TinyConsole::string;
class Topic : public IndexedString class Topic : public IndexedString
{ {
public: public:
Topic(const string& m) : IndexedString(m){}
Topic(const char* s, uint8_t len) : IndexedString(s,len){} Topic(const char* s, uint8_t len) : IndexedString(s,len){}
Topic(const char* s) : Topic(s, strlen(s)) {} 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(); } const char* c_str() const { return str().c_str(); }
@@ -121,14 +122,11 @@ class MqttMessage
return (*bun << 8) | bun[1]; } return (*bun << 8) | bun[1]; }
MqttMessage() { reset(); } MqttMessage() { reset(); }
MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= (bits_d3_d0 & 0xF); } MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= bits_d3_d0; }
MqttMessage(const MqttMessage& m)
: buffer(m.buffer), vheader(m.vheader), size(m.size), state(m.state) {}
void incoming(char byte); void incoming(char byte);
void add(char byte) { incoming(byte); } void add(char byte) { incoming(byte); }
void add(const char* p, size_t len, bool addLength=true ); 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()); } void add(const Topic& t) { add(t.str()); }
const char* end() const { return &buffer[0]+buffer.size(); } const char* end() const { return &buffer[0]+buffer.size(); }
const char* getVHeader() const { return &buffer[vheader]; } const char* getVHeader() const { return &buffer[vheader]; }
@@ -159,19 +157,10 @@ class MqttMessage
MqttError sendTo(MqttClient*); MqttError sendTo(MqttClient*);
void hexdump(const char* prefix=nullptr) const; 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: private:
void encodeLength(); void encodeLength();
string buffer; std::string buffer;
uint8_t vheader; uint8_t vheader;
uint16_t size; // bytes left to receive uint16_t size; // bytes left to receive
State state; State state;
@@ -188,14 +177,9 @@ class MqttClient
FlagWillQos = 16 | 8, // unsupported FlagWillQos = 16 | 8, // unsupported
FlagWill = 4, // unsupported FlagWill = 4, // unsupported
FlagCleanSession = 2, // unsupported FlagCleanSession = 2, // unsupported
FlagReserved = 1
};
enum __attribute__((packed)) CltFlags FlagReserved = 1, // use reserved as connected (save 1 byte)
{ FlagConnected = 1
CltFlagNone = 0,
CltFlagConnected = 1,
CltFlagToDelete = 2
}; };
public: public:
@@ -203,13 +187,13 @@ class MqttClient
/** Constructor. Broker is the adress of a local broker if not null /** Constructor. Broker is the adress of a local broker if not null
If you want to connect elsewhere, leave broker null and use connect() **/ 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(MqttBroker* broker = nullptr, const std::string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
MqttClient(const string& id) : MqttClient(nullptr, id){} MqttClient(const std::string& id) : MqttClient(nullptr, id){}
~MqttClient(); ~MqttClient();
void connect(MqttBroker* local_broker); void connect(MqttBroker* local_broker);
void connect(string broker, uint16_t port, uint16_t keep_alive = 10); 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 // TODO it seems that connected returns true in tcp mode even if
// no negociation occurred // no negociation occurred
@@ -224,8 +208,8 @@ class MqttClient
if (tcp_client) tcp_client->write(buf, length); if (tcp_client) tcp_client->write(buf, length);
} }
const string& id() const { return clientId; } const std::string& id() const { return clientId; }
void id(const string& new_id) { clientId = new_id; } void id(const std::string& new_id) { clientId = new_id; }
/** Should be called in main loop() */ /** Should be called in main loop() */
void loop(); void loop();
@@ -240,11 +224,11 @@ class MqttClient
}; };
// Publish from client to the world // Publish from client to the world
MqttError publish(const Topic&, const char* payload, size_t pay_length, bool retain=false); MqttError publish(const Topic&, const char* payload, size_t pay_length);
MqttError publish(const Topic& t, const char* payload, bool retain=false) { return publish(t, payload, strlen(payload), retain); } MqttError publish(const Topic& t, const char* payload) { return publish(t, payload, strlen(payload)); }
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) { return publish(t, s.c_str(), s.length()); }
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 std::string& s) { return publish(t,s.c_str(),s.length());}
MqttError publish(const Topic& t, bool retain=false) { return publish(t, nullptr, 0, retain);}; MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
MqttError subscribe(Topic topic, uint8_t qos=0); MqttError subscribe(Topic topic, uint8_t qos=0);
MqttError unsubscribe(Topic topic); MqttError unsubscribe(Topic topic);
@@ -254,7 +238,7 @@ class MqttClient
// TODO seems to be useless // TODO seems to be useless
bool isLocal() const { return tcp_client == nullptr; } bool isLocal() const { return tcp_client == nullptr; }
void dump(string indent="") void dump(std::string indent="")
{ {
(void)indent; (void)indent;
#if TINY_MQTT_DEBUG #if TINY_MQTT_DEBUG
@@ -291,9 +275,6 @@ class MqttClient
uint32_t keepAlive() const { return keep_alive; } uint32_t keepAlive() const { return keep_alive; }
private: 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) // event when tcp/ip link established (real or fake)
static void onConnect(void * client_ptr, TcpClient*); static void onConnect(void * client_ptr, TcpClient*);
@@ -308,50 +289,59 @@ class MqttClient
// republish a received publish if topic matches any in subscriptions // republish a received publish if topic matches any in subscriptions
MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg); MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
void clientAlive(uint32_t more_seconds); void clientAlive();
void processMessage(MqttMessage* message); void processMessage(MqttMessage* message);
uint8_t cltFlags = CltFlagNone; char mqtt_flags = 0;
char mqtt_flags; uint16_t keep_alive = 30;
uint32_t keep_alive = 30; // for client connected to remote broker, PingReq is sent when millis() >= alive
uint32_t alive; // for a client managed by a broker, disconnect it if millis() >= alive
uint32_t alive; // PingReq if millis() > alive,
MqttMessage message; MqttMessage message;
// connection to local broker, or link to the parent // connection to local broker, or link to the parent
// when MqttBroker uses MqttClient for each external connexion // when MqttBroker uses MqttClient for each external connexion
MqttBroker* local_broker=nullptr; 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; std::set<Topic> subscriptions;
string clientId; std::string clientId;
CallBack callback = nullptr; CallBack callback = nullptr;
}; };
class MqttBroker 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: public:
// TODO limit max number of clients // TODO limit max number of clients
MqttBroker(uint16_t port, uint8_t retain_size=0); MqttBroker(uint16_t port);
~MqttBroker();
void begin() { server->begin(); } void begin() { server->begin(); }
void loop(); void loop();
/** Connect the broker to a parent broker */ void connect(const std::string& host, uint16_t port=1883);
void connect(const string& host, uint16_t port=1883); bool connected() const { return state == Connected; }
/** returns true if connected to another broker */
bool connected() const { return remote_broker ? remote_broker->connected() : false; }
size_t clientsCount() const { return clients.size(); }
void retain(uint8_t size) { retain_size = size; }
void dump(string indent="") void dump(std::string indent="")
{ {
for(auto client: clients) for(const auto& client: clients)
client->dump(indent); client->dump(indent);
} }
const std::vector<MqttClient*> getClients() const { return clients; } 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: private:
friend class MqttClient; friend class MqttClient;
@@ -363,43 +353,26 @@ class MqttBroker
bool checkPassword(const char* password, uint8_t len) const bool checkPassword(const char* password, uint8_t len) const
{ return compareString(auth_password, password, len); } { 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) MqttError subscribe(const Topic& topic, uint8_t qos);
void addClient(MqttClient* client);
void removeClient(MqttClient* client); 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; bool compareString(const char* good, const char* str, uint8_t str_len) const;
std::vector<MqttClient*> clients; Clients clients;
LocalClients local_clients;
private: private:
TcpServer* server = nullptr; std::unique_ptr<TcpServer> server;
const char* auth_user = "guest"; const char* auth_user = "guest";
const char* auth_password = "guest"; const char* auth_password = "guest";
MqttClient* remote_broker = nullptr; MqttClient* remote_broker = nullptr;
void retain(const Topic& topic, const MqttMessage& msg); State state = Disconnected;
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;
}; };

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= SUB=n
all:runtests
tests: tests:
@set -e; \ set -e; \
for i in $(SUB)*-tests/Makefile; do \ for i in ${SUB}*-tests/Makefile; do \
echo '==== Making:' $$(dirname $$i); \ echo '==== Making:' $$(dirname $$i); \
$(MAKE) -C $$(dirname $$i) -j; \ $(MAKE) -C $$(dirname $$i) -j; \
done 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: debugtest:
@set -e; \ set -e; \
$(MAKE) clean; \ $(MAKE) clean; \
$(MAKE) -C debug-mode -j; \ $(MAKE) -C debug-mode -j; \
debug-mode/debug-tests.out debug-mode/debug-tests.out
runtests: runtests: debugtest
@set -e; \ $(MAKE) clean
$(MAKE) tests; \ $(MAKE) tests
for i in $(SUB)*-tests/Makefile; do \ set -e; \
for i in ${SUB}*-tests/Makefile; do \
echo '==== Running:' $$(dirname $$i); \ echo '==== Running:' $$(dirname $$i); \
$$(dirname $$i)/$$(dirname $$i).out; \ $$(dirname $$i)/$$(dirname $$i).out; \
done done
clean: clean:
@set -e; \ set -e; \
for i in $(SUB)*-tests/Makefile; do \ for i in ${SUB}*-tests/Makefile; do \
echo '==== Cleaning:' $$(dirname $$i); \ echo '==== Cleaning:' $$(dirname $$i); \
$(MAKE) -C $$(dirname $$i) clean; \ $(MAKE) -C $$(dirname $$i) clean; \
done done

View File

@@ -1,11 +0,0 @@
# GCC
# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
EXTRA_CXXFLAGS=-g3 -O0
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 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 APP_NAME := classbind-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
ARDUINO_LIB_DIRS := ../../../EspMock/libraries ARDUINO_LIB_DIRS := ../../../EspMock/libraries

View File

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

View File

@@ -1,11 +0,0 @@
# 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
APP_NAME := tinymqtt-test
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync ESP8266mDNS TinyConsole
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
EPOXY_CORE := EPOXY_CORE_ESP8266
DUMMY := 1
include ../../../EpoxyDuino/EpoxyDuino.mk

View File

@@ -1,848 +0,0 @@
// vim: ts=2 sw=2 expandtab smartindent
#include <TinyConsole.h>
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
#include <TinyStreaming.h>
#include <sstream>
#include <string>
#include <map>
using string = TinyConsole::string;
bool echo_on = true;
auto green = TinyConsole::green;
auto red = TinyConsole::red;
auto white = TinyConsole::white;
auto cyan = TinyConsole::cyan;
auto yellow = TinyConsole::yellow;
auto magenta = TinyConsole::magenta;
auto save_cursor = TinyConsole::save_cursor;
auto restore_cursor = TinyConsole::restore_cursor;
auto erase_to_end = TinyConsole::erase_to_end;
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) {}
string url;
uint16_t port;
};
const std::map<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,
* even some stress tests.
*
* Upload the sketch, the use the terminal.
* Press H for mini help.
*
* tested with mqtt-spy-0.5.4
* TODO examples of scripts
*/
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--)
{
const char c=*payload++;
if (c<32)
Console << '?';
else
Console << c;
}
Console << ']' << endl;
}
}
std::map<string, MqttClient*> clients;
std::map<string, MqttBroker*> brokers;
std::map<string, string> vars;
void eval(string& cmd);
void replace(const char* d, string& str, string srch, string to)
{
if (d[0] && 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)
{
str.erase(pos, srch.length());
str.insert(pos, to);
pos += to.length()-1;
}
}
}
void replaceVars(string& cmd)
{
cmd = ' '+cmd+' ';
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);
}
void onCommand(const string& command)
{
Console << endl;
string cmd=command;
if (cmd.substr(0,3)!="set") replaceVars(cmd);
eval(cmd);
Console << endl;
Console.prompt();
}
void setup()
{
Serial.begin(115200);
Console.begin(Serial);
Console.setPrompt("> ");
Console.setCallback(onCommand);
delay(500);
Console.cls();
Console << endl << endl;
Console << yellow
<< "***************************************************************" << endl;
Console << "* Welcome to the TinyMqtt console" << endl;
Console << "* The console allows to test all features of the libraries." << endl;
Console << "* Enter help to view the list of commands." << endl;
Console << "***************************************************************" << endl;
Console << endl;
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 << "Connecting to '" << ssid << "' ";
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
WiFi.mode(WIFI_STA);
WiFi.begin(ssid, password);
while (WiFi.status() != WL_CONNECTED)
{ Console << '-'; delay(500); }
Console << endl << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
const char* name="tinytest";
Console << "Starting MDNS, name= " << name;
MqttBroker* broker = new MqttBroker(1883);
broker->begin();
brokers["broker"] = broker;
if (Console.isTerm()) onCommand("every 333 view");
}
string getword(string& str, const char* if_empty=nullptr, char sep=' ');
int getint(string& str, const int if_empty=0)
{
string str2=str;
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;
return ret;
}
str=str2;
return if_empty;
}
string getword(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))
{
if (str[0]==quote)
{
str.erase(0,1);
break;
}
sword += str[0];
str.erase(0,1);
}
while(str[0]==sep) str.erase(0,1);
if (if_empty and sword.length()==0) return if_empty;
if (quote==false and sword.length()>=4 and sword.substr(0,3)=="rnd")
{
sword.erase(0,3);
if (sword[0]=='(')
{
int to = 100;
sword.erase(0,1);
int from=getint(sword);
if (sword[0]==',')
{
sword.erase(0,1);
to = getint(sword);
if (sword[0]!=')') Console << "Missing ')'" << endl;
}
else
{
to=from;
from=0;
}
return String(random(from,to)).c_str();
}
else
{
Console << "Missing '('" << endl;
}
}
while(str[0]==' ') str.erase(0,1);
return sword;
}
bool isaddr(string s)
{
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=' ')
{
string addr=getword(str, if_empty, sep);
string ip=addr;
std::vector<string> build;
while(ip.length())
{
string b=getword(ip,nullptr,'.');
if (isaddr(b) && build.size()<4)
{
build.push_back(b);
}
else
return addr;
}
IPAddress local=WiFi.localIP();
addr.clear();
while(build.size()!=4)
{
std::stringstream b;
b << (int)local[3-build.size()];
build.insert(build.begin(), b.str().c_str());
}
for(string s: build)
{
if (addr.length()) addr += '.';
addr += s;
}
Console << "connect address: " << addr << endl;
return addr;
}
std::set<string> commands = {
"broker", "blink", "client", "connect",
"create", "delete", "debug", "help", "interval",
"list", "ls", "ip", "off", "on", "set",
"publish", "reset", "subscribe", "unsubscribe", "view", "echo", "every"
};
void convertToCommand(string& search)
{
while(search[0]==' ') search.erase(0,1);
if (search.length()==0) return;
string matches;
int count=0;
for(string cmd: commands)
{
if (cmd.substr(0, search.length()) == search)
{
if (count) matches +=", ";
count++;
matches += cmd;
}
}
if (count==1)
search = matches;
else if (count>1)
{
Console << "Ambiguous command: " << matches << endl;
search.clear();
}
}
bool compare(string s, const char* cmd)
{
uint8_t p=0;
while(s[p++]==*cmd++)
{
if (*cmd==0 or s[p]==0) return true;
if (s[p]==' ') return true;
}
return false;
}
using ClientFunction = void(*)(string& cmd, MqttClient* publish);
struct Every
{
string cmd;
uint32_t ms;
uint32_t next;
uint32_t underrun=0;
bool active=true;
void dump()
{
if (active)
Console << green << "enabled";
else
Console << red << "disabled";
auto mill=millis();
Console << white << ms << "ms [" << cmd << "] next in ";
if (mill > next)
Console << "now";
else
Console << next-mill << "ms";
}
};
uint32_t blink_ms_on[16];
uint32_t blink_ms_off[16];
uint32_t blink_next[16];
bool blink_state[16];
int16_t blink;
std::vector<Every> everies;
void clientConnect(MqttClient* client, string& cmd)
{
string remote = getword(cmd);
uint16_t port;
auto it=list.find(remote);
if (it != list.end())
{
Console << "Connecting to free broker: " << remote << endl;
remote = it->second.url;
port=it->second.port;
}
else
port=getint(cmd);
client->connect(remote.c_str(), port, getint(cmd, 60));
Console << (client->connected() ? "connected." : "not connected") << endl;
}
void eval(string& cmd)
{
while(cmd.length())
{
MqttError retval = MqttOk;
string s;
MqttBroker* broker = nullptr;
MqttClient* client = nullptr;
// client.function notation
if (cmd.find('.') != string::npos &&
cmd.find('.') < cmd.find(' '))
{
s=getword(cmd, nullptr, '.');
if (s.length())
{
if (clients.find(s) != clients.end())
{
client = clients[s];
}
else if (brokers.find(s) != brokers.end())
{
broker = brokers[s];
}
else
{
Console << red << "Unknown class (" << s.c_str() << ")" << white << endl;
cmd.clear();
}
}
}
s = getword(cmd);
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)
{
Console << " " << fb.first << " : " << fb.second.url << ":" << fb.second.port << endl;
}
}
else if (compare(s, "delete"))
{
if (client==nullptr && broker==nullptr)
{
s = getword(cmd);
if (clients.find(s) != clients.end())
{
client = clients[s];
}
else if (brokers.find(s) != brokers.end())
{
broker = brokers[s];
}
else
Console << red << "Unable to find (" << s.c_str() << ")" << white << endl;
}
if (client)
{
for (auto it: clients)
{
if (it.second != client) continue;
Console << "deleted" << endl;
delete (it.second);
clients.erase(it.first);
break;
}
cmd += " ls";
}
else if (broker)
{
for(auto it: brokers)
{
if (broker != it.second) continue;
Console << "deleted" << endl;
delete (it.second);
brokers.erase(it.first);
break;
}
cmd += " ls";
}
else
Console << "Nothing to delete" << endl;
}
else if (broker)
{
if (compare(s,"connect"))
{
Console << "NYI" << endl;
}
else if (compare(s, "view"))
{
broker->dump();
}
else
{
Console << "Unknown broker command (" << s << ")" << endl;
s.clear();
}
}
else if (client)
{
if (compare(s,"connect"))
{
clientConnect(client, cmd);
}
else if (compare(s,"publish"))
{
retval = client->publish(getword(cmd), getword(cmd));
}
else if (compare(s,"subscribe"))
{
client->subscribe(getword(cmd));
}
else if (compare(s, "unsubscribe"))
{
client->unsubscribe(getword(cmd));
}
else if (compare(s, "view"))
{
client->dump();
}
else
{
Console << "Unknown client command (" << s << ")" << endl;
s.clear();
}
}
else if (compare(s, "on"))
{
uint8_t pin=getint(cmd, 2);
pinMode(pin, OUTPUT);
digitalWrite(pin, HIGH);
}
else if (compare(s, "off"))
{
uint8_t pin=getint(cmd, 2);
pinMode(pin, OUTPUT);
digitalWrite(pin, LOW);
}
else if (compare(s, "echo"))
{
s=getword(cmd);
if (s=="on")
echo_on = true;
else if (s=="off")
echo_on = false;
else
{
Console << s << ' ';
while(cmd.length())
{
Console << getword(cmd) << ' ';
}
}
}
else if (compare(s, "every"))
{
uint32_t ms = getint(cmd, 0);
if (ms)
{
if (cmd.length())
{
Every every;
every.ms=ms;
every.cmd=cmd;
every.next=millis()+ms;
everies.push_back(every);
every.dump();
Console << endl;
cmd.clear();
}
}
else if (compare(cmd, "off") or compare(cmd, "on"))
{
bool active=getword(cmd)=="on";
uint8_t ever=getint(cmd, 100);
uint8_t count=0;
for(auto& every: everies)
{
if (count==ever or (ever==100))
{
if (every.active != active)
{
Console << "every #" << count << (active ? " on" :" off") << endl;
every.active = active;
every.underrun = 0;
}
}
count++;
}
}
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)
{
Console << count << ": ";
every.dump();
Console << endl;
count++;
}
}
else if (compare(cmd, "remove"))
{
Console << "Removing..." << endl;
getword(cmd);
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);
}
else if (every==-1 and compare(cmd, "all"))
{
getword(cmd);
everies.clear();
}
else if (everies.size() > (uint8_t)every)
{
everies.erase(everies.begin()+every);
}
else
Console << "Bad colmmand" << endl;
}
else
Console << "Bad command" << endl;
}
else if (compare(s, "blink"))
{
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]);
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;
else
{
blink &= ~(1<< blink_nr);
}
}
}
else if (compare(s, "broker"))
{
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())
{
int port=getint(cmd, 0);
if (port)
{
MqttBroker* broker = new MqttBroker(port);
broker->begin();
brokers[id] = broker;
Console << "new broker (" << id.c_str() << ")" << endl;
}
else
{
Console << "Missing port" << endl;
cmd.clear();
}
}
else
{
Console << "Missing or existing broker name (" << id.c_str() << ")" << endl;
cmd.clear();
}
}
else if (compare(s, "client"))
{
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())
{
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;
client->setCallback(onPublish);
if (list.find(s) != list.end())
{
cmd=s+' '+cmd;
clientConnect(client, cmd);
}
Console << "new client (" << id.c_str() << ", " << s.c_str() << ')' << endl;
}
else if (s.length())
{
Console << " not found." << endl;
cmd.clear();
}
}
else
{
Console << "Missing or existing client name" << endl;
cmd.clear();
}
}
else if (compare(s, "set"))
{
string name(getword(cmd));
if (name.length()==0)
{
for(auto it: vars)
{
Console << " " << it.first << " -> " << it.second << endl;
}
}
else if (commands.find(name) != commands.end())
{
Console << "Reserved keyword (" << name << ")" << endl;
cmd.clear();
}
else
{
if (cmd.length())
{
vars[name] = cmd;
cmd.clear();
}
else if (vars.find(name) != vars.end())
vars.erase(vars.find(name));
}
}
else if (compare(s, "ls") or compare(s, "view"))
{
bool view = compare(s, "view");
if (view)
{
Console << save_cursor << magenta;
Console.gotoxy(1,1);
}
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)
{
Console << " +-- '" << it.first.c_str() << "' " << it.second->clientsCount() << " client/s."<< erase_to_end << endl;
it.second->dump(" ");
}
if (view)
{
Console.bg(white);
Console << erase_to_end << restore_cursor;
}
}
else if (compare(s, "reset"))
ESP.restart();
else if (compare(s, "ip"))
Console << "IP: " << WiFi.localIP() << endl;
else if (compare(s,"help"))
{
Console << "syntax:" << endl;
Console << " MqttBroker:" << 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.view" << endl;
Console << " name.delete" << endl;
Console << endl;
Console << " list : list of free brokers (debug 1 advised)" << endl;
Console << " debug #" << endl;
Console << " list : get list of free brokers" << endl;
Console << " blink [Dx on_ms off_ms] : make pin blink" << endl;
Console << " ls / ip / reset" << endl;
Console << " set [name][value]" << endl;
Console << " ! repeat last command" << endl;
Console << endl;
Console << " echo [on|off] or strings" << endl;
Console << " every ms [command]; every list; every remove [nr|all]; every (on|off) [#]" << endl;
Console << " on {output}; off {output}" << endl;
Console << " $id : name of the client." << endl;
Console << " rnd[(min[,max])] random number." << endl;
Console << endl;
}
else
{
while(s[0]==' ') s.erase(0,1);
if (s.length())
Console << "Unknown command (" << s.c_str() << ")" << endl;
}
if (retval != MqttOk)
{
Console << "# MQTT ERROR " << retval << endl;
}
}
}
void loop()
{
auto ms=millis();
int8_t out=0;
int16_t blink_bits = blink;
uint8_t e=0;
for(auto& every: everies)
{
if (not every.active) continue;
if (every.ms && every.cmd.length() && ms > every.next)
{
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;
every.underrun = ms+5000;
}
}
e++;
}
while(blink_bits)
{
if (blink_ms_on[out] and ms > blink_next[out])
{
if (blink_state[out])
{
blink_next[out] += blink_ms_on[out];
digitalWrite(out, LOW);
}
else
{
blink_next[out] += blink_ms_off[out];
digitalWrite(abs(out), HIGH);
}
blink_state[out] = not blink_state[out];
}
blink_bits >>=1;
out++;
}
#if defined(ESP9266)
MDNS.update();
#endif
for(auto it: brokers)
it.second->loop();
for(auto it: clients)
it.second->loop();
Console.loop();
}

View File

@@ -1,7 +1,10 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this # See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS. # 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 APP_NAME := local-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole

View File

@@ -12,11 +12,10 @@
* Also, this will allow to mock and thus run Action on github * 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
const char* lastPayload; const char* lastPayload;
size_t lastLength; size_t lastLength;
@@ -29,89 +28,57 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
lastLength = length; 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) 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)
{
EpoxyTest::set_millis(0);
MqttBroker broker(1883); MqttBroker broker(1883);
MqttClient client(&broker, "client"); assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient sender(&broker, "sender"); {
broker.loop(); assertEqual(broker.localClientsCount(), (size_t)0); // Ensure client is not yet connected
MqttClient client(&broker);
client.subscribe("#"); assertEqual(broker.localClientsCount(), (size_t)1); // Ensure client is now connected
client.subscribe("test"); }
client.setCallback(onPublish); assertEqual(broker.localClientsCount(), (size_t)0);
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
} }
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) test(local_connect)
{ {
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient client(&broker); MqttClient client;
assertTrue(client.connected()); assertTrue(client.connected());
assertEqual(broker.clientsCount(), (size_t)1); assertEqual(broker.localClientsCount(), (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);
} }
test(local_publish_should_be_dispatched) test(local_publish_should_be_dispatched)
{ {
published.clear(); 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/b");
subscriber.subscribe("a/c"); subscriber.subscribe("a/c");
subscriber.setCallback(onPublish); subscriber.setCallback(onPublish);
MqttClient publisher(&broker); MqttClient publisher;
publisher.publish("a/b"); publisher.publish("a/b");
publisher.publish("a/c"); publisher.publish("a/c");
publisher.publish("a/c"); publisher.publish("a/c");
@@ -124,18 +91,18 @@ test(local_publish_should_be_dispatched)
test(local_publish_should_be_dispatched_to_local_clients) test(local_publish_should_be_dispatched_to_local_clients)
{ {
published.clear(); 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.setCallback(onPublish);
subscriber_a.subscribe("a/b"); subscriber_a.subscribe("a/b");
subscriber_a.subscribe("a/c"); subscriber_a.subscribe("a/c");
MqttClient subscriber_b(&broker, "B"); MqttClient subscriber_b("B");
subscriber_b.setCallback(onPublish); subscriber_b.setCallback(onPublish);
subscriber_b.subscribe("a/b"); subscriber_b.subscribe("a/b");
MqttClient publisher(&broker); MqttClient publisher;
publisher.publish("a/b"); publisher.publish("a/b");
publisher.publish("a/c"); publisher.publish("a/c");
@@ -149,13 +116,13 @@ test(local_publish_should_be_dispatched_to_local_clients)
test(local_unsubscribe) test(local_unsubscribe)
{ {
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.localClientsCount(), (size_t)0);
MqttClient subscriber(&broker, ""); MqttClient subscriber;
subscriber.setCallback(onPublish); subscriber.setCallback(onPublish);
subscriber.subscribe("a/b"); subscriber.subscribe("a/b");
MqttClient publisher(&broker); MqttClient publisher;
publisher.publish("a/b"); publisher.publish("a/b");
subscriber.unsubscribe("a/b"); subscriber.unsubscribe("a/b");
@@ -169,11 +136,11 @@ test(local_unsubscribe)
test(local_nocallback_when_destroyed) test(local_nocallback_when_destroyed)
{ {
published.clear(); 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.setCallback(onPublish);
subscriber.subscribe("a/b"); subscriber.subscribe("a/b");
publisher.publish("a/b"); publisher.publish("a/b");
@@ -183,6 +150,7 @@ test(local_nocallback_when_destroyed)
assertEqual(published.size(), (size_t)1); // Only one publish has been received assertEqual(published.size(), (size_t)1); // Only one publish has been received
} }
#endif
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
// setup() and loop() // setup() and loop()

View File

@@ -1,10 +1,10 @@
# See https://github.com/bxparks/EpoxyDuino for documentation about this # See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS. # 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>) # 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 APP_NAME := network-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole 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 * 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 // 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) std::string bufferToHexa(const uint8_t* buffer, size_t length, char sep = 0, size_t ascii_pos = 0)
{ {
@@ -80,7 +78,7 @@ String toString(const IPAddress& ip)
MqttBroker broker(1883); 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; char* lastPayload = nullptr;
size_t lastLength; size_t lastLength;
@@ -144,6 +142,55 @@ test(suback)
assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1); assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
} }
uint32_t getClientKeepAlive(MqttBroker& broker)
{
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();
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(broker_ip.toString().c_str(), 1883, keep_alive);
broker.loop();
client.loop();
assertTrue(broker.clientsCount() == 1);
assertTrue(client.connected());
uint32_t ka = getClientKeepAlive(broker);
assertEqual(ka, keep_alive);
assertEqual(broker.clientsCount(), (size_t)1);
// 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 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);
set_real_time();
}
test(network_client_keep_alive_high) test(network_client_keep_alive_high)
{ {
const uint32_t keep_alive=1000; const uint32_t keep_alive=1000;
@@ -174,9 +221,8 @@ test(network_client_keep_alive_high)
uint32_t sz = broker.getClients().size(); uint32_t sz = broker.getClients().size();
assertEqual(sz , (uint32_t)1); assertEqual(sz , (uint32_t)1);
uint32_t ka = broker.getClients()[0]->keepAlive(); uint32_t ka = getClientKeepAlive(broker);
assertEqual(ka, keep_alive); assertEqual(ka, keep_alive);
} }
test(network_client_to_broker_connexion) test(network_client_to_broker_connexion)
@@ -406,20 +452,6 @@ test(network_hudge_payload)
assertEqual(strcmp(payload, lastPayload), 0); 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) test(connack)
{ {
const bool view = false; const bool view = false;
@@ -479,5 +511,4 @@ void loop() {
aunit::TestRunner::run(); aunit::TestRunner::run();
if (Serial.available()) ESP.reset(); 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 # See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS. # 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 APP_NAME := nowifi-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole 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 * Checks with a local broker. Clients must connect to the local broker
**/ **/
using string = TinyConsole::string; using namespace std;
MqttBroker broker(1883); 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; char* lastPayload = nullptr;
size_t lastLength; size_t lastLength;
@@ -279,5 +279,4 @@ void loop() {
aunit::TestRunner::run(); aunit::TestRunner::run();
if (Serial.available()) ESP.reset(); 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 # See https://github.com/bxparks/EpoxyDuino for documentation about this
# Makefile to compile and run Arduino programs natively on Linux or MacOS. # Makefile to compile and run Arduino programs natively on Linux or MacOS.
include ../Makefile.opts EXTRA_CXXFLAGS=-g3 -O0
APP_NAME := string-indexer-tests APP_NAME := string-indexer-tests
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync TinyConsole 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) test(indexer_empty)
{ {
@@ -84,7 +84,7 @@ test(indexer_indexed_operator_eq)
test(indexer_get_string) test(indexer_get_string)
{ {
string sone("one"); std::string sone("one");
IndexedString one(sone); IndexedString one(sone);
assertTrue(sone==one.str()); assertTrue(sone==one.str());

View File

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

View File

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