Compare commits
39 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6fcfc9dfc0 | ||
|
|
a6596ffc89 | ||
|
|
533ab0c70d | ||
|
|
792a28e831 | ||
|
|
9407193454 | ||
|
|
602050f309 | ||
|
|
1a70c90af2 | ||
|
|
ed4091c53e | ||
|
|
f2a805f724 | ||
|
|
3083bcf071 | ||
|
|
d01f46dbc1 | ||
|
|
39b2257619 | ||
|
|
60d385189b | ||
|
|
3f2c1c57e1 | ||
|
|
e550197d0a | ||
|
|
253bc9b3f5 | ||
|
|
96d8018960 | ||
|
|
505cacc2df | ||
|
|
62848056a2 | ||
|
|
01998e74ec | ||
|
|
5f46fd304c | ||
|
|
213d637eaf | ||
|
|
3bb2dd5a81 | ||
|
|
7d9ab6381d | ||
|
|
470cde62da | ||
|
|
3fb9b6317d | ||
|
|
ee9ad93bfd | ||
|
|
0b1a932244 | ||
|
|
972759237c | ||
|
|
cb00d7f82a | ||
|
|
0b735d22a5 | ||
|
|
9178aac02c | ||
|
|
c706fbcff2 | ||
|
|
a0c41a0ccb | ||
|
|
b780dcf99c | ||
|
|
f122d5e902 | ||
|
|
d63793cf77 | ||
|
|
8386779e92 | ||
|
|
1b988a06a2 |
28
.github/workflows/aunit.yml
vendored
Normal file
28
.github/workflows/aunit.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
# See https://docs.github.com/en/actions/guides for documentation about GitHub
|
||||
# Actions.
|
||||
|
||||
name: AUnit Tests
|
||||
|
||||
# Run on all branches.
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-18.04
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Setup
|
||||
run: |
|
||||
cd ..
|
||||
git clone https://github.com/bxparks/EpoxyDuino
|
||||
git clone https://github.com/bxparks/AceRoutine
|
||||
git clone https://github.com/bxparks/AUnit
|
||||
git clone https://github.com/bxparks/AceCommon
|
||||
git clone https://github.com/hsaturn/EspMock
|
||||
- name: Verify tests
|
||||
run: |
|
||||
make -C tests
|
||||
make -C tests runtests
|
||||
26
.github/workflows/superlinter.yml
vendored
Normal file
26
.github/workflows/superlinter.yml
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
name: Super-Linter
|
||||
|
||||
# Run this workflow every time a new commit pushed to your repository
|
||||
#
|
||||
on: push
|
||||
|
||||
jobs:
|
||||
# Set the job key. The key is displayed as the job name
|
||||
# when a job name is not provided
|
||||
super-lint:
|
||||
# Name the Job
|
||||
name: Lint code base
|
||||
# Set the type of machine to run on
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
# Checks out a copy of your repository on the ubuntu-latest machine
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
|
||||
# Runs the Super-Linter action
|
||||
- name: Run Super-Linter
|
||||
uses: github/super-linter@v3
|
||||
env:
|
||||
DEFAULT_BRANCH: main
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
22
README.md
22
README.md
@@ -1,15 +1,18 @@
|
||||
# TinyMqtt
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
ESP 8266 is a small and very capable Mqtt Broker and Client
|
||||
ESP 8266 is a small, fast and capable Mqtt Broker and Client
|
||||
|
||||
## Features
|
||||
|
||||
- Very (very !!) fast broker I saw it re-sent 1000 topics per second for two
|
||||
clients that had subscribed (payload ~15 bytes). No topic lost.
|
||||
The max I've seen was 2k msg/s (1 client 1 subscription)
|
||||
- Act as as a mqtt broker and/or a mqtt client
|
||||
- Mqtt 3.1.1 / Qos 0 supported
|
||||
- Standalone (can work without WiFi) (degraded/local mode)
|
||||
@@ -23,13 +26,16 @@ ESP 8266 is a small and very capable Mqtt Broker and Client
|
||||
* Implement zeroconf mode (needs async)
|
||||
* Add a max_clients in MqttBroker. Used with zeroconf, there will be
|
||||
no need for having tons of clients (also RAM is the problem with many clients)
|
||||
* Why not a 'global' TinyMqtt::loop() instead of having to call loop for all broker/clients instances
|
||||
* Test what is the real max number of clients for broker. As far as I saw, 1k is needed per client which would make more than 30 clients critical.
|
||||
* ~~MqttMessage uses a buffer 256 bytes which is usually far than needed.~~
|
||||
* ~~MqttClient does not support more than one subscription at time~~
|
||||
* MqttClient auto re-subscribe
|
||||
* ~~MqttClient auto re-subscribe (::resubscribe works bad on broker.emqx.io)~~
|
||||
* MqttClient auto reconnection
|
||||
* MqttClient does not callback payload...
|
||||
* ~~MqttClient unsubscribe~~
|
||||
* MqttClient does not sent payload to callback...
|
||||
* MqttClient user/password
|
||||
* Wildcards (I may implement only # as I'm not interrested by a clever and cpu consuming matching)
|
||||
|
||||
## Quickstart
|
||||
|
||||
|
||||
@@ -1,6 +1,15 @@
|
||||
// vim: ts=30
|
||||
// vim: ts=40
|
||||
Exemple of commands that can be sent via the serial monitor to tinymqtt-test
|
||||
----------------------------------------------------------------------------
|
||||
Commands can usually be abbreviated to their first letters.
|
||||
ex: cl for client, a / a.con / a.sub / a.p for publish.
|
||||
--------
|
||||
|
||||
set name value set variable name to value (later replaced)
|
||||
set name if no value, then var is erased
|
||||
set view all vars
|
||||
reserved keywords are forbidden
|
||||
|
||||
|
||||
client a starts a client (not connected no internal broker)
|
||||
a.connect [server][port][alive] connects the client, default port=1883
|
||||
@@ -8,4 +17,23 @@ a.publish topic [payload] send a topic with a payload
|
||||
a.subscribe topic subscribes to a topic
|
||||
delete a destroy the client
|
||||
|
||||
* note, if 'server' is a number, then it replaces the end of the local ip.
|
||||
i.e. if local ip is 192.168.1.10, connect 2.35 becomes 192.168.2.35
|
||||
|
||||
--------
|
||||
example:
|
||||
--------
|
||||
|
||||
client c
|
||||
c.connect broker.emqx.io
|
||||
set topic sensor/temperature
|
||||
|
||||
c.subscribe topic
|
||||
c.publish topic 15
|
||||
c.publish topic 20
|
||||
|
||||
macro exansion example
|
||||
----------------------
|
||||
|
||||
set temp publish sensor/temperature
|
||||
c.temp 20 -> c.publish sensor/temperature 20
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#define TINY_MQTT_DEBUG
|
||||
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
||||
#include <MqttStreaming.h>
|
||||
#include <sstream>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
@@ -15,11 +16,6 @@
|
||||
* cons - Takes more memory
|
||||
* - a bit hard to understand
|
||||
*
|
||||
* This sounds crazy: a mqtt mqtt that do not need a broker !
|
||||
* The use case arise when one ESP wants to publish topics and subscribe to them at the same time.
|
||||
* Without broker, the ESP won't react to its own topics.
|
||||
*
|
||||
* TinyMqtt mqtt allows this use case to work.
|
||||
*/
|
||||
|
||||
#include <my_credentials.h>
|
||||
@@ -27,18 +23,26 @@
|
||||
std::string topic="sensor/temperature";
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{ Serial << "--> " << srce->id().c_str() << ": ======> received " << topic.c_str() << endl; }
|
||||
{
|
||||
Serial << "--> " << srce->id().c_str() << ": ======> received " << topic.c_str();
|
||||
if (payload) Serial << ", payload[" << length << "]=[";
|
||||
while(length--)
|
||||
{
|
||||
const char c=*payload++;
|
||||
if (c!=10 and c!=13 and c <32) Serial << '?';
|
||||
Serial << *payload++;
|
||||
}
|
||||
Serial<< endl;
|
||||
}
|
||||
|
||||
std::map<std::string, MqttClient*> clients;
|
||||
std::map<std::string, MqttBroker*> brokers;
|
||||
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(115200);
|
||||
delay(500);
|
||||
Serial << endl << endl << endl
|
||||
<< "Demo started. Type help for more..." << endl
|
||||
<< "Connecting to '" << ssid << "' ";
|
||||
|
||||
WiFi.mode(WIFI_STA);
|
||||
@@ -48,6 +52,7 @@ void setup()
|
||||
{ Serial << '-'; delay(500); }
|
||||
|
||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||
Serial << "Type help for more..." << endl;
|
||||
|
||||
MqttBroker* broker = new MqttBroker(1883);
|
||||
broker->begin();
|
||||
@@ -78,6 +83,110 @@ std::string getword(std::string& str, const char* if_empty=nullptr, char sep=' '
|
||||
return sword;
|
||||
}
|
||||
|
||||
bool isaddr(std::string s)
|
||||
{
|
||||
if (s.length()==0 or s.length()>3) return false;
|
||||
for(char c: s)
|
||||
if (c<'0' or c>'9') return false;
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
|
||||
{
|
||||
std::string addr=getword(str, if_empty, sep);
|
||||
std::string ip=addr;
|
||||
std::vector<std::string> build;
|
||||
while(ip.length())
|
||||
{
|
||||
std::string b=getword(ip,nullptr,'.');
|
||||
if (isaddr(b) && build.size()<4)
|
||||
{
|
||||
build.push_back(b);
|
||||
}
|
||||
else
|
||||
return addr;
|
||||
}
|
||||
IPAddress local=WiFi.localIP();
|
||||
addr="";
|
||||
while(build.size()!=4)
|
||||
{
|
||||
std::stringstream b;
|
||||
b << (int)local[3-build.size()];
|
||||
build.insert(build.begin(), b.str());
|
||||
}
|
||||
for(std::string s: build)
|
||||
{
|
||||
if (addr.length()) addr += '.';
|
||||
addr += s;
|
||||
}
|
||||
return addr;
|
||||
}
|
||||
|
||||
std::map<std::string, std::string> vars;
|
||||
|
||||
std::set<std::string> commands = {
|
||||
"auto", "broker", "client", "connect",
|
||||
"create", "delete", "help", "interval",
|
||||
"ls", "ip", "off", "on", "set",
|
||||
"publish", "reset", "subscribe", "view"
|
||||
};
|
||||
|
||||
void getCommand(std::string& search)
|
||||
{
|
||||
while(search[0]==' ') search.erase(0,1);
|
||||
if (search.length()==0) return;
|
||||
std::string matches;
|
||||
int count=0;
|
||||
for(std::string cmd: commands)
|
||||
{
|
||||
if (cmd.substr(0, search.length()) == search)
|
||||
{
|
||||
if (count) matches +=", ";
|
||||
count++;
|
||||
matches += cmd;
|
||||
}
|
||||
}
|
||||
if (count==1)
|
||||
search = matches;
|
||||
else if (count>1)
|
||||
{
|
||||
Serial << "Ambiguous command: " << matches << endl;
|
||||
search="";
|
||||
}
|
||||
}
|
||||
|
||||
void replace(const char* d, std::string& str, std::string srch, std::string to)
|
||||
{
|
||||
if (d[0] && d[1])
|
||||
{
|
||||
srch=d[0]+srch+d[1];
|
||||
to=d[0]+to+d[1];
|
||||
|
||||
size_t pos = 0;
|
||||
while((pos=str.find(srch, pos)) != std::string::npos)
|
||||
{
|
||||
str.erase(pos, srch.length());
|
||||
str.insert(pos, to);
|
||||
pos += to.length();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void replaceVars(std::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);
|
||||
}
|
||||
|
||||
// publish at regular interval
|
||||
class automatic
|
||||
{
|
||||
@@ -180,6 +289,7 @@ class automatic
|
||||
{
|
||||
Serial << " auto [$id] on/off" << endl;
|
||||
Serial << " auto [$id] view" << endl;
|
||||
Serial << " auto [$id] interval [s]" << endl;
|
||||
Serial << " auto [$id] create [millis] [topic]" << endl;
|
||||
}
|
||||
|
||||
@@ -204,6 +314,12 @@ using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
|
||||
|
||||
void loop()
|
||||
{
|
||||
static long count;
|
||||
if (MqttClient::counter != count)
|
||||
{
|
||||
Serial << "# " << MqttClient::counter << endl;
|
||||
count = MqttClient::counter;
|
||||
}
|
||||
for(auto it: brokers)
|
||||
it.second->loop();
|
||||
|
||||
@@ -219,12 +335,15 @@ void loop()
|
||||
|
||||
if (c==10 or c==14)
|
||||
{
|
||||
|
||||
Serial << "----------------[ " << cmd.c_str() << " ]--------------" << endl;
|
||||
static std::string last_cmd;
|
||||
if (cmd=="!")
|
||||
cmd=last_cmd;
|
||||
else
|
||||
last_cmd=cmd;
|
||||
|
||||
if (cmd.substr(0,3)!="set") replaceVars(cmd);
|
||||
while(cmd.length())
|
||||
{
|
||||
MqttError retval = MqttOk;
|
||||
@@ -235,27 +354,34 @@ void loop()
|
||||
|
||||
// client.function notation
|
||||
// ("a.fun " becomes "fun a ")
|
||||
if (cmd.find('.') != std::string::npos)
|
||||
if (cmd.find('.') != std::string::npos &&
|
||||
cmd.find('.') < cmd.find(' '))
|
||||
{
|
||||
s=getword(cmd, nullptr, '.');
|
||||
|
||||
if (clients.find(s) != clients.end())
|
||||
if (s.length())
|
||||
{
|
||||
client = clients[s];
|
||||
}
|
||||
else if (brokers.find(s) != brokers.end())
|
||||
{
|
||||
broker = brokers[s];
|
||||
}
|
||||
else
|
||||
{
|
||||
Serial << "Unknown class (" << s.c_str() << ")" << endl;
|
||||
cmd="";
|
||||
if (clients.find(s) != clients.end())
|
||||
{
|
||||
client = clients[s];
|
||||
}
|
||||
else if (brokers.find(s) != brokers.end())
|
||||
{
|
||||
broker = brokers[s];
|
||||
}
|
||||
else
|
||||
{
|
||||
Serial << "Unknown class (" << s.c_str() << ")" << endl;
|
||||
cmd="";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
s = getword(cmd);
|
||||
if (compare(s, "delete"))
|
||||
if (s.length()) getCommand(s);
|
||||
if (s.length()==0)
|
||||
{}
|
||||
else if (compare(s, "delete"))
|
||||
{
|
||||
if (client==nullptr && broker==nullptr)
|
||||
{
|
||||
@@ -313,7 +439,7 @@ void loop()
|
||||
{
|
||||
if (compare(s,"connect"))
|
||||
{
|
||||
client->connect(getword(cmd,"192.168.1.40").c_str(), getint(cmd, 1883), getint(cmd, 60));
|
||||
client->connect(getip(cmd,"192.168.1.40").c_str(), getint(cmd, 1883), getint(cmd, 60));
|
||||
Serial << (client->connected() ? "connected." : "not connected") << endl;
|
||||
}
|
||||
else if (compare(s,"publish"))
|
||||
@@ -384,6 +510,32 @@ void loop()
|
||||
Serial << "Missing or existing client name" << endl;
|
||||
cmd+=" ls";
|
||||
}
|
||||
else if (compare(s, "set"))
|
||||
{
|
||||
std::string name(getword(cmd));
|
||||
if (name.length()==0)
|
||||
{
|
||||
for(auto it: vars)
|
||||
{
|
||||
Serial << " " << it.first << " -> " << it.second << endl;
|
||||
}
|
||||
}
|
||||
else if (commands.find(name) != commands.end())
|
||||
{
|
||||
Serial << "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"))
|
||||
{
|
||||
Serial << "--< " << clients.size() << " client/s. >--" << endl;
|
||||
@@ -421,6 +573,7 @@ void loop()
|
||||
Serial << endl;
|
||||
Serial << " help" << endl;
|
||||
Serial << " ls / ip / reset" << endl;
|
||||
Serial << " set [name][value]" << endl;
|
||||
Serial << " ! repeat last command" << endl;
|
||||
Serial << endl;
|
||||
Serial << " $id : name of the client." << endl;
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
"type": "git",
|
||||
"url": "https://github.com/hsaturn/TinyMqtt.git"
|
||||
},
|
||||
"version": "0.4.0",
|
||||
"version": "0.7.1",
|
||||
"exclude": "",
|
||||
"examples": "examples/*/*.ino",
|
||||
"frameworks": "arduino",
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name=TinyMqtt
|
||||
version=0.4.0
|
||||
version=0.7.1
|
||||
author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||
sentence=A tiny broker and client library for MQTT messaging.
|
||||
|
||||
@@ -104,7 +104,7 @@ class IndexedString
|
||||
|
||||
const std::string& str() const { return StringIndexer::str(index); }
|
||||
|
||||
const StringIndexer::index_t getIndex() const { return index; }
|
||||
const StringIndexer::index_t& getIndex() const { return index; }
|
||||
|
||||
private:
|
||||
StringIndexer::index_t index;
|
||||
|
||||
182
src/TinyMqtt.cpp
182
src/TinyMqtt.cpp
@@ -43,12 +43,17 @@ MqttClient::~MqttClient()
|
||||
delete client;
|
||||
}
|
||||
|
||||
void MqttClient::close()
|
||||
void MqttClient::close(bool bSendDisconnect)
|
||||
{
|
||||
debug("close " << id().c_str());
|
||||
mqtt_connected = false;
|
||||
if (client)
|
||||
{
|
||||
if (bSendDisconnect and client->connected())
|
||||
{
|
||||
message.create(MqttMessage::Type::Disconnect);
|
||||
message.sendTo(this);
|
||||
}
|
||||
client->stop();
|
||||
}
|
||||
|
||||
@@ -69,18 +74,18 @@ void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
|
||||
if (client->connect(broker.c_str(), port))
|
||||
{
|
||||
debug("cnx: connecting");
|
||||
message.create(MqttMessage::Type::Connect);
|
||||
message.add("MQTT",4);
|
||||
message.add(0x4); // Mqtt protocol version 3.1.1
|
||||
message.add(0x0); // Connect flags TODO user / name
|
||||
MqttMessage msg(MqttMessage::Type::Connect);
|
||||
msg.add("MQTT",4);
|
||||
msg.add(0x4); // Mqtt protocol version 3.1.1
|
||||
msg.add(0x0); // Connect flags TODO user / name
|
||||
|
||||
keep_alive = ka; // TODO not configurable
|
||||
message.add(0x00); // keep_alive
|
||||
message.add((char)keep_alive);
|
||||
message.add(clientId);
|
||||
keep_alive = ka;
|
||||
msg.add(0x00); // keep_alive
|
||||
msg.add((char)keep_alive);
|
||||
msg.add(clientId);
|
||||
debug("cnx: mqtt connecting");
|
||||
message.sendTo(this);
|
||||
message.reset();
|
||||
msg.sendTo(this);
|
||||
msg.reset();
|
||||
debug("cnx: mqtt sent " << (int32_t)parent);
|
||||
|
||||
clientAlive(0);
|
||||
@@ -120,7 +125,7 @@ void MqttBroker::loop()
|
||||
|
||||
// for(auto it=clients.begin(); it!=clients.end(); it++)
|
||||
// use index because size can change during the loop
|
||||
for(int i=0; i<clients.size(); i++)
|
||||
for(size_t i=0; i<clients.size(); i++)
|
||||
{
|
||||
auto client = clients[i];
|
||||
if (client->connected())
|
||||
@@ -146,8 +151,10 @@ MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, Mqtt
|
||||
for(auto client: clients)
|
||||
{
|
||||
i++;
|
||||
#if TINY_MQTT_DEBUG
|
||||
Serial << "brk_" << (broker && broker->connected() ? "con" : "dis") <<
|
||||
" srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
|
||||
#endif
|
||||
bool doit = false;
|
||||
if (broker && broker->connected()) // Broker is connected
|
||||
{
|
||||
@@ -166,7 +173,9 @@ MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, Mqtt
|
||||
// All is allowed
|
||||
doit = true;
|
||||
}
|
||||
#if TINY_MQTT_DEBUG
|
||||
Serial << ", doit=" << doit << ' ';
|
||||
#endif
|
||||
|
||||
if (doit) retval = client->publish(topic, msg);
|
||||
debug("");
|
||||
@@ -232,6 +241,26 @@ void MqttClient::loop()
|
||||
}
|
||||
}
|
||||
|
||||
void MqttClient::resubscribe()
|
||||
{
|
||||
// TODO resubscription limited to 256 bytes
|
||||
if (subscriptions.size())
|
||||
{
|
||||
MqttMessage msg(MqttMessage::Type::Subscribe, 2);
|
||||
|
||||
// TODO manage packet identifier
|
||||
msg.add(0);
|
||||
msg.add(0);
|
||||
|
||||
for(auto topic: subscriptions)
|
||||
{
|
||||
msg.add(topic);
|
||||
msg.add(0); // TODO qos
|
||||
}
|
||||
msg.sendTo(this); // TODO return value
|
||||
}
|
||||
}
|
||||
|
||||
MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
|
||||
{
|
||||
debug("subsribe(" << topic.c_str() << ")");
|
||||
@@ -239,33 +268,54 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
|
||||
|
||||
subscriptions.insert(topic);
|
||||
|
||||
if (parent==nullptr) // remote broker ?
|
||||
if (parent==nullptr) // remote broker
|
||||
{
|
||||
debug("remote subscribe");
|
||||
MqttMessage msg(MqttMessage::Type::Subscribe, 2);
|
||||
|
||||
// TODO manage packet identifier
|
||||
msg.add(0);
|
||||
msg.add(0);
|
||||
|
||||
msg.add(topic.str());
|
||||
msg.add(qos);
|
||||
ret = msg.sendTo(this);
|
||||
|
||||
// TODO we should wait (state machine) for SUBACK
|
||||
return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
MqttError MqttClient::unsubscribe(Topic topic)
|
||||
{
|
||||
auto it=subscriptions.find(topic);
|
||||
if (it != subscriptions.end())
|
||||
{
|
||||
subscriptions.erase(it);
|
||||
if (parent==nullptr) // remote broker
|
||||
{
|
||||
return sendTopic(topic, MqttMessage::Type::UnSubscribe, 0);
|
||||
}
|
||||
}
|
||||
return MqttOk;
|
||||
}
|
||||
|
||||
MqttError MqttClient::sendTopic(const Topic& topic, MqttMessage::Type type, uint8_t qos)
|
||||
{
|
||||
MqttMessage msg(type, 2);
|
||||
|
||||
// TODO manage packet identifier
|
||||
msg.add(0);
|
||||
msg.add(0);
|
||||
|
||||
msg.add(topic);
|
||||
msg.add(qos);
|
||||
|
||||
// TODO instead we should wait (state machine) for SUBACK / UNSUBACK ?
|
||||
return msg.sendTo(this);
|
||||
}
|
||||
|
||||
long MqttClient::counter=0;
|
||||
|
||||
void MqttClient::processMessage()
|
||||
{
|
||||
std::string error;
|
||||
std::string s;
|
||||
counter++;
|
||||
#if TINY_MQTT_DEBUG
|
||||
if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessage::Type::PingResp)
|
||||
{
|
||||
Serial << "---> INCOMING " << _HEX(message.type()) << " client(" << (int)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
|
||||
message.hexdump("Incoming");
|
||||
// message.hexdump("Incoming");
|
||||
}
|
||||
#endif
|
||||
auto header = message.getVHeader();
|
||||
const char* payload;
|
||||
uint16_t len;
|
||||
@@ -295,20 +345,6 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
|
||||
// ClientId
|
||||
message.getString(payload, len);
|
||||
debug("client id len=" << len);
|
||||
if (len>30)
|
||||
{
|
||||
Serial << '(';
|
||||
for(int i=0; i<30; i++)
|
||||
{
|
||||
if (i%5==0) Serial << ' ';
|
||||
char c=*(header+i);
|
||||
Serial << (c < 32 ? '.' : c);
|
||||
}
|
||||
Serial << " )" << endl;
|
||||
debug("Bad client id length");
|
||||
break;
|
||||
}
|
||||
clientId = std::string(payload, len);
|
||||
payload += len;
|
||||
|
||||
@@ -339,21 +375,22 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
Serial << "Connected client:" << clientId.c_str() << ", keep alive=" << keep_alive << '.' << endl;
|
||||
bclose = false;
|
||||
mqtt_connected=true;
|
||||
// Reuse received msg
|
||||
message.create(MqttMessage::Type::Connack);
|
||||
message.add(0); // Session present (not implemented)
|
||||
message.add(0); // Connection accepted
|
||||
message.sendTo(this);
|
||||
{
|
||||
MqttMessage msg(MqttMessage::Type::ConnAck);
|
||||
msg.add(0); // Session present (not implemented)
|
||||
msg.add(0); // Connection accepted
|
||||
msg.sendTo(this);
|
||||
}
|
||||
break;
|
||||
|
||||
case MqttMessage::Type::Connack:
|
||||
// TODO what more on connack ?
|
||||
case MqttMessage::Type::ConnAck:
|
||||
mqtt_connected = true;
|
||||
bclose = false;
|
||||
resubscribe();
|
||||
break;
|
||||
|
||||
case MqttMessage::Type::Suback:
|
||||
case MqttMessage::Type::Puback:
|
||||
case MqttMessage::Type::SubAck:
|
||||
case MqttMessage::Type::PubAck:
|
||||
if (!mqtt_connected) break;
|
||||
// Ignore acks
|
||||
bclose = false;
|
||||
@@ -379,6 +416,7 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
break;
|
||||
|
||||
case MqttMessage::Type::Subscribe:
|
||||
case MqttMessage::Type::UnSubscribe:
|
||||
{
|
||||
if (!mqtt_connected) break;
|
||||
payload = header+2;
|
||||
@@ -390,7 +428,15 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
debug( " topic (" << std::string(payload, len) << ')');
|
||||
outstring("Subscribes", payload, len);
|
||||
// subscribe(Topic(payload, len));
|
||||
subscriptions.insert(Topic(payload, len));
|
||||
Topic topic(payload, len);
|
||||
if ((message.type() & 0XF0) == MqttMessage::Type::Subscribe)
|
||||
subscriptions.insert(topic);
|
||||
else
|
||||
{
|
||||
auto it=subscriptions.find(topic);
|
||||
if (it != subscriptions.end())
|
||||
subscriptions.erase(it);
|
||||
}
|
||||
payload += len;
|
||||
uint8_t qos = *payload++;
|
||||
debug(" qos=" << qos);
|
||||
@@ -424,14 +470,19 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
{
|
||||
callback(this, published, nullptr, 0); // TODO send the real payload
|
||||
}
|
||||
// TODO should send PUBACK
|
||||
message.create(MqttMessage::Type::PubAck);
|
||||
// TODO re-add packet identifier if any
|
||||
message.sendTo(this);
|
||||
bclose = false;
|
||||
}
|
||||
break;
|
||||
|
||||
case MqttMessage::Type::PubAck:
|
||||
case MqttMessage::Type::Disconnect:
|
||||
// TODO should discard any will message
|
||||
if (!mqtt_connected) break;
|
||||
bclose = false;
|
||||
mqtt_connected = false;
|
||||
close(false);
|
||||
bclose=false;
|
||||
break;
|
||||
|
||||
default:
|
||||
@@ -441,7 +492,7 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
if (bclose)
|
||||
{
|
||||
Serial << "*************** Error msg 0x" << _HEX(message.type());
|
||||
if (error.length()) Serial << ':' << error.c_str();
|
||||
message.hexdump("-------ERROR ------");
|
||||
Serial << endl;
|
||||
close();
|
||||
}
|
||||
@@ -462,8 +513,7 @@ bool Topic::matches(const Topic& topic) const
|
||||
// publish from local client
|
||||
MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pay_length)
|
||||
{
|
||||
MqttMessage msg;
|
||||
msg.create(MqttMessage::Publish);
|
||||
MqttMessage msg(MqttMessage::Publish);
|
||||
msg.add(topic);
|
||||
msg.add(payload, pay_length, false);
|
||||
if (parent)
|
||||
@@ -482,10 +532,9 @@ MqttError MqttClient::publish(const Topic& topic, MqttMessage& msg)
|
||||
debug("mqttclient publish " << subscriptions.size());
|
||||
for(const auto& subscription: subscriptions)
|
||||
{
|
||||
Serial << " client=" << (int32_t)client << ", topic " << topic.str().c_str() << ' ';
|
||||
if (subscription.matches(topic))
|
||||
{
|
||||
Serial << " match/send";
|
||||
debug(" match client=" << (int32_t)client << ", topic " << topic.str().c_str() << ' ');
|
||||
if (client)
|
||||
{
|
||||
retval = msg.sendTo(this);
|
||||
@@ -495,7 +544,6 @@ MqttError MqttClient::publish(const Topic& topic, MqttMessage& msg)
|
||||
callback(this, topic, nullptr, 0); // TODO Payload
|
||||
}
|
||||
}
|
||||
Serial << endl;
|
||||
}
|
||||
return retval;
|
||||
}
|
||||
@@ -527,8 +575,15 @@ void MqttMessage::incoming(char in_byte)
|
||||
vheader = buffer.length();
|
||||
if (size==0)
|
||||
state = Complete;
|
||||
else if (size > 500) // TODO magic
|
||||
{
|
||||
state = Error;
|
||||
}
|
||||
else
|
||||
{
|
||||
buffer.reserve(size);
|
||||
state = VariableHeader;
|
||||
}
|
||||
}
|
||||
break;
|
||||
case VariableHeader:
|
||||
@@ -546,6 +601,7 @@ void MqttMessage::incoming(char in_byte)
|
||||
case Complete:
|
||||
default:
|
||||
Serial << "Spurious " << _HEX(in_byte) << endl;
|
||||
hexdump("spurious");
|
||||
reset();
|
||||
break;
|
||||
}
|
||||
@@ -579,11 +635,11 @@ void MqttMessage::encodeLength(char* msb, int length)
|
||||
|
||||
MqttError MqttMessage::sendTo(MqttClient* client)
|
||||
{
|
||||
if (buffer.size()>2)
|
||||
if (buffer.size())
|
||||
{
|
||||
debug("sending " << buffer.size() << " bytes");
|
||||
encodeLength(&buffer[1], buffer.size()-2);
|
||||
hexdump("snd");
|
||||
// hexdump("snd");
|
||||
client->write(&buffer[0], buffer.size());
|
||||
}
|
||||
else
|
||||
|
||||
@@ -5,11 +5,11 @@
|
||||
#include "StringIndexer.h"
|
||||
#include <MqttStreaming.h>
|
||||
|
||||
#define TINY_MQTT_DEBUG
|
||||
|
||||
#ifdef TINY_MQTT_DEBUG
|
||||
#if 0
|
||||
#define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); }
|
||||
#define TINY_MQTT_DEBUG 1
|
||||
#else
|
||||
#define TINY_MQTT_DEBUG 0
|
||||
#define debug(what) {}
|
||||
#endif
|
||||
|
||||
@@ -39,15 +39,17 @@ class MqttMessage
|
||||
public:
|
||||
enum Type
|
||||
{
|
||||
Unknown = 0,
|
||||
Connect = 0x10,
|
||||
Connack = 0x20,
|
||||
Publish = 0x30,
|
||||
PubAck = 0x40,
|
||||
Subscribe = 0x80,
|
||||
Suback = 0x90,
|
||||
PingReq = 0xC0,
|
||||
PingResp = 0xD0,
|
||||
Unknown = 0,
|
||||
Connect = 0x10,
|
||||
ConnAck = 0x20,
|
||||
Publish = 0x30,
|
||||
PubAck = 0x40,
|
||||
Subscribe = 0x80,
|
||||
SubAck = 0x90,
|
||||
UnSubscribe = 0xA0,
|
||||
PingReq = 0xC0,
|
||||
PingResp = 0xD0,
|
||||
Disconnect = 0xE0
|
||||
};
|
||||
enum State
|
||||
{
|
||||
@@ -119,6 +121,7 @@ class MqttClient
|
||||
};
|
||||
public:
|
||||
MqttClient(MqttBroker*);
|
||||
MqttClient(MqttBroker* brk, const std::string& id) : MqttClient(brk) { clientId=id; }
|
||||
MqttClient() : MqttClient(nullptr) {};
|
||||
|
||||
~MqttClient();
|
||||
@@ -136,7 +139,7 @@ class MqttClient
|
||||
void id(std::string& new_id) { clientId = new_id; }
|
||||
|
||||
void loop();
|
||||
void close();
|
||||
void close(bool bSendDisconnect=true);
|
||||
void setCallback(CallBack fun) {callback=fun; };
|
||||
|
||||
// Publish from client to the world
|
||||
@@ -146,23 +149,22 @@ class MqttClient
|
||||
MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
|
||||
|
||||
MqttError subscribe(Topic topic, uint8_t qos=0);
|
||||
MqttError unsubscribe(Topic& topic);
|
||||
MqttError unsubscribe(Topic topic);
|
||||
|
||||
// connected to local broker
|
||||
// TODO seems to be useless
|
||||
bool isLocal() const { return client == nullptr; }
|
||||
|
||||
#ifdef TINY_MQTT_DEBUG
|
||||
void dump()
|
||||
{
|
||||
uint32_t ms=millis();
|
||||
Serial << "MqttClient (" << clientId.c_str() << ") p=" << (int32_t) parent
|
||||
<< " c=" << (int32_t)client << (connected() ? " ON " : " OFF");
|
||||
Serial << "MqttClient (" << clientId.c_str() << ") p=" << (uint64_t) parent
|
||||
<< " c=" << (uint64_t)client << (connected() ? " ON " : " OFF");
|
||||
Serial << ", alive=" << (uint32_t)alive << '/' << ms << ", ka=" << keep_alive;
|
||||
Serial << " cnx " << (client && client->connected());
|
||||
Serial << " [";
|
||||
Serial << (client && client->connected() ? "" : "dis") << "connected";
|
||||
message.hexdump("entrant msg");
|
||||
bool c=false;
|
||||
Serial << " [";
|
||||
for(auto s: subscriptions)
|
||||
{
|
||||
Serial << (c?", ": "")<< s.str().c_str();
|
||||
@@ -172,9 +174,13 @@ class MqttClient
|
||||
|
||||
Serial << "]" << endl;
|
||||
}
|
||||
#endif
|
||||
|
||||
static long counter; // Number of messages sent
|
||||
|
||||
private:
|
||||
MqttError sendTopic(const Topic& topic, MqttMessage::Type type, uint8_t qos);
|
||||
void resubscribe();
|
||||
|
||||
friend class MqttBroker;
|
||||
MqttClient(MqttBroker* parent, WiFiClient& client);
|
||||
// republish a received publish if topic matches any in subscriptions
|
||||
@@ -221,7 +227,8 @@ class MqttBroker
|
||||
void connect(std::string host, uint32_t port=1883);
|
||||
bool connected() const { return state == Connected; }
|
||||
|
||||
#ifdef TINY_MQTT_DEBUG
|
||||
size_t clientsCount() const { return clients.size(); }
|
||||
|
||||
void dump()
|
||||
{
|
||||
Serial << clients.size() << " client/s" << endl;
|
||||
@@ -231,7 +238,6 @@ class MqttBroker
|
||||
client->dump();
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
private:
|
||||
friend class MqttClient;
|
||||
|
||||
20
tests/Makefile
Normal file
20
tests/Makefile
Normal file
@@ -0,0 +1,20 @@
|
||||
tests:
|
||||
set -e; \
|
||||
for i in *-tests/Makefile; do \
|
||||
echo '==== Making:' $$(dirname $$i); \
|
||||
$(MAKE) -C $$(dirname $$i) -j; \
|
||||
done
|
||||
|
||||
runtests:
|
||||
set -e; \
|
||||
for i in *-tests/Makefile; do \
|
||||
echo '==== Running:' $$(dirname $$i); \
|
||||
$$(dirname $$i)/$$(dirname $$i).out; \
|
||||
done
|
||||
|
||||
clean:
|
||||
set -e; \
|
||||
for i in *-tests/Makefile; do \
|
||||
echo '==== Cleaning:' $$(dirname $$i); \
|
||||
$(MAKE) -C $$(dirname $$i) clean; \
|
||||
done
|
||||
6
tests/local-tests/Makefile
Normal file
6
tests/local-tests/Makefile
Normal file
@@ -0,0 +1,6 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
APP_NAME := local-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
138
tests/local-tests/local-tests.ino
Normal file
138
tests/local-tests/local-tests.ino
Normal file
@@ -0,0 +1,138 @@
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt local unit tests.
|
||||
*
|
||||
* No wifi connection unit tests.
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
}
|
||||
|
||||
test(local_client_should_unregister_when_destroyed)
|
||||
{
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
{
|
||||
MqttClient client(&broker);
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
}
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
}
|
||||
|
||||
test(local_connect)
|
||||
{
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient client(&broker);
|
||||
assertTrue(client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
}
|
||||
|
||||
test(local_publish_should_be_dispatched)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.subscribe("a/b");
|
||||
subscriber.subscribe("a/c");
|
||||
subscriber.setCallback(onPublish);
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/c");
|
||||
publisher.publish("a/c");
|
||||
|
||||
assertEqual(published.size(), (size_t)1); // 1 client has received something
|
||||
assertTrue(published[""]["a/b"] == 1);
|
||||
assertTrue(published[""]["a/c"] == 2);
|
||||
}
|
||||
|
||||
test(local_publish_should_be_dispatched_to_local_clients)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber_a(&broker, "A");
|
||||
subscriber_a.setCallback(onPublish);
|
||||
subscriber_a.subscribe("a/b");
|
||||
subscriber_a.subscribe("a/c");
|
||||
|
||||
MqttClient subscriber_b(&broker, "B");
|
||||
subscriber_b.setCallback(onPublish);
|
||||
subscriber_b.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/c");
|
||||
|
||||
assertEqual(published.size(), (size_t)2); // 2 clients have received something
|
||||
assertTrue(published["A"]["a/b"] == 1);
|
||||
assertTrue(published["A"]["a/c"] == 1);
|
||||
assertTrue(published["B"]["a/b"] == 1);
|
||||
assertTrue(published["B"]["a/c"] == 0);
|
||||
}
|
||||
|
||||
test(local_unsubscribe)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b");
|
||||
|
||||
subscriber.unsubscribe("a/b");
|
||||
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertTrue(published[""]["a/b"] == 1); // Only one publish has been received
|
||||
}
|
||||
|
||||
test(local_nocallback_when_destroyed)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
{
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
}
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertEqual(published.size(), (size_t)0); // Only one publish has been received
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// setup() and loop()
|
||||
void setup() {
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
|
||||
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
|
||||
if (Serial.available()) ESP.reset();
|
||||
}
|
||||
Reference in New Issue
Block a user