Compare commits
166 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a52497d292 | ||
|
|
4fbfe78e53 | ||
|
|
6f93c09e2f | ||
|
|
28d54b64c9 | ||
|
|
95de4646df | ||
|
|
84d30b6343 | ||
|
|
f38cc536b8 | ||
|
|
f498995aee | ||
|
|
8e44e610b3 | ||
|
|
e66eb7aa6a | ||
|
|
4b4e72905e | ||
|
|
a717ecd66d | ||
|
|
aa62bcaf02 | ||
|
|
90435b1260 | ||
|
|
ac391a49a4 | ||
|
|
30e75b82e0 | ||
|
|
65e22c85c6 | ||
|
|
bd566945cc | ||
|
|
66cb80ff3f | ||
|
|
ef4a0263a6 | ||
|
|
3135d9a28c | ||
|
|
6b9d764c23 | ||
|
|
42d89cdf06 | ||
|
|
67ce97e523 | ||
|
|
25602ec2f5 | ||
|
|
fd305d7b48 | ||
|
|
6339be8044 | ||
|
|
d3bf379d19 | ||
|
|
3c77f7cafd | ||
|
|
ff3ff6e80e | ||
|
|
c4cc36a88f | ||
|
|
14882fed22 | ||
|
|
ead3ae90e9 | ||
|
|
5d07294fde | ||
|
|
088071d17f | ||
|
|
e41452edf0 | ||
|
|
f8a2e35dd9 | ||
|
|
43dbea1f17 | ||
|
|
02496bef73 | ||
|
|
e4ad27c805 | ||
|
|
37fb46ec3b | ||
|
|
245e74666e | ||
|
|
294657f2ca | ||
|
|
bf84e29831 | ||
|
|
0c7c830a26 | ||
|
|
6e601228e6 | ||
|
|
46798ff0de | ||
|
|
45fedf84c9 | ||
|
|
f9c8dca1e5 | ||
|
|
7e1586c0b5 | ||
|
|
123c5a8fa5 | ||
|
|
21fb01848d | ||
|
|
66b1e71ee2 | ||
|
|
e5115087ea | ||
|
|
cc004875b5 | ||
|
|
58ae2436d3 | ||
|
|
cda94368a7 | ||
|
|
0126a39327 | ||
|
|
2587371457 | ||
|
|
a880a1ff2f | ||
|
|
143d57db2d | ||
|
|
2a8dbd09c5 | ||
|
|
00333ed805 | ||
|
|
9228408f57 | ||
|
|
1653b2e386 | ||
|
|
775fbc14ee | ||
|
|
c21b7b63fb | ||
|
|
e45af112c2 | ||
|
|
f9c539ff6a | ||
|
|
7dc23d322c | ||
|
|
4fb632ce3d | ||
|
|
c9130c7a24 | ||
|
|
31c51aeaff | ||
|
|
2eeda4ecab | ||
|
|
787cb77a26 | ||
|
|
d324a913ec | ||
|
|
ac1eedd72a | ||
|
|
0900e799a9 | ||
|
|
2086c7f0e7 | ||
|
|
72382bf351 | ||
|
|
3fec7b87a8 | ||
|
|
8641627742 | ||
|
|
3b2460572b | ||
|
|
a0435b2cfb | ||
|
|
bda041417d | ||
|
|
baffda8a6d | ||
|
|
09e3a3e45f | ||
|
|
f17ece3376 | ||
|
|
0db07df27b | ||
|
|
292592c3dd | ||
|
|
1f267c135b | ||
|
|
2b92833ea5 | ||
|
|
42fc054c94 | ||
|
|
7f12ecfd6d | ||
|
|
3ae1afec27 | ||
|
|
9608ed9fdf | ||
|
|
220e904ae9 | ||
|
|
49b696315c | ||
|
|
a9ebf31e6f | ||
|
|
4b4eb0b684 | ||
|
|
18ce34c458 | ||
|
|
70ca3787bb | ||
|
|
396e3fde95 | ||
|
|
c913bc61bb | ||
|
|
7af8e46b59 | ||
|
|
0569bc6000 | ||
|
|
708a2b41dc | ||
|
|
c4edfb6e40 | ||
|
|
cf724507e9 | ||
|
|
744a590467 | ||
|
|
5a3e9bd90e | ||
|
|
d8b24adef7 | ||
|
|
4726ff293c | ||
|
|
2a4e84d827 | ||
|
|
9ef47fa6a4 | ||
|
|
3358340319 | ||
|
|
1fff9fd0e1 | ||
|
|
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 | ||
|
|
da3ec41d71 | ||
|
|
5f7b4537c8 | ||
|
|
cce4fecac6 | ||
|
|
737e217172 | ||
|
|
8fe3517894 | ||
|
|
710503663a | ||
|
|
a5b8afc0bd | ||
|
|
f1d3a15498 | ||
|
|
dfd5983715 | ||
|
|
4dcc6a6cf4 | ||
|
|
b58f3e3d67 | ||
|
|
a6b3540cb8 | ||
|
|
ccbf42f81b | ||
|
|
d39c58d8f5 | ||
|
|
36dde2c063 | ||
|
|
64a05bb60b | ||
|
|
bb89fc5284 | ||
|
|
c1fd1bc907 | ||
|
|
d919188eb0 | ||
|
|
9c7f3b6b8e | ||
|
|
88c7d552cb |
7
.github/workflows/aunit.yml
vendored
7
.github/workflows/aunit.yml
vendored
@@ -9,7 +9,7 @@ on: [push]
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-18.04
|
||||
runs-on: ubuntu-20.04
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
@@ -17,9 +17,10 @@ jobs:
|
||||
- name: Setup
|
||||
run: |
|
||||
cd ..
|
||||
git clone https://github.com/bxparks/EpoxyDuino
|
||||
git clone https://github.com/hsaturn/TinyConsole
|
||||
git clone https://github.com/hsaturn/EpoxyDuino
|
||||
git clone https://github.com/bxparks/AceRoutine
|
||||
git clone https://github.com/bxparks/AUnit
|
||||
git clone https://github.com/hsaturn/AUnit
|
||||
git clone https://github.com/bxparks/AceCommon
|
||||
git clone https://github.com/hsaturn/EspMock
|
||||
- name: Verify tests
|
||||
|
||||
2
.github/workflows/ci.yml
vendored
2
.github/workflows/ci.yml
vendored
@@ -1,6 +1,6 @@
|
||||
name: "CI"
|
||||
on:
|
||||
|
||||
|
||||
jobs:
|
||||
ci:
|
||||
runs-on: ubuntu-20.04
|
||||
|
||||
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 }}
|
||||
|
||||
43
README.md
43
README.md
@@ -10,18 +10,41 @@
|
||||
|
||||
TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32 / Esp WROOM
|
||||
|
||||
### Statuses of all unit tests of TinyMqtt and its dependencies
|
||||
|
||||
| Project | Unit tests result |
|
||||
| ----------- | ------------ |
|
||||
| TinyMqtt | [](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml) |
|
||||
| Dependencies ||
|
||||
| TinyConsole | [](https://github.com/hsaturn/TinyConsole/actions/workflows/aunit.yml) |
|
||||
| EpoxyDuino | [](https://github.com/hsaturn/EpoxyDuino/actions/workflows/aunit_tests.yml) |
|
||||
| EspMock | [](https://github.com/hsaturn/EspMock/actions/workflows/aunit.yml) |
|
||||
| AUnit | [](https://github.com/hsaturn/AUnit/actions/workflows/aunit_tests.yml) |
|
||||
| AceRoutine | [](https://github.com/bxparks/AceRoutine/actions/workflows/aunit_tests.yml) |
|
||||
|
||||
## Features
|
||||
|
||||
- Very (very !!) fast broker I saw it re-sent 1000 topics per second for two
|
||||
- Supports retained messages (not activated by default)
|
||||
- Async Wifi compatible (me-no-dev/ESPAsyncTCP@^1.2.2)
|
||||
- Very fast broker I saw it re-sent 1000 topics per second for two
|
||||
clients that had subscribed (payload ~15 bytes ESP8266). 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
|
||||
- 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,14 +56,22 @@ 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.
|
||||
|
||||
## Retained messages
|
||||
|
||||
Qos 1 is not supported, but retained messages are. So a new subscription is able to send old messages.
|
||||
This feature is disabled by default.
|
||||
The default retain parameter of MqttBroker::MqttBroker takes an optional (0 by default) number of retained messages.
|
||||
MqttBroker::retain(n) will also make the broker store n messages at max.
|
||||
|
||||
## Standalone mode (zeroconf)
|
||||
-> The zeroconf mode is not yet implemented
|
||||
zeroconf clients to connect to broker on local network.
|
||||
@@ -59,7 +90,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)
|
||||
|
||||
|
||||
74
bump_version.sh
Executable file
74
bump_version.sh
Executable file
@@ -0,0 +1,74 @@
|
||||
#!/bin/bash
|
||||
current_version=$(git describe --tags --abbrev=0)
|
||||
|
||||
function error
|
||||
{
|
||||
echo
|
||||
echo "ERROR *** $1"
|
||||
}
|
||||
if [ "$1" == "-d" ]; then
|
||||
do=0
|
||||
shift
|
||||
else
|
||||
do=1
|
||||
fi
|
||||
if [ "$1" == "" ]; then
|
||||
echo
|
||||
echo "Syntax: $0 [-d] {new_version} [commit message]"
|
||||
echo
|
||||
echo " -d : dry run, generate json and update properties but do not run git commands"
|
||||
echo ""
|
||||
echo " Current version: $current_version"
|
||||
echo
|
||||
else
|
||||
tm=$(git status --porcelain -- src/TinyMqtt.h | wc -l)
|
||||
echo "Current version: ($current_version)"
|
||||
echo "New version : ($1)"
|
||||
echo "Take info from : library.properties"
|
||||
if [ "$tm" == "1" ]; then
|
||||
error "You cannot bump version if TinyMqtt.h is modified"
|
||||
exit
|
||||
fi
|
||||
echo -n "Do you want to proceed ? "
|
||||
read a
|
||||
if [ "$a" == "y" ]; then
|
||||
echo "Doing this..."
|
||||
grep $current_version library.properties
|
||||
if [ "$?" == "0" ]; then
|
||||
sed -i "s/$current_version/$1/" library.properties
|
||||
sed -i "s/#define TINY_MQTT_REVISION/#define TINY_MQTT_REVISION \"$1\"/" src/TinyMqtt.h
|
||||
|
||||
cp library.json.skeleton library.json
|
||||
while ifs= read -r line; do
|
||||
name=$(echo "$line" | sed "s/=.*//g")
|
||||
value=$(echo "$line" | cut -d= -f 2 | sed 's/"//g')
|
||||
echo " Replacing $name in json"
|
||||
if [ "$name" == "depends" ]; then
|
||||
depends=$(echo "$value" | sed "s/,/ /g")
|
||||
echo " Depends=$depends"
|
||||
fi
|
||||
sed -i "s@#$name@$value@g" library.json
|
||||
done < library.properties
|
||||
deps=""
|
||||
for depend in $depends; do
|
||||
if [ "$deps" != "" ]; then
|
||||
deps="$deps, "
|
||||
fi
|
||||
deps="$deps'$depend' : '*'"
|
||||
done
|
||||
sed -i "s@#dependencies@$deps@g" library.json
|
||||
sed -i "s/'/\"/g" library.json
|
||||
if [ "$do" == "1" ]; then
|
||||
echo "Pushing all"
|
||||
git add library.properties
|
||||
git add library.json
|
||||
git commit -m "Release $1 $2"
|
||||
git tag $1
|
||||
git push
|
||||
git push --tags
|
||||
fi
|
||||
else
|
||||
error "Current version does not match library.property version, aborting"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
@@ -0,0 +1,111 @@
|
||||
#include <SPI.h>
|
||||
#include <Ethernet.h>
|
||||
|
||||
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
|
||||
|
||||
#define WIZRST D3 //Specify pin to use for reseting W5500
|
||||
#define WIZCS D1 //Specify the pin for SPI CS
|
||||
|
||||
#define PORT 1883
|
||||
MqttBroker broker(PORT);
|
||||
unsigned long Time;
|
||||
unsigned long freeRam;
|
||||
|
||||
/** Basic Mqtt Broker
|
||||
*
|
||||
* +-----------------------------+
|
||||
* | ESP |
|
||||
* | +--------+ |
|
||||
* | | broker | | 1883 <--- External client/s
|
||||
* | +--------+ |
|
||||
* | |
|
||||
* +-----------------------------+
|
||||
*
|
||||
* Your ESP will become a MqttBroker.
|
||||
* You can test it with any client such as mqtt-spy for example
|
||||
*
|
||||
*/
|
||||
|
||||
#if defined(USE_ETHERNET)
|
||||
|
||||
byte mac[] = { 0x00, 0xAA, 0xBB, 0xE0, 0x01, 0x25 }; //MAC Address
|
||||
//IPAddress ip = (192,168,0,88); //Fixed IP Address
|
||||
|
||||
#else
|
||||
|
||||
const char* ssid = "xxxxxxx";
|
||||
const char* password = "xxxxxxxx";
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
void WizReset() {
|
||||
Serial.print("Resetting Wiz W5500 Ethernet Board... ");
|
||||
pinMode(WIZRST, OUTPUT);
|
||||
digitalWrite(WIZRST, HIGH);
|
||||
delay(250);
|
||||
digitalWrite(WIZRST, LOW);
|
||||
delay(50);
|
||||
digitalWrite(WIZRST, HIGH);
|
||||
delay(350);
|
||||
Serial.println("Done.");
|
||||
}
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(115200);
|
||||
|
||||
#if defined(USE_ETHERNET)
|
||||
|
||||
Ethernet.init(WIZCS); // SPI CS Pin
|
||||
SPI.begin();
|
||||
WizReset();
|
||||
Console << TinyConsole::green << "Starting Ethernet...." << endl;
|
||||
Ethernet.begin(mac); //Connect using DHCP
|
||||
//Ethernet.begin(mac,ip); //Connect using Fixed IP
|
||||
if (Ethernet.hardwareStatus() == EthernetNoHardware) {
|
||||
Console << TinyConsole::red << "Ethernet shield was not found. Sorry, can't run without hardware. :(" << endl;
|
||||
} else
|
||||
if (Ethernet.linkStatus() == LinkOFF) {
|
||||
Console << TinyConsole::red << "Ethernet cable is not connected." << endl;
|
||||
}
|
||||
Console << TinyConsole::green << "Local Ethernet IP address: " << Ethernet.localIP() << endl;
|
||||
broker.begin();
|
||||
Console << "Broker ready (eth) : " << Ethernet.localIP() << " on port " << PORT << endl;
|
||||
|
||||
#else
|
||||
|
||||
if (strlen(ssid)==0)
|
||||
Console << TinyConsole::red << "****** PLEASE MODIFY ssid/password *************" << endl;
|
||||
WiFi.disconnect(); //Remove previous SSID & Password
|
||||
WiFi.begin(ssid, password); // Connect to the network
|
||||
Console << TinyConsole::white << "WiFi Connecting to " << ssid << " ...";
|
||||
int i = 0;
|
||||
while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
|
||||
delay(1000);
|
||||
Console << TinyConsole::white << ".";
|
||||
i++;
|
||||
if (i > 20) break;
|
||||
}
|
||||
Console << endl << endl;
|
||||
Console << TinyConsole::green << "Connected to " << ssid << " IP address: " << WiFi.localIP() << endl;
|
||||
broker.begin();
|
||||
Console << "Broker ready (wifi) : " << WiFi.localIP() << " on port " << PORT << endl;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
broker.loop();
|
||||
if(millis()-Time>10000) {
|
||||
Time=millis();
|
||||
if(ESP.getFreeHeap()!=freeRam)
|
||||
{
|
||||
freeRam=ESP.getFreeHeap();
|
||||
Serial.print("RAM:");
|
||||
Serial.println(freeRam);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,117 @@
|
||||
#include <SPI.h>
|
||||
#include <Ethernet.h>
|
||||
|
||||
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
|
||||
|
||||
#define WIZRST 20 //Specify pin to use for reseting W5500 = GPIO20
|
||||
#define WIZCS 17 //Specify the pin for SPI CS = GPIO17 = D5
|
||||
|
||||
#define PORT 1883
|
||||
MqttBroker broker(PORT);
|
||||
unsigned long Time;
|
||||
unsigned long freeRam;
|
||||
|
||||
/** Basic Mqtt Broker
|
||||
*
|
||||
* +-----------------------------+
|
||||
* | ESP |
|
||||
* | +--------+ |
|
||||
* | | broker | | 1883 <--- External client/s
|
||||
* | +--------+ |
|
||||
* | |
|
||||
* +-----------------------------+
|
||||
*
|
||||
* Your ESP will become a MqttBroker.
|
||||
* You can test it with any client such as mqtt-spy for example
|
||||
*
|
||||
*/
|
||||
|
||||
#if defined(USE_ETHERNET)
|
||||
|
||||
byte mac[] = { 0x00, 0xAA, 0xBB, 0xE0, 0x01, 0x25 }; //MAC Address
|
||||
//IPAddress ip = (192,168,0,88); //Fixed IP Address
|
||||
|
||||
#else
|
||||
|
||||
const char* ssid = "xxxxxxx";
|
||||
const char* password = "xxxxxxxx";
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
void WizReset() {
|
||||
Serial.print("Resetting Wiz W5500 Ethernet Board... ");
|
||||
pinMode(WIZRST, OUTPUT);
|
||||
digitalWrite(WIZRST, HIGH);
|
||||
delay(250);
|
||||
digitalWrite(WIZRST, LOW);
|
||||
delay(50);
|
||||
digitalWrite(WIZRST, HIGH);
|
||||
delay(350);
|
||||
Serial.println("Done.");
|
||||
}
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(115200);
|
||||
|
||||
#if defined(USE_ETHERNET)
|
||||
|
||||
Ethernet.init(WIZCS);
|
||||
SPI.begin();
|
||||
WizReset();
|
||||
Console << TinyConsole::green << "Starting Ethernet...." << endl;
|
||||
Ethernet.begin(mac); //Connect using DHCP
|
||||
//Ethernet.begin(mac,ip); //Connect using Fixed IP
|
||||
if (Ethernet.hardwareStatus() == EthernetNoHardware) {
|
||||
Console << TinyConsole::red << "Ethernet shield was not found. Sorry, can't run without hardware. :(" << endl;
|
||||
} else
|
||||
if (Ethernet.linkStatus() == LinkOFF) {
|
||||
Console << TinyConsole::red << "Ethernet cable is not connected." << endl;
|
||||
}
|
||||
Console << TinyConsole::green << "Local Ethernet IP address: " << Ethernet.localIP() << endl;
|
||||
broker.begin();
|
||||
Console << "Broker ready (eth) : " << Ethernet.localIP() << " on port " << PORT << endl;
|
||||
|
||||
#else
|
||||
|
||||
if (strlen(ssid)==0)
|
||||
Console << TinyConsole::red << "****** PLEASE MODIFY ssid/password *************" << endl;
|
||||
WiFi.disconnect(); //Remove previous SSID & Password
|
||||
WiFi.begin(ssid, password); // Connect to the network
|
||||
Console << TinyConsole::white << "WiFi Connecting to " << ssid << " ...";
|
||||
int i = 0;
|
||||
while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
|
||||
delay(1000);
|
||||
Console << TinyConsole::white << ".";
|
||||
i++;
|
||||
if (i > 20) break;
|
||||
}
|
||||
Console << endl << endl;
|
||||
Console << TinyConsole::green << "Connected to " << ssid << " IP address: " << WiFi.localIP() << endl;
|
||||
broker.begin();
|
||||
Console << "Broker ready (wifi) : " << WiFi.localIP() << " on port " << PORT << endl;
|
||||
|
||||
#endif
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
broker.loop();
|
||||
if(millis()-Time>10000) {
|
||||
Time=millis();
|
||||
#ifdef ARDUINO_ARCH_RP2040
|
||||
if(rp2040.getFreeHeap()!=freeRam) {
|
||||
freeRam=rp2040.getFreeHeap();
|
||||
#else
|
||||
if(ESP.getFreeHeap()!=freeRam) {
|
||||
freeRam=ESP.getFreeHeap();
|
||||
#endif
|
||||
|
||||
|
||||
Serial.print("RAM:");
|
||||
Serial.println(freeRam);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
5
examples/W5500/client-with-W5500-RP2040/readme
Normal file
5
examples/W5500/client-with-W5500-RP2040/readme
Normal file
@@ -0,0 +1,5 @@
|
||||
In TinyString.h the operator
|
||||
|
||||
TinyString& operator +=(int);
|
||||
|
||||
may need to be added.
|
||||
134
examples/advanced/mqtt_class_binder/mqtt_class_binder.ino
Normal file
134
examples/advanced/mqtt_class_binder/mqtt_class_binder.ino
Normal file
@@ -0,0 +1,134 @@
|
||||
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
||||
#include <MqttClassBinder.h>
|
||||
|
||||
/**
|
||||
* Example on how to bind a class:onPublish function
|
||||
*
|
||||
* Local broker that accept connections and two local clients
|
||||
*
|
||||
*
|
||||
* +-----------------------------+
|
||||
* | ESP |
|
||||
* | +--------+ | 1883 <--- External client/s
|
||||
* | +-------->| broker | | 1883 <--- External client/s
|
||||
* | | +--------+ |
|
||||
* | | ^ |
|
||||
* | | | |
|
||||
* | | | | -----
|
||||
* | v v | ---
|
||||
* | +----------+ +----------+ | -
|
||||
* | | internal | | internal | +-------* Wifi
|
||||
* | | client | | client | |
|
||||
* | +----------+ +----------+ |
|
||||
* | |
|
||||
* +-----------------------------+
|
||||
*
|
||||
* pros - Reduces internal latency (when publish is received by the same ESP)
|
||||
* - Reduces wifi traffic
|
||||
* - No need to have an external broker
|
||||
* - can still report to a 'main' broker (TODO see documentation that have to be written)
|
||||
* - accepts external clients
|
||||
* - MqttClassBinder allows to mix together many mqtt sources
|
||||
*
|
||||
* cons - Takes more memory (24 more bytes for the one MqttClassBinder<Class>
|
||||
* - a bit hard to understand
|
||||
*
|
||||
*/
|
||||
|
||||
const char *ssid = "";
|
||||
const char *password = "";
|
||||
|
||||
std::string topic_b="sensor/btemp";
|
||||
std::string topic_sender= "sensor/counter";
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
MqttClient mqtt_a(&broker);
|
||||
MqttClient mqtt_b(&broker);
|
||||
MqttClient mqtt_sender(&broker);
|
||||
|
||||
class MqttReceiver: public MqttClassBinder<MqttReceiver>
|
||||
{
|
||||
public:
|
||||
|
||||
void onPublish(const MqttClient* source, const Topic& topic, const char* payload, size_t /* length */)
|
||||
{
|
||||
Serial
|
||||
<< " * MqttReceiver received topic (" << topic.c_str() << ")"
|
||||
<< " from (" << source->id() << "), "
|
||||
<< " payload: (" << payload << ')' << endl;
|
||||
}
|
||||
};
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(115200);
|
||||
delay(500);
|
||||
Serial << "Clients with wifi " << endl;
|
||||
|
||||
WiFi.mode(WIFI_STA);
|
||||
WiFi.begin(ssid, password);
|
||||
|
||||
while (WiFi.status() != WL_CONNECTED)
|
||||
{
|
||||
Serial << '-'; delay(500);
|
||||
if (strlen(ssid)==0)
|
||||
Serial << "****** PLEASE EDIT THE EXAMPLE AND MODIFY ssid/password *************" << endl;
|
||||
}
|
||||
|
||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||
|
||||
broker.begin();
|
||||
|
||||
MqttReceiver* receiver = new MqttReceiver;
|
||||
|
||||
// receiver will receive both publication from two MqttClient
|
||||
// (that could be connected to two different brokers)
|
||||
MqttClassBinder<MqttReceiver>::onPublish(&mqtt_a, receiver);
|
||||
MqttClassBinder<MqttReceiver>::onPublish(&mqtt_b, receiver);
|
||||
|
||||
mqtt_a.id("mqtt_a");
|
||||
mqtt_b.id("mqtt_b");
|
||||
mqtt_sender.id("sender");
|
||||
|
||||
mqtt_a.subscribe(topic_b);
|
||||
mqtt_b.subscribe(topic_sender);
|
||||
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
broker.loop(); // Don't forget to add loop for every broker and clients
|
||||
|
||||
mqtt_a.loop();
|
||||
mqtt_b.loop();
|
||||
mqtt_sender.loop();
|
||||
|
||||
// ============= client A publish ================
|
||||
{
|
||||
static const int interval = 5000; // publishes every 5s (please avoid usage of delay())
|
||||
static uint32_t timer = millis() + interval;
|
||||
|
||||
if (millis() > timer)
|
||||
{
|
||||
static int counter = 0;
|
||||
Serial << "Sender is publishing " << topic_sender.c_str() << endl;
|
||||
timer += interval;
|
||||
mqtt_sender.publish(topic_sender, "sent by Sender, message #"+std::string(String(counter++).c_str()));
|
||||
}
|
||||
}
|
||||
|
||||
// ============= client B publish ================
|
||||
{
|
||||
static const int interval = 7000; // will send topic each 7s
|
||||
static uint32_t timer = millis() + interval;
|
||||
static int temperature;
|
||||
|
||||
if (millis() > timer)
|
||||
{
|
||||
Serial << "B is publishing " << topic_b.c_str() << endl;
|
||||
timer += interval;
|
||||
mqtt_b.publish(topic_b, "sent by B: temp="+std::string(String(16+temperature++%6).c_str()));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,9 +1,9 @@
|
||||
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
||||
|
||||
/**
|
||||
/**
|
||||
* Local broker that accept connections and two local clients
|
||||
*
|
||||
*
|
||||
*
|
||||
* +-----------------------------+
|
||||
* | ESP |
|
||||
* | +--------+ | 1883 <--- External client/s
|
||||
@@ -12,14 +12,14 @@
|
||||
* | | ^ |
|
||||
* | | | |
|
||||
* | | | | -----
|
||||
* | v v | ---
|
||||
* | +----------+ +----------+ | -
|
||||
* | v v | ---
|
||||
* | +----------+ +----------+ | -
|
||||
* | | internal | | internal | +-------* Wifi
|
||||
* | | client | | client | |
|
||||
* | +----------+ +----------+ |
|
||||
* | | client | | client | |
|
||||
* | +----------+ +----------+ |
|
||||
* | |
|
||||
* +-----------------------------+
|
||||
*
|
||||
*
|
||||
* pros - Reduces internal latency (when publish is received by the same ESP)
|
||||
* - Reduces wifi traffic
|
||||
* - No need to have an external broker
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
||||
|
||||
/** TinyMQTT allows a disconnected mode:
|
||||
*
|
||||
*
|
||||
* +-----------------------------+
|
||||
* | ESP |
|
||||
* | +--------+ |
|
||||
@@ -12,8 +12,8 @@
|
||||
* | v v |
|
||||
* | +----------+ +----------+ |
|
||||
* | | internal | | internal | |
|
||||
* | | client | | client | |
|
||||
* | +----------+ +----------+ |
|
||||
* | | client | | client | |
|
||||
* | +----------+ +----------+ |
|
||||
* | |
|
||||
* +-----------------------------+
|
||||
*
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
|
||||
|
||||
#define PORT 1883
|
||||
MqttBroker broker(PORT);
|
||||
const uint16_t PORT = 1883;
|
||||
const uint8_t RETAIN = 10; // Max retained messages
|
||||
|
||||
MqttBroker broker(PORT, RETAIN);
|
||||
|
||||
/** Basic Mqtt Broker
|
||||
*
|
||||
* +-----------------------------+
|
||||
* | ESP |
|
||||
* | +--------+ |
|
||||
* | +--------+ |
|
||||
* | | broker | | 1883 <--- External client/s
|
||||
* | +--------+ |
|
||||
* | |
|
||||
@@ -15,30 +17,32 @@ MqttBroker broker(PORT);
|
||||
*
|
||||
* Your ESP will become a MqttBroker.
|
||||
* You can test it with any client such as mqtt-spy for example
|
||||
*
|
||||
*
|
||||
* Messages are retained *only* if retain > 0
|
||||
*
|
||||
*/
|
||||
|
||||
const char* ssid = "";
|
||||
const char* password = "";
|
||||
|
||||
void setup()
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(115200);
|
||||
|
||||
if (strlen(ssid)==0)
|
||||
Serial << "****** PLEASE MODIFY ssid/password *************" << endl;
|
||||
Console << TinyConsole::red << "****** PLEASE MODIFY ssid/password *************" << endl;
|
||||
|
||||
WiFi.mode(WIFI_STA);
|
||||
WiFi.begin(ssid, password);
|
||||
|
||||
while (WiFi.status() != WL_CONNECTED) {
|
||||
|
||||
while (WiFi.status() != WL_CONNECTED) {
|
||||
Serial << '.';
|
||||
delay(500);
|
||||
}
|
||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||
Console << TinyConsole::green << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||
|
||||
broker.begin();
|
||||
Serial << "Broker ready : " << WiFi.localIP() << " on port " << PORT << endl;
|
||||
Console << "Broker ready : " << WiFi.localIP() << " on port " << PORT << endl;
|
||||
}
|
||||
|
||||
void loop()
|
||||
|
||||
@@ -1,21 +1,22 @@
|
||||
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
|
||||
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
|
||||
#include "TinyStreaming.h" // https://github.com/hsaturn/TinyConsole
|
||||
|
||||
/** Simple Client (The simplest configuration)
|
||||
/** Simple Client (The simplest configuration, client only sends topics)
|
||||
*
|
||||
*
|
||||
* +--------+
|
||||
*
|
||||
* +--------+
|
||||
* +------>| broker |<--- < Other client
|
||||
* | +--------+
|
||||
* |
|
||||
* | +--------+
|
||||
* |
|
||||
* +-----------------+
|
||||
* | ESP | |
|
||||
* | +----------+ |
|
||||
* | | internal | |
|
||||
* | | client | |
|
||||
* | +----------+ |
|
||||
* | ESP | |
|
||||
* | +----------+ |
|
||||
* | | internal | |
|
||||
* | | client | |
|
||||
* | +----------+ |
|
||||
* | |
|
||||
* +-----------------+
|
||||
*
|
||||
*
|
||||
* 1 - change the ssid/password
|
||||
* 2 - change BROKER values (or keep emqx.io test broker)
|
||||
* 3 - you can use mqtt-spy to connect to the same broker and
|
||||
@@ -38,7 +39,7 @@ const char* password = "";
|
||||
static float temp=19;
|
||||
static MqttClient client;
|
||||
|
||||
void setup()
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(115200);
|
||||
delay(500);
|
||||
@@ -49,13 +50,13 @@ void setup()
|
||||
|
||||
WiFi.mode(WIFI_STA);
|
||||
WiFi.begin(ssid, password);
|
||||
|
||||
|
||||
while (WiFi.status() != WL_CONNECTED)
|
||||
{ delay(500); Serial << '.'; }
|
||||
|
||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||
|
||||
client.connect(BROKER, BROKER_PORT); // Put here your broker ip / port
|
||||
client.connect(BROKER, BROKER_PORT);
|
||||
}
|
||||
|
||||
void loop()
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,12 +1,14 @@
|
||||
{
|
||||
"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.",
|
||||
"keywords": [ "ethernet, mqtt, m2m, iot" ],
|
||||
"description": "A lightweight MQTT library for ESP8266 and ESP32, supporting MQTT 3.1.1 with QoS and allowing to create a Mqtt broker",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/hsaturn/TinyMqtt.git"
|
||||
},
|
||||
"version": "0.7.6",
|
||||
"dependencies":
|
||||
{ "hsaturn/TinyConsole" : "*" },
|
||||
"version": "1.1.4",
|
||||
"exclude": "",
|
||||
"examples": "examples/*/*.ino",
|
||||
"frameworks": "arduino",
|
||||
|
||||
20
library.json.skeleton
Normal file
20
library.json.skeleton
Normal file
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"name": "#name",
|
||||
"keywords": [ "ethernet, mqtt, m2m, iot" ],
|
||||
"description": "#paragraph",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/hsaturn/TinyMqtt.git"
|
||||
},
|
||||
"dependencies":
|
||||
{ #dependencies },
|
||||
"version": "#version",
|
||||
"exclude": "",
|
||||
"examples": "examples/*/*.ino",
|
||||
"frameworks": "arduino",
|
||||
"platforms": [
|
||||
"atmelavr",
|
||||
"espressif8266",
|
||||
"espressif32"
|
||||
]
|
||||
}
|
||||
@@ -1,11 +1,11 @@
|
||||
name=TinyMqtt
|
||||
version=0.7.6
|
||||
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 to send and receive MQTT messages and to host a broker in your ESP 8266 and 32 WROOM. It does support MQTT 3.1.1 with QoS=0.
|
||||
version=1.1.4
|
||||
author=HSaturn, <hsaturn@gmail.com>
|
||||
maintainer=HSaturn <hsaturn@gmail.com>
|
||||
sentence=A lightweight broker and client Mqtt library for Arduino and ESP.
|
||||
paragraph=TinyMqtt supports MQTT 3.1.1 with QoS and allows to create a Mqtt broker
|
||||
category=Communication
|
||||
url=https://github.com/hsaturn/TinyMqtt
|
||||
architectures=*
|
||||
depends=hsaturn/TinyConsole
|
||||
includes=TinyMqtt.h
|
||||
depends=AsyncTCP
|
||||
|
||||
72
src/MqttClassBinder.h
Normal file
72
src/MqttClassBinder.h
Normal file
@@ -0,0 +1,72 @@
|
||||
// MqttReceiver must implement onPublish(...)
|
||||
template <class MqttReceiver>
|
||||
class MqttClassBinder
|
||||
{
|
||||
public:
|
||||
MqttClassBinder()
|
||||
{
|
||||
unregister(this);
|
||||
}
|
||||
~MqttClassBinder() { unregister(this); }
|
||||
|
||||
static void onUnpublished(MqttClient::CallBack handler)
|
||||
{
|
||||
unrouted_handler = handler;
|
||||
}
|
||||
|
||||
static void onPublish(MqttClient* client, MqttReceiver* dest)
|
||||
{
|
||||
routes.insert(std::pair<MqttClient*, MqttReceiver*>(client, dest));
|
||||
client->setCallback(onRoutePublish);
|
||||
}
|
||||
|
||||
void onPublish(const MqttClient* client, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
static_cast<MqttReceiver*>(this)->MqttReceiver::onPublish(client, topic, payload, length);
|
||||
}
|
||||
|
||||
static size_t size() { return routes.size(); }
|
||||
|
||||
static void reset() { routes.clear(); }
|
||||
|
||||
private:
|
||||
|
||||
static void onRoutePublish(const MqttClient* client, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
bool unrouted = true;
|
||||
auto receivers = routes.equal_range(client);
|
||||
for(auto it = receivers.first; it != receivers.second; ++it)
|
||||
{
|
||||
it->second->onPublish(client, topic, payload, length);
|
||||
unrouted = false;
|
||||
}
|
||||
|
||||
if (unrouted and unrouted_handler)
|
||||
{
|
||||
unrouted_handler(client, topic, payload, length);
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
void unregister(MqttClassBinder<MqttReceiver>* which)
|
||||
{
|
||||
if (routes.size()==0) return; // bug in map stl
|
||||
for(auto it=routes.begin(); it!=routes.end(); it++)
|
||||
if (it->second == which)
|
||||
{
|
||||
routes.erase(it);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
static std::multimap<const MqttClient*, MqttClassBinder<MqttReceiver>*> routes;
|
||||
static MqttClient::CallBack unrouted_handler;
|
||||
|
||||
};
|
||||
|
||||
template<class MqttReceiver>
|
||||
std::multimap<const MqttClient*, MqttClassBinder<MqttReceiver>*> MqttClassBinder<MqttReceiver>::routes;
|
||||
|
||||
template<class MqttReceiver>
|
||||
MqttClient::CallBack MqttClassBinder<MqttReceiver>::unrouted_handler = nullptr;
|
||||
|
||||
@@ -1,412 +0,0 @@
|
||||
/* MqttStreaming.h - Fork of Streaming.h adding std::string and with some minor fixes
|
||||
* (I have to speek to the author in order to include my changes to his library if possible)
|
||||
**/
|
||||
|
||||
/*
|
||||
Streaming.h - Arduino library for supporting the << streaming operator
|
||||
Copyright (c) 2010-2012 Mikal Hart. All rights reserved.
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
*/
|
||||
|
||||
/*
|
||||
Version 6 library changes
|
||||
Copyright (c) 2019 Gazoodle. All rights reserved.
|
||||
|
||||
1. _BASED moved to template to remove type conversion to long and
|
||||
sign changes which break int8_t and int16_t negative numbers.
|
||||
The print implementation still upscales to long for it's internal
|
||||
print routine.
|
||||
|
||||
2. _PAD added to allow padding & filling of characters to the stream
|
||||
|
||||
3. _WIDTH & _WIDTHZ added to allow width printing with space padding
|
||||
and zero padding for numerics
|
||||
|
||||
4. Simple _FMT mechanism ala printf, but without the typeunsafetyness
|
||||
and no internal buffers for replaceable stream printing
|
||||
*/
|
||||
|
||||
#ifndef ARDUINO_STREAMING
|
||||
#define ARDUINO_STREAMING
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
#include "Arduino.h"
|
||||
#else
|
||||
#ifndef STREAMING_CONSOLE
|
||||
#include "WProgram.h"
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#include <string>
|
||||
|
||||
#if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_MEGAAVR)
|
||||
// No stl library, so need trivial version of std::is_signed ...
|
||||
namespace std {
|
||||
template<typename T>
|
||||
struct is_signed { static const bool value = false; };
|
||||
template<>
|
||||
struct is_signed<int8_t> { static const bool value = true; };
|
||||
template<>
|
||||
struct is_signed<int16_t> { static const bool value = true; };
|
||||
template<>
|
||||
struct is_signed<int32_t> { static const bool value = true; };
|
||||
};
|
||||
#else
|
||||
#include <type_traits>
|
||||
#endif
|
||||
|
||||
#define STREAMING_LIBRARY_VERSION 6
|
||||
|
||||
#if !defined(typeof)
|
||||
#define typeof(x) __typeof__(x)
|
||||
#endif
|
||||
|
||||
// PrintBuffer implementation of Print, a small buffer to print in
|
||||
// see its use with pad_float()
|
||||
template <size_t N>
|
||||
class PrintBuffer : public Print
|
||||
{
|
||||
size_t pos = 0;
|
||||
char str[N] {};
|
||||
public:
|
||||
inline const char *operator() ()
|
||||
{ return str; };
|
||||
|
||||
// inline void clear()
|
||||
// { pos = 0; str[0] = '\0'; };
|
||||
|
||||
inline size_t write(uint8_t c)
|
||||
{ return write(&c, 1); };
|
||||
|
||||
inline size_t write(const uint8_t *buffer, size_t size)
|
||||
{
|
||||
size_t s = std::min(size, N-1 - pos); // need a /0 left
|
||||
if (s)
|
||||
{
|
||||
memcpy(&str[pos], buffer, s);
|
||||
pos += s;
|
||||
}
|
||||
return s;
|
||||
};
|
||||
};
|
||||
|
||||
// Generic template
|
||||
template<class T>
|
||||
inline Print &operator <<(Print &stream, const T &arg)
|
||||
{ stream.print(arg); return stream; }
|
||||
|
||||
// TODO sfinae maybe could do the trick ?
|
||||
inline Print &operator <<(Print &stream, const std::string &str)
|
||||
{ stream.print(str.c_str()); return stream; }
|
||||
|
||||
template<typename T>
|
||||
struct _BASED
|
||||
{
|
||||
T val;
|
||||
int base;
|
||||
_BASED(T v, int b): val(v), base(b)
|
||||
{}
|
||||
};
|
||||
|
||||
#if ARDUINO >= 100
|
||||
|
||||
struct _BYTE_CODE
|
||||
{
|
||||
byte val;
|
||||
_BYTE_CODE(byte v) : val(v)
|
||||
{}
|
||||
};
|
||||
#define _BYTE(a) _BYTE_CODE(a)
|
||||
|
||||
inline Print &operator <<(Print &obj, const _BYTE_CODE &arg)
|
||||
{ obj.write(arg.val); return obj; }
|
||||
|
||||
#else
|
||||
|
||||
#define _BYTE(a) _BASED<typeof(a)>(a, BYTE)
|
||||
|
||||
#endif
|
||||
|
||||
#define _HEX(a) _BASED<typeof(a)>(a, HEX)
|
||||
#define _DEC(a) _BASED<typeof(a)>(a, DEC)
|
||||
#define _OCT(a) _BASED<typeof(a)>(a, OCT)
|
||||
#define _BIN(a) _BASED<typeof(a)>(a, BIN)
|
||||
|
||||
// Specialization for class _BASED
|
||||
// Thanks to Arduino forum user Ben Combee who suggested this
|
||||
// clever technique to allow for expressions like
|
||||
// Serial << _HEX(a);
|
||||
|
||||
template<typename T>
|
||||
inline Print &operator <<(Print &obj, const _BASED<T> &arg)
|
||||
{ obj.print(arg.val, arg.base); return obj; }
|
||||
|
||||
#if ARDUINO >= 18
|
||||
// Specialization for class _FLOAT
|
||||
// Thanks to Michael Margolis for suggesting a way
|
||||
// to accommodate Arduino 0018's floating point precision
|
||||
// feature like this:
|
||||
// Serial << _FLOAT(gps_latitude, 6); // 6 digits of precision
|
||||
|
||||
struct _FLOAT
|
||||
{
|
||||
double val; // only Print::print(double)
|
||||
int digits;
|
||||
_FLOAT(double v, int d): val(v), digits(d)
|
||||
{}
|
||||
};
|
||||
|
||||
inline Print &operator <<(Print &obj, const _FLOAT &arg)
|
||||
{ obj.print(arg.val, arg.digits); return obj; }
|
||||
#endif
|
||||
|
||||
// Specialization for enum _EndLineCode
|
||||
// Thanks to Arduino forum user Paul V. who suggested this
|
||||
// clever technique to allow for expressions like
|
||||
// Serial << "Hello!" << endl;
|
||||
|
||||
enum _EndLineCode { endl };
|
||||
|
||||
inline Print &operator <<(Print &obj, _EndLineCode)
|
||||
{ obj.println(); return obj; }
|
||||
|
||||
// Specialization for padding & filling, mainly utilized
|
||||
// by the width printers
|
||||
//
|
||||
// Use like
|
||||
// Serial << _PAD(10,' '); // Will output 10 spaces
|
||||
// Serial << _PAD(4, '0'); // Will output 4 zeros
|
||||
struct _PAD
|
||||
{
|
||||
int8_t width;
|
||||
char chr;
|
||||
_PAD(int8_t w, char c) : width(w), chr(c) {}
|
||||
};
|
||||
|
||||
inline Print &operator <<(Print& stm, const _PAD &arg)
|
||||
{
|
||||
for(int8_t i = 0; i < arg.width; i++)
|
||||
stm.print(arg.chr);
|
||||
return stm;
|
||||
}
|
||||
|
||||
// Specialization for width printing
|
||||
//
|
||||
// Use like Result
|
||||
// -------- ------
|
||||
// Serial << _WIDTH(1,5) " 1"
|
||||
// Serial << _WIDTH(10,5) " 10"
|
||||
// Serial << _WIDTH(100,5) " 100"
|
||||
// Serial << _WIDTHZ(1,5) "00001"
|
||||
//
|
||||
// Great for times & dates, or hex dumps
|
||||
//
|
||||
// Serial << _WIDTHZ(hour,2) << ':' << _WIDTHZ(min,2) << ':' << _WIDTHZ(sec,2)
|
||||
//
|
||||
// for(int index=0; index<byte_array_size; index++)
|
||||
// Serial << _WIDTHZ(_HEX(byte_array[index]))
|
||||
|
||||
template<typename T>
|
||||
struct __WIDTH
|
||||
{
|
||||
const T val;
|
||||
int8_t width;
|
||||
char pad;
|
||||
__WIDTH(const T& v, int8_t w, char p) : val(v), width(w), pad(p) {}
|
||||
};
|
||||
|
||||
// Count digits in an integer of specific base
|
||||
template<typename T>
|
||||
inline uint8_t digits(T v, int8_t base = 10)
|
||||
{
|
||||
uint8_t digits = 0;
|
||||
if ( std::is_signed<T>::value )
|
||||
{
|
||||
if ( v < 0 )
|
||||
{
|
||||
digits++;
|
||||
v = -v; // v needs to be postive for the digits counter to work
|
||||
}
|
||||
}
|
||||
do
|
||||
{
|
||||
v /= base;
|
||||
digits++;
|
||||
} while( v > 0 );
|
||||
return digits;
|
||||
}
|
||||
|
||||
// Generic get the width of a value in base 10
|
||||
template<typename T>
|
||||
inline uint8_t get_value_width(T val)
|
||||
{ return digits(val); }
|
||||
|
||||
inline uint8_t get_value_width(const char * val)
|
||||
{ return strlen(val); }
|
||||
|
||||
#ifdef ARDUINO
|
||||
inline uint8_t get_value_width(const __FlashStringHelper * val)
|
||||
{ return strlen_P(reinterpret_cast<const char *>(val)); }
|
||||
#endif
|
||||
|
||||
// _BASED<T> get the width of a value
|
||||
template<typename T>
|
||||
inline uint8_t get_value_width(_BASED<T> b)
|
||||
{ return digits(b.val, b.base); }
|
||||
|
||||
// Constructor wrapper to allow automatic template parameter deduction
|
||||
template<typename T>
|
||||
__WIDTH<T> _WIDTH(T val, int8_t width) { return __WIDTH<T>(val, width, ' '); }
|
||||
template<typename T>
|
||||
__WIDTH<T> _WIDTHZ(T val, int8_t width) { return __WIDTH<T>(val, width, '0'); }
|
||||
|
||||
|
||||
// Operator overload to handle width printing.
|
||||
template<typename T>
|
||||
inline Print &operator <<(Print &stm, const __WIDTH<T> &arg)
|
||||
{ stm << _PAD(arg.width - get_value_width(arg.val), arg.pad) << arg.val; return stm; }
|
||||
|
||||
// explicit Operator overload to handle width printing of _FLOAT, double and float
|
||||
template<typename T>
|
||||
inline Print &pad_float(Print &stm, const __WIDTH<T> &arg, const double val, const int digits = 2) // see Print::print(double, int = 2)
|
||||
{
|
||||
PrintBuffer<32> buf; // it's only ~45B on the stack, no allocation, leak or fragmentation
|
||||
size_t size = buf.print(val, digits); // print in buf
|
||||
return stm << _PAD(arg.width - size, arg.pad) << buf(); // pad and concat what's in buf
|
||||
}
|
||||
|
||||
inline Print &operator <<(Print &stm, const __WIDTH<float> &arg)
|
||||
{ return pad_float(stm, arg, arg.val); }
|
||||
|
||||
inline Print &operator <<(Print &stm, const __WIDTH<double> &arg)
|
||||
{ return pad_float(stm, arg, arg.val); }
|
||||
|
||||
inline Print &operator <<(Print &stm, const __WIDTH<_FLOAT> &arg)
|
||||
{ auto& f = arg.val; return pad_float(stm, arg, f.val, f.digits); }
|
||||
|
||||
// a less verbose _FLOATW for _WIDTH(_FLOAT)
|
||||
#define _FLOATW(val, digits, width) _WIDTH<_FLOAT>(_FLOAT((val), (digits)), (width))
|
||||
|
||||
// Specialization for replacement formatting
|
||||
//
|
||||
// Designed to be similar to printf that everyone knows and loves/hates. But without
|
||||
// the internal buffers and type agnosticism. This version only has placeholders in
|
||||
// the format string, the actual values are supplied using the stream safe operators
|
||||
// defined in this library.
|
||||
//
|
||||
// Use like this:
|
||||
//
|
||||
// Serial << FMT(F("Replace % with %"), 1, 2 )
|
||||
// Serial << FMT("Time is %:%:%", _WIDTHZ(hours,2), _WIDTHZ(minutes,2), _WIDTHZ(seconds,2))
|
||||
// Serial << FMT("Your score is %\\%", score); // Note the \\ to escape the % sign
|
||||
|
||||
// Ok, hold your hats. This is a foray into C++11's variadic template engine ...
|
||||
|
||||
inline char get_next_format_char(const char *& format_string)
|
||||
{
|
||||
char format_char = *format_string;
|
||||
if ( format_char > 0 ) format_string++;
|
||||
return format_char;
|
||||
}
|
||||
|
||||
#ifdef ARDUINO
|
||||
inline char get_next_format_char(const __FlashStringHelper*& format_string)
|
||||
{
|
||||
char format_char = pgm_read_byte(format_string);
|
||||
if ( format_char > 0 ) format_string = reinterpret_cast<const __FlashStringHelper*>(reinterpret_cast<const char *>(format_string)+1);
|
||||
return format_char;
|
||||
}
|
||||
#endif
|
||||
|
||||
template<typename Ft>
|
||||
inline bool check_backslash(char& format_char, Ft& format_string)
|
||||
{
|
||||
if ( format_char == '\\')
|
||||
{
|
||||
format_char = get_next_format_char(format_string);
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// The template tail printer helper
|
||||
template<typename Ft, typename... Ts>
|
||||
struct __FMT
|
||||
{
|
||||
Ft format_string;
|
||||
__FMT(Ft f, Ts ... args) : format_string(f) {}
|
||||
inline void tstreamf(Print& stm, Ft format) const
|
||||
{
|
||||
while(char c = get_next_format_char(format))
|
||||
{
|
||||
check_backslash(c, format);
|
||||
if ( c )
|
||||
stm.print(c);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// The variadic template helper
|
||||
template<typename Ft, typename T, typename... Ts>
|
||||
struct __FMT<Ft, T, Ts...> : __FMT<Ft, Ts...>
|
||||
{
|
||||
T val;
|
||||
__FMT(Ft f, T t, Ts... ts) : __FMT<Ft, Ts...>(f, ts...), val(t) {}
|
||||
inline void tstreamf(Print& stm, Ft format) const
|
||||
{
|
||||
while(char c = get_next_format_char(format))
|
||||
{
|
||||
if (!check_backslash(c, format))
|
||||
{
|
||||
if ( c == '%')
|
||||
{
|
||||
stm << val;
|
||||
// Variadic recursion ... compiler rolls this out during
|
||||
// template argument pack expansion
|
||||
__FMT<Ft, Ts...>::tstreamf(stm, format);
|
||||
return;
|
||||
}
|
||||
}
|
||||
if (c)
|
||||
stm.print(c);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// The actual operator should you only instanciate the FMT
|
||||
// helper with a format string and no parameters
|
||||
template<typename Ft, typename... Ts>
|
||||
inline Print& operator <<(Print &stm, const __FMT<Ft, Ts...> &args)
|
||||
{
|
||||
args.tstreamf(stm, args.format_string);
|
||||
return stm;
|
||||
}
|
||||
|
||||
// The variadic stream helper
|
||||
template<typename Ft, typename T, typename... Ts>
|
||||
inline Print& operator <<(Print &stm, const __FMT<Ft, T, Ts...> &args)
|
||||
{
|
||||
args.tstreamf(stm, args.format_string);
|
||||
return stm;
|
||||
}
|
||||
|
||||
// As we don't have C++17, we can't get a constructor to use
|
||||
// automatic argument deduction, but ... this little trick gets
|
||||
// around that ...
|
||||
template<typename Ft, typename... Ts>
|
||||
__FMT<Ft, Ts...> _FMT(Ft format, Ts ... args) { return __FMT<Ft, Ts...>(format, args...); }
|
||||
|
||||
#endif
|
||||
@@ -1,3 +1,4 @@
|
||||
#include "StringIndexer.h"
|
||||
|
||||
std::map<StringIndexer::index_t, StringIndexer::StringCounter> StringIndexer::strings;
|
||||
StringIndexer::Strings StringIndexer::strings;
|
||||
|
||||
|
||||
@@ -1,129 +1,144 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#pragma once
|
||||
#include <assert.h>
|
||||
#include <map>
|
||||
#include <unordered_map>
|
||||
#include "TinyConsole.h"
|
||||
#include <string>
|
||||
#include <string.h>
|
||||
|
||||
using string = TinyConsole::string;
|
||||
|
||||
/***
|
||||
* Allows to store up to 255 different strings with one byte class
|
||||
* very memory efficient when one string is used many times.
|
||||
*/
|
||||
class StringIndexer
|
||||
{
|
||||
class StringCounter
|
||||
{
|
||||
std::string str;
|
||||
uint8_t used=0;
|
||||
friend class StringIndexer;
|
||||
private:
|
||||
|
||||
#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;
|
||||
class StringCounter
|
||||
{
|
||||
string str;
|
||||
uint8_t used=0;
|
||||
friend class StringIndexer;
|
||||
|
||||
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
|
||||
}
|
||||
#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;
|
||||
|
||||
static const std::string& str(const index_t& index)
|
||||
{
|
||||
static std::string dummy;
|
||||
const auto& it=strings.find(index);
|
||||
if (it == strings.end()) return dummy;
|
||||
return it->second.str;
|
||||
}
|
||||
static const string& str(const index_t& index)
|
||||
{
|
||||
static string dummy;
|
||||
const auto& it=strings.find(index);
|
||||
if (it == strings.end()) return dummy;
|
||||
return it->second.str;
|
||||
}
|
||||
|
||||
static void use(const index_t& index)
|
||||
{
|
||||
auto it=strings.find(index);
|
||||
if (it != strings.end()) it->second.used++;
|
||||
}
|
||||
static void use(const index_t& index)
|
||||
{
|
||||
auto it=strings.find(index);
|
||||
if (it != strings.end()) it->second.used++;
|
||||
}
|
||||
|
||||
static void release(const index_t& index)
|
||||
{
|
||||
auto it=strings.find(index);
|
||||
if (it != strings.end())
|
||||
{
|
||||
it->second.used--;
|
||||
if (it->second.used == 0)
|
||||
{
|
||||
strings.erase(it);
|
||||
// Serial << "Removing string(" << it->second.str.c_str() << ") size=" << strings.size() << endl;
|
||||
}
|
||||
}
|
||||
}
|
||||
static void release(const index_t& index)
|
||||
{
|
||||
auto it=strings.find(index);
|
||||
if (it != strings.end())
|
||||
{
|
||||
it->second.used--;
|
||||
if (it->second.used == 0)
|
||||
{
|
||||
strings.erase(it);
|
||||
// Serial << "Removing string(" << it->second.str.c_str() << ") size=" << strings.size() << endl;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static uint16_t count() { return strings.size(); }
|
||||
static uint16_t count() { return strings.size(); }
|
||||
|
||||
private:
|
||||
static std::map<index_t, StringCounter> strings;
|
||||
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 = 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 Strings = std::unordered_map<index_t, StringCounter>;
|
||||
|
||||
static Strings strings;
|
||||
};
|
||||
|
||||
class IndexedString
|
||||
{
|
||||
public:
|
||||
IndexedString(const IndexedString& source)
|
||||
{
|
||||
StringIndexer::use(source.index);
|
||||
index = source.index;
|
||||
}
|
||||
public:
|
||||
IndexedString(const IndexedString& source)
|
||||
{
|
||||
StringIndexer::use(source.index);
|
||||
index = source.index;
|
||||
}
|
||||
|
||||
IndexedString(const char* str, uint8_t len)
|
||||
{
|
||||
index=StringIndexer::strToIndex(str, len);
|
||||
}
|
||||
IndexedString(IndexedString&& i) : index(i.index) {}
|
||||
|
||||
IndexedString(const std::string& str) : IndexedString(str.c_str(), str.length()) {};
|
||||
IndexedString(const char* str, uint8_t len)
|
||||
{
|
||||
index=StringIndexer::strToIndex(str, len);
|
||||
}
|
||||
|
||||
~IndexedString() { StringIndexer::release(index); }
|
||||
IndexedString(const string& str) : IndexedString(str.c_str(), str.length()) {};
|
||||
|
||||
IndexedString& operator=(const IndexedString& source)
|
||||
{
|
||||
StringIndexer::use(source.index);
|
||||
index = source.index;
|
||||
return *this;
|
||||
}
|
||||
~IndexedString() { StringIndexer::release(index); }
|
||||
|
||||
friend bool operator<(const IndexedString& i1, const IndexedString& i2)
|
||||
{
|
||||
return i1.index < i2.index;
|
||||
}
|
||||
IndexedString& operator=(const IndexedString& source)
|
||||
{
|
||||
StringIndexer::use(source.index);
|
||||
index = source.index;
|
||||
return *this;
|
||||
}
|
||||
|
||||
friend bool operator==(const IndexedString& i1, const IndexedString& i2)
|
||||
{
|
||||
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); }
|
||||
friend bool operator==(const IndexedString& i1, const IndexedString& i2)
|
||||
{
|
||||
return i1.index == i2.index;
|
||||
}
|
||||
|
||||
const StringIndexer::index_t& getIndex() const { return index; }
|
||||
const string& str() const { return StringIndexer::str(index); }
|
||||
|
||||
private:
|
||||
StringIndexer::index_t index;
|
||||
const StringIndexer::index_t& getIndex() const { return index; }
|
||||
|
||||
private:
|
||||
StringIndexer::index_t index;
|
||||
};
|
||||
|
||||
1458
src/TinyMqtt.cpp
1458
src/TinyMqtt.cpp
File diff suppressed because it is too large
Load Diff
556
src/TinyMqtt.h
556
src/TinyMqtt.h
@@ -1,304 +1,428 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#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
|
||||
#define TINY_MQTT_REVISION "1.1.3"
|
||||
|
||||
#if defined(ESP8266) || defined(EPOXY_DUINO)
|
||||
#ifdef TCP_ASYNC
|
||||
#include <ESPAsyncTCP.h>
|
||||
#ifndef TINY_MQTT_DEBUG
|
||||
#define TINY_MQTT_DEBUG 0
|
||||
#endif
|
||||
|
||||
// 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(TINY_MQTT_ETHERNET)
|
||||
#include <Ethernet.h>
|
||||
#elif defined(ESP8266) || defined(EPOXY_DUINO)
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
#include <ESPAsyncTCP.h>
|
||||
#else
|
||||
#include <ESP8266WiFi.h>
|
||||
#endif
|
||||
#elif defined(ESP32)
|
||||
#include <WiFi.h>
|
||||
#ifdef TCP_ASYNC
|
||||
#include <AsyncTCP.h> // https://github.com/me-no-dev/AsyncTCP
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
#include <AsyncTCP.h> // https://github.com/me-no-dev/AsyncTCP
|
||||
#endif
|
||||
#elif defined(ARDUINO_ARCH_RP2040)
|
||||
#include <WiFi.h> // works with Raspberry Pi Pico W, earlephilhower
|
||||
#endif
|
||||
#ifdef EPOXY_DUINO
|
||||
#define dbg_ptr uint64_t
|
||||
#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>
|
||||
#include "StringIndexer.h"
|
||||
#include <MqttStreaming.h>
|
||||
|
||||
// #define TINY_MQTT_DEBUG
|
||||
#define TINY_MQTT_DEFAULT_CLIENT_ID "Tiny"
|
||||
|
||||
#ifdef TINY_MQTT_DEBUG
|
||||
#define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); }
|
||||
#include <TinyStreaming.h>
|
||||
#if TINY_MQTT_DEBUG
|
||||
#include <TinyConsole.h> // https://github.com/hsaturn/TinyConsole
|
||||
struct TinyMqtt
|
||||
{
|
||||
static int debug;
|
||||
};
|
||||
|
||||
#define debug(what) { if (TinyMqtt::debug>=1) Console << (int)__LINE__ << ' ' << what << TinyConsole::white << endl; delay(100); }
|
||||
#else
|
||||
#define debug(what) {}
|
||||
#endif
|
||||
|
||||
#ifdef TCP_ASYNC
|
||||
using TcpClient = AsyncClient;
|
||||
using TcpServer = AsyncServer;
|
||||
#if defined(TINY_MQTT_ETHERNET)
|
||||
using TcpClient = EthernetClient;
|
||||
using TcpServer = EthernetServer;
|
||||
#else
|
||||
using TcpClient = WiFiClient;
|
||||
using TcpServer = WiFiServer;
|
||||
#ifdef TINY_MQTT_ASYNC
|
||||
using TcpClient = AsyncClient;
|
||||
using TcpServer = AsyncServer;
|
||||
#else
|
||||
using TcpClient = WiFiClient;
|
||||
using TcpServer = WiFiServer;
|
||||
#endif
|
||||
#endif
|
||||
|
||||
enum MqttError
|
||||
enum __attribute__((packed)) MqttError
|
||||
{
|
||||
MqttOk = 0,
|
||||
MqttNowhereToSend=1,
|
||||
MqttInvalidMessage=2,
|
||||
MqttOk = 0,
|
||||
MqttNowhereToSend=1,
|
||||
MqttInvalidMessage=2,
|
||||
};
|
||||
|
||||
using string = TinyConsole::string;
|
||||
|
||||
class Topic : public IndexedString
|
||||
{
|
||||
public:
|
||||
Topic(const char* s, uint8_t len) : IndexedString(s,len){}
|
||||
Topic(const char* s) : Topic(s, strlen(s)) {}
|
||||
Topic(const std::string s) : Topic(s.c_str(), s.length()){};
|
||||
public:
|
||||
Topic(const string& m) : IndexedString(m){}
|
||||
Topic(const char* s, uint8_t len) : IndexedString(s,len){}
|
||||
Topic(const char* s) : Topic(s, strlen(s)) {}
|
||||
// Topic(const string s) : Topic(s.c_str(), s.length()){};
|
||||
|
||||
const char* c_str() const { return str().c_str(); }
|
||||
const char* c_str() const { return str().c_str(); }
|
||||
|
||||
bool matches(const Topic&) const;
|
||||
bool matches(const Topic&) const;
|
||||
};
|
||||
|
||||
class MqttClient;
|
||||
class MqttMessage
|
||||
{
|
||||
const uint16_t MaxBufferLength = 255;
|
||||
public:
|
||||
enum Type
|
||||
{
|
||||
Unknown = 0,
|
||||
Connect = 0x10,
|
||||
ConnAck = 0x20,
|
||||
Publish = 0x30,
|
||||
PubAck = 0x40,
|
||||
Subscribe = 0x80,
|
||||
SubAck = 0x90,
|
||||
UnSubscribe = 0xA0,
|
||||
UnSuback = 0xB0,
|
||||
PingReq = 0xC0,
|
||||
PingResp = 0xD0,
|
||||
Disconnect = 0xE0
|
||||
};
|
||||
enum State
|
||||
{
|
||||
FixedHeader=0,
|
||||
Length=1,
|
||||
VariableHeader=2,
|
||||
PayLoad=3,
|
||||
Complete=4,
|
||||
Error=5,
|
||||
Create=6
|
||||
};
|
||||
const uint16_t MaxBufferLength = 4096; //hard limit: 16k due to size decoding
|
||||
public:
|
||||
enum __attribute__((packed)) Type
|
||||
{
|
||||
Unknown = 0,
|
||||
Connect = 0x10,
|
||||
ConnAck = 0x20,
|
||||
Publish = 0x30,
|
||||
PubAck = 0x40,
|
||||
Subscribe = 0x80,
|
||||
SubAck = 0x90,
|
||||
UnSubscribe = 0xA0,
|
||||
UnSuback = 0xB0,
|
||||
PingReq = 0xC0,
|
||||
PingResp = 0xD0,
|
||||
Disconnect = 0xE0
|
||||
};
|
||||
|
||||
MqttMessage() { reset(); }
|
||||
MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= bits_d3_d0; }
|
||||
void incoming(char byte);
|
||||
void add(char byte) { incoming(byte); }
|
||||
void add(const char* p, size_t len, bool addLength=true );
|
||||
void add(const std::string& s) { add(s.c_str(), s.length()); }
|
||||
void add(const Topic& t) { add(t.str()); }
|
||||
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();
|
||||
enum __attribute__((packed)) State
|
||||
{
|
||||
FixedHeader=0,
|
||||
Length=1,
|
||||
VariableHeader=2,
|
||||
PayLoad=3,
|
||||
Complete=4,
|
||||
Error=5,
|
||||
Create=6
|
||||
};
|
||||
|
||||
void reset();
|
||||
static inline uint32_t getSize(const char* buffer)
|
||||
{
|
||||
const unsigned char* bun = (const unsigned char*)buffer;
|
||||
return (*bun << 8) | bun[1]; }
|
||||
|
||||
// buff is MSB/LSB/STRING
|
||||
// output buff+=2, len=length(str)
|
||||
static void getString(const char* &buff, uint16_t& len);
|
||||
MqttMessage() { reset(); }
|
||||
MqttMessage(Type t, uint8_t bits_d3_d0=0) { create(t); buffer[0] |= (bits_d3_d0 & 0xF); }
|
||||
MqttMessage(const MqttMessage& m)
|
||||
: buffer(m.buffer), vheader(m.vheader), size(m.size), state(m.state) {}
|
||||
|
||||
Type type() const
|
||||
{
|
||||
return state == Complete ? static_cast<Type>(buffer[0]) : Unknown;
|
||||
}
|
||||
void incoming(char byte);
|
||||
void add(char byte) { incoming(byte); }
|
||||
void add(const char* p, size_t len, bool addLength=true );
|
||||
void add(const string& s) { add(s.c_str(), s.length()); }
|
||||
void add(const Topic& t) { add(t.str()); }
|
||||
const char* end() const { return &buffer[0]+buffer.size(); }
|
||||
const char* getVHeader() const { return &buffer[vheader]; }
|
||||
void complete() { encodeLength(); }
|
||||
void retained() { if ((buffer[0] & 0xF)==Publish) buffer[0] |= 1; }
|
||||
|
||||
void create(Type type)
|
||||
{
|
||||
buffer=(char)type;
|
||||
buffer+='\0'; // reserved for msg length
|
||||
vheader=2;
|
||||
size=0;
|
||||
state=Create;
|
||||
}
|
||||
MqttError sendTo(MqttClient*) const;
|
||||
void hexdump(const char* prefix=nullptr) const;
|
||||
void reset();
|
||||
|
||||
private:
|
||||
void encodeLength(char* msb, int length) const;
|
||||
// buff is MSB/LSB/STRING
|
||||
// output buff+=2, len=length(str)
|
||||
static void getString(const char* &buff, uint16_t& len);
|
||||
|
||||
mutable std::string buffer; // mutable -> sendTo()
|
||||
uint8_t vheader;
|
||||
uint16_t size; // bytes left to receive
|
||||
State state;
|
||||
Type type() const
|
||||
{
|
||||
return state == Complete ? static_cast<Type>(buffer[0] & 0xF0) : Unknown;
|
||||
}
|
||||
|
||||
uint8_t flags() const { return static_cast<uint8_t>(buffer[0] & 0x0F); }
|
||||
|
||||
void create(Type type)
|
||||
{
|
||||
buffer=(decltype(buffer)::value_type)type;
|
||||
buffer+='\0'; // reserved for msg length byte 1/2
|
||||
buffer+='\0'; // reserved for msg length byte 2/2 (fixed)
|
||||
vheader=3; // Should never change
|
||||
size=0;
|
||||
state=Create;
|
||||
}
|
||||
MqttError sendTo(MqttClient*);
|
||||
void hexdump(const char* prefix=nullptr) const;
|
||||
|
||||
MqttMessage& operator = (MqttMessage&& m)
|
||||
{
|
||||
buffer = std::move(m.buffer);
|
||||
vheader = m.vheader;
|
||||
size = m.size;
|
||||
state = m.state;
|
||||
return *this;
|
||||
}
|
||||
|
||||
private:
|
||||
void encodeLength();
|
||||
|
||||
string buffer;
|
||||
uint8_t vheader;
|
||||
uint16_t size; // bytes left to receive
|
||||
State state;
|
||||
};
|
||||
|
||||
class MqttBroker;
|
||||
class MqttClient
|
||||
{
|
||||
using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length);
|
||||
enum Flags
|
||||
{
|
||||
FlagUserName = 128,
|
||||
FlagPassword = 64,
|
||||
FlagWillRetain = 32, // unsupported
|
||||
FlagWillQos = 16 | 8, // unsupported
|
||||
FlagWill = 4, // unsupported
|
||||
FlagCleanSession = 2, // unsupported
|
||||
FlagReserved = 1
|
||||
};
|
||||
public:
|
||||
/** 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){}
|
||||
enum __attribute__((packed)) Flags
|
||||
{
|
||||
FlagUserName = 128,
|
||||
FlagPassword = 64,
|
||||
FlagWillRetain = 32, // unsupported
|
||||
FlagWillQos = 16 | 8, // unsupported
|
||||
FlagWill = 4, // unsupported
|
||||
FlagCleanSession = 2, // unsupported
|
||||
FlagReserved = 1
|
||||
};
|
||||
|
||||
~MqttClient();
|
||||
enum __attribute__((packed)) CltFlags
|
||||
{
|
||||
CltFlagNone = 0,
|
||||
CltFlagConnected = 1,
|
||||
CltFlagToDelete = 2
|
||||
};
|
||||
public:
|
||||
|
||||
void connect(MqttBroker* parent);
|
||||
void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10);
|
||||
using CallBack = void (*)(const MqttClient* source, const Topic& topic, const char* payload, size_t payload_length);
|
||||
|
||||
bool connected() { return
|
||||
(parent!=nullptr and client==nullptr) or
|
||||
(client and client->connected()); }
|
||||
void write(const char* buf, size_t length)
|
||||
{ if (client) client->write(buf, length); }
|
||||
/** Constructor. Broker is the adress of a local broker if not null
|
||||
If you want to connect elsewhere, leave broker null and use connect() **/
|
||||
MqttClient(MqttBroker* broker = nullptr, const string& id = TINY_MQTT_DEFAULT_CLIENT_ID);
|
||||
MqttClient(const string& id) : MqttClient(nullptr, id){}
|
||||
|
||||
const std::string& id() const { return clientId; }
|
||||
void id(std::string& new_id) { clientId = new_id; }
|
||||
~MqttClient();
|
||||
|
||||
/** Should be called in main loop() */
|
||||
void loop();
|
||||
void close(bool bSendDisconnect=true);
|
||||
void setCallback(CallBack fun) {callback=fun; };
|
||||
void connect(MqttBroker* local_broker);
|
||||
void connect(string broker, uint16_t port = 1883, uint16_t keep_alive = 10);
|
||||
void connect(const IPAddress& ip, uint16_t port = 1883, uint16_t keep_alive = 10)
|
||||
{ connect(ip.toString().c_str(), port, keep_alive); }
|
||||
|
||||
// Publish from client to the world
|
||||
MqttError publish(const Topic&, const char* payload, size_t pay_length);
|
||||
MqttError publish(const Topic& t, const char* payload) { return publish(t, payload, strlen(payload)); }
|
||||
MqttError publish(const Topic& t, const String& s) { return publish(t, s.c_str(), s.length()); }
|
||||
MqttError publish(const Topic& t, const std::string& s) { return publish(t,s.c_str(),s.length());}
|
||||
MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
|
||||
// TODO it seems that connected returns true in tcp mode even if
|
||||
// no negociation occurred
|
||||
bool connected()
|
||||
{
|
||||
return (local_broker!=nullptr and tcp_client==nullptr)
|
||||
or (tcp_client and tcp_client->connected());
|
||||
}
|
||||
|
||||
MqttError subscribe(Topic topic, uint8_t qos=0);
|
||||
MqttError unsubscribe(Topic topic);
|
||||
bool isSubscribedTo(const Topic& topic) const;
|
||||
void write(const char* buf, size_t length)
|
||||
{
|
||||
if (tcp_client) tcp_client->write(buf, length);
|
||||
}
|
||||
|
||||
// connected to local broker
|
||||
// TODO seems to be useless
|
||||
bool isLocal() const { return client == nullptr; }
|
||||
const string& id() const { return clientId; }
|
||||
void id(const string& new_id) { clientId = new_id; }
|
||||
|
||||
void dump(std::string indent="")
|
||||
{
|
||||
uint32_t ms=millis();
|
||||
Serial << indent << "+-- " << '\'' << clientId.c_str() << "' " << (connected() ? " ON " : " OFF");
|
||||
Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive << ' ';
|
||||
Serial << (client && client->connected() ? "" : "dis") << "connected";
|
||||
if (subscriptions.size())
|
||||
{
|
||||
bool c = false;
|
||||
Serial << " [";
|
||||
for(auto s: subscriptions)
|
||||
{
|
||||
if (c) Serial << ", ";
|
||||
Serial << s.str().c_str();
|
||||
c=true;
|
||||
}
|
||||
Serial << ']';
|
||||
}
|
||||
Serial << endl;
|
||||
}
|
||||
/** Should be called in main loop() */
|
||||
void loop();
|
||||
void close(bool bSendDisconnect=true);
|
||||
void setCallback(CallBack fun)
|
||||
{
|
||||
callback=fun;
|
||||
#if TINY_MQTT_DEBUG
|
||||
Console << TinyConsole::magenta << "Callback set to " << (long)fun << TinyConsole::white << endl;
|
||||
if (callback) callback(this, "test/topic", "value", 5);
|
||||
#endif
|
||||
};
|
||||
|
||||
/** Count the number of messages that have been sent **/
|
||||
static long counter;
|
||||
// Publish from client to the world
|
||||
MqttError publish(const Topic&, const char* payload, size_t pay_length, bool retain=false);
|
||||
MqttError publish(const Topic& t, const char* payload, bool retain=false) { return publish(t, payload, strlen(payload), retain); }
|
||||
MqttError publish(const Topic& t, const String& s, bool retain=false) { return publish(t, s.c_str(), s.length(), retain); }
|
||||
MqttError publish(const Topic& t, const string& s, bool retain=false) { return publish(t,s.c_str(),s.length(), retain);}
|
||||
MqttError publish(const Topic& t, bool retain=false) { return publish(t, nullptr, 0, retain);};
|
||||
|
||||
private:
|
||||
static void onConnect(void * client_ptr, TcpClient*);
|
||||
#ifdef TCP_ASYNC
|
||||
static void onData(void* client_ptr, TcpClient*, void* data, size_t len);
|
||||
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
|
||||
bool isLocal() const { return tcp_client == nullptr; }
|
||||
|
||||
void dump(string indent="")
|
||||
{
|
||||
(void)indent;
|
||||
#if TINY_MQTT_DEBUG
|
||||
uint32_t ms=millis();
|
||||
Console << indent << "+-- " << '\'' << clientId.c_str() << "' " << (connected() ? " ON " : " OFF");
|
||||
Console << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive << ' ';
|
||||
if (tcp_client)
|
||||
{
|
||||
if (tcp_client->connected())
|
||||
Console << TinyConsole::green << "connected";
|
||||
else
|
||||
Console << TinyConsole::red << "disconnected";
|
||||
Console << TinyConsole::white;
|
||||
}
|
||||
if (subscriptions.size())
|
||||
{
|
||||
bool c = false;
|
||||
Console << " [";
|
||||
for(auto s: subscriptions)
|
||||
{
|
||||
if (c) Console << ", ";
|
||||
Console << s.str().c_str();
|
||||
c=true;
|
||||
}
|
||||
Console << ']';
|
||||
}
|
||||
Console << TinyConsole::erase_to_end << endl;
|
||||
#endif
|
||||
}
|
||||
|
||||
#ifdef EPOXY_DUINO
|
||||
static std::map<MqttMessage::Type, int> counters; // Number of processed messages
|
||||
static int instances;
|
||||
#endif
|
||||
MqttError sendTopic(const Topic& topic, MqttMessage::Type type, uint8_t qos);
|
||||
void resubscribe();
|
||||
uint32_t keepAlive() const { return keep_alive; }
|
||||
|
||||
friend class MqttBroker;
|
||||
MqttClient(MqttBroker* parent, TcpClient* client);
|
||||
// republish a received publish if topic matches any in subscriptions
|
||||
MqttError publishIfSubscribed(const Topic& topic, const MqttMessage& msg);
|
||||
private:
|
||||
bool mqtt_connected() const { return cltFlags & CltFlagConnected; }
|
||||
void setFlag(CltFlags f) { cltFlags |= f; }
|
||||
void resetFlag(CltFlags f) { cltFlags &= ~f; }
|
||||
|
||||
void clientAlive(uint32_t more_seconds);
|
||||
void processMessage(const MqttMessage* message);
|
||||
// event when tcp/ip link established (real or fake)
|
||||
static void onConnect(void * client_ptr, TcpClient*);
|
||||
#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);
|
||||
void resubscribe();
|
||||
|
||||
bool mqtt_connected = false;
|
||||
char mqtt_flags;
|
||||
uint32_t keep_alive = 60;
|
||||
uint32_t alive;
|
||||
MqttMessage message;
|
||||
friend class MqttBroker;
|
||||
MqttClient(MqttBroker* local_broker, TcpClient* client);
|
||||
// republish a received publish if topic matches any in subscriptions
|
||||
MqttError publishIfSubscribed(const Topic& topic, MqttMessage& msg);
|
||||
|
||||
// TODO having a pointer on MqttBroker may produce larger binaries
|
||||
// due to unecessary function linked if ever parent is not used
|
||||
// (this is the case when MqttBroker isn't used except here)
|
||||
MqttBroker* parent=nullptr; // connection to local broker
|
||||
void clientAlive(uint32_t more_seconds);
|
||||
void processMessage(MqttMessage* message);
|
||||
|
||||
TcpClient* client=nullptr; // connection to mqtt client or to remote broker
|
||||
std::set<Topic> subscriptions;
|
||||
std::string clientId;
|
||||
CallBack callback = nullptr;
|
||||
uint8_t cltFlags = CltFlagNone;
|
||||
char mqtt_flags;
|
||||
uint32_t keep_alive = 30;
|
||||
uint32_t alive;
|
||||
MqttMessage message;
|
||||
|
||||
// connection to local broker, or link to the parent
|
||||
// when MqttBroker uses MqttClient for each external connexion
|
||||
MqttBroker* local_broker=nullptr;
|
||||
|
||||
TcpClient* tcp_client=nullptr; // connection to remote broker
|
||||
std::set<Topic> subscriptions;
|
||||
string clientId;
|
||||
CallBack callback = nullptr;
|
||||
};
|
||||
|
||||
class MqttBroker
|
||||
{
|
||||
enum State
|
||||
{
|
||||
Disconnected, // Also the initial state
|
||||
Connecting, // connect and sends a fake publish to avoid circular cnx
|
||||
Connected, // this->broker is connected and circular cnx avoided
|
||||
};
|
||||
public:
|
||||
// TODO limit max number of clients
|
||||
MqttBroker(uint16_t port);
|
||||
~MqttBroker();
|
||||
public:
|
||||
// TODO limit max number of clients
|
||||
MqttBroker(uint16_t port, uint8_t retain_size=0);
|
||||
~MqttBroker();
|
||||
|
||||
void begin() { server->begin(); }
|
||||
void loop();
|
||||
void begin() { server->begin(); }
|
||||
void loop();
|
||||
|
||||
void connect(const std::string& host, uint16_t port=1883);
|
||||
bool connected() const { return state == Connected; }
|
||||
/** Connect the broker to a parent broker */
|
||||
void connect(const string& host, uint16_t port=1883);
|
||||
/** returns true if connected to another broker */
|
||||
bool connected() const { return remote_broker ? remote_broker->connected() : false; }
|
||||
|
||||
size_t clientsCount() const { return clients.size(); }
|
||||
size_t clientsCount() const { return clients.size(); }
|
||||
uint8_t retain() { return retain_size; }
|
||||
void retain(uint8_t size) { retain_size = size; if (size==0) retained.clear(); }
|
||||
uint8_t retainCount() const { return retained.size(); }
|
||||
|
||||
void dump(std::string indent="")
|
||||
{
|
||||
for(auto client: clients)
|
||||
client->dump(indent);
|
||||
}
|
||||
void dump(string indent="")
|
||||
{
|
||||
for(auto client: clients)
|
||||
client->dump(indent);
|
||||
}
|
||||
|
||||
private:
|
||||
friend class MqttClient;
|
||||
const std::vector<MqttClient*> getClients() const { return clients; }
|
||||
#ifdef EPOXY_DUINO
|
||||
static int instances;
|
||||
#endif
|
||||
|
||||
static void onClient(void*, TcpClient*);
|
||||
bool checkUser(const char* user, uint8_t len) const
|
||||
{ return compareString(auth_user, user, len); }
|
||||
private:
|
||||
friend class MqttClient;
|
||||
|
||||
bool checkPassword(const char* password, uint8_t len) const
|
||||
{ return compareString(auth_password, password, len); }
|
||||
static void onClient(void*, TcpClient*);
|
||||
bool checkUser(const char* user, uint8_t len) const
|
||||
{ return compareString(auth_user, user, len); }
|
||||
|
||||
bool checkPassword(const char* password, uint8_t len) const
|
||||
{ return compareString(auth_password, password, len); }
|
||||
|
||||
MqttError publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const;
|
||||
MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg);
|
||||
|
||||
MqttError subscribe(const Topic& topic, uint8_t qos);
|
||||
MqttError subscribe(MqttClient*, const Topic& topic, uint8_t qos);
|
||||
|
||||
// For clients that are added not by the broker itself
|
||||
void addClient(MqttClient* client);
|
||||
void removeClient(MqttClient* client);
|
||||
// For clients that are added not by the broker itself (local clients)
|
||||
void addClient(MqttClient* client);
|
||||
void removeClient(MqttClient* client);
|
||||
|
||||
bool compareString(const char* good, const char* str, uint8_t str_len) const;
|
||||
std::vector<MqttClient*> clients;
|
||||
TcpServer* server;
|
||||
bool compareString(const char* good, const char* str, uint8_t str_len) const;
|
||||
std::vector<MqttClient*> clients;
|
||||
|
||||
const char* auth_user = "guest";
|
||||
const char* auth_password = "guest";
|
||||
State state = Disconnected;
|
||||
private:
|
||||
TcpServer* server = nullptr;
|
||||
|
||||
MqttClient* broker = nullptr;
|
||||
const char* auth_user = "guest";
|
||||
const char* auth_password = "guest";
|
||||
MqttClient* remote_broker = nullptr;
|
||||
|
||||
void closeRemoteBroker();
|
||||
|
||||
void retain(const Topic& topic, const MqttMessage& msg);
|
||||
void retainDrop();
|
||||
|
||||
struct Retain
|
||||
{
|
||||
Retain(unsigned long ts, const MqttMessage& m) : timestamp(ts), msg(m) {}
|
||||
Retain(Retain&& r) : timestamp(r.timestamp), msg(std::move(r.msg)) {}
|
||||
|
||||
Retain& operator=(Retain&& r)
|
||||
{
|
||||
timestamp = r.timestamp;
|
||||
msg = std::move(r.msg);
|
||||
return *this;
|
||||
}
|
||||
|
||||
unsigned long timestamp;
|
||||
MqttMessage msg;
|
||||
};
|
||||
|
||||
std::map<Topic, Retain> retained;
|
||||
uint8_t retain_size;
|
||||
};
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
const char *ssid = "YOUR-SSID-HERE";
|
||||
const char *password = "YOUR-PASSWORD-HERE";
|
||||
@@ -1,20 +1,40 @@
|
||||
SUB=
|
||||
|
||||
all:runtests
|
||||
|
||||
tests:
|
||||
set -e; \
|
||||
for i in *-tests/Makefile; do \
|
||||
@set -e; \
|
||||
for i in $(SUB)*-tests/Makefile; do \
|
||||
echo '==== Making:' $$(dirname $$i); \
|
||||
$(MAKE) -C $$(dirname $$i) -j; \
|
||||
done
|
||||
$(MAKE) -C compile-test
|
||||
|
||||
runtests: tests
|
||||
set -e; \
|
||||
for i in *-tests/Makefile; do \
|
||||
valgrind:
|
||||
@set -e; \
|
||||
$(MAKE) tests; \
|
||||
for i in $(SUB)*-tests/Makefile; do \
|
||||
echo '==== Running:' $$(dirname $$i); \
|
||||
valgrind $$(dirname $$i)/$$(dirname $$i).out; \
|
||||
done
|
||||
|
||||
debugtest:
|
||||
@set -e; \
|
||||
$(MAKE) clean; \
|
||||
$(MAKE) -C debug-mode -j; \
|
||||
debug-mode/debug-tests.out
|
||||
|
||||
runtests:
|
||||
@set -e; \
|
||||
$(MAKE) tests; \
|
||||
for i in $(SUB)*-tests/Makefile; do \
|
||||
echo '==== Running:' $$(dirname $$i); \
|
||||
$$(dirname $$i)/$$(dirname $$i).out; \
|
||||
done
|
||||
|
||||
clean:
|
||||
set -e; \
|
||||
for i in *-tests/Makefile; do \
|
||||
@set -e; \
|
||||
for i in $(SUB)*-tests/Makefile; do \
|
||||
echo '==== Cleaning:' $$(dirname $$i); \
|
||||
$(MAKE) -C $$(dirname $$i) clean; \
|
||||
done
|
||||
|
||||
11
tests/Makefile.opts
Normal file
11
tests/Makefile.opts
Normal file
@@ -0,0 +1,11 @@
|
||||
|
||||
# GCC
|
||||
# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
|
||||
EXTRA_CXXFLAGS=-g3 -O0 -std=c++17
|
||||
|
||||
CXXFLAGS=-D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0
|
||||
|
||||
# CLANG SANITIZE
|
||||
# CXX=clang
|
||||
# EXTRA_CXXFLAGS=-g3 -O0 -fsanitize=memory
|
||||
# LDFLAGS = -lpthread -lstdc++
|
||||
10
tests/classbind-tests/Makefile
Normal file
10
tests/classbind-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 -DTINY_MQTT_TESTS
|
||||
|
||||
APP_NAME := classbind-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
353
tests/classbind-tests/classbind-tests.ino
Normal file
353
tests/classbind-tests/classbind-tests.ino
Normal file
@@ -0,0 +1,353 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <MqttClassBinder.h>
|
||||
#include <map>
|
||||
#include <iostream>
|
||||
#include <iomanip>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
#include <iostream>
|
||||
|
||||
// --------------------- CUT HERE - MQTT MESSAGE ROUTER FILE ----------------------------
|
||||
|
||||
class TestReceiver : public MqttClassBinder<TestReceiver>
|
||||
{
|
||||
public:
|
||||
TestReceiver(const char* name) : MqttClassBinder(), name_(name) {}
|
||||
|
||||
void onPublish(const MqttClient* /* source */, const Topic& topic, const char* /* payload */, size_t /* length */)
|
||||
{
|
||||
(void) topic;
|
||||
// Serial << "--> routed message received by " << name_ << ':' << topic.c_str() << " = " << payload << endl;
|
||||
messages[name_]++;
|
||||
}
|
||||
|
||||
private:
|
||||
const std::string name_;
|
||||
|
||||
public:
|
||||
static std::map<std::string, int> messages;
|
||||
};
|
||||
|
||||
std::map<std::string, int> TestReceiver::messages;
|
||||
|
||||
static int unrouted = 0;
|
||||
void onUnrouted(const MqttClient*, const Topic& topic, const char*, size_t)
|
||||
{
|
||||
(void) topic;
|
||||
// Serial << "--> unrouted: " << topic.c_str() << endl;
|
||||
unrouted++;
|
||||
}
|
||||
|
||||
|
||||
static std::string topic="sensor/temperature";
|
||||
|
||||
/**
|
||||
* TinyMqtt network unit tests.
|
||||
*
|
||||
* No wifi connection unit tests.
|
||||
* Checks with a local broker. Clients must connect to the local broker
|
||||
**/
|
||||
|
||||
// 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)
|
||||
{
|
||||
return String(ip[0])+'.'+String(ip[1])+'.'+String(ip[2])+'.'+String(ip[3]);
|
||||
}
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
void reset_and_start_servers(int n, bool early_accept = true)
|
||||
{
|
||||
MqttClassBinder<TestReceiver>::reset();
|
||||
TestReceiver::messages.clear();
|
||||
unrouted = 0;
|
||||
|
||||
ESP8266WiFiClass::resetInstances();
|
||||
ESP8266WiFiClass::earlyAccept = early_accept;
|
||||
while(n)
|
||||
{
|
||||
ESP8266WiFiClass::selectInstance(n--);
|
||||
WiFi.mode(WIFI_STA);
|
||||
WiFi.begin("fake_ssid", "fake_pwd");
|
||||
}
|
||||
}
|
||||
|
||||
test(classbind_one_client_receives_the_message)
|
||||
{
|
||||
reset_and_start_servers(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress ip_broker = WiFi.localIP();
|
||||
|
||||
// We have a 2nd ESP in order to test through wifi (opposed to local)
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
assertTrue(client.connected());
|
||||
|
||||
TestReceiver receiver("receiver");
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client, &receiver);
|
||||
|
||||
client.subscribe("a/b");
|
||||
client.publish("a/b", "ab");
|
||||
|
||||
for (int i =0; i<10; i++)
|
||||
{
|
||||
client.loop();
|
||||
broker.loop();
|
||||
}
|
||||
|
||||
assertEqual(TestReceiver::messages["receiver"], 1);
|
||||
assertEqual(unrouted, 0);
|
||||
}
|
||||
|
||||
test(classbind_routes_should_be_empty_when_receiver_goes_out_of_scope)
|
||||
{
|
||||
reset_and_start_servers(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress ip_broker = WiFi.localIP();
|
||||
|
||||
// We have a 2nd ESP in order to test through wifi (opposed to local)
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
assertTrue(client.connected());
|
||||
|
||||
// Make a receiver going out of scope
|
||||
{
|
||||
TestReceiver receiver("receiver");
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client, &receiver);
|
||||
assertEqual(MqttClassBinder<TestReceiver>::size(), (size_t)1);
|
||||
}
|
||||
|
||||
client.subscribe("a/b");
|
||||
client.publish("a/b", "ab");
|
||||
|
||||
for (int i =0; i<10; i++)
|
||||
{
|
||||
client.loop();
|
||||
broker.loop();
|
||||
}
|
||||
|
||||
assertEqual(TestReceiver::messages["receiver"], 0);
|
||||
assertEqual(MqttClassBinder<TestReceiver>::size(), (size_t)0);
|
||||
}
|
||||
|
||||
test(classbind_publish_should_be_dispatched_to_many_receivers)
|
||||
{
|
||||
reset_and_start_servers(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress ip_broker = WiFi.localIP();
|
||||
|
||||
// We have a 2nd ESP in order to test through wifi (opposed to local)
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
assertTrue(client.connected());
|
||||
|
||||
TestReceiver receiver_1("receiver_1");
|
||||
TestReceiver receiver_2("receiver_2");
|
||||
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client, &receiver_1);
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client, &receiver_2);
|
||||
client.subscribe("a/b");
|
||||
client.publish("a/b", "ab");
|
||||
|
||||
for (int i =0; i<10; i++)
|
||||
{
|
||||
client.loop();
|
||||
broker.loop();
|
||||
}
|
||||
|
||||
assertEqual(TestReceiver::messages["receiver_1"], 1);
|
||||
assertEqual(TestReceiver::messages["receiver_2"], 1);
|
||||
}
|
||||
|
||||
test(classbind_register_to_many_clients)
|
||||
{
|
||||
reset_and_start_servers(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress ip_broker = WiFi.localIP();
|
||||
|
||||
// We have a 2nd ESP in order to test through wifi (opposed to local)
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client_1;
|
||||
client_1.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
|
||||
MqttClient client_2;
|
||||
client_2.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
|
||||
assertTrue(client_1.connected());
|
||||
assertTrue(client_2.connected());
|
||||
|
||||
TestReceiver receiver("receiver");
|
||||
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client_1, &receiver);
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client_2, &receiver);
|
||||
|
||||
auto loop = [&client_1, &client_2, &broker]()
|
||||
{
|
||||
client_1.loop();
|
||||
client_2.loop();
|
||||
broker.loop();
|
||||
};
|
||||
|
||||
client_1.subscribe("a/b");
|
||||
client_2.subscribe("a/b");
|
||||
|
||||
// Ensure subscribptions are passed
|
||||
for (int i =0; i<5; i++) loop();
|
||||
|
||||
client_1.publish("a/b", "from 1");
|
||||
client_2.publish("a/b", "from 2");
|
||||
|
||||
// Ensure publishes are processed
|
||||
for (int i =0; i<5; i++) loop();
|
||||
|
||||
assertEqual(TestReceiver::messages["receiver"], 4);
|
||||
}
|
||||
|
||||
test(classbind_unrouted_fallback)
|
||||
{
|
||||
reset_and_start_servers(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress ip_broker = WiFi.localIP();
|
||||
|
||||
// We have a 2nd ESP in order to test through wifi (opposed to local)
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
|
||||
assertTrue(client.connected());
|
||||
|
||||
MqttClassBinder<TestReceiver>::onUnpublished(onUnrouted);
|
||||
{
|
||||
TestReceiver receiver("receiver");
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client, &receiver);
|
||||
}
|
||||
|
||||
client.subscribe("a/b");
|
||||
client.publish("a/b", "from 2");
|
||||
|
||||
// Ensure subscribptions are passed
|
||||
for (int i =0; i<5; i++)
|
||||
{
|
||||
client.loop();
|
||||
broker.loop();
|
||||
}
|
||||
|
||||
assertEqual(TestReceiver::messages["receiver"], 0);
|
||||
assertEqual(unrouted, 1);
|
||||
}
|
||||
|
||||
test(classbind_should_cleanup_when_MqttClient_dies)
|
||||
{
|
||||
reset_and_start_servers(2, true);
|
||||
TestReceiver receiver("receiver");
|
||||
|
||||
{
|
||||
MqttClient client;
|
||||
|
||||
MqttClassBinder<TestReceiver>::onPublish(&client, &receiver);
|
||||
assertEqual(MqttClassBinder<TestReceiver>::size(), (size_t)1);
|
||||
}
|
||||
assertEqual(MqttClassBinder<TestReceiver>::size(), (size_t)1);
|
||||
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// setup() and loop()
|
||||
void setup() {
|
||||
/* delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
*/
|
||||
|
||||
Serial.println("=============[ TinyMqtt class-bind TESTS ]========================");
|
||||
|
||||
WiFi.mode(WIFI_STA);
|
||||
WiFi.begin("network", "password");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
|
||||
if (Serial.available()) ESP.reset();
|
||||
}
|
||||
23
tests/compile-test/Makefile
Normal file
23
tests/compile-test/Makefile
Normal file
@@ -0,0 +1,23 @@
|
||||
# vim: noexpandtab
|
||||
|
||||
|
||||
APP_NAME := compile-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync ESP8266mDNS TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
DUMMY := 1
|
||||
RUN = no
|
||||
APP_SRCS_COMP += $(shell find ../../examples -name "*.ino")
|
||||
APP_SRCS_CPP += $(APP_SRCS_COMP:%.ino=%.o)
|
||||
CXXFLAGS = -D_GNU_SOURCE -Werror=return-type -std=gnu++17 -Wall -g3 -O0 -DEPOXY_DUINO
|
||||
|
||||
include ../Makefile.opts
|
||||
|
||||
all:
|
||||
|
||||
compile-tests.out: $(OBJS)
|
||||
|
||||
run:
|
||||
@echo "No run for compile tests"
|
||||
exit 0
|
||||
|
||||
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 TinyConsole
|
||||
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();
|
||||
}
|
||||
7
tests/howto
Normal file
7
tests/howto
Normal file
@@ -0,0 +1,7 @@
|
||||
cd TinyMqtt/tests/../..
|
||||
git clone https://github.com/hsaturn/EspMock.git
|
||||
git clone https://github.com/bxparks/AUnit.git
|
||||
git clone https://github.com/bxparks/EpoxyDuino.git
|
||||
cd TinyMqtt/tests
|
||||
make
|
||||
make runtests
|
||||
10
tests/length-tests.todo/Makefile
Normal file
10
tests/length-tests.todo/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 := length-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
54
tests/length-tests.todo/length-tests.ino
Normal file
54
tests/length-tests.todo/length-tests.ino
Normal file
@@ -0,0 +1,54 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt local unit tests.
|
||||
*
|
||||
* Clients are connected to pseudo remote broker
|
||||
* The remote should be 127.0.0.1:1883 <--- But this does not work due to Esp network limitations
|
||||
* 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
|
||||
|
||||
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(length_decode_greater_than_127)
|
||||
{
|
||||
// TODO WRITE THIS TEST
|
||||
// The test should verify than a mqtt message with more than 127 bytes is correctly decoded
|
||||
assertEqual(1,2);
|
||||
}
|
||||
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// 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();
|
||||
}
|
||||
@@ -1,8 +1,10 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
include ../Makefile.opts
|
||||
|
||||
APP_NAME := local-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
|
||||
@@ -1,152 +1,221 @@
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt local unit tests.
|
||||
*
|
||||
* Clients are connected to pseudo remote broker
|
||||
* The remote should be 127.0.0.1:1883 <--- But this does not work due to Esp network limitations
|
||||
* 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
|
||||
**/
|
||||
* TinyMqtt local unit tests.
|
||||
*
|
||||
* Clients are connected to pseudo remote broker
|
||||
* The remote should be 127.0.0.1:1883 <--- But this does not work due to Esp network limitations
|
||||
* 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;
|
||||
using string = TinyConsole::string;
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
|
||||
const char* lastPayload;
|
||||
std::string lastPayload;
|
||||
size_t lastLength;
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
lastPayload = payload;
|
||||
lastLength = length;
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
lastPayload = std::string(payload, length);
|
||||
lastLength = length;
|
||||
}
|
||||
|
||||
test(local_not_connected_by_default)
|
||||
{
|
||||
MqttClient client;
|
||||
assertEqual(client.connected(), false);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
assertEqual(broker.connected(), false);
|
||||
}
|
||||
|
||||
test(local_client_should_unregister_when_destroyed)
|
||||
{
|
||||
return;
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
{
|
||||
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);
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
{
|
||||
assertEqual(broker.clientsCount(), (size_t)0); // Ensure client is not yet connected
|
||||
MqttClient client(&broker);
|
||||
assertEqual(broker.clientsCount(), (size_t)1); // Ensure client is now connected
|
||||
}
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
}
|
||||
|
||||
test(local_client_do_not_disconnect_after_publishing_and_long_inactivity)
|
||||
{
|
||||
published.clear();
|
||||
EpoxyTest::set_millis(0);
|
||||
MqttBroker broker(1883);
|
||||
MqttClient client(&broker, "client");
|
||||
MqttClient sender(&broker, "sender");
|
||||
broker.loop();
|
||||
|
||||
client.subscribe("#");
|
||||
client.subscribe("test");
|
||||
client.setCallback(onPublish);
|
||||
assertEqual(broker.clientsCount(), (size_t)2);
|
||||
|
||||
sender.publish("test", "value");
|
||||
broker.loop();
|
||||
|
||||
EpoxyTest::add_seconds(600);
|
||||
client.loop();
|
||||
sender.loop();
|
||||
broker.loop();
|
||||
|
||||
sender.publish("test", "value");
|
||||
broker.loop();
|
||||
sender.loop();
|
||||
broker.loop();
|
||||
|
||||
assertEqual(broker.clientsCount(), (size_t)2);
|
||||
assertEqual(sender.connected(), true);
|
||||
assertEqual(client.connected(), true);
|
||||
|
||||
assertEqual(published.size(), (size_t)1); // client has received something
|
||||
}
|
||||
|
||||
#if 0
|
||||
test(local_connect)
|
||||
{
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient client;
|
||||
assertTrue(client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
MqttClient client(&broker);
|
||||
assertTrue(client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
}
|
||||
|
||||
test(local_publish_to_nowhere)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient publisher;
|
||||
MqttError status = publisher.publish("a/b");
|
||||
assertEqual(status, MqttError::MqttNowhereToSend);
|
||||
}
|
||||
|
||||
test(local_publish_should_be_dispatched)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber;
|
||||
subscriber.subscribe("a/b");
|
||||
subscriber.subscribe("a/c");
|
||||
subscriber.setCallback(onPublish);
|
||||
MqttClient subscriber(&broker, "");
|
||||
subscriber.subscribe("a/b");
|
||||
subscriber.subscribe("a/c");
|
||||
subscriber.setCallback(onPublish);
|
||||
|
||||
MqttClient publisher;
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/c");
|
||||
publisher.publish("a/c");
|
||||
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);
|
||||
assertEqual(published.size(), (size_t)1); // 1 client has received something
|
||||
assertEqual(published[""]["a/b"], 1);
|
||||
assertEqual(published[""]["a/c"], 2);
|
||||
}
|
||||
|
||||
test(hudge_payload)
|
||||
{
|
||||
published.clear();
|
||||
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b"); // Note -> this does not send any byte .... (nowhere to send)
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b", payload); // This publish is received
|
||||
|
||||
// onPublish should have filled lastPayload and lastLength
|
||||
assertEqual(payload, lastPayload.c_str());
|
||||
assertEqual(lastLength, strlen(payload));
|
||||
assertEqual(strncmp(payload, lastPayload.c_str(), lastLength), 0);
|
||||
}
|
||||
|
||||
test(local_publish_should_be_dispatched_to_local_clients)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber_a("A");
|
||||
subscriber_a.setCallback(onPublish);
|
||||
subscriber_a.subscribe("a/b");
|
||||
subscriber_a.subscribe("a/c");
|
||||
MqttClient subscriber_a(&broker, "A");
|
||||
subscriber_a.setCallback(onPublish);
|
||||
subscriber_a.subscribe("a/b");
|
||||
subscriber_a.subscribe("a/c");
|
||||
|
||||
MqttClient subscriber_b("B");
|
||||
subscriber_b.setCallback(onPublish);
|
||||
subscriber_b.subscribe("a/b");
|
||||
MqttClient subscriber_b(&broker, "B");
|
||||
subscriber_b.setCallback(onPublish);
|
||||
subscriber_b.subscribe("a/b");
|
||||
|
||||
MqttClient publisher;
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/c");
|
||||
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);
|
||||
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(local_unsubscribe)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber;
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
MqttClient subscriber(&broker, "");
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher;
|
||||
publisher.publish("a/b");
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b");
|
||||
|
||||
subscriber.unsubscribe("a/b");
|
||||
subscriber.unsubscribe("a/b");
|
||||
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertTrue(published[""]["a/b"] == 1); // Only one publish has been received
|
||||
assertEqual(published[""]["a/b"], 1); // Only one publish has been received
|
||||
}
|
||||
|
||||
test(local_nocallback_when_destroyed)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient publisher;
|
||||
{
|
||||
MqttClient subscriber;
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
publisher.publish("a/b");
|
||||
}
|
||||
MqttClient publisher(&broker);
|
||||
{
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
publisher.publish("a/b");
|
||||
}
|
||||
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||
}
|
||||
#endif
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// setup() and loop()
|
||||
void setup() {
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
|
||||
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
|
||||
Serial.println("=============[ LOCAL TinyMqtt TESTS ]========================");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
aunit::TestRunner::run();
|
||||
|
||||
if (Serial.available()) ESP.reset();
|
||||
if (Serial.available()) ESP.reset();
|
||||
}
|
||||
|
||||
13
tests/network-tests/Makefile
Normal file
13
tests/network-tests/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.
|
||||
|
||||
include ../Makefile.opts
|
||||
|
||||
# Remove flto flag from EpoxyDuino (too many <optimized out>)
|
||||
# CXXFLAGS = -Wextra -Wall -std=gnu++11 -fno-exceptions -fno-threadsafe-statics
|
||||
|
||||
APP_NAME := network-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
714
tests/network-tests/network-tests.ino
Normal file
714
tests/network-tests/network-tests.ino
Normal file
@@ -0,0 +1,714 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
#include <iostream>
|
||||
#include <iomanip>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
#include <iostream>
|
||||
|
||||
/**
|
||||
* TinyMqtt network unit tests.
|
||||
*
|
||||
* No wifi connection unit tests.
|
||||
* Checks with a local broker. Clients must connect to the local broker
|
||||
**/
|
||||
|
||||
using string = TinyConsole::string;
|
||||
|
||||
// if ascii_pos = 0, no ascii dump, else ascii dump starts after column ascii_pos
|
||||
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)
|
||||
{
|
||||
return String(ip[0])+'.'+String(ip[1])+'.'+String(ip[2])+'.'+String(ip[3]);
|
||||
}
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
|
||||
char* lastPayload = nullptr;
|
||||
size_t lastLength;
|
||||
|
||||
void start_many_wifi_esp(int n, bool early_accept = true)
|
||||
{
|
||||
ESP8266WiFiClass::resetInstances();
|
||||
ESP8266WiFiClass::earlyAccept = early_accept;
|
||||
while(n)
|
||||
{
|
||||
ESP8266WiFiClass::selectInstance(n--);
|
||||
WiFi.mode(WIFI_STA);
|
||||
WiFi.begin("fake_ssid", "fake_pwd");
|
||||
}
|
||||
}
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
|
||||
if (lastPayload) free(lastPayload);
|
||||
lastPayload = strdup(payload);
|
||||
lastLength = length;
|
||||
}
|
||||
|
||||
test(single_broker_begin)
|
||||
{
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
|
||||
// TODO Nothing is tested here !
|
||||
}
|
||||
|
||||
test(suback)
|
||||
{
|
||||
start_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress broker_ip = WiFi.localIP();
|
||||
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(broker_ip.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);
|
||||
}
|
||||
|
||||
test(remote_client_deletion)
|
||||
{
|
||||
assertEqual(MqttClient::instances, 0);
|
||||
{
|
||||
start_many_wifi_esp(3, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress broker_ip = WiFi.localIP();
|
||||
|
||||
// A first remote client
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient remote_client;
|
||||
assertEqual(MqttClient::instances, 1);
|
||||
|
||||
remote_client.connect(broker_ip.toString().c_str());
|
||||
broker.loop(); remote_client.loop();
|
||||
assertEqual(MqttClient::instances, 2); // broker creates a client to manage remote_client
|
||||
|
||||
// A second remote client
|
||||
ESP8266WiFiClass::selectInstance(3);
|
||||
MqttClient secund_client;
|
||||
assertEqual(MqttClient::instances, 3);
|
||||
|
||||
secund_client.connect(broker_ip.toString().c_str());
|
||||
broker.loop(); remote_client.loop();
|
||||
assertEqual(MqttClient::instances, 4);
|
||||
|
||||
// Now disconnect remote clients
|
||||
remote_client.close();
|
||||
broker.loop(); remote_client.loop();
|
||||
assertEqual(MqttClient::instances, 3);
|
||||
|
||||
secund_client.close();
|
||||
broker.loop(); remote_client.loop();
|
||||
assertEqual(MqttClient::instances, 2); // These instances are in this scope
|
||||
|
||||
// Now simulate that the external client is dead without disconnecting
|
||||
secund_client.connect(broker_ip.toString().c_str());
|
||||
broker.loop(); remote_client.loop();
|
||||
assertEqual(MqttClient::instances, 3);
|
||||
|
||||
WiFi.disconnect();
|
||||
broker.loop(); remote_client.loop();
|
||||
broker.loop(); remote_client.loop();
|
||||
assertEqual(MqttClient::instances, 2);
|
||||
|
||||
}
|
||||
|
||||
assertEqual(MqttClient::instances, 0);
|
||||
}
|
||||
|
||||
test(broker_connect_and_client_deletion)
|
||||
{
|
||||
assertEqual(MqttClient::instances, 0);
|
||||
{
|
||||
start_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttBroker remote_broker(1883);
|
||||
remote_broker.begin();
|
||||
IPAddress remote_broker_ip = WiFi.localIP();
|
||||
assertEqual(MqttClient::instances, 0);
|
||||
|
||||
ESP8266WiFiClass::selectInstance(1);
|
||||
broker.connect(remote_broker_ip.toString().c_str());
|
||||
remote_broker.loop();
|
||||
assertEqual(remote_broker.clientsCount(), (size_t)1);
|
||||
|
||||
// Here, we have two MqttClient
|
||||
// The client that connects broker to remote_broker
|
||||
// The client created by remote_broker
|
||||
assertEqual(MqttClient::instances, 2);
|
||||
|
||||
broker.connect("");
|
||||
remote_broker.loop(); broker.loop();
|
||||
remote_broker.loop(); broker.loop();
|
||||
assertEqual(remote_broker.clientsCount(), (size_t)0);
|
||||
}
|
||||
assertEqual(MqttClient::instances, 0);
|
||||
}
|
||||
|
||||
test(client_keep_alive_high)
|
||||
{
|
||||
const uint32_t keep_alive=1000;
|
||||
start_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress broker_ip = WiFi.localIP();
|
||||
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(broker_ip.toString().c_str(), 1883, keep_alive);
|
||||
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);
|
||||
|
||||
uint32_t sz = broker.getClients().size();
|
||||
assertEqual(sz , (uint32_t)1);
|
||||
|
||||
uint32_t ka = broker.getClients()[0]->keepAlive();
|
||||
assertEqual(ka, keep_alive);
|
||||
|
||||
}
|
||||
|
||||
test(retained_message)
|
||||
{
|
||||
published.clear();
|
||||
|
||||
start_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
broker.retain(10);
|
||||
IPAddress broker_ip = WiFi.localIP();
|
||||
|
||||
MqttClient local_client(&broker, "sender");
|
||||
|
||||
// Send a retained message
|
||||
// No remote client connected
|
||||
local_client.publish("topic", "retained once", true);
|
||||
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
|
||||
|
||||
// Send a second message on the same topic (issue 86)
|
||||
local_client.publish("topic", "retained once", true);
|
||||
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
|
||||
|
||||
// Send a second message on the same topic (issue 86)
|
||||
local_client.publish("topic", "retained last", true);
|
||||
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
|
||||
|
||||
// No connect a client from 2nd Esp
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient remote_client("receiver");
|
||||
remote_client.connect(broker_ip, 1883);
|
||||
remote_client.setCallback(onPublish);
|
||||
|
||||
assertTrue(remote_client.connected());
|
||||
for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
|
||||
assertEqual(broker.clientsCount(), (size_t) 2);
|
||||
|
||||
// Should not have received anything yet
|
||||
assertEqual(published.size(), (size_t)0);
|
||||
|
||||
// Now, remote client subscribes to topic
|
||||
remote_client.subscribe("#");
|
||||
for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
|
||||
|
||||
// Check that the retained message is published once
|
||||
assertEqual(published.size(), (size_t)1);
|
||||
assertEqual(published["receiver"]["topic"], 1);
|
||||
|
||||
// FIXME we should check that
|
||||
// 1 - Retained message has the retain flag set
|
||||
// 2 - Published retained messages that are send normally have their retain flag off
|
||||
|
||||
// The next part of this test does not pass yet (due to remote_client.close()
|
||||
// that does not work well.
|
||||
return;
|
||||
|
||||
// Now remove the retained message
|
||||
remote_client.close();
|
||||
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
|
||||
assertFalse(remote_client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t) 1);
|
||||
|
||||
// Disconnect / reconnect the remote clien that should receive again the message
|
||||
remote_client.connect(broker_ip, 1883);
|
||||
remote_client.subscribe("topic");
|
||||
assertTrue(remote_client.connected());
|
||||
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
|
||||
assertEqual(broker.clientsCount(), (size_t) 2);
|
||||
assertEqual(published.size(), (size_t)2);
|
||||
|
||||
// Remove the retained message now
|
||||
local_client.publish("topic", "", true);
|
||||
assertEqual(published.size(), (size_t)1);
|
||||
|
||||
// And reconnect the remote client
|
||||
remote_client.connect(broker_ip, 1883);
|
||||
for(int i=0; i<4; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
|
||||
assertEqual(broker.clientsCount(), (size_t) 2);
|
||||
|
||||
// check that the message was received
|
||||
assertEqual(published.size(), (size_t)2);
|
||||
}
|
||||
|
||||
test(retained_payload) // # issue #84
|
||||
{
|
||||
published.clear();
|
||||
|
||||
start_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
broker.retain(10);
|
||||
IPAddress broker_ip = WiFi.localIP();
|
||||
|
||||
MqttClient local_client(&broker, "sender");
|
||||
|
||||
// Send a retained message
|
||||
// No remote client connected
|
||||
local_client.publish("topic", "retained", true);
|
||||
for(int i=0; i<2; i++) { broker.loop(); local_client.loop(); };
|
||||
|
||||
// No connect a client from 2nd Esp
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient remote_client("receiver");
|
||||
remote_client.connect(broker_ip, 1883);
|
||||
remote_client.setCallback(onPublish);
|
||||
remote_client.subscribe("#");
|
||||
|
||||
assertTrue(remote_client.connected());
|
||||
for(int i=0; i<10; i++) { broker.loop(); local_client.loop(); remote_client.loop(); };
|
||||
|
||||
// Check that the retained message is published
|
||||
assertEqual(lastPayload, "retained");
|
||||
}
|
||||
|
||||
test(remote_client_disconnect_reconnect)
|
||||
{
|
||||
published.clear();
|
||||
start_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress broker_ip = WiFi.localIP();
|
||||
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(broker_ip, 1883);
|
||||
|
||||
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
|
||||
assertEqual(broker.clientsCount(), (size_t) 1);
|
||||
|
||||
// Disconnect the client
|
||||
client.close();
|
||||
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
|
||||
assertEqual(broker.clientsCount(), (size_t) 0);
|
||||
|
||||
// Reconnect the client
|
||||
client.connect(broker_ip, 1883);
|
||||
for(int i=0; i<4; i++) { broker.loop(); client.loop(); };
|
||||
assertEqual(broker.clientsCount(), (size_t) 1);
|
||||
}
|
||||
|
||||
test(client_to_broker_connexion)
|
||||
{
|
||||
start_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
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());
|
||||
}
|
||||
|
||||
test(one_client_one_broker_publish_and_subscribe)
|
||||
{
|
||||
start_many_wifi_esp(2, true);
|
||||
published.clear();
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress ip_broker = WiFi.localIP();
|
||||
|
||||
// We have a 2nd ESP in order to test through wifi (opposed to local)
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
assertTrue(client.connected());
|
||||
|
||||
client.setCallback(onPublish);
|
||||
client.subscribe("a/b");
|
||||
client.publish("a/b", "ab");
|
||||
|
||||
for (int i =0; i<2; i++)
|
||||
{
|
||||
client.loop();
|
||||
broker.loop();
|
||||
}
|
||||
|
||||
assertEqual(published.size(), (size_t)1);
|
||||
assertEqual((int)lastLength, (int)2); // sizeof(ab)
|
||||
}
|
||||
|
||||
test(one_client_one_broker_hudge_payload)
|
||||
{
|
||||
start_many_wifi_esp(2, true);
|
||||
published.clear();
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress ip_broker = WiFi.localIP();
|
||||
|
||||
// We have a 2nd ESP in order to test through wifi (opposed to local)
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(ip_broker.toString().c_str(), 1883);
|
||||
broker.loop();
|
||||
assertTrue(client.connected());
|
||||
|
||||
std::string sent;
|
||||
|
||||
for(int i=0; i<400; i++)
|
||||
sent += char('a'+i%26);
|
||||
|
||||
client.setCallback(onPublish);
|
||||
client.subscribe("a/b");
|
||||
client.publish("a/b", sent.c_str());
|
||||
|
||||
for (int i =0; i<2; i++)
|
||||
{
|
||||
client.loop();
|
||||
broker.loop();
|
||||
}
|
||||
|
||||
assertEqual(published.size(), (size_t)1);
|
||||
assertEqual((unsigned int)lastLength, (unsigned int)sent.size());
|
||||
}
|
||||
|
||||
test(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);
|
||||
}
|
||||
|
||||
|
||||
// THESE TESTS ARE IN LOCAL MODE
|
||||
// WE HAVE TO CONVERT THEM TO WIFI MODE (pass through virtual TCP link)
|
||||
|
||||
test(connect)
|
||||
{
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient client(&broker);
|
||||
assertTrue(client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
}
|
||||
|
||||
test(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[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1);
|
||||
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/c"], 2);
|
||||
}
|
||||
|
||||
test(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(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[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1); // Only one publish has been received
|
||||
}
|
||||
|
||||
test(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(small_payload)
|
||||
{
|
||||
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);
|
||||
}
|
||||
|
||||
test(hudge_payload)
|
||||
{
|
||||
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b"); // Note -> this does not send any byte .... (nowhere to send)
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b", payload); // This publish is received
|
||||
|
||||
// onPublish should have filled lastPayload and lastLength
|
||||
assertEqual(payload, lastPayload);
|
||||
assertEqual(lastLength, strlen(payload));
|
||||
assertEqual(strcmp(payload, lastPayload), 0);
|
||||
}
|
||||
|
||||
test(disconnected_when_broker_is_deleted)
|
||||
{
|
||||
MqttBroker* broker = new MqttBroker(1883);
|
||||
broker->begin();
|
||||
|
||||
MqttClient client;
|
||||
client.connect(broker);
|
||||
assertEqual(client.connected(), true);
|
||||
client.publish("a", "b");
|
||||
|
||||
delete broker;
|
||||
assertEqual(client.connected(), false);
|
||||
}
|
||||
|
||||
test(connack)
|
||||
{
|
||||
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_many_wifi_esp(2, true);
|
||||
assertEqual(WiFi.status(), WL_CONNECTED);
|
||||
|
||||
MqttBroker broker(1883);
|
||||
broker.begin();
|
||||
IPAddress broker_ip = WiFi.localIP();
|
||||
|
||||
ESP8266WiFiClass::selectInstance(2);
|
||||
MqttClient client;
|
||||
client.connect(broker_ip.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() {
|
||||
/* delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
*/
|
||||
|
||||
Serial.println("=============[ NETWORK TinyMqtt TESTS ]========================");
|
||||
|
||||
WiFi.mode(WIFI_STA);
|
||||
WiFi.begin("network", "password");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
|
||||
if (Serial.available()) ESP.reset();
|
||||
published.clear(); // Avoid crash in unit tests due to exit handlers
|
||||
}
|
||||
@@ -1,8 +1,10 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
include ../Makefile.opts
|
||||
|
||||
APP_NAME := nowifi-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsyncTCP TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
|
||||
@@ -1,166 +1,283 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt nowifi unit tests.
|
||||
*
|
||||
* No wifi connection unit tests.
|
||||
*
|
||||
* No wifi connection unit tests.
|
||||
* Checks with a local broker. Clients must connect to the local broker
|
||||
**/
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
using string = TinyConsole::string;
|
||||
|
||||
MqttBroker broker(1883);
|
||||
|
||||
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
std::map<string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||
|
||||
char* lastPayload = nullptr;
|
||||
size_t lastLength;
|
||||
|
||||
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||
{
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
|
||||
if (lastPayload) free(lastPayload);
|
||||
if (srce)
|
||||
published[srce->id()][topic]++;
|
||||
|
||||
if (lastPayload) free(lastPayload);
|
||||
lastPayload = strdup(payload);
|
||||
lastLength = length;
|
||||
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);
|
||||
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);
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient client(&broker);
|
||||
assertTrue(client.connected());
|
||||
assertEqual(broker.clientsCount(), (size_t)1);
|
||||
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);
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.subscribe("a/b");
|
||||
subscriber.subscribe("a/c");
|
||||
subscriber.setCallback(onPublish);
|
||||
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");
|
||||
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);
|
||||
assertEqual(published.size(), (size_t)1); // 1 client has received something
|
||||
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1);
|
||||
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/c"], 2);
|
||||
}
|
||||
|
||||
test(nowifi_publish_should_be_dispatched_to_clients)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
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_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 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
|
||||
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);
|
||||
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_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();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b"); // This publish is received
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b"); // This publish is received
|
||||
|
||||
subscriber.unsubscribe("a/b");
|
||||
subscriber.unsubscribe("a/b");
|
||||
|
||||
publisher.publish("a/b"); // Those one, no (unsubscribed)
|
||||
publisher.publish("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
|
||||
assertEqual(published[TINY_MQTT_DEFAULT_CLIENT_ID]["a/b"], 1); // Only one publish has been received
|
||||
}
|
||||
|
||||
test(nowifi_nocallback_when_destroyed)
|
||||
{
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
published.clear();
|
||||
assertEqual(broker.clientsCount(), (size_t)0);
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
MqttClient publisher(&broker);
|
||||
|
||||
{
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
publisher.publish("a/b");
|
||||
}
|
||||
{
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
publisher.publish("a/b");
|
||||
}
|
||||
|
||||
publisher.publish("a/b");
|
||||
publisher.publish("a/b");
|
||||
|
||||
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||
}
|
||||
|
||||
test(nowifi_payload_nullptr)
|
||||
test(nowifi_small_payload)
|
||||
{
|
||||
published.clear();
|
||||
published.clear();
|
||||
|
||||
const char* payload="abcd";
|
||||
const char* payload="abcd";
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b", payload, strlen(payload)); // This publish is received
|
||||
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);
|
||||
assertEqual(lastLength, (size_t)4);
|
||||
}
|
||||
|
||||
test(nowifi_hudge_payload)
|
||||
{
|
||||
const char* payload="This payload is hudge, just because its length exceeds 127. Thus when encoding length, we have to encode it on two bytes at min. This should not prevent the message from being encoded and decoded successfully !";
|
||||
|
||||
MqttClient subscriber(&broker);
|
||||
subscriber.setCallback(onPublish);
|
||||
subscriber.subscribe("a/b");
|
||||
|
||||
MqttClient publisher(&broker);
|
||||
publisher.publish("a/b", payload); // This publish is received
|
||||
|
||||
// onPublish should have filled lastPayload and lastLength
|
||||
assertEqual(payload, lastPayload);
|
||||
assertEqual(lastLength, strlen(payload));
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// 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 ]========================");
|
||||
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
aunit::TestRunner::run();
|
||||
|
||||
if (Serial.available()) ESP.reset();
|
||||
if (Serial.available()) ESP.reset();
|
||||
published.clear(); // Avoid crash at exit handlers
|
||||
}
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||
|
||||
include ../Makefile.opts
|
||||
|
||||
APP_NAME := string-indexer-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <StringIndexer.h>
|
||||
#include <map>
|
||||
|
||||
/**
|
||||
* TinyMqtt / StringIndexer unit tests.
|
||||
*
|
||||
**/
|
||||
* TinyMqtt / StringIndexer unit tests.
|
||||
*
|
||||
**/
|
||||
|
||||
using namespace std;
|
||||
using string = TinyConsole::string;
|
||||
|
||||
test(indexer_empty)
|
||||
{
|
||||
@@ -17,93 +19,101 @@ test(indexer_empty)
|
||||
test(indexer_strings_deleted_should_empty_indexer)
|
||||
{
|
||||
assertTrue(StringIndexer::count()==0);
|
||||
{
|
||||
IndexedString one("one");
|
||||
{
|
||||
IndexedString one("one");
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
IndexedString two("two");
|
||||
IndexedString two("two");
|
||||
assertEqual(StringIndexer::count(), 2);
|
||||
IndexedString three("three");
|
||||
IndexedString three("three");
|
||||
assertEqual(StringIndexer::count(), 3);
|
||||
IndexedString four("four");
|
||||
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");
|
||||
IndexedString one ("one");
|
||||
IndexedString two ("one");
|
||||
IndexedString three("one");
|
||||
IndexedString fourt("one");
|
||||
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
}
|
||||
|
||||
test(indexer_size_of_indexed_string)
|
||||
{
|
||||
assertEqual(sizeof(IndexedString), (size_t)1);
|
||||
assertEqual(sizeof(IndexedString), (size_t)1);
|
||||
}
|
||||
|
||||
test(indexer_different_strings_are_different)
|
||||
{
|
||||
IndexedString one("one");
|
||||
IndexedString two("two");
|
||||
IndexedString one("one");
|
||||
IndexedString two("two");
|
||||
|
||||
assertFalse(one == two);
|
||||
assertFalse(one == two);
|
||||
}
|
||||
|
||||
test(indexer_same_strings_should_equal)
|
||||
{
|
||||
IndexedString one("one");
|
||||
IndexedString two("one");
|
||||
IndexedString one("one");
|
||||
IndexedString two("one");
|
||||
|
||||
assertTrue(one == two);
|
||||
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");
|
||||
{
|
||||
IndexedString same = one;
|
||||
assertTrue(one == same);
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
IndexedString one("one");
|
||||
{
|
||||
IndexedString same = one;
|
||||
assertTrue(one == same);
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
}
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
assertEqual(StringIndexer::count(), 1);
|
||||
}
|
||||
|
||||
test(indexer_get_string)
|
||||
{
|
||||
std::string sone("one");
|
||||
IndexedString one(sone);
|
||||
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");
|
||||
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());
|
||||
assertTrue(two1.getIndex() == two2.getIndex());
|
||||
assertTrue(one1.getIndex() != two1.getIndex());
|
||||
}
|
||||
|
||||
//----------------------------------------------------------------------------
|
||||
// setup() and loop()
|
||||
void setup() {
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
delay(1000);
|
||||
Serial.begin(115200);
|
||||
while(!Serial);
|
||||
|
||||
Serial.println("=============[ TinyMqtt StringIndexer TESTS ]========================");
|
||||
Serial.println("=============[ TinyMqtt StringIndexer TESTS ]========================");
|
||||
}
|
||||
|
||||
void loop() {
|
||||
aunit::TestRunner::run();
|
||||
aunit::TestRunner::run();
|
||||
|
||||
// if (Serial.available()) ESP.reset();
|
||||
// if (Serial.available()) ESP.reset();
|
||||
}
|
||||
|
||||
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.
|
||||
|
||||
include ../Makefile.opts
|
||||
|
||||
APP_NAME := topic-tests
|
||||
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock ESP8266WiFi ESPAsync TinyConsole
|
||||
ARDUINO_LIB_DIRS := ../../../EspMock/libraries
|
||||
EPOXY_CORE := EPOXY_CORE_ESP8266
|
||||
include ../../../EpoxyDuino/EpoxyDuino.mk
|
||||
82
tests/topic-tests/topic-tests.ino
Normal file
82
tests/topic-tests/topic-tests.ino
Normal file
@@ -0,0 +1,82 @@
|
||||
// vim: ts=2 sw=2 expandtab
|
||||
#include <Arduino.h>
|
||||
#include <AUnit.h>
|
||||
#include <TinyMqtt.h>
|
||||
#include <map>
|
||||
#include <iostream>
|
||||
|
||||
/**
|
||||
* TinyMqtt / StringIndexer unit tests.
|
||||
*
|
||||
**/
|
||||
|
||||
bool testTopicMatch(const char* a, const char* b, bool expected)
|
||||
{
|
||||
Topic ta(a);
|
||||
Topic tb(b);
|
||||
bool match(ta.matches(tb));
|
||||
std::cout << " " << ta.c_str() << ' ';
|
||||
if (match != expected)
|
||||
std::cout << (expected ? " should match " : " should not match ");
|
||||
else
|
||||
std::cout << (expected ? " matches " : " unmatches ");
|
||||
std::cout << tb.c_str() << std::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