Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d12096ef51 | ||
|
|
ea56d21190 | ||
|
|
c802c895b6 | ||
|
|
074bca971f | ||
|
|
7bd9c27b89 | ||
|
|
3e73673302 | ||
|
|
4b12aaa198 | ||
|
|
5f9cab8992 | ||
|
|
96766f7091 | ||
|
|
354aec239f | ||
|
|
3839a0a830 | ||
|
|
0444a4c348 | ||
|
|
73207e4745 | ||
|
|
b7d44445af | ||
|
|
cce6b2ecfc | ||
|
|
883f1e27e6 | ||
|
|
e7fc147424 | ||
|
|
2147b147fc | ||
|
|
f5e9a43461 | ||
|
|
cabb56fc8c | ||
|
|
58786eb6d9 | ||
|
|
776242b259 | ||
|
|
a9d19c3218 | ||
|
|
7bd299ec07 | ||
|
|
107469cd78 | ||
|
|
709e1fd567 | ||
|
|
4eb8f18ebf | ||
|
|
d5d27c8020 |
52
.github/workflows/superlinter.yml
vendored
52
.github/workflows/superlinter.yml
vendored
@@ -1,26 +1,52 @@
|
||||
name: Super-Linter
|
||||
---
|
||||
#################################
|
||||
#################################
|
||||
## Super Linter GitHub Actions ##
|
||||
#################################
|
||||
#################################
|
||||
name: Lint Code Base
|
||||
|
||||
# Run this workflow every time a new commit pushed to your repository
|
||||
#
|
||||
# Documentation:
|
||||
# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions
|
||||
#
|
||||
|
||||
#############################
|
||||
# Start the job on all push #
|
||||
#############################
|
||||
on: push
|
||||
|
||||
###############
|
||||
# Set the Job #
|
||||
###############
|
||||
jobs:
|
||||
# Set the job key. The key is displayed as the job name
|
||||
# when a job name is not provided
|
||||
super-lint:
|
||||
build:
|
||||
# Name the Job
|
||||
name: Lint code base
|
||||
# Set the type of machine to run on
|
||||
name: Lint Code Base
|
||||
# Set the agent to run on
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
##################
|
||||
# Load all steps #
|
||||
##################
|
||||
steps:
|
||||
# Checks out a copy of your repository on the ubuntu-latest machine
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
##########################
|
||||
# Checkout the code base #
|
||||
##########################
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
# Full git history is needed to get a proper
|
||||
# list of changed files within `super-linter`
|
||||
fetch-depth: 0
|
||||
|
||||
# Runs the Super-Linter action
|
||||
- name: Run Super-Linter
|
||||
uses: github/super-linter@v3
|
||||
################################
|
||||
# Run Linter against code base #
|
||||
################################
|
||||
- name: Lint Code Base
|
||||
uses: github/super-linter/slim@v4
|
||||
env:
|
||||
VALIDATE_ALL_CODEBASE: false
|
||||
# Change to 'master' if your main branch differs
|
||||
DEFAULT_BRANCH: main
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
20
README.md
20
README.md
@@ -17,11 +17,20 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
|
||||
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
|
||||
- Wildcards supported (+ # $ and * (even if not part of the spec...))
|
||||
- Standalone (can work without WiFi) (degraded/local mode)
|
||||
- Brokers can connect to another broker and becomes then a
|
||||
proxy for clients that are connected to it.
|
||||
- zeroconf, this is a strange but very powerful mode where
|
||||
all brokers tries to connect together on the same local network.
|
||||
- small memory footprint (very efficient topic storage)
|
||||
- long messages are supported (>127 bytes)
|
||||
- TinyMQTT is largely unit tested, so once a bug is fixed, it is fixed forever
|
||||
|
||||
## Limitations
|
||||
|
||||
- Max of 255 different topics can be stored (change index_t type to allow more)
|
||||
- No Qos because messages are not queued but immediately sent to clients
|
||||
|
||||
## Quickstart
|
||||
|
||||
@@ -33,10 +42,11 @@ TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32
|
||||
|
||||
| Example | Description |
|
||||
| ------------------- | ------------------------------------------ |
|
||||
| client-without-wifi | standalone example |
|
||||
| simple-client | Connect the ESP to an external Mqtt broker |
|
||||
| simple-broker | Simple Mqtt broker with your ESP |
|
||||
| tinymqtt-test | Complex console example |
|
||||
| [client-with-wifi](https://github.com/hsaturn/TinyMqtt/tree/main/examples/client-with-wifi/client-with-wifi.ino) | standalone example |
|
||||
| [client-without-wifi](https://github.com/hsaturn/TinyMqtt/tree/main/examples/client-without-wifi/client-without-wifi.ino) | standalone example |
|
||||
| [simple-client](https://github.com/hsaturn/TinyMqtt/tree/main/examples/simple-client/simple-client.ino) | Connect the ESP to an external Mqtt broker |
|
||||
| [simple-broker](https://github.com/hsaturn/TinyMqtt/tree/main/examples/simple-broker/simple-broker.ino) | Simple Mqtt broker with your ESP |
|
||||
| [tinymqtt-test](https://github.com/hsaturn/TinyMqtt/tree/main/examples/tinymqtt-test/tinymqtt-test.ino) | Complex console example |
|
||||
|
||||
- tinymqtt-test : This is a complex sketch with a terminal console
|
||||
that allows to add clients publish, connect etc with interpreted commands.
|
||||
@@ -59,7 +69,7 @@ no need for having tons of clients (also RAM is the problem with many clients)
|
||||
* ~~MqttClient auto re-subscribe (::resubscribe works bad on broker.emqx.io)~~
|
||||
* MqttClient auto reconnection
|
||||
* MqttClient user/password
|
||||
* Wildcards (I may implement only # as I'm not interrested by a clever and cpu consuming matching)
|
||||
* ~~Wildcards (I may implement only # as I'm not interrested by a clever and cpu consuming matching)~~
|
||||
* I suspect that MqttClient::parent could be removed and replaced with a simple boolean
|
||||
(this'll need to rewrite a few functions)
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
// vim: ts=2 sw=2
|
||||
#define TINY_MQTT_DEBUG
|
||||
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
||||
#include <MqttStreaming.h>
|
||||
#if defined(ESP8266)
|
||||
@@ -33,14 +35,19 @@ 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();
|
||||
if (payload) Serial << ", payload[" << length << "]=[";
|
||||
if (payload)
|
||||
{
|
||||
Serial << ", payload[" << length << "]=[";
|
||||
while(length--)
|
||||
{
|
||||
const char c=*payload++;
|
||||
if (c!=10 and c!=13 and c <32) Serial << '?';
|
||||
Serial << *payload++;
|
||||
if (c<32)
|
||||
Serial << '?';
|
||||
else
|
||||
Serial << c;
|
||||
}
|
||||
Serial << ']' << endl;
|
||||
}
|
||||
Serial<< endl;
|
||||
}
|
||||
|
||||
std::map<std::string, MqttClient*> clients;
|
||||
@@ -673,7 +680,12 @@ void eval(std::string& cmd)
|
||||
else if (compare(s, "broker"))
|
||||
{
|
||||
std::string id=getword(cmd);
|
||||
if (id.length() or brokers.find(id)!=brokers.end())
|
||||
if (clients.find(id) != clients.end())
|
||||
{
|
||||
Serial << "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)
|
||||
@@ -685,16 +697,26 @@ void eval(std::string& cmd)
|
||||
Serial << "new broker (" << id.c_str() << ")" << endl;
|
||||
}
|
||||
else
|
||||
{
|
||||
Serial << "Missing port" << endl;
|
||||
cmd.clear();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
Serial << "Missing or existing broker name (" << id.c_str() << ")" << endl;
|
||||
cmd+=" ls";
|
||||
cmd.clear();
|
||||
}
|
||||
}
|
||||
else if (compare(s, "client"))
|
||||
{
|
||||
std::string id=getword(cmd);
|
||||
if (id.length() or clients.find(id)!=clients.end())
|
||||
if (brokers.find(id) != brokers.end())
|
||||
{
|
||||
Serial << "A broker have that name" << endl;
|
||||
cmd.clear();
|
||||
}
|
||||
else if (id.length() or clients.find(id)!=clients.end())
|
||||
{
|
||||
s=getword(cmd); // broker name
|
||||
if (s=="" or brokers.find(s) != brokers.end())
|
||||
@@ -711,11 +733,14 @@ void eval(std::string& cmd)
|
||||
else if (s.length())
|
||||
{
|
||||
Serial << " not found." << endl;
|
||||
cmd.clear();
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
Serial << "Missing or existing client name" << endl;
|
||||
cmd+=" ls";
|
||||
cmd.clear();
|
||||
}
|
||||
}
|
||||
else if (compare(s, "set"))
|
||||
{
|
||||
@@ -766,7 +791,9 @@ void eval(std::string& cmd)
|
||||
{
|
||||
Serial << "syntax:" << endl;
|
||||
Serial << " MqttBroker:" << endl;
|
||||
Serial << " broker {name} {port} : create a new broker" << endl;
|
||||
Serial << " broker {broker_name} {port} : create a new broker" << endl;
|
||||
Serial << " broker_name.delete : delete a broker (buggy)" << endl;
|
||||
Serial << " broker_name.view : dump a broker" << endl;
|
||||
Serial << endl;
|
||||
Serial << " MqttClient:" << endl;
|
||||
Serial << " client {name} {parent broker} : create a client then" << endl;
|
||||
@@ -775,17 +802,18 @@ void eval(std::string& cmd)
|
||||
Serial << " name.publish [topic][payload]" << endl;
|
||||
Serial << " name.view" << endl;
|
||||
Serial << " name.delete" << endl;
|
||||
Serial << endl;
|
||||
|
||||
automatic::help();
|
||||
Serial << endl;
|
||||
Serial << " help" << endl;
|
||||
Serial << " blink [Dx on_ms off_ms]" << endl;
|
||||
Serial << " blink [Dx on_ms off_ms] : make pin blink" << endl;
|
||||
Serial << " ls / ip / reset" << endl;
|
||||
Serial << " set [name][value]" << endl;
|
||||
Serial << " ! repeat last command" << endl;
|
||||
Serial << endl;
|
||||
Serial << " echo [on|off] or strings" << endl;
|
||||
Serial << " every ms [command]; every list; every remove [nr|all], every (on|off) [#]" << endl;
|
||||
Serial << " every ms [command]; every list; every remove [nr|all]; every (on|off) [#]" << endl;
|
||||
Serial << " on {output}; off {output}" << endl;
|
||||
Serial << " $id : name of the client." << endl;
|
||||
Serial << " rnd[(min[,max])] random number." << endl;
|
||||
@@ -855,11 +883,6 @@ void loop()
|
||||
MDNS.update();
|
||||
#endif
|
||||
|
||||
if (MqttClient::counter != count)
|
||||
{
|
||||
Serial << "# " << MqttClient::counter << endl;
|
||||
count = MqttClient::counter;
|
||||
}
|
||||
for(auto it: brokers)
|
||||
it.second->loop();
|
||||
|
||||
|
||||
18
library.json
18
library.json
@@ -1,18 +0,0 @@
|
||||
{
|
||||
"name": "TinyMqtt",
|
||||
"keywords": "ethernet, mqtt, m2m, iot",
|
||||
"description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive and host a broker for MQTT. It does support MQTT 3.1.1 with QOS=0 on ESP8266 and ESP32 WROOM platfrms.",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/hsaturn/TinyMqtt.git"
|
||||
},
|
||||
"version": "0.8.0",
|
||||
"exclude": "",
|
||||
"examples": "examples/*/*.ino",
|
||||
"frameworks": "arduino",
|
||||
"platforms": [
|
||||
"atmelavr",
|
||||
"espressif8266",
|
||||
"espressif32"
|
||||
]
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
name=TinyMqtt
|
||||
version=0.8.0
|
||||
version=0.9.5
|
||||
author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||
sentence=A tiny broker and client library for MQTT messaging.
|
||||
@@ -8,4 +8,3 @@ category=Communication
|
||||
url=https://github.com/hsaturn/TinyMqtt
|
||||
architectures=*
|
||||
includes=TinyMqtt.h
|
||||
depends=AsyncTCP
|
||||
|
||||
@@ -26,30 +26,7 @@ class StringIndexer
|
||||
#endif
|
||||
};
|
||||
public:
|
||||
using index_t=uint8_t;
|
||||
|
||||
static index_t strToIndex(const char* str, uint8_t len)
|
||||
{
|
||||
for(auto it=strings.begin(); it!=strings.end(); it++)
|
||||
{
|
||||
if (strncmp(it->second.str.c_str(), str, len)==0)
|
||||
{
|
||||
it->second.used++;
|
||||
return it->first;
|
||||
}
|
||||
}
|
||||
for(index_t index=1; index; index++)
|
||||
{
|
||||
if (strings.find(index)==strings.end())
|
||||
{
|
||||
strings[index].str = std::string(str, len);
|
||||
strings[index].used++;
|
||||
// Serial << "Creating index " << index << " for (" << strings[index].str.c_str() << ") len=" << len << endl;
|
||||
return index;
|
||||
}
|
||||
}
|
||||
return 0; // TODO out of indexes
|
||||
}
|
||||
using index_t = uint8_t;
|
||||
|
||||
static const std::string& str(const index_t& index)
|
||||
{
|
||||
@@ -82,6 +59,32 @@ class StringIndexer
|
||||
static uint16_t count() { return strings.size(); }
|
||||
|
||||
private:
|
||||
friend class IndexedString;
|
||||
|
||||
// increment use of str or create a new index
|
||||
static index_t strToIndex(const char* str, uint8_t len)
|
||||
{
|
||||
for(auto it=strings.begin(); it!=strings.end(); it++)
|
||||
{
|
||||
if (it->second.str.length() == len && strcmp(it->second.str.c_str(), str)==0)
|
||||
{
|
||||
it->second.used++;
|
||||
return it->first;
|
||||
}
|
||||
}
|
||||
for(index_t index=1; index; index++)
|
||||
{
|
||||
if (strings.find(index)==strings.end())
|
||||
{
|
||||
strings[index].str = std::string(str, len);
|
||||
strings[index].used++;
|
||||
// Serial << "Creating index " << index << " for (" << strings[index].str.c_str() << ") len=" << len << endl;
|
||||
return index;
|
||||
}
|
||||
}
|
||||
return 0; // TODO out of indexes
|
||||
}
|
||||
|
||||
static std::map<index_t, StringCounter> strings;
|
||||
};
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
MqttBroker::MqttBroker(uint16_t port)
|
||||
{
|
||||
server = new TcpServer(port);
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
server->onClient(onClient, this);
|
||||
#endif
|
||||
}
|
||||
@@ -26,7 +26,7 @@ MqttBroker::~MqttBroker()
|
||||
MqttClient::MqttClient(MqttBroker* parent, TcpClient* new_client)
|
||||
: parent(parent)
|
||||
{
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
client = new_client;
|
||||
client->onData(onData, this);
|
||||
// client->onConnect() TODO
|
||||
@@ -91,7 +91,7 @@ void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
|
||||
client = new TcpClient;
|
||||
|
||||
debug("Trying to connect to " << broker.c_str() << ':' << port);
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
client->onData(onData, this);
|
||||
client->onConnect(onConnect, this);
|
||||
client->connect(broker.c_str(), port);
|
||||
@@ -146,7 +146,7 @@ void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
|
||||
|
||||
void MqttBroker::loop()
|
||||
{
|
||||
#ifndef TCP_ASYNC
|
||||
#ifndef TINY_MQTT_ASYNC
|
||||
WiFiClient client = server->available();
|
||||
|
||||
if (client)
|
||||
@@ -281,7 +281,7 @@ void MqttClient::loop()
|
||||
// there is no need to send one PingReq per instance.
|
||||
}
|
||||
}
|
||||
#ifndef TCP_ASYNC
|
||||
#ifndef TINY_MQTT_ASYNC
|
||||
while(client && client->available()>0)
|
||||
{
|
||||
message.incoming(client->read());
|
||||
@@ -314,7 +314,7 @@ void MqttClient::onConnect(void *mqttclient_ptr, TcpClient*)
|
||||
mqtt->clientAlive(0);
|
||||
}
|
||||
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
void MqttClient::onData(void* client_ptr, TcpClient*, void* data, size_t len)
|
||||
{
|
||||
char* char_ptr = static_cast<char*>(data);
|
||||
@@ -636,10 +636,66 @@ if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::T
|
||||
bool Topic::matches(const Topic& topic) const
|
||||
{
|
||||
if (getIndex() == topic.getIndex()) return true;
|
||||
if (str() == topic.str()) return true;
|
||||
const char* p1 = c_str();
|
||||
const char* p2 = topic.c_str();
|
||||
|
||||
if (p1 == p2) return true;
|
||||
if (*p2 == '$' and *p1 != '$') return false;
|
||||
|
||||
while(*p1 and *p2)
|
||||
{
|
||||
if (*p1 == '+')
|
||||
{
|
||||
++p1;
|
||||
if (*p1 and *p1!='/') return false;
|
||||
if (*p1) ++p1;
|
||||
while(*p2 and *p2++!='/');
|
||||
}
|
||||
else if (*p1 == '#')
|
||||
{
|
||||
if (*++p1==0) return true;
|
||||
return false;
|
||||
}
|
||||
else if (*p1 == '*')
|
||||
{
|
||||
const char c=*(p1+1);
|
||||
if (c==0) return true;
|
||||
if (c!='/') return false;
|
||||
const char*p = p1+2;
|
||||
while(*p and *p2)
|
||||
{
|
||||
if (*p == *p2)
|
||||
{
|
||||
if (*p==0) return true;
|
||||
if (*p=='/')
|
||||
{
|
||||
p1=p;
|
||||
break;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
while(*p2 and *p2++!='/');
|
||||
break;
|
||||
}
|
||||
++p;
|
||||
++p2;
|
||||
}
|
||||
if (*p==0) return true;
|
||||
}
|
||||
else if (*p1 == *p2)
|
||||
{
|
||||
++p1;
|
||||
++p2;
|
||||
}
|
||||
else
|
||||
return false;
|
||||
}
|
||||
if (*p1=='/' and p1[1]=='#' and p1[2]==0) return true;
|
||||
return *p1==0 and *p2==0;
|
||||
}
|
||||
|
||||
|
||||
// publish from local client
|
||||
MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pay_length)
|
||||
{
|
||||
@@ -771,9 +827,18 @@ void MqttMessage::encodeLength()
|
||||
if (state != Complete)
|
||||
{
|
||||
int length = buffer.size()-3; // 3 = 1 byte for header + 2 bytes for pre-reserved length field.
|
||||
if (length <= 0x7F)
|
||||
{
|
||||
buffer.erase(1,1);
|
||||
buffer[1] = length;
|
||||
vheader = 2;
|
||||
}
|
||||
else
|
||||
{
|
||||
buffer[1] = 0x80 | (length & 0x7F);
|
||||
buffer[2] = (length >> 7);
|
||||
vheader = 3;
|
||||
}
|
||||
|
||||
// We could check that buffer[2] < 128 (end of length encoding)
|
||||
state = Complete;
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
#pragma once
|
||||
|
||||
// TODO Should add a AUnit with both TCP_ASYNC and not TCP_ASYNC
|
||||
// #define TCP_ASYNC // Uncomment this to use ESPAsyncTCP instead of normal cnx
|
||||
// TODO Should add a AUnit with both TINY_MQTT_ASYNC and not TINY_MQTT_ASYNC
|
||||
// #define TINY_MQTT_ASYNC // Uncomment this to use ESPAsyncTCP instead of normal cnx
|
||||
|
||||
#if defined(ESP8266) || defined(EPOXY_DUINO)
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
#include <ESPAsyncTCP.h>
|
||||
#else
|
||||
#include <ESP8266WiFi.h>
|
||||
#endif
|
||||
#elif defined(ESP32)
|
||||
#include <WiFi.h>
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
#include <AsyncTCP.h> // https://github.com/me-no-dev/AsyncTCP
|
||||
#endif
|
||||
#endif
|
||||
@@ -20,6 +20,14 @@
|
||||
#else
|
||||
#define dbg_ptr uint32_t
|
||||
#endif
|
||||
|
||||
#ifdef WIO_TERMINAL
|
||||
// Uncommon board handling
|
||||
// If you have a problem with this line, just remove it.
|
||||
// Note: https://github.com/hsaturn/TinyMqtt/issues/41
|
||||
#include <rpcWiFi.h>
|
||||
#endif
|
||||
|
||||
#include <vector>
|
||||
#include <set>
|
||||
#include <string>
|
||||
@@ -34,7 +42,7 @@
|
||||
#define debug(what) {}
|
||||
#endif
|
||||
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
using TcpClient = AsyncClient;
|
||||
using TcpServer = AsyncServer;
|
||||
#else
|
||||
@@ -213,7 +221,6 @@ class MqttClient
|
||||
bool c = false;
|
||||
Serial << " [";
|
||||
for(auto s: subscriptions)
|
||||
(void)indent;
|
||||
{
|
||||
if (c) Serial << ", ";
|
||||
Serial << s.str().c_str();
|
||||
@@ -233,7 +240,7 @@ class MqttClient
|
||||
|
||||
// event when tcp/ip link established (real or fake)
|
||||
static void onConnect(void * client_ptr, TcpClient*);
|
||||
#ifdef TCP_ASYNC
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
static void onData(void* client_ptr, TcpClient*, void* data, size_t len);
|
||||
#endif
|
||||
MqttError sendTopic(const Topic& topic, MqttMessage::Type type, uint8_t qos);
|
||||
|
||||
@@ -5,7 +5,15 @@ tests:
|
||||
$(MAKE) -C $$(dirname $$i) -j; \
|
||||
done
|
||||
|
||||
runtests: tests
|
||||
debugtest:
|
||||
set -e; \
|
||||
$(MAKE) clean; \
|
||||
$(MAKE) -C debug-mode -j; \
|
||||
debug-mode/debug-tests.out
|
||||
|
||||
runtests: debugtest
|
||||
$(MAKE) clean
|
||||
$(MAKE) tests
|
||||
set -e; \
|
||||
for i in *-tests/Makefile; do \
|
||||
echo '==== Running:' $$(dirname $$i); \
|
||||
|
||||
13
tests/debug-mode/Makefile
Normal file
13
tests/debug-mode/Makefile
Normal file
@@ -0,0 +1,13 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
EXTRA_CXXFLAGS=-g3 -O0 -DTINY_MQTT_DEBUG
|
||||
|
||||
# Remove flto flag from EpoxyDuino (too many <optimized out>)
|
||||
CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
|
||||
|
||||
APP_NAME := debug-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
15
tests/debug-mode/debug-tests.ino
Normal file
15
tests/debug-mode/debug-tests.ino
Normal file
@@ -0,0 +1,15 @@
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
#include <iostream>
|
||||
#include <iomanip>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
|
||||
// Only compilation check, so do nothing
|
||||
|
||||
void setup() {}
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
}
|
||||
@@ -1,6 +1,8 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
EXTRA_CXXFLAGS=-g3 -O0
|
||||
|
||||
APP_NAME := length-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
|
||||
@@ -2,6 +2,10 @@
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
#include <iostream>
|
||||
#include <iomanip>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
|
||||
/**
|
||||
* TinyMqtt network unit tests.
|
||||
@@ -10,7 +14,60 @@
|
||||
* Checks with a local broker. Clients must connect to the local broker
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
// 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::stringstream out;
|
||||
std::string ascii;
|
||||
std::string h("0123456789ABCDEF");
|
||||
for(size_t i=0; i<length; i++)
|
||||
{
|
||||
uint8_t c = buffer[i];
|
||||
out << h[ c >> 4] << h[ c & 0x0F ];
|
||||
if (sep) out << sep;
|
||||
if (ascii_pos)
|
||||
{
|
||||
if (c>=32)
|
||||
ascii += c;
|
||||
else
|
||||
ascii +='.';
|
||||
}
|
||||
}
|
||||
std::string ret(out.str());
|
||||
if (ascii_pos)
|
||||
{
|
||||
while(ret.length() < ascii_pos)
|
||||
ret += ' ';
|
||||
ret +='[' + ascii + ']';
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
|
||||
void dumpMqttMessage(const uint8_t* buffer, size_t length)
|
||||
{
|
||||
std::map<int, std::string> pkt =
|
||||
{ { MqttMessage::Unknown , "Unknown " },
|
||||
{ MqttMessage::Connect , "Connect " },
|
||||
{ MqttMessage::ConnAck , "ConnAck " },
|
||||
{ MqttMessage::Publish , "Publish " },
|
||||
{ MqttMessage::PubAck , "PubAck " },
|
||||
{ MqttMessage::Subscribe , "Subscribe " },
|
||||
{ MqttMessage::SubAck , "SubAck " },
|
||||
{ MqttMessage::UnSubscribe , "Unsubscribe " },
|
||||
{ MqttMessage::UnSuback , "UnSubAck " },
|
||||
{ MqttMessage::PingReq , "PingReq " },
|
||||
{ MqttMessage::PingResp , "PingResp " },
|
||||
{ MqttMessage::Disconnect , "Disconnect " } };
|
||||
|
||||
std::cout << " | data sent " << std::setw(3) << length << " : ";
|
||||
auto it = pkt.find(buffer[0] & 0xF0);
|
||||
if (it == pkt.end())
|
||||
std::cout << pkt[MqttMessage::Unknown];
|
||||
else
|
||||
std::cout << it->second;
|
||||
|
||||
std::cout << bufferToHexa(buffer, length, ' ', 60) << std::endl;
|
||||
}
|
||||
|
||||
String toString(const IPAddress& ip)
|
||||
{
|
||||
@@ -299,7 +356,7 @@ test(network_hudge_payload)
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
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
|
||||
@@ -310,6 +367,47 @@ test(network_hudge_payload)
|
||||
assertEqual(strcmp(payload, lastPayload), 0);
|
||||
}
|
||||
|
||||
test(connack)
|
||||
{
|
||||
const bool view = false;
|
||||
|
||||
NetworkObserver check(
|
||||
[this](const WiFiClient*, const uint8_t* buffer, size_t length)
|
||||
{
|
||||
if (view) dumpMqttMessage(buffer, length);
|
||||
if (buffer[0] == MqttMessage::ConnAck)
|
||||
{
|
||||
std::string hex = bufferToHexa(buffer, length);
|
||||
assertStringCaseEqual(hex.c_str(), "20020000");
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
start_servers(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.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
|
||||
assertTrue(broker.clientsCount() == 1);
|
||||
assertTrue(client.connected());
|
||||
|
||||
MqttClient::counters[MqttMessage::Type::SubAck] = 0;
|
||||
client.subscribe("a/b");
|
||||
|
||||
// TODO how to avoid these loops ???
|
||||
broker.loop();
|
||||
client.loop();
|
||||
|
||||
assertEqual(MqttClient::counters[MqttMessage::Type::SubAck], 1);
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// setup() and loop()
|
||||
void setup() {
|
||||
|
||||
@@ -93,6 +93,104 @@ test(nowifi_publish_should_be_dispatched_to_clients)
|
||||
assertEqual(published["B"]["a/c"], 0);
|
||||
}
|
||||
|
||||
test(nowifi_subscribe_with_star_wildcard)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker, "A");
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("house/*/temp");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("house/bedroom/temp");
|
||||
publisher.publish("house/kitchen/temp");
|
||||
publisher.publish("house/living_room/tv/temp");
|
||||
publisher.publish("building/location1/bedroom/temp");
|
||||
|
||||
assertEqual(published["A"]["house/bedroom/temp"], 1);
|
||||
assertEqual(published["A"]["house/kitchen/temp"], 1);
|
||||
assertEqual(published["A"]["house/living_room/tv/temp"], 1);
|
||||
assertEqual(published["A"]["building/location1/bedroom/temp"], 0);
|
||||
}
|
||||
|
||||
test(nowifi_subscribe_with_plus_wildcard)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker, "A");
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("house/+/temp");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("house/bedroom/temp");
|
||||
publisher.publish("house/kitchen/temp");
|
||||
publisher.publish("house/living_room/tv/temp");
|
||||
publisher.publish("building/location1/bedroom/temp");
|
||||
|
||||
assertEqual(published["A"]["house/bedroom/temp"], 1);
|
||||
assertEqual(published["A"]["house/kitchen/temp"], 1);
|
||||
assertEqual(published["A"]["house/living_room/tv/temp"], 0);
|
||||
assertEqual(published["A"]["building/location1/bedroom/temp"], 0);
|
||||
}
|
||||
|
||||
test(nowifi_should_not_receive_sys_msg)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker, "A");
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("+/data");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("$SYS/data");
|
||||
|
||||
assertEqual(published["A"]["$SYS/data"], 0);
|
||||
}
|
||||
|
||||
test(nowifi_subscribe_with_mixed_wildcards)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker, "A");
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("+/data/#");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("node1/data/update");
|
||||
publisher.publish("node2/data/delta");
|
||||
publisher.publish("node3/data");
|
||||
|
||||
assertEqual(published["A"]["node1/data/update"], 1);
|
||||
assertEqual(published["A"]["node2/data/delta"], 1);
|
||||
assertEqual(published["A"]["node3/data"], 1);
|
||||
}
|
||||
|
||||
test(nowifi_unsubscribe_with_wildcards)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker, "A");
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("one/two/+");
|
||||
subscriber.subscribe("one/two/three");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("one/two/three");
|
||||
publisher.publish("one/two/four");
|
||||
|
||||
subscriber.unsubscribe("one/two/+");
|
||||
publisher.publish("one/two/five");
|
||||
|
||||
assertEqual(published["A"]["one/two/three"], 1);
|
||||
assertEqual(published["A"]["one/two/four"], 1);
|
||||
assertEqual(published["A"]["one/two/five"], 0);
|
||||
}
|
||||
|
||||
test(nowifi_unsubscribe)
|
||||
{
|
||||
published.clear();
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
EXTRA_CXXFLAGS=-g3 -O0
|
||||
|
||||
APP_NAME := string-indexer-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
|
||||
@@ -62,6 +62,14 @@ test(indexer_same_strings_should_equal)
|
||||
assertTrue(one == two);
|
||||
}
|
||||
|
||||
test(indexer_compare_strings_with_same_beginning)
|
||||
{
|
||||
IndexedString two("one_two");
|
||||
IndexedString one("one");
|
||||
|
||||
assertNotEqual(one.getIndex(), two.getIndex());
|
||||
}
|
||||
|
||||
test(indexer_indexed_operator_eq)
|
||||
{
|
||||
IndexedString one("one");
|
||||
|
||||
10
tests/topic-tests/Makefile
Normal file
10
tests/topic-tests/Makefile
Normal file
@@ -0,0 +1,10 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
EXTRA_CXXFLAGS=-g3 -O0
|
||||
|
||||
APP_NAME := topic-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
85
tests/topic-tests/topic-tests.ino
Normal file
85
tests/topic-tests/topic-tests.ino
Normal file
@@ -0,0 +1,85 @@
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
#include <iostream>
|
||||
|
||||
#define endl "\n"
|
||||
|
||||
/**
|
||||
* TinyMqtt / StringIndexer unit tests.
|
||||
*
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
|
||||
bool testTopicMatch(const char* a, const char* b, bool expected)
|
||||
{
|
||||
Topic ta(a);
|
||||
Topic tb(b);
|
||||
bool match(ta.matches(tb));
|
||||
cout << " " << ta.c_str() << ' ';
|
||||
if (match != expected)
|
||||
cout << (expected ? " should match " : " should not match ");
|
||||
else
|
||||
cout << (expected ? " matches " : " unmatches ");
|
||||
cout << tb.c_str() << endl;
|
||||
return expected == match;
|
||||
}
|
||||
|
||||
test(topic_matches)
|
||||
{
|
||||
// matching
|
||||
assertTrue(testTopicMatch("a/b/c" , "a/b/c" , true));
|
||||
assertTrue(testTopicMatch("a/*/c" , "a/xyz/c" , true));
|
||||
assertTrue(testTopicMatch("a/*/e" , "a/b/c/d/e" , true));
|
||||
assertTrue(testTopicMatch("a/*" , "a/b/c/d/e" , true));
|
||||
assertTrue(testTopicMatch("*/c" , "a/b/c" , true));
|
||||
assertTrue(testTopicMatch("/*/c" , "/a/b/c" , true));
|
||||
assertTrue(testTopicMatch("a/*" , "a/b/c/d" , true));
|
||||
assertTrue(testTopicMatch("a/+/c" , "a/b/c" , true));
|
||||
assertTrue(testTopicMatch("a/+/c/+/e", "a/b/c/d/e" , true));
|
||||
assertTrue(testTopicMatch("a/*/c/+/e", "a/b/c/d/e" , true));
|
||||
assertTrue(testTopicMatch("/+/b" , "/a/b" , true));
|
||||
assertTrue(testTopicMatch("+" , "a" , true));
|
||||
assertTrue(testTopicMatch("a/b/#" , "a/b/c/d" , true));
|
||||
assertTrue(testTopicMatch("a/b/#" , "a/b" , true));
|
||||
assertTrue(testTopicMatch("a/*/c" , "a/*/c" , true));
|
||||
|
||||
// not matching
|
||||
assertTrue(testTopicMatch("a/b/c" , "a/b/d" , false));
|
||||
assertTrue(testTopicMatch("a/b/c" , "a/b/d" , false));
|
||||
assertTrue(testTopicMatch("a/*/e" , "a/b/c/d/f" , false));
|
||||
assertTrue(testTopicMatch("a/+" , "a" , false));
|
||||
assertTrue(testTopicMatch("a/+" , "a/b/d" , false));
|
||||
assertTrue(testTopicMatch("a/+/" , "a/" , false));
|
||||
|
||||
// $SYS topics
|
||||
assertTrue(testTopicMatch("+/any" , "$SYS/any" , false));
|
||||
assertTrue(testTopicMatch("*/any" , "$SYS/any" , false));
|
||||
assertTrue(testTopicMatch("$SYS/any" , "$SYS/any" , true));
|
||||
assertTrue(testTopicMatch("$SYS/+/y" , "$SYS/a/y" , true));
|
||||
assertTrue(testTopicMatch("$SYS/#" , "$SYS/a/y" , true));
|
||||
|
||||
// not valid
|
||||
assertTrue(testTopicMatch("a/#/b" , "a/x/b" , false));
|
||||
assertTrue(testTopicMatch("a+" , "a/b/d" , false));
|
||||
assertTrue(testTopicMatch("a/b/#/d" , "a/b/c/d" , false));
|
||||
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// 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