Compare commits

...

53 Commits

Author SHA1 Message Date
hsaturn
5d07294fde Merge branch 'main' into timeout 2023-03-23 13:46:02 +01:00
hsaturn
088071d17f [readme] Words about retain 2023-03-23 13:44:48 +01:00
Francois BIOT
e41452edf0 [fixes] Timeout and broker to broker modifications 2023-03-23 13:42:09 +01:00
hsaturn
f8a2e35dd9 [readme] Words about retain 2023-03-22 20:37:28 +01:00
hsaturn
43dbea1f17 [test] Fix payload bug in test + moved huge paylod from network to here 2023-03-22 20:31:41 +01:00
hsaturn
02496bef73 [test] Test added for retain 2023-03-22 20:31:05 +01:00
hsaturn
e4ad27c805 [MqttClient] Added connect(IPAddress) 2023-03-22 20:29:52 +01:00
hsaturn
37fb46ec3b [TinyMqtt.cpp] Removed obsolete comment 2023-03-22 20:29:25 +01:00
hsaturn
245e74666e [examples] Little modification for RETAIN 2023-03-22 20:28:58 +01:00
hsaturn
294657f2ca [bump_version] Added a commit message for bump version 2023-03-22 09:43:04 +01:00
Francois BIOT
bf84e29831 retain is coming git status! 2023-03-22 00:29:55 +01:00
Francois BIOT
0c7c830a26 Release 0.9.19 2023-03-11 18:51:08 +01:00
hsaturn
6e601228e6 Added compatibility with me-no-dev/ESPAsyncTCP@^1.2.2 2023-03-11 18:49:51 +01:00
hsaturn
46798ff0de Fix bug with Async Tcp 2023-03-11 18:47:41 +01:00
Francois BIOT
45fedf84c9 tinymqtt-tests.ino fix bad color after underrun 2023-02-24 00:18:34 +01:00
Francois BIOT
f9c8dca1e5 tinymqtt-tests fix prompt bug 2023-02-23 23:56:22 +01:00
Francois BIOT
7e1586c0b5 platformio, make tiny-tests example compilation ok 2023-02-23 23:08:30 +01:00
hsaturn
123c5a8fa5 Release 0.9.18 2023-02-23 20:43:27 +01:00
hsaturn
21fb01848d Release 0.9.17 2023-02-23 20:42:26 +01:00
hsaturn
66b1e71ee2 Fix depends 2023-02-23 20:36:10 +01:00
hsaturn
e5115087ea Release 0.9.16 2023-02-23 20:15:38 +01:00
hsaturn
cc004875b5 Release 0.9.16 2023-02-23 20:12:49 +01:00
Francois BIOT
58ae2436d3 Release 0.9.15 2023-02-23 19:41:47 +01:00
Francois BIOT
cda94368a7 Change bump version script 2023-02-23 19:37:11 +01:00
Francois BIOT
0126a39327 Release 0.9.14 2023-02-23 19:36:51 +01:00
Francois BIOT
2587371457 Minor typo changes and add comments 2023-02-23 19:24:27 +01:00
hsaturn
a880a1ff2f Minor updates 2023-02-23 19:22:40 +01:00
hsaturn
143d57db2d Re-enabled lot of local unit tests 2023-02-22 07:40:12 +01:00
hsaturn
2a8dbd09c5 Memory deletion fixes 2023-02-20 05:24:35 +01:00
Francois BIOT
00333ed805 [TinyMqtt] Fix obsolete warning 2023-02-20 03:22:50 +01:00
hsaturn
9228408f57 [tests] Added -Wall and use TinyConsole::string 2023-02-20 02:39:43 +01:00
hsaturn
1653b2e386 [tests] Added a compilation test (based on example tiny-tests) 2023-02-20 02:28:22 +01:00
Francois BIOT
775fbc14ee [tests] Use TinyConsole::string instead of any 2023-02-20 02:24:39 +01:00
hsaturn
c21b7b63fb [tests] Removed warning and using namespace std 2023-02-20 02:21:33 +01:00
hsaturn
e45af112c2 Update README.md 2023-02-19 09:16:35 +01:00
hsaturn
f9c539ff6a Added TinyConsole aunit test and dependency 2023-02-19 09:16:10 +01:00
hsaturn
7dc23d322c TinyString moved to TinyConsole 2023-02-19 08:38:11 +01:00
Francois BIOT
4fb632ce3d [TinyString] change size_t to be more tolerant with signed ints 2023-02-19 06:04:54 +01:00
hsaturn
c9130c7a24 [TinyString] Added size_t, added find(char) 2023-02-19 05:21:55 +01:00
hsaturn
31c51aeaff [aunit] Use my git repo instead of bxpark's 2023-02-15 07:57:25 +01:00
hsaturn
2eeda4ecab [makefiles] Added missing Makefile.opt 2023-02-15 05:39:17 +01:00
hsaturn
787cb77a26 String indexer std::string removed 2023-02-15 05:37:23 +01:00
hsaturn
d324a913ec Merge pull request #59 from richievos/clearer-version-error
More informative error on version mismatch
2023-02-13 09:00:39 +01:00
Richie Vos
ac1eedd72a More informative error on version mismatch
I spent a lot of time debugging my arduino, trying to figure out why my
calls were all failing. Turned out to be due to the mqtt cli using v5, while
this library only supports v4. By mqtt cli I mean the [hivemq one](https://hivemq.github.io/mqtt-cli/),
which is the first one that shows up on google searches.

Being new to mqtt this burned me for awhile, so I'm hoping this helps the next
person. Both by having this PR show up if they search, and making the error
more informative.
2023-02-12 21:37:17 -08:00
hsaturn
0900e799a9 Update README.md 2023-02-02 03:15:57 +01:00
hsaturn
2086c7f0e7 Added auint test to unit tests array 2023-02-02 03:14:25 +01:00
hsaturn
72382bf351 Added missing dependency to bxparks AceRoutine 2023-02-02 03:02:03 +01:00
hsaturn
3fec7b87a8 Unit tests of dependencies projects added 2023-02-02 02:21:59 +01:00
hsaturn
8641627742 Re-added flto in makefile 2023-01-15 16:04:16 +01:00
hsaturn
3b2460572b Fix unit tests 2023-01-14 14:26:30 +01:00
hsaturn
a0435b2cfb Release 0.9.12 unit test build upgrade 2023-01-03 04:33:47 +01:00
hsaturn
bda041417d Release 0.9.12 2023-01-03 04:32:14 +01:00
hsaturn
baffda8a6d MqttClient - fix local disconnect after pulish + ka 2023-01-03 04:25:26 +01:00
29 changed files with 1738 additions and 403 deletions

View File

@@ -9,7 +9,7 @@ on: [push]
jobs: jobs:
build: build:
runs-on: ubuntu-18.04 runs-on: ubuntu-20.04
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@@ -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/bxparks/EpoxyDuino git clone https://github.com/hsaturn/EpoxyDuino
git clone https://github.com/bxparks/AceRoutine git clone https://github.com/bxparks/AceRoutine
git clone https://github.com/bxparks/AUnit git clone https://github.com/hsaturn/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,8 +10,22 @@
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
- Supports retained messages (not activated by default)
- Async Wifi compatible (me-no-dev/ESPAsyncTCP@^1.2.2)
- Very fast broker I saw it re-sent 1000 topics per second for two - 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)
@@ -51,6 +65,13 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
- tinymqtt-test : This is a complex sketch with a terminal console - tinymqtt-test : This is a complex sketch with a terminal console
that allows to add clients publish, connect etc with interpreted commands. that allows to add clients publish, connect etc with interpreted commands.
## Retained messages
Qos 1 is not supported, but retained messages are. So a new subscription is able to send old messages.
This feature is disabled by default.
The default retain parameter of MqttBroker::MqttBroker takes an optional (0 by default) number of retained messages.
MqttBroker::retain(n) will also make the broker store n messages at max.
## Standalone mode (zeroconf) ## Standalone mode (zeroconf)
-> The zeroconf mode is not yet implemented -> The zeroconf mode is not yet implemented
zeroconf clients to connect to broker on local network. zeroconf clients to connect to broker on local network.

61
bump_version.sh Executable file
View File

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

View File

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

View File

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

View File

@@ -26,23 +26,25 @@ 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 = ""; const char *ssid = "Freebox-786A2F";
const char* password = ""; const char *password = "usurpavi8dalum64lumine?";
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) {}
std::string url; string url;
uint16_t port; uint16_t port;
}; };
const std::map<std::string, free_broker> list = const std::map<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,
@@ -73,8 +75,8 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
} }
} }
std::map<std::string, MqttClient*> clients; std::map<string, MqttClient *> clients;
std::map<std::string, MqttBroker*> brokers; std::map<string, MqttBroker *> brokers;
void setup() void setup()
{ {
@@ -86,7 +88,8 @@ void setup()
delay(500); delay(500);
Console.cls(); Console.cls();
Console << endl << endl; Console << endl
<< endl;
Console << yellow Console << yellow
<< "***************************************************************" << endl; << "***************************************************************" << endl;
Console << "* Welcome to the TinyMqtt console" << endl; Console << "* Welcome to the TinyMqtt console" << endl;
@@ -97,7 +100,8 @@ 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 << white; Console << endl
<< white;
Console << "Connecting to '" << ssid << "' "; Console << "Connecting to '" << ssid << "' ";
@@ -107,9 +111,13 @@ 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 << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl; Console << endl
<< "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
const char *name = "tinytest"; const char *name = "tinytest";
Console << "Starting MDNS, name= " << name; Console << "Starting MDNS, name= " << name;
@@ -118,36 +126,41 @@ 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()) onCommand("every 333 view"); if (Console.isTerm())
onCommand("every 333 view");
Console.prompt();
} }
std::string getword(std::string& str, const char* if_empty=nullptr, char sep=' '); string getword(string &str, const char *if_empty = nullptr, char sep = ' ');
int getint(std::string& str, const int if_empty=0) int getint(string &str, const int if_empty = 0)
{ {
std::string str2=str; string str2 = str;
std::string sword = getword(str); 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]==' ') sword.erase(0,1); while (isdigit(sword[0]) or sword[0] == ' ')
if (sword.length()) str = sword+' '+str; sword.erase(0, 1);
if (sword.length())
str = sword + ' ' + str;
return ret; return ret;
} }
str = str2; str = str2;
return if_empty; return if_empty;
} }
std::string getword(std::string& str, const char* if_empty/*=nullptr*/, char sep/*=' '*/) string getword(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) str.erase(0,1); if (quote)
std::string sword; str.erase(0, 1);
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)
@@ -158,8 +171,10 @@ std::string getword(std::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) str.erase(0,1); while (str[0] == sep)
if (if_empty and sword.length()==0) return if_empty; 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") if (quote == false and sword.length() >= 4 and sword.substr(0, 3) == "rnd")
{ {
sword.erase(0, 3); sword.erase(0, 3);
@@ -172,7 +187,8 @@ std::string getword(std::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]!=')') Console << "Missing ')'" << endl; if (sword[0] != ')')
Console << "Missing ')'" << endl;
} }
else else
{ {
@@ -186,26 +202,29 @@ std::string getword(std::string& str, const char* if_empty/*=nullptr*/, char sep
Console << "Missing '('" << endl; Console << "Missing '('" << endl;
} }
} }
while(str[0]==' ') str.erase(0,1); while (str[0] == ' ')
str.erase(0, 1);
return sword; return sword;
} }
bool isaddr(std::string s) bool isaddr(string s)
{ {
if (s.length()==0 or s.length()>3) return false; if (s.length() == 0 or s.length() > 3)
return false;
for (char c : s) for (char c : s)
if (c<'0' or c>'9') return false; if (c < '0' or c > '9')
return false;
return true; return true;
} }
std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ') string getip(string &str, const char *if_empty = nullptr, char sep = ' ')
{ {
std::string addr=getword(str, if_empty, sep); string addr = getword(str, if_empty, sep);
std::string ip=addr; string ip = addr;
std::vector<std::string> build; std::vector<string> build;
while (ip.length()) while (ip.length())
{ {
std::string b=getword(ip,nullptr,'.'); 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);
@@ -219,37 +238,40 @@ std::string getip(std::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()); build.insert(build.begin(), b.str().c_str());
} }
for(std::string s: build) for (string s : build)
{ {
if (addr.length()) addr += '.'; if (addr.length())
addr += '.';
addr += s; addr += s;
} }
Console << "connect address: " << addr << endl; Console << "connect address: " << addr << endl;
return addr; return addr;
} }
std::map<std::string, std::string> vars; std::map<string, string> vars;
std::set<std::string> commands = { std::set<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(std::string& search) void convertToCommand(string &search)
{ {
while(search[0]==' ') search.erase(0,1); while (search[0] == ' ')
if (search.length()==0) return; search.erase(0, 1);
std::string matches; if (search.length() == 0)
return;
string matches;
int count = 0; int count = 0;
for(std::string cmd: commands) for (string cmd : commands)
{ {
if (cmd.substr(0, search.length()) == search) if (cmd.substr(0, search.length()) == search)
{ {
if (count) matches +=", "; if (count)
matches += ", ";
count++; count++;
matches += cmd; matches += cmd;
} }
@@ -263,7 +285,7 @@ void convertToCommand(std::string& search)
} }
} }
void replace(const char* d, std::string& str, std::string srch, std::string to) void replace(const char *d, string &str, string srch, string to)
{ {
if (d[0] && d[1]) if (d[0] && d[1])
{ {
@@ -271,7 +293,7 @@ void replace(const char* d, std::string& str, std::string srch, std::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)) != std::string::npos) while ((pos = str.find(srch, pos)) != string::npos)
{ {
str.erase(pos, srch.length()); str.erase(pos, srch.length());
str.insert(pos, to); str.insert(pos, to);
@@ -280,7 +302,7 @@ void replace(const char* d, std::string& str, std::string srch, std::string to)
} }
} }
void replaceVars(std::string& cmd) void replaceVars(string &cmd)
{ {
cmd = ' ' + cmd + ' '; cmd = ' ' + cmd + ' ';
@@ -291,27 +313,28 @@ void replaceVars(std::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(std::string s, const char* cmd) bool compare(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) return true; if (*cmd == 0 or s[p] == 0)
if (s[p]==' ') return true; return true;
if (s[p] == ' ')
return true;
} }
return false; return false;
} }
using ClientFunction = void(*)(std::string& cmd, MqttClient* publish); using ClientFunction = void (*)(string &cmd, MqttClient *publish);
struct Every struct Every
{ {
std::string cmd; string cmd;
uint32_t ms; uint32_t ms;
uint32_t next; uint32_t next;
uint32_t underrun = 0; uint32_t underrun = 0;
@@ -341,19 +364,19 @@ int16_t blink;
std::vector<Every> everies; std::vector<Every> everies;
void onCommand(const std::string& command) void onCommand(const string &command)
{ {
Console << endl; Console << endl;
std::string cmd=command; string cmd = command;
if (cmd.substr(0,3)!="set") replaceVars(cmd); if (cmd.substr(0, 3) != "set")
replaceVars(cmd);
eval(cmd); eval(cmd);
Console << endl; Console << endl;
Console.prompt();
} }
void clientConnect(MqttClient* client, std::string& cmd) void clientConnect(MqttClient *client, string &cmd)
{ {
std::string remote = getword(cmd); 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())
@@ -369,18 +392,18 @@ void clientConnect(MqttClient* client, std::string& cmd)
Console << (client->connected() ? "connected." : "not connected") << endl; Console << (client->connected() ? "connected." : "not connected") << endl;
} }
void eval(std::string& cmd) void eval(string &cmd)
{ {
while (cmd.length()) while (cmd.length())
{ {
MqttError retval = MqttOk; MqttError retval = MqttOk;
std::string s; string s;
MqttBroker *broker = nullptr; MqttBroker *broker = nullptr;
MqttClient *client = nullptr; MqttClient *client = nullptr;
// client.function notation // client.function notation
if (cmd.find('.') != std::string::npos && if (cmd.find('.') != string::npos &&
cmd.find('.') < cmd.find(' ')) cmd.find('.') < cmd.find(' '))
{ {
s = getword(cmd, nullptr, '.'); s = getword(cmd, nullptr, '.');
@@ -404,9 +427,11 @@ void eval(std::string& cmd)
} }
s = getword(cmd); s = getword(cmd);
if (s.length()) convertToCommand(s); if (s.length())
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
@@ -443,7 +468,8 @@ void eval(std::string& cmd)
{ {
for (auto it : clients) for (auto it : clients)
{ {
if (it.second != client) continue; if (it.second != client)
continue;
Console << "deleted" << endl; Console << "deleted" << endl;
delete (it.second); delete (it.second);
clients.erase(it.first); clients.erase(it.first);
@@ -455,7 +481,8 @@ void eval(std::string& cmd)
{ {
for (auto it : brokers) for (auto it : brokers)
{ {
if (broker != it.second) continue; if (broker != it.second)
continue;
Console << "deleted" << endl; Console << "deleted" << endl;
delete (it.second); delete (it.second);
brokers.erase(it.first); brokers.erase(it.first);
@@ -632,7 +659,7 @@ void eval(std::string& cmd)
} }
else if (compare(s, "broker")) else if (compare(s, "broker"))
{ {
std::string id=getword(cmd); 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;
@@ -663,7 +690,7 @@ void eval(std::string& cmd)
} }
else if (compare(s, "client")) else if (compare(s, "client"))
{ {
std::string id=getword(cmd); 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;
@@ -675,7 +702,8 @@ void eval(std::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()) broker = brokers[s]; if (s.length())
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);
@@ -700,7 +728,7 @@ void eval(std::string& cmd)
} }
else if (compare(s, "set")) else if (compare(s, "set"))
{ {
std::string name(getword(cmd)); string name(getword(cmd));
if (name.length() == 0) if (name.length() == 0)
{ {
for (auto it : vars) for (auto it : vars)
@@ -788,7 +816,8 @@ void eval(std::string& cmd)
} }
else else
{ {
while(s[0]==' ') s.erase(0,1); while (s[0] == ' ')
s.erase(0, 1);
if (s.length()) if (s.length())
Console << "Unknown command (" << s.c_str() << ")" << endl; Console << "Unknown command (" << s.c_str() << ")" << endl;
} }
@@ -809,16 +838,18 @@ void loop()
for (auto &every : everies) for (auto &every : everies)
{ {
if (not every.active) continue; if (not every.active)
continue;
if (every.ms && every.cmd.length() && ms > every.next) if (every.ms && every.cmd.length() && ms > every.next)
{ {
std::string cmd(every.cmd); 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;
} }
} }
@@ -845,7 +876,6 @@ void loop()
out++; out++;
} }
static long count;
#if defined(ESP9266) #if defined(ESP9266)
MDNS.update(); MDNS.update();
#endif #endif

20
library.json Normal file
View File

@@ -0,0 +1,20 @@
{
"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"
]
}

20
library.json.skeleton Normal file
View File

@@ -0,0 +1,20 @@
{
"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.11 version=0.9.19
author=Francois BIOT, HSaturn, <hsaturn@gmail.com> author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com> maintainer=Francois BIOT <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 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. 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).
category=Communication category=Communication
url=https://github.com/hsaturn/TinyMqtt url=https://github.com/hsaturn/TinyMqtt
architectures=* architectures=*
depends=TinyConsole depends=hsaturn/TinyConsole
includes=TinyMqtt.h includes=TinyMqtt.h

View File

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

View File

@@ -1,18 +1,25 @@
// 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
{ {
std::string str; string str;
uint8_t used=0; uint8_t used=0;
friend class StringIndexer; friend class StringIndexer;
@@ -29,9 +36,9 @@ class StringIndexer
public: public:
using index_t = uint8_t; using index_t = uint8_t;
static const std::string& str(const index_t& index) static const string& str(const index_t& index)
{ {
static std::string dummy; static 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;
@@ -77,7 +84,7 @@ class StringIndexer
{ {
if (strings.find(index)==strings.end()) if (strings.find(index)==strings.end())
{ {
strings[index].str = std::string(str, len); strings[index].str = 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;
@@ -86,7 +93,9 @@ class StringIndexer
return 0; // TODO out of indexes return 0; // TODO out of indexes
} }
static std::map<index_t, StringCounter> strings; using Strings = std::unordered_map<index_t, StringCounter>;
static Strings strings;
}; };
class IndexedString class IndexedString
@@ -98,12 +107,14 @@ 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 std::string& str) : IndexedString(str.c_str(), str.length()) {}; IndexedString(const string& str) : IndexedString(str.c_str(), str.length()) {};
~IndexedString() { StringIndexer::release(index); } ~IndexedString() { StringIndexer::release(index); }
@@ -124,7 +135,7 @@ class IndexedString
return i1.index == i2.index; return i1.index == i2.index;
} }
const std::string& str() const { return StringIndexer::str(index); } const 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,8 +15,10 @@ 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) MqttBroker::MqttBroker(uint16_t port, uint8_t max_retain_size)
{ {
debug("New broker" << port);
retain_size = max_retain_size;
server = new TcpServer(port); server = new TcpServer(port);
#ifdef TINY_MQTT_ASYNC #ifdef TINY_MQTT_ASYNC
server->onClient(onClient, this); server->onClient(onClient, this);
@@ -27,7 +29,14 @@ MqttBroker::~MqttBroker()
{ {
while(clients.size()) while(clients.size())
{ {
delete clients[0]; 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; delete server;
} }
@@ -52,9 +61,12 @@ MqttClient::MqttClient(MqttBroker* local_broker, TcpClient* new_client)
#endif #endif
} }
MqttClient::MqttClient(MqttBroker* local_broker, const std::string& id) MqttClient::MqttClient(MqttBroker* local_broker, const string& id)
: local_broker(local_broker), clientId(id) : local_broker(local_broker), clientId(id)
{ {
alive = 0;
keep_alive = 0;
if (local_broker) local_broker->addClient(this); if (local_broker) local_broker->addClient(this);
} }
@@ -68,7 +80,7 @@ MqttClient::~MqttClient()
void MqttClient::close(bool bSendDisconnect) void MqttClient::close(bool bSendDisconnect)
{ {
debug("close " << id().c_str()); debug("close " << id().c_str());
mqtt_connected = false; resetFlag(CltFlagConnected);
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())
@@ -92,9 +104,10 @@ void MqttClient::connect(MqttBroker* local)
debug("MqttClient::connect_local"); debug("MqttClient::connect_local");
close(); close();
local_broker = local; local_broker = local;
local_broker->addClient(this);
} }
void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka) void MqttClient::connect(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;
@@ -105,7 +118,7 @@ void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
#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, ka); tcp_client->connect(broker.c_str(), port);
#else #else
if (tcp_client->connect(broker.c_str(), port)) if (tcp_client->connect(broker.c_str(), port))
{ {
@@ -125,12 +138,13 @@ void MqttBroker::addClient(MqttClient* client)
clients.push_back(client); clients.push_back(client);
} }
void MqttBroker::connect(const std::string& host, uint16_t port) void MqttBroker::connect(const 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)
@@ -160,14 +174,16 @@ 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);
broker->addClient(new MqttClient(broker, client)); MqttClient* mqtt = new MqttClient(broker, 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->available(); WiFiClient client = server->accept();
if (client) if (client)
{ {
@@ -198,9 +214,19 @@ void MqttBroker::loop()
} }
} }
MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos) // Obvioulsy called when the broker is connected to another broker.
MqttError MqttBroker::subscribe(MqttClient* client, const Topic& topic, uint8_t qos)
{ {
debug("MqttBroker::subscribe"); debug("MqttBroker::subscribe to " << topic.str() << ", retained=" << retained.size() );
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);
@@ -208,10 +234,12 @@ MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
return MqttNowhereToSend; return MqttNowhereToSend;
} }
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg)
{ {
MqttError retval = MqttOk; MqttError retval = MqttOk;
retain(topic, msg);
debug("MqttBroker::publish"); debug("MqttBroker::publish");
int i=0; int i=0;
for(auto client: clients) for(auto client: clients)
@@ -281,25 +309,26 @@ void MqttClient::clientAlive(uint32_t more_seconds)
void MqttClient::loop() void MqttClient::loop()
{ {
if (alive && (millis() > alive)) if (keep_alive && (millis() >= alive - 5000))
{ {
if (local_broker) if (tcp_client && tcp_client->connected())
{
debug(red << "timeout client");
close();
debug(red << "closed");
}
else if (tcp_client && tcp_client->connected())
{ {
debug("pingreq"); debug("pingreq");
uint16_t pingreq = MqttMessage::Type::PingReq; static MqttMessage pingreq(MqttMessage::Type::PingReq);
tcp_client->write((const char*)(&pingreq), 2); pingreq.sendTo(this);
clientAlive(0); clientAlive(0);
// 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)
{ {
@@ -378,13 +407,13 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
subscriptions.insert(topic); subscriptions.insert(topic);
if (local_broker==nullptr) // remote broker if (local_broker==nullptr) // connected to a remote broker
{ {
return sendTopic(topic, MqttMessage::Type::Subscribe, qos); return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
} }
else else
{ {
return local_broker->subscribe(topic, qos); return local_broker->subscribe(this, topic, qos);
} }
return ret; return ret;
} }
@@ -437,7 +466,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
switch(mesg->type()) switch(mesg->type())
{ {
case MqttMessage::Type::Connect: case MqttMessage::Type::Connect:
if (mqtt_connected) if (mqtt_connected())
{ {
debug("already connected"); debug("already connected");
break; break;
@@ -452,13 +481,13 @@ void MqttClient::processMessage(MqttMessage* mesg)
} }
if (header[6]!=0x04) if (header[6]!=0x04)
{ {
debug("unknown level"); debug("Unsupported MQTT version (" << (int) header[6] << "), only version=4 supported" << endl);
break; // Level 3.1.1 break; // Level 3.1.1
} }
// ClientId // ClientId
mesg->getString(payload, len); mesg->getString(payload, len);
clientId = std::string(payload, len); clientId = string(payload, len);
payload += len; payload += len;
if (mqtt_flags & FlagWill) // Will topic if (mqtt_flags & FlagWill) // Will topic
@@ -487,7 +516,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
Console << yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white << endl; Console << yellow << "Client " << clientId << " connected : keep alive=" << keep_alive << '.' << white << endl;
#endif #endif
bclose = false; bclose = false;
mqtt_connected=true; setFlag(CltFlagConnected);
{ {
MqttMessage msg(MqttMessage::Type::ConnAck); MqttMessage msg(MqttMessage::Type::ConnAck);
msg.add(0); // Session present (not implemented) msg.add(0); // Session present (not implemented)
@@ -497,14 +526,14 @@ void MqttClient::processMessage(MqttMessage* mesg)
break; break;
case MqttMessage::Type::ConnAck: case MqttMessage::Type::ConnAck:
mqtt_connected = true; setFlag(CltFlagConnected);
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 (!mqtt_connected) break; if (not mqtt_connected()) break;
// Ignore acks // Ignore acks
bclose = false; bclose = false;
break; break;
@@ -515,7 +544,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
break; break;
case MqttMessage::Type::PingReq: case MqttMessage::Type::PingReq:
if (!mqtt_connected) break; if (not mqtt_connected()) break;
if (tcp_client) if (tcp_client)
{ {
uint16_t pingreq = MqttMessage::Type::PingResp; uint16_t pingreq = MqttMessage::Type::PingResp;
@@ -532,15 +561,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
case MqttMessage::Type::Subscribe: case MqttMessage::Type::Subscribe:
case MqttMessage::Type::UnSubscribe: case MqttMessage::Type::UnSubscribe:
{ {
if (!mqtt_connected) break; if (not mqtt_connected()) break;
payload = header+2; payload = header+2;
debug("un/subscribe loop"); debug("un/subscribe loop");
std::string qoss; string qoss;
while(payload < mesg->end()) while(payload < mesg->end())
{ {
mesg->getString(payload, len); // Topic mesg->getString(payload, len); // Topic
debug( " topic (" << std::string(payload, len) << ')'); debug( " topic (" << string(payload, len) << ')');
// subscribe(Topic(payload, len)); // subscribe(Topic(payload, len));
Topic topic(payload, len); Topic topic(payload, len);
@@ -555,7 +584,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
} }
else else
qoss.push_back(qos); qoss.push_back(qos);
subscriptions.insert(topic); subscribe(topic);
} }
else else
{ {
@@ -576,15 +605,15 @@ void MqttClient::processMessage(MqttMessage* mesg)
break; break;
case MqttMessage::Type::UnSuback: case MqttMessage::Type::UnSuback:
if (!mqtt_connected) break; if (not mqtt_connected()) break;
bclose = false; bclose = false;
break; break;
case MqttMessage::Type::Publish: case MqttMessage::Type::Publish:
#if TINY_MQTT_DEBUG #if TINY_MQTT_DEBUG
Console << "publish " << mqtt_connected << '/' << (long) tcp_client << endl; Console << "publish " << mqtt_connected() << '/' << (long) tcp_client << endl;
#endif #endif
if (mqtt_connected or tcp_client == nullptr) if (mqtt_connected() or tcp_client == nullptr)
{ {
uint8_t qos = mesg->flags(); uint8_t qos = mesg->flags();
payload = header; payload = header;
@@ -594,7 +623,7 @@ void MqttClient::processMessage(MqttMessage* mesg)
#if TINY_MQTT_DEBUG #if TINY_MQTT_DEBUG
Console << "Received Publish (" << published.str().c_str() << ") size=" << (int)len << endl; Console << "Received Publish (" << published.str().c_str() << ") size=" << (int)len << endl;
#endif #endif
// << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl; // << '(' << 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
@@ -605,13 +634,13 @@ 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.\n"; Console << (isSubscribedTo(published) ? "not" : "") << " subscribed.\r\n";
Console << "has " << (callback ? "" : "no ") << " callback.\n"; Console << "has " << (callback ? "" : "no ") << " callback.\r\n";
} }
#endif #endif
if (callback and isSubscribedTo(published)) if (callback and isSubscribedTo(published))
{ {
callback(this, published, payload, len); // TODO send the real payload callback(this, published, payload, len);
} }
} }
else if (local_broker) // from outside to inside else if (local_broker) // from outside to inside
@@ -625,8 +654,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 (!mqtt_connected) break; if (not mqtt_connected()) break;
mqtt_connected = false; resetFlag(CltFlagConnected);
close(false); close(false);
bclose=false; bclose=false;
break; break;
@@ -715,9 +744,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) MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pay_length, bool retain)
{ {
MqttMessage msg(MqttMessage::Publish); MqttMessage msg(MqttMessage::Publish, retain ? 1 : 0);
msg.add(topic); msg.add(topic);
msg.add(payload, pay_length, false); msg.add(payload, pay_length, false);
msg.complete(); msg.complete();
@@ -881,12 +910,41 @@ 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, std::string> tts={ static std::map<Type, string> tts={
{ Connect, "Connect" }, { Connect, "Connect" },
{ ConnAck, "Connack" }, { ConnAck, "Connack" },
{ Publish, "Publish" }, { Publish, "Publish" },
@@ -899,7 +957,7 @@ void MqttMessage::hexdump(const char* prefix) const
{ PingResp, "Pingresp" }, { PingResp, "Pingresp" },
{ Disconnect, "Disconnect" } { Disconnect, "Disconnect" }
}; };
std::string t("Unknown"); 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];
@@ -916,7 +974,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 = " - ";
std::string ascii; string ascii;
Console << prefix << " size(" << buffer.size() << "), state=" << state << endl; Console << prefix << " size(" << buffer.size() << "), state=" << state << endl;

View File

@@ -68,12 +68,15 @@ 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 std::string s) : Topic(s.c_str(), s.length()){}; // Topic(const 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(); }
@@ -118,11 +121,14 @@ 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; } MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= (bits_d3_d0 & 0xF); }
MqttMessage(const MqttMessage& m)
: buffer(m.buffer), vheader(m.vheader), size(m.size), state(m.state) {}
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 std::string& s) { add(s.c_str(), s.length()); } void add(const 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]; }
@@ -153,10 +159,19 @@ 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();
std::string buffer; 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;
@@ -175,19 +190,28 @@ class MqttClient
FlagCleanSession = 2, // unsupported FlagCleanSession = 2, // unsupported
FlagReserved = 1 FlagReserved = 1
}; };
enum __attribute__((packed)) CltFlags
{
CltFlagNone = 0,
CltFlagConnected = 1,
CltFlagToDelete = 2
};
public: public:
using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length); using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length);
/** 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 std::string& id = TINY_MQTT_DEFAULT_CLIENT_ID); MqttClient(MqttBroker* broker = nullptr, const string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
MqttClient(const std::string& id) : MqttClient(nullptr, id){} MqttClient(const string& id) : MqttClient(nullptr, id){}
~MqttClient(); ~MqttClient();
void connect(MqttBroker* local_broker); void connect(MqttBroker* local_broker);
void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10); void connect(string broker, uint16_t port, uint16_t keep_alive = 10);
void connect(const IPAddress& ip, uint16_t port, uint16_t keep_alive = 10)
{ connect(ip.toString().c_str(), port, keep_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
@@ -202,8 +226,8 @@ class MqttClient
if (tcp_client) tcp_client->write(buf, length); if (tcp_client) tcp_client->write(buf, length);
} }
const std::string& id() const { return clientId; } const string& id() const { return clientId; }
void id(const std::string& new_id) { clientId = new_id; } void id(const string& new_id) { clientId = new_id; }
/** Should be called in main loop() */ /** Should be called in main loop() */
void loop(); void loop();
@@ -218,11 +242,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); MqttError publish(const Topic&, const char* payload, size_t pay_length, bool retain=false);
MqttError publish(const Topic& t, const char* payload) { return publish(t, payload, strlen(payload)); } MqttError publish(const Topic& t, const char* payload, bool retain=false) { return publish(t, payload, strlen(payload), retain); }
MqttError publish(const Topic& t, const String& s) { 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, const string& s, bool retain=false) { return publish(t,s.c_str(),s.length(), retain);}
MqttError publish(const Topic& t) { return publish(t, nullptr, 0);}; MqttError publish(const Topic& t, bool retain=false) { return publish(t, nullptr, 0, retain);};
MqttError subscribe(Topic topic, uint8_t qos=0); MqttError subscribe(Topic topic, uint8_t qos=0);
MqttError unsubscribe(Topic topic); MqttError unsubscribe(Topic topic);
@@ -232,7 +256,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(std::string indent="") void dump(string indent="")
{ {
(void)indent; (void)indent;
#if TINY_MQTT_DEBUG #if TINY_MQTT_DEBUG
@@ -269,6 +293,9 @@ 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*);
@@ -286,7 +313,7 @@ class MqttClient
void clientAlive(uint32_t more_seconds); void clientAlive(uint32_t more_seconds);
void processMessage(MqttMessage* message); void processMessage(MqttMessage* message);
bool mqtt_connected = false; uint8_t cltFlags = CltFlagNone;
char mqtt_flags; char mqtt_flags;
uint32_t keep_alive = 30; uint32_t keep_alive = 30;
uint32_t alive; uint32_t alive;
@@ -298,32 +325,29 @@ class MqttClient
TcpClient* tcp_client=nullptr; // connection to remote broker TcpClient* tcp_client=nullptr; // connection to remote broker
std::set<Topic> subscriptions; std::set<Topic> subscriptions;
std::string clientId; 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); MqttBroker(uint16_t port, uint8_t retain_size=0);
~MqttBroker(); ~MqttBroker();
void begin() { server->begin(); } void begin() { server->begin(); }
void loop(); void loop();
void connect(const std::string& host, uint16_t port=1883); /** Connect the broker to a parent broker */
bool connected() const { return state == Connected; } void connect(const string& host, uint16_t port=1883);
/** returns true if connected to another broker */
bool connected() const { return remote_broker ? remote_broker->connected() : false; }
size_t clientsCount() const { return clients.size(); } size_t clientsCount() const { return clients.size(); }
void retain(uint8_t size) { retain_size = size; }
void dump(std::string indent="") void dump(string indent="")
{ {
for(auto client: clients) for(auto client: clients)
client->dump(indent); client->dump(indent);
@@ -341,10 +365,9 @@ 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 publish(const MqttClient* source, const Topic& topic, MqttMessage& msg) const; MqttError subscribe(MqttClient*, const Topic& topic, uint8_t qos);
MqttError subscribe(const Topic& topic, uint8_t qos);
// For clients that are added not by the broker itself (local clients) // For clients that are added not by the broker itself (local clients)
void addClient(MqttClient* client); void addClient(MqttClient* client);
@@ -360,5 +383,25 @@ class MqttBroker
const char* auth_password = "guest"; const char* auth_password = "guest";
MqttClient* remote_broker = nullptr; MqttClient* remote_broker = nullptr;
State state = Disconnected; void retain(const Topic& topic, const MqttMessage& msg);
void retainDrop();
struct Retain
{
Retain(unsigned long ts, const MqttMessage& m) : timestamp(ts), msg(m) {}
Retain(Retain&& r) : timestamp(r.timestamp), msg(std::move(r.msg)) {}
Retain& operator=(Retain&& r)
{
timestamp = r.timestamp;
msg = std::move(r.msg);
return *this;
}
unsigned long timestamp;
MqttMessage msg;
};
std::map<Topic, Retain> retained;
uint8_t retain_size;
}; };

View File

@@ -1,28 +1,40 @@
SUB=
all:runtests
tests: tests:
set -e; \ @set -e; \
for i in *-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: debugtest runtests:
$(MAKE) clean @set -e; \
$(MAKE) tests $(MAKE) tests; \
set -e; \ for i in $(SUB)*-tests/Makefile; do \
for i in *-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 *-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

11
tests/Makefile.opts Normal file
View File

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

View File

@@ -3,9 +3,6 @@
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,9 +17,10 @@ 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 */)
{ {
Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl; (void) topic;
// Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
messages[name_]++; messages[name_]++;
} }
@@ -35,7 +36,8 @@ 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)
{ {
Serial << "--> unrouted: " << topic.c_str() << endl; (void) topic;
// Serial << "--> unrouted: " << topic.c_str() << endl;
unrouted++; unrouted++;
} }
@@ -338,7 +340,7 @@ void setup() {
while(!Serial); while(!Serial);
*/ */
Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS ]========================"); Serial.println("=============[ TinyMqtt class-bind TESTS ]========================");
WiFi.mode(WIFI_STA); WiFi.mode(WIFI_STA);
WiFi.begin("network", "password"); WiFi.begin("network", "password");

View File

@@ -0,0 +1,11 @@
# 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

@@ -0,0 +1,848 @@
// 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,10 +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.
EXTRA_CXXFLAGS=-g3 -O0 include ../Makefile.opts
# 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,23 +12,32 @@
* 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 namespace std; using string = TinyConsole::string;
MqttBroker broker(1883); MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
const char* lastPayload; std::string lastPayload;
size_t lastLength; size_t lastLength;
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length) void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
{ {
if (srce) if (srce)
published[srce->id()][topic]++; published[srce->id()][topic]++;
lastPayload = payload; lastPayload = std::string(payload, length);
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);
@@ -40,27 +49,70 @@ test(local_client_should_unregister_when_destroyed)
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
} }
#if 0 test(local_client_do_not_disconnect_after_publishing_and_long_inactivity)
{
published.clear();
EpoxyTest::set_millis(0);
MqttBroker broker(1883);
MqttClient client(&broker, "client");
MqttClient sender(&broker, "sender");
broker.loop();
client.subscribe("#");
client.subscribe("test");
client.setCallback(onPublish);
assertEqual(broker.clientsCount(), (size_t)2);
sender.publish("test", "value");
broker.loop();
EpoxyTest::add_seconds(600);
client.loop();
sender.loop();
broker.loop();
sender.publish("test", "value");
broker.loop();
sender.loop();
broker.loop();
assertEqual(broker.clientsCount(), (size_t)2);
assertEqual(sender.connected(), true);
assertEqual(client.connected(), true);
assertEqual(published.size(), (size_t)1); // client has received something
}
test(local_connect) test(local_connect)
{ {
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
MqttClient client; MqttClient client(&broker);
assertTrue(client.connected()); assertTrue(client.connected());
assertEqual(broker.clientsCount(), (size_t)1); assertEqual(broker.clientsCount(), (size_t)1);
} }
test(local_publish_to_nowhere)
{
published.clear();
assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher;
MqttError status = publisher.publish("a/b");
assertEqual(status, MqttError::MqttNowhereToSend);
}
test(local_publish_should_be_dispatched) test(local_publish_should_be_dispatched)
{ {
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber; MqttClient subscriber(&broker, "");
subscriber.subscribe("a/b"); subscriber.subscribe("a/b");
subscriber.subscribe("a/c"); subscriber.subscribe("a/c");
subscriber.setCallback(onPublish); subscriber.setCallback(onPublish);
MqttClient publisher; MqttClient publisher(&broker);
publisher.publish("a/b"); publisher.publish("a/b");
publisher.publish("a/c"); publisher.publish("a/c");
publisher.publish("a/c"); publisher.publish("a/c");
@@ -70,21 +122,40 @@ test(local_publish_should_be_dispatched)
assertEqual(published[""]["a/c"], 2); assertEqual(published[""]["a/c"], 2);
} }
test(hudge_payload)
{
published.clear();
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
MqttClient subscriber(&broker);
assertEqual(broker.clientsCount(), (size_t)1);
subscriber.setCallback(onPublish);
subscriber.subscribe("a/b"); // Note -> this does not send any byte .... (nowhere to send)
MqttClient publisher(&broker);
publisher.publish("a/b", payload); // This publish is received
// onPublish should have filled lastPayload and lastLength
assertEqual(payload, lastPayload.c_str());
assertEqual(lastLength, strlen(payload));
assertEqual(strncmp(payload, lastPayload.c_str(), lastLength), 0);
}
test(local_publish_should_be_dispatched_to_local_clients) test(local_publish_should_be_dispatched_to_local_clients)
{ {
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber_a("A"); MqttClient subscriber_a(&broker, "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("B"); MqttClient subscriber_b(&broker, "B");
subscriber_b.setCallback(onPublish); subscriber_b.setCallback(onPublish);
subscriber_b.subscribe("a/b"); subscriber_b.subscribe("a/b");
MqttClient publisher; MqttClient publisher(&broker);
publisher.publish("a/b"); publisher.publish("a/b");
publisher.publish("a/c"); publisher.publish("a/c");
@@ -100,11 +171,11 @@ test(local_unsubscribe)
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
MqttClient subscriber; MqttClient subscriber(&broker, "");
subscriber.setCallback(onPublish); subscriber.setCallback(onPublish);
subscriber.subscribe("a/b"); subscriber.subscribe("a/b");
MqttClient publisher; MqttClient publisher(&broker);
publisher.publish("a/b"); publisher.publish("a/b");
subscriber.unsubscribe("a/b"); subscriber.unsubscribe("a/b");
@@ -120,9 +191,9 @@ test(local_nocallback_when_destroyed)
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
MqttClient publisher; MqttClient publisher(&broker);
{ {
MqttClient subscriber; MqttClient subscriber(&broker);
subscriber.setCallback(onPublish); subscriber.setCallback(onPublish);
subscriber.subscribe("a/b"); subscriber.subscribe("a/b");
publisher.publish("a/b"); publisher.publish("a/b");
@@ -132,7 +203,6 @@ 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.
EXTRA_CXXFLAGS=-g3 -O0 include ../Makefile.opts
# 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,6 +16,8 @@
* 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)
{ {
@@ -78,12 +80,12 @@ String toString(const IPAddress& ip)
MqttBroker broker(1883); MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
char* lastPayload = nullptr; char* lastPayload = nullptr;
size_t lastLength; size_t lastLength;
void start_servers(int n, bool early_accept = true) void start_many_wifi_esp(int n, bool early_accept = true)
{ {
ESP8266WiFiClass::resetInstances(); ESP8266WiFiClass::resetInstances();
ESP8266WiFiClass::earlyAccept = early_accept; ESP8266WiFiClass::earlyAccept = early_accept;
@@ -105,7 +107,7 @@ void onPublish(const MqttClient* srce, const Topic& topic, const char* payload,
lastLength = length; lastLength = length;
} }
test(network_single_broker_begin) test(single_broker_begin)
{ {
assertEqual(WiFi.status(), WL_CONNECTED); assertEqual(WiFi.status(), WL_CONNECTED);
@@ -117,7 +119,7 @@ test(network_single_broker_begin)
test(suback) test(suback)
{ {
start_servers(2, true); start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED); assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883); MqttBroker broker(1883);
@@ -142,10 +144,10 @@ test(suback)
assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1); assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
} }
test(network_client_keep_alive_high) test(client_keep_alive_high)
{ {
const uint32_t keep_alive=1000; const uint32_t keep_alive=1000;
start_servers(2, true); start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED); assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883); MqttBroker broker(1883);
@@ -177,9 +179,116 @@ test(network_client_keep_alive_high)
} }
test(network_client_to_broker_connexion) test(retained_message)
{ {
start_servers(2, true); published.clear();
start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
broker.retain(10);
IPAddress broker_ip = WiFi.localIP();
MqttClient local_client(&broker);
// Send a retained message
// No remote client connected
local_client.publish("topic", "retained", true);
for(int i=0; i<2; i++)
{
broker.loop();
local_client.loop();
};
// No connect a client from 2nd Esp
ESP8266WiFiClass::selectInstance(2);
MqttClient remote_client;
remote_client.connect(broker_ip, 1883);
remote_client.setCallback(onPublish);
assertTrue(remote_client.connected());
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 2);
// Should not have received anything yet
assertEqual(published.size(), (size_t)0);
// Now, remote client subscribes to topic
remote_client.subscribe("topic");
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
// Check that the retained message is published
assertEqual(published.size(), (size_t)1);
// FIXME we should check that
// 1 - Retained message has the retain flag set
// 2 - Published retained messages that are send normally have their retain flag off
// The next part of this test does not pass yet (due to remote_client.close()
// that does not work well.
return;
// Now remove the retained message
remote_client.close();
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertFalse(remote_client.connected());
assertEqual(broker.clientsCount(), (size_t) 1);
// Disconnect / reconnect the remote clien that should receive again the message
remote_client.connect(broker_ip, 1883);
remote_client.subscribe("topic");
assertTrue(remote_client.connected());
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 2);
assertEqual(published.size(), (size_t)2);
// Remove the retained message now
local_client.publish("topic", "", true);
assertEqual(published.size(), (size_t)1);
// And reconnect the remote client
remote_client.connect(broker_ip, 1883);
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 2);
// check that the message was received
assertEqual(published.size(), (size_t)2);
}
test(remote_client_disconnect_reconnect)
{
published.clear();
start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883);
broker.begin();
IPAddress broker_ip = WiFi.localIP();
ESP8266WiFiClass::selectInstance(2);
MqttClient client;
client.connect(broker_ip, 1883);
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 1);
// Disconnect the client
client.close();
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 0);
// Reconnect the client
client.connect(broker_ip, 1883);
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
assertEqual(broker.clientsCount(), (size_t) 1);
}
test(client_to_broker_connexion)
{
start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED); assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883); MqttBroker broker(1883);
@@ -195,9 +304,9 @@ test(network_client_to_broker_connexion)
assertTrue(client.connected()); assertTrue(client.connected());
} }
test(network_one_client_one_broker_publish_and_subscribe_through_network) test(one_client_one_broker_publish_and_subscribe)
{ {
start_servers(2, true); start_many_wifi_esp(2, true);
published.clear(); published.clear();
assertEqual(WiFi.status(), WL_CONNECTED); assertEqual(WiFi.status(), WL_CONNECTED);
@@ -226,9 +335,9 @@ test(network_one_client_one_broker_publish_and_subscribe_through_network)
assertEqual((int)lastLength, (int)2); // sizeof(ab) assertEqual((int)lastLength, (int)2); // sizeof(ab)
} }
test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network) test(one_client_one_broker_hudge_payload)
{ {
start_servers(2, true); start_many_wifi_esp(2, true);
published.clear(); published.clear();
assertEqual(WiFi.status(), WL_CONNECTED); assertEqual(WiFi.status(), WL_CONNECTED);
@@ -245,8 +354,8 @@ test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
std::string sent; std::string sent;
for(int i=0; i<200; i++) for(int i=0; i<400; i++)
sent += char('0'+i%10); sent += char('a'+i%26);
client.setCallback(onPublish); client.setCallback(onPublish);
client.subscribe("a/b"); client.subscribe("a/b");
@@ -262,7 +371,7 @@ test(network_one_client_one_broker_hudge_publish_and_subscribe_through_network)
assertEqual((unsigned int)lastLength, (unsigned int)sent.size()); assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
} }
test(network_client_should_unregister_when_destroyed) test(client_should_unregister_when_destroyed)
{ {
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
{ {
@@ -276,7 +385,7 @@ test(network_client_should_unregister_when_destroyed)
// THESE TESTS ARE IN LOCAL MODE // THESE TESTS ARE IN LOCAL MODE
// WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link) // WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link)
test(network_connect) test(connect)
{ {
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
@@ -285,7 +394,7 @@ test(network_connect)
assertEqual(broker.clientsCount(), (size_t)1); assertEqual(broker.clientsCount(), (size_t)1);
} }
test(network_publish_should_be_dispatched) test(publish_should_be_dispatched)
{ {
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
@@ -305,7 +414,7 @@ test(network_publish_should_be_dispatched)
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/c"], 2); assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/c"], 2);
} }
test(network_publish_should_be_dispatched_to_clients) test(publish_should_be_dispatched_to_clients)
{ {
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
@@ -330,7 +439,7 @@ test(network_publish_should_be_dispatched_to_clients)
assertEqual(published["B"]["a/c"], 0); assertEqual(published["B"]["a/c"], 0);
} }
test(network_unsubscribe) test(unsubscribe)
{ {
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
@@ -350,7 +459,7 @@ test(network_unsubscribe)
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1); // Only one publish has been received assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1); // Only one publish has been received
} }
test(network_nocallback_when_destroyed) test(nocallback_when_destroyed)
{ {
published.clear(); published.clear();
assertEqual(broker.clientsCount(), (size_t)0); assertEqual(broker.clientsCount(), (size_t)0);
@@ -369,7 +478,7 @@ test(network_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
} }
test(network_small_payload) test(small_payload)
{ {
published.clear(); published.clear();
@@ -387,7 +496,7 @@ test(network_small_payload)
assertEqual(lastLength, (size_t)4); assertEqual(lastLength, (size_t)4);
} }
test(network_hudge_payload) test(hudge_payload)
{ {
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !"; const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
@@ -404,6 +513,20 @@ 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;
@@ -420,7 +543,7 @@ test(connack)
} }
); );
start_servers(2, true); start_many_wifi_esp(2, true);
assertEqual(WiFi.status(), WL_CONNECTED); assertEqual(WiFi.status(), WL_CONNECTED);
MqttBroker broker(1883); MqttBroker broker(1883);
@@ -453,7 +576,7 @@ void setup() {
while(!Serial); while(!Serial);
*/ */
Serial.println("=============[ FAKE NETWORK TinyMqtt TESTS ]========================"); Serial.println("=============[ NETWORK TinyMqtt TESTS ]========================");
WiFi.mode(WIFI_STA); WiFi.mode(WIFI_STA);
WiFi.begin("network", "password"); WiFi.begin("network", "password");
@@ -463,4 +586,5 @@ 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,10 +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.
EXTRA_CXXFLAGS=-g3 -O0 include ../Makefile.opts
# 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 namespace std; using string = TinyConsole::string;
MqttBroker broker(1883); MqttBroker broker(1883);
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count std::map<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,4 +279,5 @@ 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.
EXTRA_CXXFLAGS=-g3 -O0 include ../Makefile.opts
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 namespace std; using string = TinyConsole::string;
test(indexer_empty) test(indexer_empty)
{ {
@@ -84,7 +84,7 @@ test(indexer_indexed_operator_eq)
test(indexer_get_string) test(indexer_get_string)
{ {
std::string sone("one"); 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.
EXTRA_CXXFLAGS=-g3 -O0 include ../Makefile.opts
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,26 +5,22 @@
#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));
cout << " " << ta.c_str() << ' '; std::cout << " " << ta.c_str() << ' ';
if (match != expected) if (match != expected)
cout << (expected ? " should match " : " should not match "); std::cout << (expected ? " should match " : " should not match ");
else else
cout << (expected ? " matches " : " unmatches "); std::cout << (expected ? " matches " : " unmatches ");
cout << tb.c_str() << endl; std::cout << tb.c_str() << std::endl;
return expected == match; return expected == match;
} }