Compare commits
43 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5834a278c7 | ||
|
|
146d0de1d4 | ||
|
|
297a22efb5 | ||
|
|
510ff514a9 | ||
|
|
ad6f7155e5 | ||
|
|
3ed5874373 | ||
|
|
e1a936e081 | ||
|
|
0757a95fbf | ||
|
|
7c8d71262f | ||
|
|
138ce973f2 | ||
|
|
bf499117b7 | ||
|
|
4ed6f72602 | ||
|
|
87a78c549f | ||
|
|
5211360b91 | ||
|
|
549a23ffb7 | ||
|
|
3a1af655d7 | ||
|
|
e71ffefc5a | ||
|
|
b6a0dde2b1 | ||
|
|
babc391632 | ||
|
|
27bdbb9a0b | ||
|
|
6a9e158428 | ||
|
|
6fc6794dc3 | ||
|
|
1eaa514579 | ||
|
|
7af4c2ca69 | ||
|
|
a340558460 | ||
|
|
9a7db237d3 | ||
|
|
91e083e7b0 | ||
|
|
97adc985e6 | ||
|
|
d5dd896b45 | ||
|
|
bd7fa8f39c | ||
|
|
6395e931ce | ||
|
|
635fee6f7c | ||
|
|
dc2420d88e | ||
|
|
2fbc46cbe2 | ||
|
|
a003156ae1 | ||
|
|
913e1aa7ae | ||
|
|
8272515bd7 | ||
|
|
9a7f6a3020 | ||
|
|
fead702d9f | ||
|
|
eaf938f2fd | ||
|
|
8eefa63f45 | ||
|
|
9d48c436d8 | ||
|
|
82c5b971e9 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,2 +1,5 @@
|
||||
*~
|
||||
src/my_credentials.h
|
||||
*.o
|
||||
*.swp
|
||||
*.out
|
||||
|
||||
@@ -40,6 +40,7 @@ std::map<std::string, MqttBroker*> brokers;
|
||||
|
||||
void setup()
|
||||
{
|
||||
WiFi.persistent(false); // https://github.com/esp8266/Arduino/issues/1054
|
||||
Serial.begin(115200);
|
||||
delay(500);
|
||||
Serial << endl << endl << endl
|
||||
@@ -399,11 +400,11 @@ void loop()
|
||||
}
|
||||
if (client)
|
||||
{
|
||||
clients.erase(s);
|
||||
for (auto it: clients)
|
||||
{
|
||||
if (it.second != client) continue;
|
||||
Serial << "deleted" << endl;
|
||||
delete (it.second);
|
||||
clients.erase(it.first);
|
||||
break;
|
||||
}
|
||||
@@ -413,9 +414,9 @@ void loop()
|
||||
{
|
||||
for(auto it: brokers)
|
||||
{
|
||||
Serial << (int32_t)it.second << '/' << (int32_t)broker << endl;
|
||||
if (broker != it.second) continue;
|
||||
Serial << "deleted" << endl;
|
||||
delete (it.second);
|
||||
brokers.erase(it.first);
|
||||
break;
|
||||
}
|
||||
|
||||
@@ -9,13 +9,19 @@
|
||||
TinyMqtt KEYWORD1
|
||||
|
||||
MqttBroker KEYWORD1
|
||||
connect KEYWORD2
|
||||
clientsCount KEYWORD2
|
||||
begin KEYWORD2
|
||||
loop KEYWORD2
|
||||
port KEYWORD2
|
||||
|
||||
MqttClient KEYWORD1
|
||||
connect KEYWORD2
|
||||
connected KEYWORD2
|
||||
publish KEYWORD2
|
||||
setCallback KEYWORD2
|
||||
subscribe KEYWORD2
|
||||
unsubscribe KEYWORD2
|
||||
|
||||
Topic KEYWORD1
|
||||
matches KEYWORD2
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "TinyMqtt",
|
||||
"keywords": "ethernet, mqtt, m2m, iot",
|
||||
"description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows you to send and receive MQTT messages. It does support MQTT 3.1.1 without any QOS.",
|
||||
"description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages. It does support MQTT 3.1.1 without QOS=0.",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/hsaturn/TinyMqtt.git"
|
||||
},
|
||||
"version": "0.7.1",
|
||||
"version": "0.7.3",
|
||||
"exclude": "",
|
||||
"examples": "examples/*/*.ino",
|
||||
"frameworks": "arduino",
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
name=TinyMqtt
|
||||
version=0.7.1
|
||||
version=0.7.3
|
||||
author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||
sentence=A tiny broker and client library for MQTT messaging.
|
||||
paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows you to send and receive MQTT messages and to jhost a broker in your ESP. It does support MQTT 3.1.1 without any QOS.
|
||||
paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages and to host a broker in your ESP. It does support MQTT 3.1.1 without QoS=0.
|
||||
category=Communication
|
||||
url=https://github.com/hsaturn/TinyMqtt
|
||||
architectures=*
|
||||
includes=TinyMqtt.h
|
||||
depends=
|
||||
|
||||
@@ -15,6 +15,16 @@ class StringIndexer
|
||||
std::string str;
|
||||
uint8_t used=0;
|
||||
friend class StringIndexer;
|
||||
|
||||
#if EPOXY_DUINO
|
||||
public:
|
||||
// Workaround to avoid coredump in Indexer::release
|
||||
// when destroying a Topic after the deletion of
|
||||
// StringIndexer::strings map (which can occurs only with AUnit,
|
||||
// never in the ESP itself, because ESP never ends)
|
||||
// (I hate static vars)
|
||||
~StringCounter() { used=255; }
|
||||
#endif
|
||||
};
|
||||
public:
|
||||
using index_t=uint8_t;
|
||||
@@ -29,7 +39,7 @@ class StringIndexer
|
||||
return it->first;
|
||||
}
|
||||
}
|
||||
for(index_t index=0; index<255; index++)
|
||||
for(index_t index=1; index; index++)
|
||||
{
|
||||
if (strings.find(index)==strings.end())
|
||||
{
|
||||
@@ -70,6 +80,8 @@ class StringIndexer
|
||||
}
|
||||
}
|
||||
|
||||
static uint16_t count() { return strings.size(); }
|
||||
|
||||
private:
|
||||
static std::map<index_t, StringCounter> strings;
|
||||
};
|
||||
@@ -88,6 +100,8 @@ class IndexedString
|
||||
index=StringIndexer::strToIndex(str, len);
|
||||
}
|
||||
|
||||
IndexedString(const std::string& str) : IndexedString(str.c_str(), str.length()) {};
|
||||
|
||||
~IndexedString() { StringIndexer::release(index); }
|
||||
|
||||
IndexedString& operator=(const IndexedString& source)
|
||||
@@ -102,6 +116,11 @@ class IndexedString
|
||||
return i1.index < i2.index;
|
||||
}
|
||||
|
||||
friend bool operator==(const IndexedString& i1, const IndexedString& i2)
|
||||
{
|
||||
return i1.index == i2.index;
|
||||
}
|
||||
|
||||
const std::string& str() const { return StringIndexer::str(index); }
|
||||
|
||||
const StringIndexer::index_t& getIndex() const { return index; }
|
||||
|
||||
164
src/TinyMqtt.cpp
164
src/TinyMqtt.cpp
@@ -19,6 +19,7 @@ MqttBroker::~MqttBroker()
|
||||
{
|
||||
delete clients[0];
|
||||
}
|
||||
server.close();
|
||||
}
|
||||
|
||||
// private constructor used by broker only
|
||||
@@ -29,8 +30,8 @@ MqttClient::MqttClient(MqttBroker* parent, WiFiClient& new_client)
|
||||
alive = millis()+5000; // client expires after 5s if no CONNECT msg
|
||||
}
|
||||
|
||||
MqttClient::MqttClient(MqttBroker* parent)
|
||||
: parent(parent)
|
||||
MqttClient::MqttClient(MqttBroker* parent, const std::string& id)
|
||||
: parent(parent), clientId(id)
|
||||
{
|
||||
client = nullptr;
|
||||
|
||||
@@ -97,6 +98,13 @@ void MqttBroker::addClient(MqttClient* client)
|
||||
clients.push_back(client);
|
||||
}
|
||||
|
||||
void MqttBroker::connect(const std::string& host, uint16_t port)
|
||||
{
|
||||
if (broker == nullptr) broker = new MqttClient;
|
||||
broker->connect(host, port);
|
||||
broker->parent = this; // Because connect removed the link
|
||||
}
|
||||
|
||||
void MqttBroker::removeClient(MqttClient* remove)
|
||||
{
|
||||
for(auto it=clients.begin(); it!=clients.end(); it++)
|
||||
@@ -104,6 +112,11 @@ void MqttBroker::removeClient(MqttClient* remove)
|
||||
auto client=*it;
|
||||
if (client==remove)
|
||||
{
|
||||
// TODO if this broker is connected to an external broker
|
||||
// we have to unsubscribe remove's topics.
|
||||
// (but doing this, check that other clients are not subscribed...)
|
||||
// Unless -> we could receive useless messages
|
||||
// -> we are using (memory) one IndexedString plus its string for nothing.
|
||||
debug("Remove " << clients.size());
|
||||
clients.erase(it);
|
||||
debug("Client removed " << clients.size());
|
||||
@@ -117,6 +130,13 @@ void MqttBroker::loop()
|
||||
{
|
||||
WiFiClient client = server.available();
|
||||
|
||||
if (broker)
|
||||
{
|
||||
// TODO should monitor broker's activity.
|
||||
// 1 When broker disconnect and reconnect we have to re-subscribe
|
||||
broker->loop();
|
||||
}
|
||||
|
||||
if (client)
|
||||
{
|
||||
addClient(new MqttClient(this, client));
|
||||
@@ -142,7 +162,15 @@ void MqttBroker::loop()
|
||||
}
|
||||
}
|
||||
|
||||
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg)
|
||||
MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
|
||||
{
|
||||
if (broker && broker->connected())
|
||||
{
|
||||
return broker->subscribe(topic, qos);
|
||||
}
|
||||
}
|
||||
|
||||
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const
|
||||
{
|
||||
MqttError retval = MqttOk;
|
||||
|
||||
@@ -156,28 +184,27 @@ MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, Mqtt
|
||||
" 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
|
||||
if (broker && broker->connected()) // this (MqttBroker) is connected (to a external broker)
|
||||
{
|
||||
// ext broker -> clients or
|
||||
// or clients -> ext broker
|
||||
if (source == broker) // broker -> clients
|
||||
// ext_broker -> clients or clients -> ext_broker
|
||||
if (source == broker) // external broker -> internal clients
|
||||
doit = true;
|
||||
else // clients -> broker
|
||||
else // external clients -> this broker
|
||||
{
|
||||
MqttError ret = broker->publish(topic, msg);
|
||||
// As this broker is connected to another broker, simply forward the msg
|
||||
MqttError ret = broker->publishIfSubscribed(topic, msg);
|
||||
if (ret != MqttOk) retval = ret;
|
||||
}
|
||||
}
|
||||
else // Disconnected: R7
|
||||
else // Disconnected
|
||||
{
|
||||
// All is allowed
|
||||
doit = true;
|
||||
}
|
||||
#if TINY_MQTT_DEBUG
|
||||
Serial << ", doit=" << doit << ' ';
|
||||
#endif
|
||||
|
||||
if (doit) retval = client->publish(topic, msg);
|
||||
if (doit) retval = client->publishIfSubscribed(topic, msg);
|
||||
debug("");
|
||||
}
|
||||
return retval;
|
||||
@@ -236,7 +263,8 @@ void MqttClient::loop()
|
||||
message.incoming(client->read());
|
||||
if (message.type())
|
||||
{
|
||||
processMessage();
|
||||
processMessage(&message);
|
||||
message.reset();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -272,6 +300,10 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
|
||||
{
|
||||
return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
|
||||
}
|
||||
else
|
||||
{
|
||||
return parent->subscribe(topic, qos);
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
@@ -306,22 +338,22 @@ MqttError MqttClient::sendTopic(const Topic& topic, MqttMessage::Type type, uint
|
||||
|
||||
long MqttClient::counter=0;
|
||||
|
||||
void MqttClient::processMessage()
|
||||
void MqttClient::processMessage(const MqttMessage* mesg)
|
||||
{
|
||||
counter++;
|
||||
#if TINY_MQTT_DEBUG
|
||||
if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessage::Type::PingResp)
|
||||
if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::Type::PingResp)
|
||||
{
|
||||
Serial << "---> INCOMING " << _HEX(message.type()) << " client(" << (int)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
|
||||
// message.hexdump("Incoming");
|
||||
Serial << "---> INCOMING " << _HEX(mesg->type()) << " client(" << (int)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
|
||||
// mesg->hexdump("Incoming");
|
||||
}
|
||||
#endif
|
||||
auto header = message.getVHeader();
|
||||
auto header = mesg->getVHeader();
|
||||
const char* payload;
|
||||
uint16_t len;
|
||||
bool bclose=true;
|
||||
|
||||
switch(message.type() & 0XF0)
|
||||
switch(mesg->type() & 0XF0)
|
||||
{
|
||||
case MqttMessage::Type::Connect:
|
||||
if (mqtt_connected)
|
||||
@@ -344,30 +376,30 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
}
|
||||
|
||||
// ClientId
|
||||
message.getString(payload, len);
|
||||
mesg->getString(payload, len);
|
||||
clientId = std::string(payload, len);
|
||||
payload += len;
|
||||
|
||||
if (mqtt_flags & FlagWill) // Will topic
|
||||
{
|
||||
message.getString(payload, len); // Will Topic
|
||||
mesg->getString(payload, len); // Will Topic
|
||||
outstring("WillTopic", payload, len);
|
||||
payload += len;
|
||||
|
||||
message.getString(payload, len); // Will Message
|
||||
mesg->getString(payload, len); // Will Message
|
||||
outstring("WillMessage", payload, len);
|
||||
payload += len;
|
||||
}
|
||||
// FIXME forgetting credential is allowed (security hole)
|
||||
if (mqtt_flags & FlagUserName)
|
||||
{
|
||||
message.getString(payload, len);
|
||||
mesg->getString(payload, len);
|
||||
if (!parent->checkUser(payload, len)) break;
|
||||
payload += len;
|
||||
}
|
||||
if (mqtt_flags & FlagPassword)
|
||||
{
|
||||
message.getString(payload, len);
|
||||
mesg->getString(payload, len);
|
||||
if (!parent->checkPassword(payload, len)) break;
|
||||
payload += len;
|
||||
}
|
||||
@@ -422,14 +454,14 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
payload = header+2;
|
||||
|
||||
debug("subscribe loop");
|
||||
while(payload < message.end())
|
||||
while(payload < mesg->end())
|
||||
{
|
||||
message.getString(payload, len); // Topic
|
||||
mesg->getString(payload, len); // Topic
|
||||
debug( " topic (" << std::string(payload, len) << ')');
|
||||
outstring("Subscribes", payload, len);
|
||||
// subscribe(Topic(payload, len));
|
||||
Topic topic(payload, len);
|
||||
if ((message.type() & 0XF0) == MqttMessage::Type::Subscribe)
|
||||
if ((mesg->type() & 0XF0) == MqttMessage::Type::Subscribe)
|
||||
subscriptions.insert(topic);
|
||||
else
|
||||
{
|
||||
@@ -448,37 +480,38 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
break;
|
||||
|
||||
case MqttMessage::Type::Publish:
|
||||
if (!mqtt_connected) break;
|
||||
if (mqtt_connected or client == nullptr)
|
||||
{
|
||||
uint8_t qos = message.type() & 0x6;
|
||||
uint8_t qos = mesg->type() & 0x6;
|
||||
payload = header;
|
||||
message.getString(payload, len);
|
||||
mesg->getString(payload, len);
|
||||
Topic published(payload, len);
|
||||
payload += len;
|
||||
len=message.end()-payload;
|
||||
// Serial << "Received Publish (" << published.str().c_str() << ") size=" << (int)len
|
||||
// << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << message.length() << endl;
|
||||
// << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl;
|
||||
if (qos) payload+=2; // ignore packet identifier if any
|
||||
len=mesg->end()-payload;
|
||||
// TODO reset DUP
|
||||
// TODO reset RETAIN
|
||||
if (parent)
|
||||
|
||||
if (client==nullptr) // internal MqttClient receives publish
|
||||
{
|
||||
if (callback and isSubscribedTo(published))
|
||||
{
|
||||
callback(this, published, payload, len); // TODO send the real payload
|
||||
}
|
||||
}
|
||||
else if (parent) // from outside to inside
|
||||
{
|
||||
debug("publishing to parent");
|
||||
parent->publish(this, published, message);
|
||||
parent->publish(this, published, *mesg);
|
||||
}
|
||||
else if (callback && subscriptions.find(published)!=subscriptions.end())
|
||||
{
|
||||
callback(this, published, nullptr, 0); // TODO send the real payload
|
||||
}
|
||||
message.create(MqttMessage::Type::PubAck);
|
||||
// TODO re-add packet identifier if any
|
||||
message.sendTo(this);
|
||||
bclose = false;
|
||||
}
|
||||
break;
|
||||
|
||||
case MqttMessage::Type::Disconnect:
|
||||
// TODO should discard any will message
|
||||
// TODO should discard any will msg
|
||||
if (!mqtt_connected) break;
|
||||
mqtt_connected = false;
|
||||
close(false);
|
||||
@@ -491,8 +524,9 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
};
|
||||
if (bclose)
|
||||
{
|
||||
Serial << "*************** Error msg 0x" << _HEX(message.type());
|
||||
message.hexdump("-------ERROR ------");
|
||||
Serial << "*************** Error msg 0x" << _HEX(mesg->type());
|
||||
mesg->hexdump("-------ERROR ------");
|
||||
dump();
|
||||
Serial << endl;
|
||||
close();
|
||||
}
|
||||
@@ -500,7 +534,6 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
||||
{
|
||||
clientAlive(parent ? 5 : 0);
|
||||
}
|
||||
message.reset();
|
||||
}
|
||||
|
||||
bool Topic::matches(const Topic& topic) const
|
||||
@@ -516,8 +549,11 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
|
||||
MqttMessage msg(MqttMessage::Publish);
|
||||
msg.add(topic);
|
||||
msg.add(payload, pay_length, false);
|
||||
msg.complete();
|
||||
if (parent)
|
||||
{
|
||||
return parent->publish(this, topic, msg);
|
||||
}
|
||||
else if (client)
|
||||
return msg.sendTo(this);
|
||||
else
|
||||
@@ -525,29 +561,33 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
|
||||
}
|
||||
|
||||
// republish a received publish if it matches any in subscriptions
|
||||
MqttError MqttClient::publish(const Topic& topic, MqttMessage& msg)
|
||||
MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage& msg)
|
||||
{
|
||||
MqttError retval=MqttOk;
|
||||
|
||||
debug("mqttclient publish " << subscriptions.size());
|
||||
for(const auto& subscription: subscriptions)
|
||||
if (isSubscribedTo(topic))
|
||||
{
|
||||
if (subscription.matches(topic))
|
||||
if (client)
|
||||
retval = msg.sendTo(this);
|
||||
else
|
||||
{
|
||||
debug(" match client=" << (int32_t)client << ", topic " << topic.str().c_str() << ' ');
|
||||
if (client)
|
||||
{
|
||||
retval = msg.sendTo(this);
|
||||
}
|
||||
else if (callback)
|
||||
{
|
||||
callback(this, topic, nullptr, 0); // TODO Payload
|
||||
}
|
||||
processMessage(&msg);
|
||||
// callback(this, topic, nullptr, 0); // TODO Payload
|
||||
}
|
||||
}
|
||||
return retval;
|
||||
}
|
||||
|
||||
bool MqttClient::isSubscribedTo(const Topic& topic) const
|
||||
{
|
||||
for(const auto& subscription: subscriptions)
|
||||
if (subscription.matches(topic))
|
||||
return true;
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
void MqttMessage::reset()
|
||||
{
|
||||
buffer.clear();
|
||||
@@ -622,7 +662,7 @@ void MqttMessage::add(const char* p, size_t len, bool addLength)
|
||||
while(len--) incoming(*p++);
|
||||
}
|
||||
|
||||
void MqttMessage::encodeLength(char* msb, int length)
|
||||
void MqttMessage::encodeLength(char* msb, int length) const
|
||||
{
|
||||
do
|
||||
{
|
||||
@@ -633,7 +673,13 @@ void MqttMessage::encodeLength(char* msb, int length)
|
||||
} while (length);
|
||||
};
|
||||
|
||||
MqttError MqttMessage::sendTo(MqttClient* client)
|
||||
void MqttMessage::complete()
|
||||
{
|
||||
encodeLength(&buffer[1], buffer.size()-2);
|
||||
state = Complete;
|
||||
}
|
||||
|
||||
MqttError MqttMessage::sendTo(MqttClient* client) const
|
||||
{
|
||||
if (buffer.size())
|
||||
{
|
||||
|
||||
@@ -72,6 +72,7 @@ class MqttMessage
|
||||
const char* end() const { return &buffer[0]+buffer.size(); }
|
||||
const char* getVHeader() const { return &buffer[vheader]; }
|
||||
uint16_t length() const { return buffer.size(); }
|
||||
void complete();
|
||||
|
||||
void reset();
|
||||
|
||||
@@ -85,6 +86,13 @@ class MqttMessage
|
||||
return state == Complete ? static_cast<Type>(buffer[0]) : Unknown;
|
||||
}
|
||||
|
||||
// shouldn't exist because it breaks constness :-(
|
||||
// but this saves memory so ...
|
||||
void changeType(Type type) const
|
||||
{
|
||||
buffer[0] = type;
|
||||
}
|
||||
|
||||
void create(Type type)
|
||||
{
|
||||
buffer=(char)type;
|
||||
@@ -93,13 +101,13 @@ class MqttMessage
|
||||
size=0;
|
||||
state=Create;
|
||||
}
|
||||
MqttError sendTo(MqttClient*);
|
||||
MqttError sendTo(MqttClient*) const;
|
||||
void hexdump(const char* prefix=nullptr) const;
|
||||
|
||||
private:
|
||||
void encodeLength(char* msb, int length);
|
||||
void encodeLength(char* msb, int length) const;
|
||||
|
||||
std::string buffer;
|
||||
mutable std::string buffer; // mutable -> sendTo()
|
||||
uint8_t vheader;
|
||||
uint16_t size; // bytes left to receive
|
||||
State state;
|
||||
@@ -120,14 +128,15 @@ class MqttClient
|
||||
FlagReserved = 1
|
||||
};
|
||||
public:
|
||||
MqttClient(MqttBroker*);
|
||||
MqttClient(MqttBroker* brk, const std::string& id) : MqttClient(brk) { clientId=id; }
|
||||
MqttClient() : MqttClient(nullptr) {};
|
||||
/** Constructor. If broker is not null, this is the adress of a local broker.
|
||||
If you want to connect elsewhere, leave broker null and use connect() **/
|
||||
MqttClient(MqttBroker* broker = nullptr, const std::string& id="");
|
||||
MqttClient(const std::string& id) : MqttClient(nullptr, id){}
|
||||
|
||||
~MqttClient();
|
||||
|
||||
void connect(MqttBroker* parent);
|
||||
void connect(std::string broker, uint16_t port, uint16_t ka=10);
|
||||
void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10);
|
||||
|
||||
bool connected() { return
|
||||
(parent!=nullptr and client==nullptr) or
|
||||
@@ -138,6 +147,7 @@ class MqttClient
|
||||
const std::string& id() const { return clientId; }
|
||||
void id(std::string& new_id) { clientId = new_id; }
|
||||
|
||||
/** Should be called in main loop() */
|
||||
void loop();
|
||||
void close(bool bSendDisconnect=true);
|
||||
void setCallback(CallBack fun) {callback=fun; };
|
||||
@@ -150,6 +160,7 @@ class MqttClient
|
||||
|
||||
MqttError subscribe(Topic topic, uint8_t qos=0);
|
||||
MqttError unsubscribe(Topic topic);
|
||||
bool isSubscribedTo(const Topic& topic) const;
|
||||
|
||||
// connected to local broker
|
||||
// TODO seems to be useless
|
||||
@@ -158,11 +169,10 @@ class MqttClient
|
||||
void dump()
|
||||
{
|
||||
uint32_t ms=millis();
|
||||
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 << "MqttClient (" << clientId.c_str() << ") " << (connected() ? " ON " : " OFF");
|
||||
Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive;
|
||||
Serial << (client && client->connected() ? "" : "dis") << "connected";
|
||||
message.hexdump("entrant msg");
|
||||
message.hexdump("entrant msg");
|
||||
bool c=false;
|
||||
Serial << " [";
|
||||
for(auto s: subscriptions)
|
||||
@@ -175,7 +185,8 @@ class MqttClient
|
||||
Serial << "]" << endl;
|
||||
}
|
||||
|
||||
static long counter; // Number of messages sent
|
||||
/** Count the number of messages that have been sent **/
|
||||
static long counter;
|
||||
|
||||
private:
|
||||
MqttError sendTopic(const Topic& topic, MqttMessage::Type type, uint8_t qos);
|
||||
@@ -184,10 +195,10 @@ class MqttClient
|
||||
friend class MqttBroker;
|
||||
MqttClient(MqttBroker* parent, WiFiClient& client);
|
||||
// republish a received publish if topic matches any in subscriptions
|
||||
MqttError publish(const Topic& topic, MqttMessage& msg);
|
||||
MqttError publishIfSubscribed(const Topic& topic, const MqttMessage& msg);
|
||||
|
||||
void clientAlive(uint32_t more_seconds);
|
||||
void processMessage();
|
||||
void processMessage(const MqttMessage* message);
|
||||
|
||||
bool mqtt_connected = false;
|
||||
char mqtt_flags;
|
||||
@@ -222,9 +233,9 @@ class MqttBroker
|
||||
void begin() { server.begin(); }
|
||||
void loop();
|
||||
|
||||
uint8_t port() const { return server.port(); }
|
||||
uint16_t port() const { return server.port(); }
|
||||
|
||||
void connect(std::string host, uint32_t port=1883);
|
||||
void connect(const std::string& host, uint16_t port=1883);
|
||||
bool connected() const { return state == Connected; }
|
||||
|
||||
size_t clientsCount() const { return clients.size(); }
|
||||
@@ -249,7 +260,9 @@ class MqttBroker
|
||||
{ return compareString(auth_password, password, len); }
|
||||
|
||||
|
||||
MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg);
|
||||
MqttError publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const;
|
||||
|
||||
MqttError subscribe(const Topic& topic, uint8_t qos);
|
||||
|
||||
// For clients that are added not by the broker itself
|
||||
void addClient(MqttClient* client);
|
||||
|
||||
@@ -3,9 +3,12 @@
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt local unit tests.
|
||||
* TinyMqtt local unit tests.
|
||||
*
|
||||
* No wifi connection unit tests.
|
||||
* Clients are connected to pseudo remote broker
|
||||
* The remote will be 127.0.0.1:1883
|
||||
* We are using 127.0.0.1 because this is simpler to test with a single ESP
|
||||
* Also, this will allow to mock and thus run Action on github
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
@@ -14,27 +17,36 @@ MqttBroker broker(1883);
|
||||
|
||||
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
|
||||
const char* lastPayload;
|
||||
size_t lastLength;
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
lastPayload = payload;
|
||||
lastLength = length;
|
||||
}
|
||||
|
||||
test(local_client_should_unregister_when_destroyed)
|
||||
{
|
||||
return;
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
{
|
||||
MqttClient client(&broker);
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
MqttClient client;
|
||||
assertEqual(broker.clientsCount(), (size_t)0); // Ensure client is not yet connected
|
||||
client.connect("127.0.0.1", 1883);
|
||||
assertEqual(broker.clientsCount(), (size_t)1); // Ensure client is now connected
|
||||
}
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
}
|
||||
|
||||
#if 0
|
||||
test(local_connect)
|
||||
{
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient client(&broker);
|
||||
MqttClient client;
|
||||
assertTrue(client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
}
|
||||
@@ -44,12 +56,12 @@ test(local_publish_should_be_dispatched)
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
MqttClient subscriber;
|
||||
subscriber.subscribe("a/b");
|
||||
subscriber.subscribe("a/c");
|
||||
subscriber.setCallback(onPublish);
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
MqttClient publisher;
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/c");
|
||||
publisher.publish("a/c");
|
||||
@@ -64,16 +76,16 @@ test(local_publish_should_be_dispatched_to_local_clients)
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber_a(&broker, "A");
|
||||
MqttClient subscriber_a("A");
|
||||
subscriber_a.setCallback(onPublish);
|
||||
subscriber_a.subscribe("a/b");
|
||||
subscriber_a.subscribe("a/c");
|
||||
|
||||
MqttClient subscriber_b(&broker, "B");
|
||||
MqttClient subscriber_b("B");
|
||||
subscriber_b.setCallback(onPublish);
|
||||
subscriber_b.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
MqttClient publisher;
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/c");
|
||||
|
||||
@@ -89,11 +101,11 @@ test(local_unsubscribe)
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
MqttClient subscriber;
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
MqttClient publisher;
|
||||
publisher.publish("a/b");
|
||||
|
||||
subscriber.unsubscribe("a/b");
|
||||
@@ -109,30 +121,32 @@ test(local_nocallback_when_destroyed)
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient publisher;
|
||||
{
|
||||
MqttClient subscriber(&broker);
|
||||
MqttClient subscriber;
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
publisher.publish("a/b");
|
||||
}
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertEqual(published.size(), (size_t)0); // Only one publish has been received
|
||||
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||
}
|
||||
#endif
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// setup() and loop()
|
||||
void setup() {
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
|
||||
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
aunit::TestRunner::run();
|
||||
|
||||
if (Serial.available()) ESP.reset();
|
||||
}
|
||||
|
||||
6
tests/nowifi-tests/Makefile
Normal file
6
tests/nowifi-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 := nowifi-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
165
tests/nowifi-tests/nowifi-tests.ino
Normal file
165
tests/nowifi-tests/nowifi-tests.ino
Normal file
@@ -0,0 +1,165 @@
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt nowifi unit tests.
|
||||
*
|
||||
* No wifi connection unit tests.
|
||||
* Checks with a local broker. Clients must connect to the local broker
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
|
||||
const char* lastPayload;
|
||||
size_t lastLength;
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
lastPayload = payload;
|
||||
lastLength = length;
|
||||
}
|
||||
|
||||
test(nowifi_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(nowifi_connect)
|
||||
{
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient client(&broker);
|
||||
assertTrue(client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
}
|
||||
|
||||
test(nowifi_publish_should_be_dispatched)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.subscribe("a/b");
|
||||
subscriber.subscribe("a/c");
|
||||
subscriber.setCallback(onPublish);
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/c");
|
||||
publisher.publish("a/c");
|
||||
|
||||
assertEqual(published.size(), (size_t)1); // 1 client has received something
|
||||
assertEqual(published[""]["a/b"], 1);
|
||||
assertEqual(published[""]["a/c"], 2);
|
||||
}
|
||||
|
||||
test(nowifi_publish_should_be_dispatched_to_clients)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber_a(&broker, "A");
|
||||
subscriber_a.setCallback(onPublish);
|
||||
subscriber_a.subscribe("a/b");
|
||||
subscriber_a.subscribe("a/c");
|
||||
|
||||
MqttClient subscriber_b(&broker, "B");
|
||||
subscriber_b.setCallback(onPublish);
|
||||
subscriber_b.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b"); // A and B should receive this
|
||||
publisher.publish("a/c"); // A should receive this
|
||||
|
||||
assertEqual(published.size(), (size_t)2); // 2 clients have received something
|
||||
assertEqual(published["A"]["a/b"], 1);
|
||||
assertEqual(published["A"]["a/c"], 1);
|
||||
assertEqual(published["B"]["a/b"], 1);
|
||||
assertEqual(published["B"]["a/c"], 0);
|
||||
}
|
||||
|
||||
test(nowifi_unsubscribe)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b"); // This publish is received
|
||||
|
||||
subscriber.unsubscribe("a/b");
|
||||
|
||||
publisher.publish("a/b"); // Those one, no (unsubscribed)
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertEqual(published[""]["a/b"], 1); // Only one publish has been received
|
||||
}
|
||||
|
||||
test(nowifi_nocallback_when_destroyed)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
|
||||
{
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
publisher.publish("a/b");
|
||||
}
|
||||
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||
}
|
||||
|
||||
test(nowifi_payload_nullptr)
|
||||
{
|
||||
return; // FIXME
|
||||
published.clear();
|
||||
|
||||
const char* payload="abcd";
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b", payload, strlen(payload)); // This publish is received
|
||||
|
||||
// coming from MqttClient::publish(...)
|
||||
assertEqual(payload, lastPayload);
|
||||
assertEqual(lastLength, (size_t)4);
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// 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();
|
||||
}
|
||||
6
tests/result.json
Normal file
6
tests/result.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"schemaVersion" : 1,
|
||||
"label" : "tests",
|
||||
"message" : "Message content",
|
||||
"color": "red"
|
||||
}
|
||||
2
tests/result.yaml
Normal file
2
tests/result.yaml
Normal file
@@ -0,0 +1,2 @@
|
||||
result: 1
|
||||
insert: "passed"
|
||||
6
tests/string-indexer-tests/Makefile
Normal file
6
tests/string-indexer-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 := string-indexer-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
123
tests/string-indexer-tests/string-indexer-tests.ino
Normal file
123
tests/string-indexer-tests/string-indexer-tests.ino
Normal file
@@ -0,0 +1,123 @@
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt local unit tests.
|
||||
*
|
||||
* Clients are connected to pseudo remote broker
|
||||
* The remote will be 127.0.0.1:1883
|
||||
* We are using 127.0.0.1 because this is simpler to test with a single ESP
|
||||
* Also, this will allow to mock and thus run Action on github
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
}
|
||||
|
||||
test(indexer_empty)
|
||||
{
|
||||
assertEqual(StringIndexer::count(), 0);
|
||||
}
|
||||
|
||||
test(indexer_strings_deleted_should_empty_indexer)
|
||||
{
|
||||
assertTrue(StringIndexer::count()==0);
|
||||
{
|
||||
IndexedString one("one");
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
IndexedString two("two");
|
||||
assertEqual(StringIndexer::count(), 2);
|
||||
IndexedString three("three");
|
||||
assertEqual(StringIndexer::count(), 3);
|
||||
IndexedString four("four");
|
||||
assertEqual(StringIndexer::count(), 4);
|
||||
}
|
||||
assertEqual(StringIndexer::count(), 0);
|
||||
}
|
||||
|
||||
test(indexer_same_strings_count_as_one)
|
||||
{
|
||||
IndexedString one ("one");
|
||||
IndexedString two ("one");
|
||||
IndexedString three("one");
|
||||
IndexedString fourt("one");
|
||||
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
}
|
||||
|
||||
test(indexer_size_of_indexed_string)
|
||||
{
|
||||
assertEqual(sizeof(IndexedString), (size_t)1);
|
||||
}
|
||||
|
||||
test(indexer_different_strings_are_different)
|
||||
{
|
||||
IndexedString one("one");
|
||||
IndexedString two("two");
|
||||
|
||||
assertFalse(one == two);
|
||||
}
|
||||
|
||||
test(indexer_same_strings_should_equal)
|
||||
{
|
||||
IndexedString one("one");
|
||||
IndexedString two("one");
|
||||
|
||||
assertTrue(one == two);
|
||||
}
|
||||
|
||||
test(indexer_indexed_operator_eq)
|
||||
{
|
||||
IndexedString one("one");
|
||||
{
|
||||
IndexedString same = one;
|
||||
assertTrue(one == same);
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
}
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
}
|
||||
|
||||
test(indexer_get_string)
|
||||
{
|
||||
std::string sone("one");
|
||||
IndexedString one(sone);
|
||||
|
||||
assertTrue(sone==one.str());
|
||||
}
|
||||
|
||||
test(indexer_get_index)
|
||||
{
|
||||
IndexedString one1("one");
|
||||
IndexedString one2("one");
|
||||
IndexedString two1("two");
|
||||
IndexedString two2("two");
|
||||
|
||||
assertTrue(one1.getIndex() == one2.getIndex());
|
||||
assertTrue(two1.getIndex() == two2.getIndex());
|
||||
assertTrue(one1.getIndex() != two1.getIndex());
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// setup() and loop()
|
||||
void setup() {
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
|
||||
Serial.println("=============[ TinyMqtt StringIndexer TESTS ]========================");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
|
||||
if (Serial.available()) ESP.reset();
|
||||
}
|
||||
Reference in New Issue
Block a user