Compare commits
118 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
20292b7b7b | ||
|
|
26de3befa8 | ||
|
|
1098466055 | ||
|
|
2d3663e78c | ||
|
|
5e16282ad0 | ||
|
|
e35a43c4a4 | ||
|
|
087a203ba0 | ||
|
|
5d313bbf5e | ||
|
|
ce896f02c4 | ||
|
|
d3210c3c93 | ||
|
|
23f1207718 | ||
|
|
122ab88960 | ||
|
|
28b0ac1611 | ||
|
|
1cfb5cfab1 | ||
|
|
b023cd67a9 | ||
|
|
24ee6b5201 | ||
|
|
2e92a98db2 | ||
|
|
c59bddfd39 | ||
|
|
7bdb9cc0cd | ||
|
|
be62699702 | ||
|
|
77da47e1da | ||
|
|
88797bfafd | ||
|
|
1e3b37623d | ||
|
|
ba6a96976a | ||
|
|
6afd3939b3 | ||
|
|
2ffe0c13fa | ||
|
|
fe3f8d7b32 | ||
|
|
d1c7ebe134 | ||
|
|
aa0ed9a7a7 | ||
|
|
48eb0daf9a | ||
|
|
34c05bc37a | ||
|
|
7c96c4a5cc | ||
|
|
b280196395 | ||
|
|
c75f4893e8 | ||
|
|
d666f6a53b | ||
|
|
7ef18de755 | ||
|
|
838df3a34a | ||
|
|
ad602194cf | ||
|
|
afc9370e3e | ||
|
|
d96143f185 | ||
|
|
9c939a5667 | ||
|
|
8a25155fd8 | ||
|
|
d64ffe772e | ||
|
|
db610e6f0f | ||
|
|
6711f30ad0 | ||
|
|
3e8d34e4e7 | ||
|
|
67a296eb28 | ||
|
|
e90076d010 | ||
|
|
f42464c173 | ||
|
|
36b452281f | ||
|
|
077c0c6adf | ||
|
|
6f1e5d7488 | ||
|
|
ca8ad88109 | ||
|
|
986a9c592d | ||
|
|
62868cba34 | ||
|
|
80dade00fe | ||
|
|
8254bd4831 | ||
|
|
5834a278c7 | ||
|
|
146d0de1d4 | ||
|
|
297a22efb5 | ||
|
|
510ff514a9 | ||
|
|
ad6f7155e5 | ||
|
|
3ed5874373 | ||
|
|
e1a936e081 | ||
|
|
0757a95fbf | ||
|
|
7c8d71262f | ||
|
|
138ce973f2 | ||
|
|
bf499117b7 | ||
|
|
4ed6f72602 | ||
|
|
87a78c549f | ||
|
|
5211360b91 | ||
|
|
549a23ffb7 | ||
|
|
3a1af655d7 | ||
|
|
e71ffefc5a | ||
|
|
b6a0dde2b1 | ||
|
|
babc391632 | ||
|
|
27bdbb9a0b | ||
|
|
6a9e158428 | ||
|
|
6fc6794dc3 | ||
|
|
1eaa514579 | ||
|
|
7af4c2ca69 | ||
|
|
a340558460 | ||
|
|
9a7db237d3 | ||
|
|
91e083e7b0 | ||
|
|
97adc985e6 | ||
|
|
6fcfc9dfc0 | ||
|
|
a6596ffc89 | ||
|
|
533ab0c70d | ||
|
|
d5dd896b45 | ||
|
|
bd7fa8f39c | ||
|
|
6395e931ce | ||
|
|
635fee6f7c | ||
|
|
dc2420d88e | ||
|
|
2fbc46cbe2 | ||
|
|
a003156ae1 | ||
|
|
913e1aa7ae | ||
|
|
8272515bd7 | ||
|
|
9a7f6a3020 | ||
|
|
fead702d9f | ||
|
|
eaf938f2fd | ||
|
|
8eefa63f45 | ||
|
|
9d48c436d8 | ||
|
|
792a28e831 | ||
|
|
9407193454 | ||
|
|
602050f309 | ||
|
|
1a70c90af2 | ||
|
|
ed4091c53e | ||
|
|
f2a805f724 | ||
|
|
3083bcf071 | ||
|
|
d01f46dbc1 | ||
|
|
39b2257619 | ||
|
|
60d385189b | ||
|
|
3f2c1c57e1 | ||
|
|
e550197d0a | ||
|
|
253bc9b3f5 | ||
|
|
96d8018960 | ||
|
|
505cacc2df | ||
|
|
62848056a2 |
28
.github/workflows/aunit.yml
vendored
Normal file
28
.github/workflows/aunit.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# See https://docs.github.com/en/actions/guides for documentation about GitHub
|
||||||
|
# Actions.
|
||||||
|
|
||||||
|
name: AUnit Tests
|
||||||
|
|
||||||
|
# Run on all branches.
|
||||||
|
on: [push]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Setup
|
||||||
|
run: |
|
||||||
|
cd ..
|
||||||
|
git clone https://github.com/bxparks/EpoxyDuino
|
||||||
|
git clone https://github.com/bxparks/AceRoutine
|
||||||
|
git clone https://github.com/bxparks/AUnit
|
||||||
|
git clone https://github.com/bxparks/AceCommon
|
||||||
|
git clone https://github.com/hsaturn/EspMock
|
||||||
|
- name: Verify tests
|
||||||
|
run: |
|
||||||
|
make -C tests
|
||||||
|
make -C tests runtests
|
||||||
18
.github/workflows/ci.yml
vendored
Normal file
18
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
name: "CI"
|
||||||
|
on:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
ci:
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout this repository
|
||||||
|
uses: actions/checkout@v2.3.4
|
||||||
|
- name: Cache for arduino-ci
|
||||||
|
uses: actions/cache@v2.1.3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.arduino15
|
||||||
|
key: ${{ runner.os }}-arduino
|
||||||
|
- name: Install nix
|
||||||
|
uses: cachix/install-nix-action@v12
|
||||||
|
- run: nix-shell -I nixpkgs=channel:nixpkgs-unstable -p arduino-ci --run "arduino-ci"
|
||||||
1
.github/workflows/superlinter.yml
vendored
1
.github/workflows/superlinter.yml
vendored
@@ -1,6 +1,7 @@
|
|||||||
name: Super-Linter
|
name: Super-Linter
|
||||||
|
|
||||||
# Run this workflow every time a new commit pushed to your repository
|
# Run this workflow every time a new commit pushed to your repository
|
||||||
|
#
|
||||||
on: push
|
on: push
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,2 +0,0 @@
|
|||||||
*~
|
|
||||||
src/my_credentials.h
|
|
||||||
51
README.md
51
README.md
@@ -1,17 +1,19 @@
|
|||||||
# TinyMqtt
|
# TinyMqtt
|
||||||
|
|
||||||

|

|
||||||

|
[](https://github.com/hsaturn/TinyMqtt/actions/workflows/aunit.yml)
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
ESP 8266 is a small, fast and capable Mqtt Broker and Client
|
TinyMqtt is a small, fast and capable Mqtt Broker and Client for Esp8266 / Esp32 / Esp WROOM
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Very (very !!) fast broker I saw it re-sent 1000 topics per second for two
|
- Very (very !!) fast broker I saw it re-sent 1000 topics per second for two
|
||||||
clients that had subscribed (payload ~15 bytes). No topic lost.
|
clients that had subscribed (payload ~15 bytes ESP8266). No topic lost.
|
||||||
The max I've seen was 2k msg/s (1 client 1 subscription)
|
The max I've seen was 2k msg/s (1 client 1 subscription)
|
||||||
- Act as as a mqtt broker and/or a mqtt client
|
- Act as as a mqtt broker and/or a mqtt client
|
||||||
- Mqtt 3.1.1 / Qos 0 supported
|
- Mqtt 3.1.1 / Qos 0 supported
|
||||||
@@ -21,31 +23,16 @@ ESP 8266 is a small, fast and capable Mqtt Broker and Client
|
|||||||
- zeroconf, this is a strange but very powerful mode where
|
- zeroconf, this is a strange but very powerful mode where
|
||||||
all brokers tries to connect together on the same local network.
|
all brokers tries to connect together on the same local network.
|
||||||
|
|
||||||
## TODO List
|
|
||||||
* Use [Async library](https://github.com/me-no-dev/ESPAsyncTCP)
|
|
||||||
* Implement zeroconf mode (needs async)
|
|
||||||
* Add a max_clients in MqttBroker. Used with zeroconf, there will be
|
|
||||||
no need for having tons of clients (also RAM is the problem with many clients)
|
|
||||||
* Test what is the real max number of clients for broker. As far as I saw, 1k is needed per client which would make more than 30 clients critical.
|
|
||||||
* ~~MqttMessage uses a buffer 256 bytes which is usually far than needed.~~
|
|
||||||
* ~~MqttClient does not support more than one subscription at time~~
|
|
||||||
* ~~MqttClient auto re-subscribe (::resubscribe works bad on broker.emqx.io)~~
|
|
||||||
* MqttClient auto reconnection
|
|
||||||
* ~~MqttClient unsubscribe~~
|
|
||||||
* MqttClient does not sent payload to callback...
|
|
||||||
* MqttClient user/password
|
|
||||||
* Wildcards (I may implement only # as I'm not interrested by a clever and cpu consuming matching)
|
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
* install [TinyMqtt library](https://github.com/hsaturn/TinyMqtt)
|
* install [TinyMqtt library](https://github.com/hsaturn/TinyMqtt)
|
||||||
|
(you can use the Arduino library manager and search for TinyMqtt)
|
||||||
* modify <libraries/TinyMqtt/src/my_credentials.h> (wifi setup)
|
* modify <libraries/TinyMqtt/src/my_credentials.h> (wifi setup)
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
||||||
| Example | Description |
|
| Example | Description |
|
||||||
| ---------------------------- | --------------------------------- |
|
| ------------------- | ------------------------------------------ |
|
||||||
| client-without-wifi | standalone example |
|
| client-without-wifi | standalone example |
|
||||||
| simple-client | Connect the ESP to an external Mqtt broker |
|
| simple-client | Connect the ESP to an external Mqtt broker |
|
||||||
| simple-broker | Simple Mqtt broker with your ESP |
|
| simple-broker | Simple Mqtt broker with your ESP |
|
||||||
@@ -56,11 +43,25 @@ no need for having tons of clients (also RAM is the problem with many clients)
|
|||||||
|
|
||||||
## Standalone mode (zeroconf)
|
## Standalone mode (zeroconf)
|
||||||
-> The zeroconf mode is not yet implemented
|
-> The zeroconf mode is not yet implemented
|
||||||
zerofonf clients to connect to broker on local network.
|
zeroconf clients to connect to broker on local network.
|
||||||
|
|
||||||
In Zeroconf mode, each ESP is a a broker and scans the local network.
|
In Zeroconf mode, each ESP is a a broker and scans the local network.
|
||||||
After a while one ESP naturally becomes a 'master' and all ESP are connected together.
|
After a while one ESP naturally becomes a 'master' and all ESP are connected together.
|
||||||
No problem if the master dies, a new master will be choosen soon.
|
No problem if the master dies, a new master will be choosen soon.
|
||||||
|
|
||||||
|
## TODO List
|
||||||
|
* ~~Use [Async library](https://github.com/me-no-dev/ESPAsyncTCP)~~
|
||||||
|
* Implement zeroconf mode (needs async)
|
||||||
|
* Add a max_clients in MqttBroker. Used with zeroconf, there will be
|
||||||
|
no need for having tons of clients (also RAM is the problem with many clients)
|
||||||
|
* Why not a 'global' TinyMqtt::loop() instead of having to call loop for all broker/clients instances
|
||||||
|
* Test what is the real max number of clients for broker. As far as I saw, 1k is needed per client which would make more than 30 clients critical.
|
||||||
|
* ~~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)
|
||||||
|
* I suspect that MqttClient::parent could be removed and replaced with a simple boolean
|
||||||
|
(this'll need to rewrite a few functions)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Gnu GPL 3.0, see [LICENSE](https://github.com/hsaturn/TinyMqtt/blob/main/LICENSE).
|
Gnu GPL 3.0, see [LICENSE](https://github.com/hsaturn/TinyMqtt/blob/main/LICENSE).
|
||||||
|
|||||||
@@ -3,20 +3,32 @@
|
|||||||
/**
|
/**
|
||||||
* Local broker that accept connections and two local clients
|
* 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)
|
* pros - Reduces internal latency (when publish is received by the same ESP)
|
||||||
* - Reduces wifi traffic
|
* - Reduces wifi traffic
|
||||||
* - No need to have an external broker
|
* - No need to have an external broker
|
||||||
* - can still report to a 'main' broker (TODO see documentation that have to be written)
|
* - can still report to a 'main' broker (TODO see documentation that have to be written)
|
||||||
* - accepts external clients
|
* - accepts external clients
|
||||||
*
|
*
|
||||||
* cons - Takes more memory
|
* cons - Takes more memory
|
||||||
* - a bit hard to understand
|
* - a bit hard to understand
|
||||||
*
|
*
|
||||||
* This sounds crazy: a mqtt mqtt that do not need a broker !
|
|
||||||
* The use case arise when one ESP wants to publish topics and subscribe to them at the same time.
|
|
||||||
* Without broker, the ESP won't react to its own topics.
|
|
||||||
*
|
|
||||||
* TinyMqtt mqtt allows this use case to work.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <my_credentials.h>
|
#include <my_credentials.h>
|
||||||
@@ -37,8 +49,8 @@ void onPublishB(const MqttClient* source, const Topic& topic, const char* payloa
|
|||||||
void setup()
|
void setup()
|
||||||
{
|
{
|
||||||
Serial.begin(115200);
|
Serial.begin(115200);
|
||||||
delay(500);
|
delay(500);
|
||||||
Serial << "Clients with wifi " << endl;
|
Serial << "Clients with wifi " << endl;
|
||||||
|
|
||||||
WiFi.mode(WIFI_STA);
|
WiFi.mode(WIFI_STA);
|
||||||
WiFi.begin(ssid, password);
|
WiFi.begin(ssid, password);
|
||||||
@@ -47,8 +59,8 @@ void setup()
|
|||||||
|
|
||||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||||
|
|
||||||
broker.begin();
|
broker.begin();
|
||||||
|
|
||||||
mqtt_a.setCallback(onPublishA);
|
mqtt_a.setCallback(onPublishA);
|
||||||
mqtt_a.subscribe(topic);
|
mqtt_a.subscribe(topic);
|
||||||
|
|
||||||
@@ -58,30 +70,30 @@ void setup()
|
|||||||
|
|
||||||
void loop()
|
void loop()
|
||||||
{
|
{
|
||||||
broker.loop();
|
broker.loop(); // Don't forget to add loop for every broker and clients
|
||||||
|
|
||||||
mqtt_a.loop();
|
mqtt_a.loop();
|
||||||
mqtt_b.loop();
|
mqtt_b.loop();
|
||||||
|
|
||||||
// ============= client A publish ================
|
// ============= client A publish ================
|
||||||
static const int intervalA = 5000; // publishes every 5s
|
static const int intervalA = 5000; // publishes every 5s
|
||||||
static uint32_t timerA = millis() + intervalA;
|
static uint32_t timerA = millis() + intervalA;
|
||||||
|
|
||||||
if (millis() > timerA)
|
if (millis() > timerA)
|
||||||
{
|
{
|
||||||
Serial << "A is publishing " << topic.c_str() << endl;
|
Serial << "A is publishing " << topic.c_str() << endl;
|
||||||
timerA += intervalA;
|
timerA += intervalA;
|
||||||
mqtt_a.publish(topic);
|
mqtt_a.publish(topic);
|
||||||
}
|
}
|
||||||
|
|
||||||
// ============= client B publish ================
|
// ============= client B publish ================
|
||||||
static const int intervalB = 7000; // will send topic each 7s
|
static const int intervalB = 7000; // will send topic each 7s
|
||||||
static uint32_t timerB = millis() + intervalB;
|
static uint32_t timerB = millis() + intervalB;
|
||||||
|
|
||||||
if (millis() > timerB)
|
if (millis() > timerB)
|
||||||
{
|
{
|
||||||
Serial << "B is publishing " << topic.c_str() << endl;
|
Serial << "B is publishing " << topic.c_str() << endl;
|
||||||
timerB += intervalB;
|
timerB += intervalB;
|
||||||
mqtt_b.publish(topic, std::string(String(15+millis()%10).c_str()));
|
mqtt_b.publish(topic, std::string(String(15+millis()%10).c_str()));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,12 +1,30 @@
|
|||||||
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
||||||
|
|
||||||
/** TinyMQTT allows a disconnected mode:
|
/** TinyMQTT allows a disconnected mode:
|
||||||
*
|
*
|
||||||
* In this example, local clients A and B are talking together, no need to be connected.
|
* +-----------------------------+
|
||||||
* A single ESP can use this to be able to comunicate with itself with the power
|
* | ESP |
|
||||||
* of MQTT, and once connected still continue to work with others.
|
* | +--------+ |
|
||||||
*
|
* | +-------->| broker | |
|
||||||
*/
|
* | | +--------+ |
|
||||||
|
* | | ^ |
|
||||||
|
* | | | |
|
||||||
|
* | v v |
|
||||||
|
* | +----------+ +----------+ |
|
||||||
|
* | | internal | | internal | |
|
||||||
|
* | | client | | client | |
|
||||||
|
* | +----------+ +----------+ |
|
||||||
|
* | |
|
||||||
|
* +-----------------------------+
|
||||||
|
*
|
||||||
|
* In this example, local clients A and B are talking together, no need to be connected.
|
||||||
|
*
|
||||||
|
* A single ESP can use this to be able to comunicate with itself with the power
|
||||||
|
* of MQTT, and once connected still continue to work with others.
|
||||||
|
*
|
||||||
|
* The broker may still be conected if wifi is on.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
std::string topic="sensor/temperature";
|
std::string topic="sensor/temperature";
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,16 @@
|
|||||||
#define PORT 1883
|
#define PORT 1883
|
||||||
MqttBroker broker(PORT);
|
MqttBroker broker(PORT);
|
||||||
|
|
||||||
|
/** Basic Mqtt Broker
|
||||||
|
*
|
||||||
|
* +-----------------------------+
|
||||||
|
* | ESP |
|
||||||
|
* | +--------+ |
|
||||||
|
* | | broker | | 1883 <--- External client/s
|
||||||
|
* | +--------+ |
|
||||||
|
* | |
|
||||||
|
* +-----------------------------+
|
||||||
|
*/
|
||||||
void setup()
|
void setup()
|
||||||
{
|
{
|
||||||
Serial.begin(115200);
|
Serial.begin(115200);
|
||||||
|
|||||||
@@ -1,9 +1,23 @@
|
|||||||
#include <ESP8266WiFi.h>
|
|
||||||
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
|
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
|
||||||
|
|
||||||
/** Simple Client
|
/** Simple Client (The simplest configuration)
|
||||||
*
|
*
|
||||||
* This is the simplest Mqtt client configuration
|
*
|
||||||
|
* +--------+
|
||||||
|
* +------>| broker |<--- < Other client
|
||||||
|
* | +--------+
|
||||||
|
* |
|
||||||
|
* +-----------------+
|
||||||
|
* | ESP | |
|
||||||
|
* | +----------+ |
|
||||||
|
* | | internal | |
|
||||||
|
* | | client | |
|
||||||
|
* | +----------+ |
|
||||||
|
* | |
|
||||||
|
* +-----------------+
|
||||||
|
*
|
||||||
|
* 1 - edit my_credentials.h to setup wifi essid/password
|
||||||
|
* 2 - change BROKER values (or keep emqx.io test broker)
|
||||||
*
|
*
|
||||||
* pro - small memory footprint (both ram and flash)
|
* pro - small memory footprint (both ram and flash)
|
||||||
* - very simple to setup and use
|
* - very simple to setup and use
|
||||||
@@ -13,6 +27,9 @@
|
|||||||
* - local publishes takes more time (because they go outside)
|
* - local publishes takes more time (because they go outside)
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
const char* BROKER = "broker.emqx.io";
|
||||||
|
const uint16_t BROKER_PORT = 1883;
|
||||||
|
|
||||||
#include <my_credentials.h>
|
#include <my_credentials.h>
|
||||||
|
|
||||||
static float temp=19;
|
static float temp=19;
|
||||||
@@ -32,8 +49,7 @@ void setup()
|
|||||||
|
|
||||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||||
|
|
||||||
client.connect("192.168.1.40", 1883); // Put here your broker ip / port
|
client.connect(BROKER, BROKER_PORT); // Put here your broker ip / port
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void loop()
|
void loop()
|
||||||
|
|||||||
@@ -1,21 +1,25 @@
|
|||||||
#define TINY_MQTT_DEBUG
|
|
||||||
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
|
||||||
#include <MqttStreaming.h>
|
#include <MqttStreaming.h>
|
||||||
|
#if defined(ESP8266)
|
||||||
|
#include <ESP8266mDNS.h>
|
||||||
|
#elif defined(ESP32)
|
||||||
|
#include <ESPmDNS.h>
|
||||||
|
#else
|
||||||
|
#error Unsupported platform
|
||||||
|
#endif
|
||||||
|
#include <ESPmDNS.h>
|
||||||
|
|
||||||
#include <sstream>
|
#include <sstream>
|
||||||
#include <map>
|
#include <map>
|
||||||
|
|
||||||
/**
|
/** Very complex example
|
||||||
* Console allowing to make any kind of test.
|
* Console allowing to make any kind of test.
|
||||||
*
|
*
|
||||||
* pros - Reduces internal latency (when publish is received by the same ESP)
|
* Upload the sketch, the use the terminal.
|
||||||
* - Reduces wifi traffic
|
* Press H for mini help.
|
||||||
* - 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
|
|
||||||
*
|
|
||||||
* cons - Takes more memory
|
|
||||||
* - a bit hard to understand
|
|
||||||
*
|
*
|
||||||
|
* tested with mqtt-spy-0.5.4
|
||||||
|
* TODO examples of scripts
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <my_credentials.h>
|
#include <my_credentials.h>
|
||||||
@@ -40,6 +44,7 @@ std::map<std::string, MqttBroker*> brokers;
|
|||||||
|
|
||||||
void setup()
|
void setup()
|
||||||
{
|
{
|
||||||
|
WiFi.persistent(false); // https://github.com/esp8266/Arduino/issues/1054
|
||||||
Serial.begin(115200);
|
Serial.begin(115200);
|
||||||
delay(500);
|
delay(500);
|
||||||
Serial << endl << endl << endl
|
Serial << endl << endl << endl
|
||||||
@@ -54,6 +59,14 @@ void setup()
|
|||||||
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
Serial << "Connected to " << ssid << "IP address: " << WiFi.localIP() << endl;
|
||||||
Serial << "Type help for more..." << endl;
|
Serial << "Type help for more..." << endl;
|
||||||
|
|
||||||
|
const char* name="tinytest";
|
||||||
|
Serial << "Starting MDNS, name= " << name;
|
||||||
|
if (!MDNS.begin(name))
|
||||||
|
Serial << " error, not available." << endl;
|
||||||
|
else
|
||||||
|
Serial << " ok." << endl;
|
||||||
|
|
||||||
|
|
||||||
MqttBroker* broker = new MqttBroker(1883);
|
MqttBroker* broker = new MqttBroker(1883);
|
||||||
broker->begin();
|
broker->begin();
|
||||||
brokers["broker"] = broker;
|
brokers["broker"] = broker;
|
||||||
@@ -125,10 +138,10 @@ std::string getip(std::string& str, const char* if_empty=nullptr, char sep=' ')
|
|||||||
std::map<std::string, std::string> vars;
|
std::map<std::string, std::string> vars;
|
||||||
|
|
||||||
std::set<std::string> commands = {
|
std::set<std::string> commands = {
|
||||||
"auto", "broker", "client", "connect",
|
"auto", "broker", "blink", "client", "connect",
|
||||||
"create", "delete", "help", "interval",
|
"create", "delete", "help", "interval",
|
||||||
"ls", "ip", "off", "on", "set",
|
"ls", "ip", "off", "on", "set",
|
||||||
"publish", "reset", "subscribe", "view"
|
"publish", "reset", "subscribe", "unsubscribe", "view", "every"
|
||||||
};
|
};
|
||||||
|
|
||||||
void getCommand(std::string& search)
|
void getCommand(std::string& search)
|
||||||
@@ -306,15 +319,414 @@ std::map<MqttClient*, automatic*> automatic::autos;
|
|||||||
|
|
||||||
bool compare(std::string s, const char* cmd)
|
bool compare(std::string s, const char* cmd)
|
||||||
{
|
{
|
||||||
if (s.length()==0 or s.length()>strlen(cmd)) return false;
|
uint8_t p=0;
|
||||||
return strncmp(cmd, s.c_str(), s.length())==0;
|
while(s[p++]==*cmd++)
|
||||||
|
{
|
||||||
|
if (*cmd==0 or s[p]==0) return true;
|
||||||
|
if (s[p]==' ') return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
|
using ClientFunction = void(*)(std::string& cmd, MqttClient* publish);
|
||||||
|
|
||||||
|
struct Every
|
||||||
|
{
|
||||||
|
std::string cmd;
|
||||||
|
uint32_t ms;
|
||||||
|
uint32_t next;
|
||||||
|
|
||||||
|
void dump()
|
||||||
|
{
|
||||||
|
auto mill=millis();
|
||||||
|
Serial << ms << "ms [" << cmd << "] next in ";
|
||||||
|
if (mill > next)
|
||||||
|
Serial << "now";
|
||||||
|
else
|
||||||
|
Serial << next-mill << "ms";
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
uint32_t blink_ms_on[16];
|
||||||
|
uint32_t blink_ms_off[16];
|
||||||
|
uint32_t blink_next[16];
|
||||||
|
bool blink_state[16];
|
||||||
|
int16_t blink;
|
||||||
|
|
||||||
|
std::vector<Every> everies;
|
||||||
|
|
||||||
|
void eval(std::string& cmd)
|
||||||
|
{
|
||||||
|
while(cmd.length())
|
||||||
|
{
|
||||||
|
MqttError retval = MqttOk;
|
||||||
|
|
||||||
|
std::string s;
|
||||||
|
MqttBroker* broker = nullptr;
|
||||||
|
MqttClient* client = nullptr;
|
||||||
|
|
||||||
|
// client.function notation
|
||||||
|
// ("a.fun " becomes "fun a ")
|
||||||
|
if (cmd.find('.') != std::string::npos &&
|
||||||
|
cmd.find('.') < cmd.find(' '))
|
||||||
|
{
|
||||||
|
s=getword(cmd, nullptr, '.');
|
||||||
|
|
||||||
|
if (s.length())
|
||||||
|
{
|
||||||
|
if (clients.find(s) != clients.end())
|
||||||
|
{
|
||||||
|
client = clients[s];
|
||||||
|
}
|
||||||
|
else if (brokers.find(s) != brokers.end())
|
||||||
|
{
|
||||||
|
broker = brokers[s];
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
Serial << "Unknown class (" << s.c_str() << ")" << endl;
|
||||||
|
cmd="";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
s = getword(cmd);
|
||||||
|
if (s.length()) getCommand(s);
|
||||||
|
if (s.length()==0)
|
||||||
|
{}
|
||||||
|
else if (compare(s, "delete"))
|
||||||
|
{
|
||||||
|
if (client==nullptr && broker==nullptr)
|
||||||
|
{
|
||||||
|
s = getword(cmd);
|
||||||
|
if (clients.find(s) != clients.end())
|
||||||
|
{
|
||||||
|
client = clients[s];
|
||||||
|
}
|
||||||
|
else if (brokers.find(s) != brokers.end())
|
||||||
|
{
|
||||||
|
broker = brokers[s];
|
||||||
|
}
|
||||||
|
else
|
||||||
|
Serial << "Unable to find (" << s.c_str() << ")" << endl;
|
||||||
|
}
|
||||||
|
if (client)
|
||||||
|
{
|
||||||
|
for (auto it: clients)
|
||||||
|
{
|
||||||
|
if (it.second != client) continue;
|
||||||
|
Serial << "deleted" << endl;
|
||||||
|
delete (it.second);
|
||||||
|
clients.erase(it.first);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
cmd += " ls";
|
||||||
|
}
|
||||||
|
else if (broker)
|
||||||
|
{
|
||||||
|
for(auto it: brokers)
|
||||||
|
{
|
||||||
|
if (broker != it.second) continue;
|
||||||
|
Serial << "deleted" << endl;
|
||||||
|
delete (it.second);
|
||||||
|
brokers.erase(it.first);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
cmd += " ls";
|
||||||
|
}
|
||||||
|
else
|
||||||
|
Serial << "Nothing to delete" << endl;
|
||||||
|
}
|
||||||
|
else if (broker)
|
||||||
|
{
|
||||||
|
if (compare(s,"connect"))
|
||||||
|
{
|
||||||
|
Serial << "NYI" << endl;
|
||||||
|
}
|
||||||
|
else if (compare(s, "view"))
|
||||||
|
{
|
||||||
|
broker->dump();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (client)
|
||||||
|
{
|
||||||
|
if (compare(s,"connect"))
|
||||||
|
{
|
||||||
|
client->connect(getip(cmd,"192.168.1.40").c_str(), getint(cmd, 1883), getint(cmd, 60));
|
||||||
|
Serial << (client->connected() ? "connected." : "not connected") << endl;
|
||||||
|
}
|
||||||
|
else if (compare(s,"publish"))
|
||||||
|
{
|
||||||
|
while (cmd[0]==' ') cmd.erase(0,1);
|
||||||
|
retval = client->publish(getword(cmd, topic.c_str()), cmd.c_str(), cmd.length());
|
||||||
|
cmd=""; // remove payload
|
||||||
|
}
|
||||||
|
else if (compare(s,"subscribe"))
|
||||||
|
{
|
||||||
|
client->subscribe(getword(cmd, topic.c_str()));
|
||||||
|
}
|
||||||
|
else if (compare(s, "unsubscribe"))
|
||||||
|
{
|
||||||
|
client->unsubscribe(getword(cmd, topic.c_str()));
|
||||||
|
}
|
||||||
|
else if (compare(s, "view"))
|
||||||
|
{
|
||||||
|
client->dump();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (compare(s, "on"))
|
||||||
|
{
|
||||||
|
uint8_t pin=getint(cmd, 2);
|
||||||
|
pinMode(pin, OUTPUT);
|
||||||
|
digitalWrite(pin, HIGH);
|
||||||
|
}
|
||||||
|
else if (compare(s, "off"))
|
||||||
|
{
|
||||||
|
uint8_t pin=getint(cmd, 2);
|
||||||
|
pinMode(pin, OUTPUT);
|
||||||
|
digitalWrite(pin, LOW);
|
||||||
|
}
|
||||||
|
else if (compare(s, "every"))
|
||||||
|
{
|
||||||
|
uint32_t ms = getint(cmd, 0);
|
||||||
|
if (ms and cmd.length())
|
||||||
|
{
|
||||||
|
Every every;
|
||||||
|
every.ms=ms;
|
||||||
|
every.cmd=cmd;
|
||||||
|
every.next=millis()+ms;
|
||||||
|
everies.push_back(every);
|
||||||
|
every.dump();
|
||||||
|
Serial << endl;
|
||||||
|
cmd="";
|
||||||
|
}
|
||||||
|
else if (ms==0 and compare(cmd, "list"))
|
||||||
|
{
|
||||||
|
getword(cmd);
|
||||||
|
Serial << "List of everies (ms=" << millis() << ")" << endl;
|
||||||
|
uint8_t count=0;
|
||||||
|
for(auto& every: everies)
|
||||||
|
{
|
||||||
|
Serial << count << ": ";
|
||||||
|
every.dump();
|
||||||
|
Serial << endl;
|
||||||
|
count++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (ms==0 and compare(cmd, "remove"))
|
||||||
|
{
|
||||||
|
getword(cmd);
|
||||||
|
int8_t every=getint(cmd, -1);
|
||||||
|
if (every==-1 and compare(cmd, "all"))
|
||||||
|
{
|
||||||
|
getword(cmd);
|
||||||
|
everies.clear();
|
||||||
|
}
|
||||||
|
else if (everies.size() > (uint8_t)every)
|
||||||
|
{
|
||||||
|
everies.erase(everies.begin()+every);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (compare(s, "blink"))
|
||||||
|
{
|
||||||
|
int8_t blink_nr = getint(cmd, -1);
|
||||||
|
if (blink_nr >= 0)
|
||||||
|
{
|
||||||
|
blink_ms_on[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
|
||||||
|
blink_ms_off[blink_nr]=getint(cmd, blink_ms_on[blink_nr]);
|
||||||
|
pinMode(blink_nr, OUTPUT);
|
||||||
|
blink_next[blink_nr] = millis();
|
||||||
|
Serial << "Blink " << blink_nr << ' ' << (blink_ms_on[blink_nr] ? "on" : "off") << endl;
|
||||||
|
if (blink_ms_on[blink_nr])
|
||||||
|
blink |= 1<< blink_nr;
|
||||||
|
else
|
||||||
|
{
|
||||||
|
blink &= ~(1<< blink_nr);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (compare(s, "auto"))
|
||||||
|
{
|
||||||
|
automatic::command(client, cmd);
|
||||||
|
if (client == nullptr)
|
||||||
|
cmd.clear();
|
||||||
|
}
|
||||||
|
else if (compare(s, "broker"))
|
||||||
|
{
|
||||||
|
std::string id=getword(cmd);
|
||||||
|
if (id.length() or brokers.find(id)!=brokers.end())
|
||||||
|
{
|
||||||
|
int port=getint(cmd, 0);
|
||||||
|
if (port)
|
||||||
|
{
|
||||||
|
MqttBroker* broker = new MqttBroker(port);
|
||||||
|
broker->begin();
|
||||||
|
|
||||||
|
brokers[id] = broker;
|
||||||
|
Serial << "new broker (" << id.c_str() << ")" << endl;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
Serial << "Missing port" << endl;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
Serial << "Missing or existing broker name (" << id.c_str() << ")" << endl;
|
||||||
|
cmd+=" ls";
|
||||||
|
}
|
||||||
|
else if (compare(s, "client"))
|
||||||
|
{
|
||||||
|
std::string id=getword(cmd);
|
||||||
|
if (id.length() or clients.find(id)!=clients.end())
|
||||||
|
{
|
||||||
|
s=getword(cmd); // broker name
|
||||||
|
if (s=="" or brokers.find(s) != brokers.end())
|
||||||
|
{
|
||||||
|
MqttBroker* broker = nullptr;
|
||||||
|
if (s.length()) broker = brokers[s];
|
||||||
|
MqttClient* client = new MqttClient(broker);
|
||||||
|
client->id(id);
|
||||||
|
clients[id]=client;
|
||||||
|
client->setCallback(onPublish);
|
||||||
|
client->subscribe(topic);
|
||||||
|
Serial << "new client (" << id.c_str() << ", " << s.c_str() << ')' << endl;
|
||||||
|
}
|
||||||
|
else if (s.length())
|
||||||
|
{
|
||||||
|
Serial << " not found." << endl;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
Serial << "Missing or existing client name" << endl;
|
||||||
|
cmd+=" ls";
|
||||||
|
}
|
||||||
|
else if (compare(s, "set"))
|
||||||
|
{
|
||||||
|
std::string name(getword(cmd));
|
||||||
|
if (name.length()==0)
|
||||||
|
{
|
||||||
|
for(auto it: vars)
|
||||||
|
{
|
||||||
|
Serial << " " << it.first << " -> " << it.second << endl;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (commands.find(name) != commands.end())
|
||||||
|
{
|
||||||
|
Serial << "Reserved keyword (" << name << ")" << endl;
|
||||||
|
cmd.clear();
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
if (cmd.length())
|
||||||
|
{
|
||||||
|
vars[name] = cmd;
|
||||||
|
cmd.clear();
|
||||||
|
}
|
||||||
|
else if (vars.find(name) != vars.end())
|
||||||
|
vars.erase(vars.find(name));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (compare(s, "ls") or compare(s, "view"))
|
||||||
|
{
|
||||||
|
Serial << "--< " << clients.size() << " client/s. >--" << endl;
|
||||||
|
for(auto it: clients)
|
||||||
|
{
|
||||||
|
Serial << " "; it.second->dump();
|
||||||
|
}
|
||||||
|
|
||||||
|
Serial << "--< " << brokers.size() << " brokers/s. >--" << endl;
|
||||||
|
for(auto it: brokers)
|
||||||
|
{
|
||||||
|
Serial << " ==[ Broker: " << it.first.c_str() << " ]== ";
|
||||||
|
it.second->dump();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (compare(s, "reset"))
|
||||||
|
ESP.restart();
|
||||||
|
else if (compare(s, "ip"))
|
||||||
|
Serial << "IP: " << WiFi.localIP() << endl;
|
||||||
|
else if (compare(s,"help"))
|
||||||
|
{
|
||||||
|
Serial << "syntax:" << endl;
|
||||||
|
Serial << " MqttBroker:" << endl;
|
||||||
|
Serial << " broker {name} {port} : create a new broker" << endl;
|
||||||
|
Serial << endl;
|
||||||
|
Serial << " MqttClient:" << endl;
|
||||||
|
Serial << " client {name} {parent broker} : create a client then" << endl;
|
||||||
|
Serial << " name.connect [ip] [port] [alive]" << endl;
|
||||||
|
Serial << " name.[un]subscribe [topic]" << endl;
|
||||||
|
Serial << " name.publish [topic][payload]" << endl;
|
||||||
|
Serial << " name.view" << endl;
|
||||||
|
Serial << " name.delete" << endl;
|
||||||
|
|
||||||
|
automatic::help();
|
||||||
|
Serial << endl;
|
||||||
|
Serial << " help" << endl;
|
||||||
|
Serial << " blink [Dx on_ms off_ms]" << endl;
|
||||||
|
Serial << " ls / ip / reset" << endl;
|
||||||
|
Serial << " set [name][value]" << endl;
|
||||||
|
Serial << " ! repeat last command" << endl;
|
||||||
|
Serial << endl;
|
||||||
|
Serial << " every ms [command]; every list; every remove [nr|all]" << endl;
|
||||||
|
Serial << " on {output}; off {output}" << endl;
|
||||||
|
Serial << " $id : name of the client." << endl;
|
||||||
|
Serial << " default topic is '" << topic.c_str() << "'" << endl;
|
||||||
|
Serial << endl;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
while(s[0]==' ') s.erase(0,1);
|
||||||
|
if (s.length())
|
||||||
|
Serial << "Unknown command (" << s.c_str() << ")" << endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (retval != MqttOk)
|
||||||
|
{
|
||||||
|
Serial << "## ERROR " << retval << endl;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
void loop()
|
void loop()
|
||||||
{
|
{
|
||||||
|
auto ms=millis();
|
||||||
|
int8_t out=0;
|
||||||
|
int16_t blink_bits = blink;
|
||||||
|
|
||||||
|
for(auto& every: everies)
|
||||||
|
{
|
||||||
|
if (every.ms && every.cmd.length() && ms > every.next)
|
||||||
|
{
|
||||||
|
std::string cmd(every.cmd);
|
||||||
|
eval(cmd);
|
||||||
|
every.next += every.ms;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
while(blink_bits)
|
||||||
|
{
|
||||||
|
if (blink_ms_on[out] and ms > blink_next[out])
|
||||||
|
{
|
||||||
|
if (blink_state[out])
|
||||||
|
{
|
||||||
|
blink_next[out] += blink_ms_on[out];
|
||||||
|
digitalWrite(out, LOW);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
blink_next[out] += blink_ms_off[out];
|
||||||
|
digitalWrite(abs(out), HIGH);
|
||||||
|
}
|
||||||
|
blink_state[out] = not blink_state[out];
|
||||||
|
}
|
||||||
|
blink_bits >>=1;
|
||||||
|
out++;
|
||||||
|
}
|
||||||
|
|
||||||
static long count;
|
static long count;
|
||||||
|
#if defined(ESP9266)
|
||||||
|
MDNS.update();
|
||||||
|
#endif
|
||||||
|
|
||||||
if (MqttClient::counter != count)
|
if (MqttClient::counter != count)
|
||||||
{
|
{
|
||||||
Serial << "# " << MqttClient::counter << endl;
|
Serial << "# " << MqttClient::counter << endl;
|
||||||
@@ -335,7 +747,6 @@ void loop()
|
|||||||
|
|
||||||
if (c==10 or c==14)
|
if (c==10 or c==14)
|
||||||
{
|
{
|
||||||
|
|
||||||
Serial << "----------------[ " << cmd.c_str() << " ]--------------" << endl;
|
Serial << "----------------[ " << cmd.c_str() << " ]--------------" << endl;
|
||||||
static std::string last_cmd;
|
static std::string last_cmd;
|
||||||
if (cmd=="!")
|
if (cmd=="!")
|
||||||
@@ -344,254 +755,7 @@ void loop()
|
|||||||
last_cmd=cmd;
|
last_cmd=cmd;
|
||||||
|
|
||||||
if (cmd.substr(0,3)!="set") replaceVars(cmd);
|
if (cmd.substr(0,3)!="set") replaceVars(cmd);
|
||||||
while(cmd.length())
|
eval(cmd);
|
||||||
{
|
|
||||||
MqttError retval = MqttOk;
|
|
||||||
|
|
||||||
std::string s;
|
|
||||||
MqttBroker* broker = nullptr;
|
|
||||||
MqttClient* client = nullptr;
|
|
||||||
|
|
||||||
// client.function notation
|
|
||||||
// ("a.fun " becomes "fun a ")
|
|
||||||
if (cmd.find('.') != std::string::npos &&
|
|
||||||
cmd.find('.') < cmd.find(' '))
|
|
||||||
{
|
|
||||||
s=getword(cmd, nullptr, '.');
|
|
||||||
|
|
||||||
if (s.length())
|
|
||||||
{
|
|
||||||
if (clients.find(s) != clients.end())
|
|
||||||
{
|
|
||||||
client = clients[s];
|
|
||||||
}
|
|
||||||
else if (brokers.find(s) != brokers.end())
|
|
||||||
{
|
|
||||||
broker = brokers[s];
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
Serial << "Unknown class (" << s.c_str() << ")" << endl;
|
|
||||||
cmd="";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
s = getword(cmd);
|
|
||||||
if (s.length()) getCommand(s);
|
|
||||||
if (s.length()==0)
|
|
||||||
{}
|
|
||||||
else if (compare(s, "delete"))
|
|
||||||
{
|
|
||||||
if (client==nullptr && broker==nullptr)
|
|
||||||
{
|
|
||||||
s = getword(cmd);
|
|
||||||
if (clients.find(s) != clients.end())
|
|
||||||
{
|
|
||||||
client = clients[s];
|
|
||||||
}
|
|
||||||
else if (brokers.find(s) != brokers.end())
|
|
||||||
{
|
|
||||||
broker = brokers[s];
|
|
||||||
}
|
|
||||||
else
|
|
||||||
Serial << "Unable to find (" << s.c_str() << ")" << endl;
|
|
||||||
}
|
|
||||||
if (client)
|
|
||||||
{
|
|
||||||
clients.erase(s);
|
|
||||||
for (auto it: clients)
|
|
||||||
{
|
|
||||||
if (it.second != client) continue;
|
|
||||||
Serial << "deleted" << endl;
|
|
||||||
clients.erase(it.first);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
cmd += " ls";
|
|
||||||
}
|
|
||||||
else if (broker)
|
|
||||||
{
|
|
||||||
for(auto it: brokers)
|
|
||||||
{
|
|
||||||
Serial << (int32_t)it.second << '/' << (int32_t)broker << endl;
|
|
||||||
if (broker != it.second) continue;
|
|
||||||
Serial << "deleted" << endl;
|
|
||||||
brokers.erase(it.first);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
cmd += " ls";
|
|
||||||
}
|
|
||||||
else
|
|
||||||
Serial << "Nothing to delete" << endl;
|
|
||||||
}
|
|
||||||
else if (broker)
|
|
||||||
{
|
|
||||||
if (compare(s,"connect"))
|
|
||||||
{
|
|
||||||
Serial << "NYI" << endl;
|
|
||||||
}
|
|
||||||
else if (compare(s, "view"))
|
|
||||||
{
|
|
||||||
broker->dump();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (client)
|
|
||||||
{
|
|
||||||
if (compare(s,"connect"))
|
|
||||||
{
|
|
||||||
client->connect(getip(cmd,"192.168.1.40").c_str(), getint(cmd, 1883), getint(cmd, 60));
|
|
||||||
Serial << (client->connected() ? "connected." : "not connected") << endl;
|
|
||||||
}
|
|
||||||
else if (compare(s,"publish"))
|
|
||||||
{
|
|
||||||
while (cmd[0]==' ') cmd.erase(0,1);
|
|
||||||
retval = client->publish(getword(cmd, topic.c_str()), cmd.c_str(), cmd.length());
|
|
||||||
cmd=""; // remove payload
|
|
||||||
}
|
|
||||||
else if (compare(s,"subscribe"))
|
|
||||||
{
|
|
||||||
client->subscribe(getword(cmd, topic.c_str()));
|
|
||||||
}
|
|
||||||
else if (compare(s, "view"))
|
|
||||||
{
|
|
||||||
client->dump();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (compare(s, "auto"))
|
|
||||||
{
|
|
||||||
automatic::command(client, cmd);
|
|
||||||
if (client == nullptr)
|
|
||||||
cmd.clear();
|
|
||||||
}
|
|
||||||
else if (compare(s, "broker"))
|
|
||||||
{
|
|
||||||
std::string id=getword(cmd);
|
|
||||||
if (id.length() or brokers.find(id)!=brokers.end())
|
|
||||||
{
|
|
||||||
int port=getint(cmd, 0);
|
|
||||||
if (port)
|
|
||||||
{
|
|
||||||
MqttBroker* broker = new MqttBroker(port);
|
|
||||||
broker->begin();
|
|
||||||
|
|
||||||
brokers[id] = broker;
|
|
||||||
Serial << "new broker (" << id.c_str() << ")" << endl;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
Serial << "Missing port" << endl;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
Serial << "Missing or existing broker name (" << id.c_str() << ")" << endl;
|
|
||||||
cmd+=" ls";
|
|
||||||
}
|
|
||||||
else if (compare(s, "client"))
|
|
||||||
{
|
|
||||||
std::string id=getword(cmd);
|
|
||||||
if (id.length() or clients.find(id)!=clients.end())
|
|
||||||
{
|
|
||||||
s=getword(cmd); // broker name
|
|
||||||
if (s=="" or brokers.find(s) != brokers.end())
|
|
||||||
{
|
|
||||||
MqttBroker* broker = nullptr;
|
|
||||||
if (s.length()) broker = brokers[s];
|
|
||||||
MqttClient* client = new MqttClient(broker);
|
|
||||||
client->id(id);
|
|
||||||
clients[id]=client;
|
|
||||||
client->setCallback(onPublish);
|
|
||||||
client->subscribe(topic);
|
|
||||||
Serial << "new client (" << id.c_str() << ", " << s.c_str() << ')' << endl;
|
|
||||||
}
|
|
||||||
else if (s.length())
|
|
||||||
{
|
|
||||||
Serial << " not found." << endl;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else
|
|
||||||
Serial << "Missing or existing client name" << endl;
|
|
||||||
cmd+=" ls";
|
|
||||||
}
|
|
||||||
else if (compare(s, "set"))
|
|
||||||
{
|
|
||||||
std::string name(getword(cmd));
|
|
||||||
if (name.length()==0)
|
|
||||||
{
|
|
||||||
for(auto it: vars)
|
|
||||||
{
|
|
||||||
Serial << " " << it.first << " -> " << it.second << endl;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (commands.find(name) != commands.end())
|
|
||||||
{
|
|
||||||
Serial << "Reserved keyword (" << name << ")" << endl;
|
|
||||||
cmd.clear();
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
if (cmd.length())
|
|
||||||
{
|
|
||||||
vars[name] = cmd;
|
|
||||||
cmd.clear();
|
|
||||||
}
|
|
||||||
else if (vars.find(name) != vars.end())
|
|
||||||
vars.erase(vars.find(name));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (compare(s, "ls") or compare(s, "view"))
|
|
||||||
{
|
|
||||||
Serial << "--< " << clients.size() << " client/s. >--" << endl;
|
|
||||||
for(auto it: clients)
|
|
||||||
{
|
|
||||||
Serial << " "; it.second->dump();
|
|
||||||
}
|
|
||||||
|
|
||||||
Serial << "--< " << brokers.size() << " brokers/s. >--" << endl;
|
|
||||||
for(auto it: brokers)
|
|
||||||
{
|
|
||||||
Serial << " ==[ Broker: " << it.first.c_str() << " ]== ";
|
|
||||||
it.second->dump();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else if (compare(s, "reset"))
|
|
||||||
ESP.restart();
|
|
||||||
else if (compare(s, "ip"))
|
|
||||||
Serial << "IP: " << WiFi.localIP() << endl;
|
|
||||||
else if (compare(s,"help"))
|
|
||||||
{
|
|
||||||
Serial << "syntax:" << endl;
|
|
||||||
Serial << " MqttBroker:" << endl;
|
|
||||||
Serial << " broker {name} {port} : create a new broker" << endl;
|
|
||||||
Serial << endl;
|
|
||||||
Serial << " MqttClient:" << endl;
|
|
||||||
Serial << " client {name} {parent broker} : create a client then" << endl;
|
|
||||||
Serial << " name.connect [ip] [port] [alive]" << endl;
|
|
||||||
Serial << " name.subscribe [topic]" << endl;
|
|
||||||
Serial << " name.publish [topic][payload]" << endl;
|
|
||||||
Serial << " name.view" << endl;
|
|
||||||
Serial << " name.delete" << endl;
|
|
||||||
|
|
||||||
automatic::help();
|
|
||||||
Serial << endl;
|
|
||||||
Serial << " help" << endl;
|
|
||||||
Serial << " ls / ip / reset" << endl;
|
|
||||||
Serial << " set [name][value]" << endl;
|
|
||||||
Serial << " ! repeat last command" << endl;
|
|
||||||
Serial << endl;
|
|
||||||
Serial << " $id : name of the client." << endl;
|
|
||||||
Serial << " default topic is '" << topic.c_str() << "'" << endl;
|
|
||||||
Serial << endl;
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
while(s[0]==' ') s.erase(0,1);
|
|
||||||
if (s.length())
|
|
||||||
Serial << "Unknown command (" << s.c_str() << ")" << endl;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (retval != MqttOk)
|
|
||||||
{
|
|
||||||
Serial << "## ERROR " << retval << endl;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -9,13 +9,19 @@
|
|||||||
TinyMqtt KEYWORD1
|
TinyMqtt KEYWORD1
|
||||||
|
|
||||||
MqttBroker KEYWORD1
|
MqttBroker KEYWORD1
|
||||||
|
connect KEYWORD2
|
||||||
|
clientsCount KEYWORD2
|
||||||
begin KEYWORD2
|
begin KEYWORD2
|
||||||
loop KEYWORD2
|
loop KEYWORD2
|
||||||
|
port KEYWORD2
|
||||||
|
|
||||||
MqttClient KEYWORD1
|
MqttClient KEYWORD1
|
||||||
|
connect KEYWORD2
|
||||||
|
connected KEYWORD2
|
||||||
publish KEYWORD2
|
publish KEYWORD2
|
||||||
setCallback KEYWORD2
|
setCallback KEYWORD2
|
||||||
subscribe KEYWORD2
|
subscribe KEYWORD2
|
||||||
|
unsubscribe KEYWORD2
|
||||||
|
|
||||||
Topic KEYWORD1
|
Topic KEYWORD1
|
||||||
matches KEYWORD2
|
matches KEYWORD2
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "TinyMqtt",
|
"name": "TinyMqtt",
|
||||||
"keywords": "ethernet, mqtt, m2m, iot",
|
"keywords": "ethernet, mqtt, m2m, iot",
|
||||||
"description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows you to send and receive MQTT messages. It does support MQTT 3.1.1 without any QOS.",
|
"description": "MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive and host a broker for MQTT. It does support MQTT 3.1.1 with QOS=0 on ESP8266 and ESP32 WROOM platfrms.",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/hsaturn/TinyMqtt.git"
|
"url": "https://github.com/hsaturn/TinyMqtt.git"
|
||||||
},
|
},
|
||||||
"version": "0.7.0",
|
"version": "0.7.4",
|
||||||
"exclude": "",
|
"exclude": "",
|
||||||
"examples": "examples/*/*.ino",
|
"examples": "examples/*/*.ino",
|
||||||
"frameworks": "arduino",
|
"frameworks": "arduino",
|
||||||
|
|||||||
@@ -1,10 +1,11 @@
|
|||||||
name=TinyMqtt
|
name=TinyMqtt
|
||||||
version=0.7.0
|
version=0.7.4
|
||||||
author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
author=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||||
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
maintainer=Francois BIOT, HSaturn, <hsaturn@gmail.com>
|
||||||
sentence=A tiny broker and client library for MQTT messaging.
|
sentence=A tiny broker and client library for MQTT messaging.
|
||||||
paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows you to send and receive MQTT messages and to jhost a broker in your ESP. It does support MQTT 3.1.1 without any QOS.
|
paragraph=MQTT is a lightweight messaging protocol ideal for small devices. This library allows to send and receive MQTT messages and to host a broker in your ESP 8266 and 32 WROOM. It does support MQTT 3.1.1 with QoS=0.
|
||||||
category=Communication
|
category=Communication
|
||||||
url=https://github.com/hsaturn/TinyMqtt
|
url=https://github.com/hsaturn/TinyMqtt
|
||||||
architectures=*
|
architectures=*
|
||||||
includes=TinyMqtt.h
|
includes=TinyMqtt.h
|
||||||
|
depends=AsyncTCP
|
||||||
|
|||||||
@@ -2,7 +2,6 @@
|
|||||||
#include <map>
|
#include <map>
|
||||||
#include <string>
|
#include <string>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include <ESP8266WiFi.h>
|
|
||||||
|
|
||||||
/***
|
/***
|
||||||
* Allows to store up to 255 different strings with one byte class
|
* Allows to store up to 255 different strings with one byte class
|
||||||
@@ -15,11 +14,21 @@ class StringIndexer
|
|||||||
std::string str;
|
std::string str;
|
||||||
uint8_t used=0;
|
uint8_t used=0;
|
||||||
friend class StringIndexer;
|
friend class StringIndexer;
|
||||||
|
|
||||||
|
#if EPOXY_DUINO
|
||||||
|
public:
|
||||||
|
// Workaround to avoid coredump in Indexer::release
|
||||||
|
// when destroying a Topic after the deletion of
|
||||||
|
// StringIndexer::strings map (which can occurs only with AUnit,
|
||||||
|
// never in the ESP itself, because ESP never ends)
|
||||||
|
// (I hate static vars)
|
||||||
|
~StringCounter() { used=255; }
|
||||||
|
#endif
|
||||||
};
|
};
|
||||||
public:
|
public:
|
||||||
using index_t=uint8_t;
|
using index_t=uint8_t;
|
||||||
|
|
||||||
static const index_t strToIndex(const char* str, uint8_t len)
|
static index_t strToIndex(const char* str, uint8_t len)
|
||||||
{
|
{
|
||||||
for(auto it=strings.begin(); it!=strings.end(); it++)
|
for(auto it=strings.begin(); it!=strings.end(); it++)
|
||||||
{
|
{
|
||||||
@@ -29,7 +38,7 @@ class StringIndexer
|
|||||||
return it->first;
|
return it->first;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for(index_t index=0; index<255; index++)
|
for(index_t index=1; index; index++)
|
||||||
{
|
{
|
||||||
if (strings.find(index)==strings.end())
|
if (strings.find(index)==strings.end())
|
||||||
{
|
{
|
||||||
@@ -70,6 +79,8 @@ class StringIndexer
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
static uint16_t count() { return strings.size(); }
|
||||||
|
|
||||||
private:
|
private:
|
||||||
static std::map<index_t, StringCounter> strings;
|
static std::map<index_t, StringCounter> strings;
|
||||||
};
|
};
|
||||||
@@ -88,6 +99,8 @@ class IndexedString
|
|||||||
index=StringIndexer::strToIndex(str, len);
|
index=StringIndexer::strToIndex(str, len);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
IndexedString(const std::string& str) : IndexedString(str.c_str(), str.length()) {};
|
||||||
|
|
||||||
~IndexedString() { StringIndexer::release(index); }
|
~IndexedString() { StringIndexer::release(index); }
|
||||||
|
|
||||||
IndexedString& operator=(const IndexedString& source)
|
IndexedString& operator=(const IndexedString& source)
|
||||||
@@ -102,6 +115,11 @@ class IndexedString
|
|||||||
return i1.index < i2.index;
|
return i1.index < i2.index;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
friend bool operator==(const IndexedString& i1, const IndexedString& i2)
|
||||||
|
{
|
||||||
|
return i1.index == i2.index;
|
||||||
|
}
|
||||||
|
|
||||||
const std::string& str() const { return StringIndexer::str(index); }
|
const std::string& str() const { return StringIndexer::str(index); }
|
||||||
|
|
||||||
const StringIndexer::index_t& getIndex() const { return index; }
|
const StringIndexer::index_t& getIndex() const { return index; }
|
||||||
|
|||||||
344
src/TinyMqtt.cpp
344
src/TinyMqtt.cpp
@@ -9,8 +9,12 @@ void outstring(const char* prefix, const char*p, uint16_t len)
|
|||||||
Serial << '\'' << endl;
|
Serial << '\'' << endl;
|
||||||
}
|
}
|
||||||
|
|
||||||
MqttBroker::MqttBroker(uint16_t port) : server(port)
|
MqttBroker::MqttBroker(uint16_t port)
|
||||||
{
|
{
|
||||||
|
server = new TcpServer(port);
|
||||||
|
#ifdef TCP_ASYNC
|
||||||
|
server->onClient(onClient, this);
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
MqttBroker::~MqttBroker()
|
MqttBroker::~MqttBroker()
|
||||||
@@ -19,18 +23,26 @@ MqttBroker::~MqttBroker()
|
|||||||
{
|
{
|
||||||
delete clients[0];
|
delete clients[0];
|
||||||
}
|
}
|
||||||
|
delete server;
|
||||||
}
|
}
|
||||||
|
|
||||||
// private constructor used by broker only
|
// private constructor used by broker only
|
||||||
MqttClient::MqttClient(MqttBroker* parent, WiFiClient& new_client)
|
MqttClient::MqttClient(MqttBroker* parent, TcpClient* new_client)
|
||||||
: parent(parent)
|
: parent(parent)
|
||||||
{
|
{
|
||||||
client = new WiFiClient(new_client);
|
#ifdef TCP_ASYNC
|
||||||
|
client = new_client;
|
||||||
|
client->onData(onData, this);
|
||||||
|
// client->onConnect() TODO
|
||||||
|
// client->onDisconnect() TODO
|
||||||
|
#else
|
||||||
|
client = new WiFiClient(*new_client);
|
||||||
|
#endif
|
||||||
alive = millis()+5000; // client expires after 5s if no CONNECT msg
|
alive = millis()+5000; // client expires after 5s if no CONNECT msg
|
||||||
}
|
}
|
||||||
|
|
||||||
MqttClient::MqttClient(MqttBroker* parent)
|
MqttClient::MqttClient(MqttBroker* parent, const std::string& id)
|
||||||
: parent(parent)
|
: parent(parent), clientId(id)
|
||||||
{
|
{
|
||||||
client = nullptr;
|
client = nullptr;
|
||||||
|
|
||||||
@@ -41,7 +53,6 @@ MqttClient::~MqttClient()
|
|||||||
{
|
{
|
||||||
close();
|
close();
|
||||||
delete client;
|
delete client;
|
||||||
Serial << "Client deleted" << endl;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void MqttClient::close(bool bSendDisconnect)
|
void MqttClient::close(bool bSendDisconnect)
|
||||||
@@ -68,29 +79,22 @@ void MqttClient::close(bool bSendDisconnect)
|
|||||||
void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
|
void MqttClient::connect(std::string broker, uint16_t port, uint16_t ka)
|
||||||
{
|
{
|
||||||
debug("cnx: closing");
|
debug("cnx: closing");
|
||||||
|
keep_alive = ka;
|
||||||
close();
|
close();
|
||||||
if (client) delete client;
|
if (client) delete client;
|
||||||
client = new WiFiClient;
|
client = new TcpClient;
|
||||||
|
|
||||||
debug("Trying to connect to " << broker.c_str() << ':' << port);
|
debug("Trying to connect to " << broker.c_str() << ':' << port);
|
||||||
|
#ifdef TCP_ASYNC
|
||||||
|
client->onData(onData, this);
|
||||||
|
client->onConnect(onConnect, this);
|
||||||
|
client->connect(broker.c_str(), port);
|
||||||
|
#else
|
||||||
if (client->connect(broker.c_str(), port))
|
if (client->connect(broker.c_str(), port))
|
||||||
{
|
{
|
||||||
debug("cnx: connecting");
|
onConnect(this, client);
|
||||||
MqttMessage msg(MqttMessage::Type::Connect);
|
|
||||||
msg.add("MQTT",4);
|
|
||||||
msg.add(0x4); // Mqtt protocol version 3.1.1
|
|
||||||
msg.add(0x0); // Connect flags TODO user / name
|
|
||||||
|
|
||||||
keep_alive = ka;
|
|
||||||
msg.add(0x00); // keep_alive
|
|
||||||
msg.add((char)keep_alive);
|
|
||||||
msg.add(clientId);
|
|
||||||
debug("cnx: mqtt connecting");
|
|
||||||
msg.sendTo(this);
|
|
||||||
msg.reset();
|
|
||||||
debug("cnx: mqtt sent " << (int32_t)parent);
|
|
||||||
|
|
||||||
clientAlive(0);
|
|
||||||
}
|
}
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
void MqttBroker::addClient(MqttClient* client)
|
void MqttBroker::addClient(MqttClient* client)
|
||||||
@@ -98,6 +102,13 @@ void MqttBroker::addClient(MqttClient* client)
|
|||||||
clients.push_back(client);
|
clients.push_back(client);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void MqttBroker::connect(const std::string& host, uint16_t port)
|
||||||
|
{
|
||||||
|
if (broker == nullptr) broker = new MqttClient;
|
||||||
|
broker->connect(host, port);
|
||||||
|
broker->parent = this; // Because connect removed the link
|
||||||
|
}
|
||||||
|
|
||||||
void MqttBroker::removeClient(MqttClient* remove)
|
void MqttBroker::removeClient(MqttClient* remove)
|
||||||
{
|
{
|
||||||
for(auto it=clients.begin(); it!=clients.end(); it++)
|
for(auto it=clients.begin(); it!=clients.end(); it++)
|
||||||
@@ -105,6 +116,11 @@ void MqttBroker::removeClient(MqttClient* remove)
|
|||||||
auto client=*it;
|
auto client=*it;
|
||||||
if (client==remove)
|
if (client==remove)
|
||||||
{
|
{
|
||||||
|
// TODO if this broker is connected to an external broker
|
||||||
|
// we have to unsubscribe remove's topics.
|
||||||
|
// (but doing this, check that other clients are not subscribed...)
|
||||||
|
// Unless -> we could receive useless messages
|
||||||
|
// -> we are using (memory) one IndexedString plus its string for nothing.
|
||||||
debug("Remove " << clients.size());
|
debug("Remove " << clients.size());
|
||||||
clients.erase(it);
|
clients.erase(it);
|
||||||
debug("Client removed " << clients.size());
|
debug("Client removed " << clients.size());
|
||||||
@@ -114,15 +130,31 @@ void MqttBroker::removeClient(MqttClient* remove)
|
|||||||
debug("Error cannot remove client"); // TODO should not occur
|
debug("Error cannot remove client"); // TODO should not occur
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void MqttBroker::onClient(void* broker_ptr, TcpClient* client)
|
||||||
|
{
|
||||||
|
MqttBroker* broker = static_cast<MqttBroker*>(broker_ptr);
|
||||||
|
|
||||||
|
broker->addClient(new MqttClient(broker, client));
|
||||||
|
debug("New client");
|
||||||
|
}
|
||||||
|
|
||||||
void MqttBroker::loop()
|
void MqttBroker::loop()
|
||||||
{
|
{
|
||||||
WiFiClient client = server.available();
|
#ifndef TCP_ASYNC
|
||||||
|
WiFiClient client = server->available();
|
||||||
|
|
||||||
if (client)
|
if (client)
|
||||||
{
|
{
|
||||||
addClient(new MqttClient(this, client));
|
onClient(this, &client);
|
||||||
debug("New client (" << clients.size() << ')');
|
|
||||||
}
|
}
|
||||||
|
#endif
|
||||||
|
if (broker)
|
||||||
|
{
|
||||||
|
// TODO should monitor broker's activity.
|
||||||
|
// 1 When broker disconnect and reconnect we have to re-subscribe
|
||||||
|
broker->loop();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
// for(auto it=clients.begin(); it!=clients.end(); it++)
|
// for(auto it=clients.begin(); it!=clients.end(); it++)
|
||||||
// use index because size can change during the loop
|
// use index because size can change during the loop
|
||||||
@@ -135,7 +167,7 @@ void MqttBroker::loop()
|
|||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
debug("Client " << client->id().c_str() << " Disconnected, parent=" << (int32_t)client->parent);
|
debug("Client " << client->id().c_str() << " Disconnected, parent=" << (dbg_ptr)client->parent);
|
||||||
// Note: deleting a client not added by the broker itself will probably crash later.
|
// Note: deleting a client not added by the broker itself will probably crash later.
|
||||||
delete client;
|
delete client;
|
||||||
break;
|
break;
|
||||||
@@ -143,7 +175,16 @@ void MqttBroker::loop()
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, MqttMessage& msg)
|
MqttError MqttBroker::subscribe(const Topic& topic, uint8_t qos)
|
||||||
|
{
|
||||||
|
if (broker && broker->connected())
|
||||||
|
{
|
||||||
|
return broker->subscribe(topic, qos);
|
||||||
|
}
|
||||||
|
return MqttNowhereToSend;
|
||||||
|
}
|
||||||
|
|
||||||
|
MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const
|
||||||
{
|
{
|
||||||
MqttError retval = MqttOk;
|
MqttError retval = MqttOk;
|
||||||
|
|
||||||
@@ -152,33 +193,32 @@ MqttError MqttBroker::publish(const MqttClient* source, const Topic& topic, Mqtt
|
|||||||
for(auto client: clients)
|
for(auto client: clients)
|
||||||
{
|
{
|
||||||
i++;
|
i++;
|
||||||
#if TINY_MQTT_DEBUG
|
#ifdef TINY_MQTT_DEBUG
|
||||||
Serial << "brk_" << (broker && broker->connected() ? "con" : "dis") <<
|
Serial << "brk_" << (broker && broker->connected() ? "con" : "dis") <<
|
||||||
" srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
|
" srce=" << (source->isLocal() ? "loc" : "rem") << " clt#" << i << ", local=" << client->isLocal() << ", con=" << client->connected() << endl;
|
||||||
#endif
|
#endif
|
||||||
bool doit = false;
|
bool doit = false;
|
||||||
if (broker && broker->connected()) // Broker is connected
|
if (broker && broker->connected()) // this (MqttBroker) is connected (to a external broker)
|
||||||
{
|
{
|
||||||
// ext broker -> clients or
|
// ext_broker -> clients or clients -> ext_broker
|
||||||
// or clients -> ext broker
|
if (source == broker) // external broker -> internal clients
|
||||||
if (source == broker) // broker -> clients
|
|
||||||
doit = true;
|
doit = true;
|
||||||
else // clients -> broker
|
else // external clients -> this broker
|
||||||
{
|
{
|
||||||
MqttError ret = broker->publish(topic, msg);
|
// As this broker is connected to another broker, simply forward the msg
|
||||||
|
MqttError ret = broker->publishIfSubscribed(topic, msg);
|
||||||
if (ret != MqttOk) retval = ret;
|
if (ret != MqttOk) retval = ret;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else // Disconnected: R7
|
else // Disconnected
|
||||||
{
|
{
|
||||||
// All is allowed
|
|
||||||
doit = true;
|
doit = true;
|
||||||
}
|
}
|
||||||
#if TINY_MQTT_DEBUG
|
#ifdef TINY_MQTT_DEBUG
|
||||||
Serial << ", doit=" << doit << ' ';
|
Serial << ", doit=" << doit << ' ';
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
if (doit) retval = client->publish(topic, msg);
|
if (doit) retval = client->publishIfSubscribed(topic, msg);
|
||||||
debug("");
|
debug("");
|
||||||
}
|
}
|
||||||
return retval;
|
return retval;
|
||||||
@@ -224,24 +264,64 @@ void MqttClient::loop()
|
|||||||
{
|
{
|
||||||
debug("pingreq");
|
debug("pingreq");
|
||||||
uint16_t pingreq = MqttMessage::Type::PingReq;
|
uint16_t pingreq = MqttMessage::Type::PingReq;
|
||||||
client->write((uint8_t*)(&pingreq), 2);
|
client->write((const char*)(&pingreq), 2);
|
||||||
clientAlive(0);
|
clientAlive(0);
|
||||||
|
|
||||||
// TODO when many MqttClient passes through a local browser
|
// TODO when many MqttClient passes through a local broker
|
||||||
// there is no need to send one PingReq per instance.
|
// there is no need to send one PingReq per instance.
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
#ifndef TCP_ASYNC
|
||||||
while(client && client->available()>0)
|
while(client && client->available()>0)
|
||||||
{
|
{
|
||||||
message.incoming(client->read());
|
message.incoming(client->read());
|
||||||
if (message.type())
|
if (message.type())
|
||||||
{
|
{
|
||||||
processMessage();
|
processMessage(&message);
|
||||||
|
message.reset();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void MqttClient::onConnect(void *mqttclient_ptr, TcpClient*)
|
||||||
|
{
|
||||||
|
MqttClient* mqtt = static_cast<MqttClient*>(mqttclient_ptr);
|
||||||
|
debug("cnx: connecting");
|
||||||
|
MqttMessage msg(MqttMessage::Type::Connect);
|
||||||
|
msg.add("MQTT",4);
|
||||||
|
msg.add(0x4); // Mqtt protocol version 3.1.1
|
||||||
|
msg.add(0x0); // Connect flags TODO user / name
|
||||||
|
|
||||||
|
msg.add(0x00); // keep_alive
|
||||||
|
msg.add((char)mqtt->keep_alive);
|
||||||
|
msg.add(mqtt->clientId);
|
||||||
|
debug("cnx: mqtt connecting");
|
||||||
|
msg.sendTo(mqtt);
|
||||||
|
msg.reset();
|
||||||
|
debug("cnx: mqtt sent " << (dbg_ptr)mqtt->parent);
|
||||||
|
|
||||||
|
mqtt->clientAlive(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef TCP_ASYNC
|
||||||
|
void MqttClient::onData(void* client_ptr, TcpClient*, void* data, size_t len)
|
||||||
|
{
|
||||||
|
char* char_ptr = static_cast<char*>(data);
|
||||||
|
MqttClient* client=static_cast<MqttClient*>(client_ptr);
|
||||||
|
while(len>0)
|
||||||
|
{
|
||||||
|
client->message.incoming(*char_ptr++);
|
||||||
|
if (client->message.type())
|
||||||
|
{
|
||||||
|
client->processMessage(&client->message);
|
||||||
|
client->message.reset();
|
||||||
|
}
|
||||||
|
len--;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
void MqttClient::resubscribe()
|
void MqttClient::resubscribe()
|
||||||
{
|
{
|
||||||
// TODO resubscription limited to 256 bytes
|
// TODO resubscription limited to 256 bytes
|
||||||
@@ -269,42 +349,64 @@ MqttError MqttClient::subscribe(Topic topic, uint8_t qos)
|
|||||||
|
|
||||||
subscriptions.insert(topic);
|
subscriptions.insert(topic);
|
||||||
|
|
||||||
if (parent==nullptr) // remote broker ?
|
if (parent==nullptr) // remote broker
|
||||||
{
|
{
|
||||||
debug("remote subscribe");
|
return sendTopic(topic, MqttMessage::Type::Subscribe, qos);
|
||||||
MqttMessage msg(MqttMessage::Type::Subscribe, 2);
|
}
|
||||||
|
else
|
||||||
// TODO manage packet identifier
|
{
|
||||||
msg.add(0);
|
return parent->subscribe(topic, qos);
|
||||||
msg.add(0);
|
|
||||||
|
|
||||||
msg.add(topic);
|
|
||||||
msg.add(qos);
|
|
||||||
ret = msg.sendTo(this);
|
|
||||||
|
|
||||||
// TODO we should wait (state machine) for SUBACK
|
|
||||||
}
|
}
|
||||||
return ret;
|
return ret;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
MqttError MqttClient::unsubscribe(Topic topic)
|
||||||
|
{
|
||||||
|
auto it=subscriptions.find(topic);
|
||||||
|
if (it != subscriptions.end())
|
||||||
|
{
|
||||||
|
subscriptions.erase(it);
|
||||||
|
if (parent==nullptr) // remote broker
|
||||||
|
{
|
||||||
|
return sendTopic(topic, MqttMessage::Type::UnSubscribe, 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return MqttOk;
|
||||||
|
}
|
||||||
|
|
||||||
|
MqttError MqttClient::sendTopic(const Topic& topic, MqttMessage::Type type, uint8_t qos)
|
||||||
|
{
|
||||||
|
MqttMessage msg(type, 2);
|
||||||
|
|
||||||
|
// TODO manage packet identifier
|
||||||
|
msg.add(0);
|
||||||
|
msg.add(0);
|
||||||
|
|
||||||
|
msg.add(topic);
|
||||||
|
msg.add(qos);
|
||||||
|
|
||||||
|
// TODO instead we should wait (state machine) for SUBACK / UNSUBACK ?
|
||||||
|
return msg.sendTo(this);
|
||||||
|
}
|
||||||
|
|
||||||
long MqttClient::counter=0;
|
long MqttClient::counter=0;
|
||||||
|
|
||||||
void MqttClient::processMessage()
|
void MqttClient::processMessage(const MqttMessage* mesg)
|
||||||
{
|
{
|
||||||
counter++;
|
counter++;
|
||||||
#if TINY_MQTT_DEBUG
|
#ifdef TINY_MQTT_DEBUG
|
||||||
if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessage::Type::PingResp)
|
if (mesg->type() != MqttMessage::Type::PingReq && mesg->type() != MqttMessage::Type::PingResp)
|
||||||
{
|
{
|
||||||
Serial << "---> INCOMING " << _HEX(message.type()) << " client(" << (int)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
|
Serial << "---> INCOMING " << _HEX(mesg->type()) << " client(" << (dbg_ptr)client << ':' << clientId << ") mem=" << ESP.getFreeHeap() << endl;
|
||||||
// message.hexdump("Incoming");
|
// mesg->hexdump("Incoming");
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
auto header = message.getVHeader();
|
auto header = mesg->getVHeader();
|
||||||
const char* payload;
|
const char* payload;
|
||||||
uint16_t len;
|
uint16_t len;
|
||||||
bool bclose=true;
|
bool bclose=true;
|
||||||
|
|
||||||
switch(message.type() & 0XF0)
|
switch(mesg->type() & 0XF0)
|
||||||
{
|
{
|
||||||
case MqttMessage::Type::Connect:
|
case MqttMessage::Type::Connect:
|
||||||
if (mqtt_connected)
|
if (mqtt_connected)
|
||||||
@@ -327,30 +429,30 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ClientId
|
// ClientId
|
||||||
message.getString(payload, len);
|
mesg->getString(payload, len);
|
||||||
clientId = std::string(payload, len);
|
clientId = std::string(payload, len);
|
||||||
payload += len;
|
payload += len;
|
||||||
|
|
||||||
if (mqtt_flags & FlagWill) // Will topic
|
if (mqtt_flags & FlagWill) // Will topic
|
||||||
{
|
{
|
||||||
message.getString(payload, len); // Will Topic
|
mesg->getString(payload, len); // Will Topic
|
||||||
outstring("WillTopic", payload, len);
|
outstring("WillTopic", payload, len);
|
||||||
payload += len;
|
payload += len;
|
||||||
|
|
||||||
message.getString(payload, len); // Will Message
|
mesg->getString(payload, len); // Will Message
|
||||||
outstring("WillMessage", payload, len);
|
outstring("WillMessage", payload, len);
|
||||||
payload += len;
|
payload += len;
|
||||||
}
|
}
|
||||||
// FIXME forgetting credential is allowed (security hole)
|
// FIXME forgetting credential is allowed (security hole)
|
||||||
if (mqtt_flags & FlagUserName)
|
if (mqtt_flags & FlagUserName)
|
||||||
{
|
{
|
||||||
message.getString(payload, len);
|
mesg->getString(payload, len);
|
||||||
if (!parent->checkUser(payload, len)) break;
|
if (!parent->checkUser(payload, len)) break;
|
||||||
payload += len;
|
payload += len;
|
||||||
}
|
}
|
||||||
if (mqtt_flags & FlagPassword)
|
if (mqtt_flags & FlagPassword)
|
||||||
{
|
{
|
||||||
message.getString(payload, len);
|
mesg->getString(payload, len);
|
||||||
if (!parent->checkPassword(payload, len)) break;
|
if (!parent->checkPassword(payload, len)) break;
|
||||||
payload += len;
|
payload += len;
|
||||||
}
|
}
|
||||||
@@ -389,7 +491,7 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
|||||||
if (client)
|
if (client)
|
||||||
{
|
{
|
||||||
uint16_t pingreq = MqttMessage::Type::PingResp;
|
uint16_t pingreq = MqttMessage::Type::PingResp;
|
||||||
client->write((uint8_t*)(&pingreq), 2);
|
client->write((const char*)(&pingreq), 2);
|
||||||
bclose = false;
|
bclose = false;
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
@@ -404,25 +506,27 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
|||||||
if (!mqtt_connected) break;
|
if (!mqtt_connected) break;
|
||||||
payload = header+2;
|
payload = header+2;
|
||||||
|
|
||||||
debug("subscribe loop");
|
debug("un/subscribe loop");
|
||||||
while(payload < message.end())
|
while(payload < mesg->end())
|
||||||
{
|
{
|
||||||
message.getString(payload, len); // Topic
|
mesg->getString(payload, len); // Topic
|
||||||
debug( " topic (" << std::string(payload, len) << ')');
|
debug( " topic (" << std::string(payload, len) << ')');
|
||||||
outstring("Subscribes", payload, len);
|
outstring(" un/subscribes", payload, len);
|
||||||
// subscribe(Topic(payload, len));
|
// subscribe(Topic(payload, len));
|
||||||
Topic topic(payload, len);
|
Topic topic(payload, len);
|
||||||
if ((message.type() & 0XF0) == MqttMessage::Type::Subscribe)
|
payload += len;
|
||||||
|
if ((mesg->type() & 0XF0) == MqttMessage::Type::Subscribe)
|
||||||
|
{
|
||||||
|
uint8_t qos = *payload++;
|
||||||
|
if (qos != 0) debug("Unsupported QOS" << qos << endl);
|
||||||
subscriptions.insert(topic);
|
subscriptions.insert(topic);
|
||||||
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
auto it=subscriptions.find(topic);
|
auto it=subscriptions.find(topic);
|
||||||
if (it != subscriptions.end())
|
if (it != subscriptions.end())
|
||||||
subscriptions.erase(it);
|
subscriptions.erase(it);
|
||||||
}
|
}
|
||||||
payload += len;
|
|
||||||
uint8_t qos = *payload++;
|
|
||||||
debug(" qos=" << qos);
|
|
||||||
}
|
}
|
||||||
debug("end loop");
|
debug("end loop");
|
||||||
bclose = false;
|
bclose = false;
|
||||||
@@ -430,38 +534,44 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
|||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
|
|
||||||
case MqttMessage::Type::Publish:
|
case MqttMessage::Type::UnSuback:
|
||||||
if (!mqtt_connected) break;
|
if (!mqtt_connected) break;
|
||||||
|
bclose = false;
|
||||||
|
break;
|
||||||
|
|
||||||
|
case MqttMessage::Type::Publish:
|
||||||
|
if (mqtt_connected or client == nullptr)
|
||||||
{
|
{
|
||||||
uint8_t qos = message.type() & 0x6;
|
uint8_t qos = mesg->type() & 0x6;
|
||||||
payload = header;
|
payload = header;
|
||||||
message.getString(payload, len);
|
mesg->getString(payload, len);
|
||||||
Topic published(payload, len);
|
Topic published(payload, len);
|
||||||
payload += len;
|
payload += len;
|
||||||
len=message.end()-payload;
|
|
||||||
// Serial << "Received Publish (" << published.str().c_str() << ") size=" << (int)len
|
// Serial << "Received Publish (" << published.str().c_str() << ") size=" << (int)len
|
||||||
// << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << message.length() << endl;
|
// << '(' << std::string(payload, len).c_str() << ')' << " msglen=" << mesg->length() << endl;
|
||||||
if (qos) payload+=2; // ignore packet identifier if any
|
if (qos) payload+=2; // ignore packet identifier if any
|
||||||
|
len=mesg->end()-payload;
|
||||||
// TODO reset DUP
|
// TODO reset DUP
|
||||||
// TODO reset RETAIN
|
// TODO reset RETAIN
|
||||||
if (parent)
|
|
||||||
|
if (client==nullptr) // internal MqttClient receives publish
|
||||||
|
{
|
||||||
|
if (callback and isSubscribedTo(published))
|
||||||
|
{
|
||||||
|
callback(this, published, payload, len); // TODO send the real payload
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (parent) // from outside to inside
|
||||||
{
|
{
|
||||||
debug("publishing to parent");
|
debug("publishing to parent");
|
||||||
parent->publish(this, published, message);
|
parent->publish(this, published, *mesg);
|
||||||
}
|
}
|
||||||
else if (callback && subscriptions.find(published)!=subscriptions.end())
|
|
||||||
{
|
|
||||||
callback(this, published, nullptr, 0); // TODO send the real payload
|
|
||||||
}
|
|
||||||
message.create(MqttMessage::Type::PubAck);
|
|
||||||
// TODO re-add packet identifier if any
|
|
||||||
message.sendTo(this);
|
|
||||||
bclose = false;
|
bclose = false;
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
|
|
||||||
case MqttMessage::Type::Disconnect:
|
case MqttMessage::Type::Disconnect:
|
||||||
// TODO should discard any will message
|
// TODO should discard any will msg
|
||||||
if (!mqtt_connected) break;
|
if (!mqtt_connected) break;
|
||||||
mqtt_connected = false;
|
mqtt_connected = false;
|
||||||
close(false);
|
close(false);
|
||||||
@@ -474,8 +584,9 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
|||||||
};
|
};
|
||||||
if (bclose)
|
if (bclose)
|
||||||
{
|
{
|
||||||
Serial << "*************** Error msg 0x" << _HEX(message.type());
|
Serial << "*************** Error msg 0x" << _HEX(mesg->type());
|
||||||
message.hexdump("-------ERROR ------");
|
mesg->hexdump("-------ERROR ------");
|
||||||
|
dump();
|
||||||
Serial << endl;
|
Serial << endl;
|
||||||
close();
|
close();
|
||||||
}
|
}
|
||||||
@@ -483,7 +594,6 @@ if (message.type() != MqttMessage::Type::PingReq && message.type() != MqttMessag
|
|||||||
{
|
{
|
||||||
clientAlive(parent ? 5 : 0);
|
clientAlive(parent ? 5 : 0);
|
||||||
}
|
}
|
||||||
message.reset();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
bool Topic::matches(const Topic& topic) const
|
bool Topic::matches(const Topic& topic) const
|
||||||
@@ -499,8 +609,11 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
|
|||||||
MqttMessage msg(MqttMessage::Publish);
|
MqttMessage msg(MqttMessage::Publish);
|
||||||
msg.add(topic);
|
msg.add(topic);
|
||||||
msg.add(payload, pay_length, false);
|
msg.add(payload, pay_length, false);
|
||||||
|
msg.complete();
|
||||||
if (parent)
|
if (parent)
|
||||||
|
{
|
||||||
return parent->publish(this, topic, msg);
|
return parent->publish(this, topic, msg);
|
||||||
|
}
|
||||||
else if (client)
|
else if (client)
|
||||||
return msg.sendTo(this);
|
return msg.sendTo(this);
|
||||||
else
|
else
|
||||||
@@ -508,29 +621,33 @@ MqttError MqttClient::publish(const Topic& topic, const char* payload, size_t pa
|
|||||||
}
|
}
|
||||||
|
|
||||||
// republish a received publish if it matches any in subscriptions
|
// republish a received publish if it matches any in subscriptions
|
||||||
MqttError MqttClient::publish(const Topic& topic, MqttMessage& msg)
|
MqttError MqttClient::publishIfSubscribed(const Topic& topic, const MqttMessage& msg)
|
||||||
{
|
{
|
||||||
MqttError retval=MqttOk;
|
MqttError retval=MqttOk;
|
||||||
|
|
||||||
debug("mqttclient publish " << subscriptions.size());
|
debug("mqttclient publish " << subscriptions.size());
|
||||||
for(const auto& subscription: subscriptions)
|
if (isSubscribedTo(topic))
|
||||||
{
|
{
|
||||||
if (subscription.matches(topic))
|
if (client)
|
||||||
|
retval = msg.sendTo(this);
|
||||||
|
else
|
||||||
{
|
{
|
||||||
debug(" match client=" << (int32_t)client << ", topic " << topic.str().c_str() << ' ');
|
processMessage(&msg);
|
||||||
if (client)
|
// callback(this, topic, nullptr, 0); // TODO Payload
|
||||||
{
|
|
||||||
retval = msg.sendTo(this);
|
|
||||||
}
|
|
||||||
else if (callback)
|
|
||||||
{
|
|
||||||
callback(this, topic, nullptr, 0); // TODO Payload
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return retval;
|
return retval;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool MqttClient::isSubscribedTo(const Topic& topic) const
|
||||||
|
{
|
||||||
|
for(const auto& subscription: subscriptions)
|
||||||
|
if (subscription.matches(topic))
|
||||||
|
return true;
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
void MqttMessage::reset()
|
void MqttMessage::reset()
|
||||||
{
|
{
|
||||||
buffer.clear();
|
buffer.clear();
|
||||||
@@ -599,13 +716,14 @@ void MqttMessage::add(const char* p, size_t len, bool addLength)
|
|||||||
{
|
{
|
||||||
if (addLength)
|
if (addLength)
|
||||||
{
|
{
|
||||||
|
buffer.reserve(buffer.length()+addLength+2);
|
||||||
incoming(len>>8);
|
incoming(len>>8);
|
||||||
incoming(len & 0xFF);
|
incoming(len & 0xFF);
|
||||||
}
|
}
|
||||||
while(len--) incoming(*p++);
|
while(len--) incoming(*p++);
|
||||||
}
|
}
|
||||||
|
|
||||||
void MqttMessage::encodeLength(char* msb, int length)
|
void MqttMessage::encodeLength(char* msb, int length) const
|
||||||
{
|
{
|
||||||
do
|
do
|
||||||
{
|
{
|
||||||
@@ -616,7 +734,13 @@ void MqttMessage::encodeLength(char* msb, int length)
|
|||||||
} while (length);
|
} while (length);
|
||||||
};
|
};
|
||||||
|
|
||||||
MqttError MqttMessage::sendTo(MqttClient* client)
|
void MqttMessage::complete()
|
||||||
|
{
|
||||||
|
encodeLength(&buffer[1], buffer.size()-2);
|
||||||
|
state = Complete;
|
||||||
|
}
|
||||||
|
|
||||||
|
MqttError MqttMessage::sendTo(MqttClient* client) const
|
||||||
{
|
{
|
||||||
if (buffer.size())
|
if (buffer.size())
|
||||||
{
|
{
|
||||||
|
|||||||
100
src/TinyMqtt.h
100
src/TinyMqtt.h
@@ -1,18 +1,48 @@
|
|||||||
#include <ESP8266WiFi.h>
|
#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
|
||||||
|
|
||||||
|
#if defined(ESP8266) || defined(EPOXY_DUINO)
|
||||||
|
#ifdef TCP_ASYNC
|
||||||
|
#include <ESPAsyncTCP.h>
|
||||||
|
#else
|
||||||
|
#include <ESP8266WiFi.h>
|
||||||
|
#endif
|
||||||
|
#elif defined(ESP32)
|
||||||
|
#ifdef TCP_ASYNC
|
||||||
|
#include <AsyncTCP.h> // https://github.com/me-no-dev/AsyncTCP
|
||||||
|
#else
|
||||||
|
#include <WiFi.h>
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
#ifdef EPOXY_DUINO
|
||||||
|
#define dbg_ptr uint64_t
|
||||||
|
#else
|
||||||
|
#define dbg_ptr uint32_t
|
||||||
|
#endif
|
||||||
#include <vector>
|
#include <vector>
|
||||||
#include <set>
|
#include <set>
|
||||||
#include <string>
|
#include <string>
|
||||||
#include "StringIndexer.h"
|
#include "StringIndexer.h"
|
||||||
#include <MqttStreaming.h>
|
#include <MqttStreaming.h>
|
||||||
|
|
||||||
#if 0
|
// #define TINY_MQTT_DEBUG
|
||||||
|
|
||||||
|
#ifdef TINY_MQTT_DEBUG
|
||||||
#define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); }
|
#define debug(what) { Serial << __LINE__ << ' ' << what << endl; delay(100); }
|
||||||
#define TINY_MQTT_DEBUG 1
|
|
||||||
#else
|
#else
|
||||||
#define TINY_MQTT_DEBUG 0
|
|
||||||
#define debug(what) {}
|
#define debug(what) {}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#ifdef TCP_ASYNC
|
||||||
|
using TcpClient = AsyncClient;
|
||||||
|
using TcpServer = AsyncServer;
|
||||||
|
#else
|
||||||
|
using TcpClient = WiFiClient;
|
||||||
|
using TcpServer = WiFiServer;
|
||||||
|
#endif
|
||||||
|
|
||||||
enum MqttError
|
enum MqttError
|
||||||
{
|
{
|
||||||
MqttOk = 0,
|
MqttOk = 0,
|
||||||
@@ -47,6 +77,7 @@ class MqttMessage
|
|||||||
Subscribe = 0x80,
|
Subscribe = 0x80,
|
||||||
SubAck = 0x90,
|
SubAck = 0x90,
|
||||||
UnSubscribe = 0xA0,
|
UnSubscribe = 0xA0,
|
||||||
|
UnSuback = 0xB0,
|
||||||
PingReq = 0xC0,
|
PingReq = 0xC0,
|
||||||
PingResp = 0xD0,
|
PingResp = 0xD0,
|
||||||
Disconnect = 0xE0
|
Disconnect = 0xE0
|
||||||
@@ -72,6 +103,7 @@ class MqttMessage
|
|||||||
const char* end() const { return &buffer[0]+buffer.size(); }
|
const char* end() const { return &buffer[0]+buffer.size(); }
|
||||||
const char* getVHeader() const { return &buffer[vheader]; }
|
const char* getVHeader() const { return &buffer[vheader]; }
|
||||||
uint16_t length() const { return buffer.size(); }
|
uint16_t length() const { return buffer.size(); }
|
||||||
|
void complete();
|
||||||
|
|
||||||
void reset();
|
void reset();
|
||||||
|
|
||||||
@@ -79,7 +111,6 @@ class MqttMessage
|
|||||||
// output buff+=2, len=length(str)
|
// output buff+=2, len=length(str)
|
||||||
static void getString(const char* &buff, uint16_t& len);
|
static void getString(const char* &buff, uint16_t& len);
|
||||||
|
|
||||||
|
|
||||||
Type type() const
|
Type type() const
|
||||||
{
|
{
|
||||||
return state == Complete ? static_cast<Type>(buffer[0]) : Unknown;
|
return state == Complete ? static_cast<Type>(buffer[0]) : Unknown;
|
||||||
@@ -88,18 +119,18 @@ class MqttMessage
|
|||||||
void create(Type type)
|
void create(Type type)
|
||||||
{
|
{
|
||||||
buffer=(char)type;
|
buffer=(char)type;
|
||||||
buffer+='\0';
|
buffer+='\0'; // reserved for msg length
|
||||||
vheader=2;
|
vheader=2;
|
||||||
size=0;
|
size=0;
|
||||||
state=Create;
|
state=Create;
|
||||||
}
|
}
|
||||||
MqttError sendTo(MqttClient*);
|
MqttError sendTo(MqttClient*) const;
|
||||||
void hexdump(const char* prefix=nullptr) const;
|
void hexdump(const char* prefix=nullptr) const;
|
||||||
|
|
||||||
private:
|
private:
|
||||||
void encodeLength(char* msb, int length);
|
void encodeLength(char* msb, int length) const;
|
||||||
|
|
||||||
std::string buffer;
|
mutable std::string buffer; // mutable -> sendTo()
|
||||||
uint8_t vheader;
|
uint8_t vheader;
|
||||||
uint16_t size; // bytes left to receive
|
uint16_t size; // bytes left to receive
|
||||||
State state;
|
State state;
|
||||||
@@ -120,14 +151,15 @@ class MqttClient
|
|||||||
FlagReserved = 1
|
FlagReserved = 1
|
||||||
};
|
};
|
||||||
public:
|
public:
|
||||||
MqttClient(MqttBroker*);
|
/** Constructor. If broker is not null, this is the adress of a local broker.
|
||||||
MqttClient(MqttBroker* brk, const std::string& id) : MqttClient(brk) { clientId=id; }
|
If you want to connect elsewhere, leave broker null and use connect() **/
|
||||||
MqttClient() : MqttClient(nullptr) {};
|
MqttClient(MqttBroker* broker = nullptr, const std::string& id="");
|
||||||
|
MqttClient(const std::string& id) : MqttClient(nullptr, id){}
|
||||||
|
|
||||||
~MqttClient();
|
~MqttClient();
|
||||||
|
|
||||||
void connect(MqttBroker* parent);
|
void connect(MqttBroker* parent);
|
||||||
void connect(std::string broker, uint16_t port, uint16_t ka=10);
|
void connect(std::string broker, uint16_t port, uint16_t keep_alive = 10);
|
||||||
|
|
||||||
bool connected() { return
|
bool connected() { return
|
||||||
(parent!=nullptr and client==nullptr) or
|
(parent!=nullptr and client==nullptr) or
|
||||||
@@ -138,6 +170,7 @@ class MqttClient
|
|||||||
const std::string& id() const { return clientId; }
|
const std::string& id() const { return clientId; }
|
||||||
void id(std::string& new_id) { clientId = new_id; }
|
void id(std::string& new_id) { clientId = new_id; }
|
||||||
|
|
||||||
|
/** Should be called in main loop() */
|
||||||
void loop();
|
void loop();
|
||||||
void close(bool bSendDisconnect=true);
|
void close(bool bSendDisconnect=true);
|
||||||
void setCallback(CallBack fun) {callback=fun; };
|
void setCallback(CallBack fun) {callback=fun; };
|
||||||
@@ -149,7 +182,8 @@ class MqttClient
|
|||||||
MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
|
MqttError publish(const Topic& t) { return publish(t, nullptr, 0);};
|
||||||
|
|
||||||
MqttError subscribe(Topic topic, uint8_t qos=0);
|
MqttError subscribe(Topic topic, uint8_t qos=0);
|
||||||
MqttError unsubscribe(Topic& topic);
|
MqttError unsubscribe(Topic topic);
|
||||||
|
bool isSubscribedTo(const Topic& topic) const;
|
||||||
|
|
||||||
// connected to local broker
|
// connected to local broker
|
||||||
// TODO seems to be useless
|
// TODO seems to be useless
|
||||||
@@ -158,11 +192,10 @@ class MqttClient
|
|||||||
void dump()
|
void dump()
|
||||||
{
|
{
|
||||||
uint32_t ms=millis();
|
uint32_t ms=millis();
|
||||||
Serial << "MqttClient (" << clientId.c_str() << ") p=" << (int32_t) parent
|
Serial << "MqttClient (" << clientId.c_str() << ") " << (connected() ? " ON " : " OFF");
|
||||||
<< " c=" << (int32_t)client << (connected() ? " ON " : " OFF");
|
Serial << ", alive=" << alive << '/' << ms << ", ka=" << keep_alive;
|
||||||
Serial << ", alive=" << (uint32_t)alive << '/' << ms << ", ka=" << keep_alive;
|
|
||||||
Serial << (client && client->connected() ? "" : "dis") << "connected";
|
Serial << (client && client->connected() ? "" : "dis") << "connected";
|
||||||
message.hexdump("entrant msg");
|
message.hexdump("entrant msg");
|
||||||
bool c=false;
|
bool c=false;
|
||||||
Serial << " [";
|
Serial << " [";
|
||||||
for(auto s: subscriptions)
|
for(auto s: subscriptions)
|
||||||
@@ -175,22 +208,28 @@ class MqttClient
|
|||||||
Serial << "]" << endl;
|
Serial << "]" << endl;
|
||||||
}
|
}
|
||||||
|
|
||||||
static long counter; // Number of messages sent
|
/** Count the number of messages that have been sent **/
|
||||||
|
static long counter;
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
static void onConnect(void * client_ptr, TcpClient*);
|
||||||
|
#ifdef TCP_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();
|
void resubscribe();
|
||||||
|
|
||||||
friend class MqttBroker;
|
friend class MqttBroker;
|
||||||
MqttClient(MqttBroker* parent, WiFiClient& client);
|
MqttClient(MqttBroker* parent, TcpClient* client);
|
||||||
// republish a received publish if topic matches any in subscriptions
|
// republish a received publish if topic matches any in subscriptions
|
||||||
MqttError publish(const Topic& topic, MqttMessage& msg);
|
MqttError publishIfSubscribed(const Topic& topic, const MqttMessage& msg);
|
||||||
|
|
||||||
void clientAlive(uint32_t more_seconds);
|
void clientAlive(uint32_t more_seconds);
|
||||||
void processMessage();
|
void processMessage(const MqttMessage* message);
|
||||||
|
|
||||||
bool mqtt_connected = false;
|
bool mqtt_connected = false;
|
||||||
char mqtt_flags;
|
char mqtt_flags;
|
||||||
uint32_t keep_alive;
|
uint32_t keep_alive = 60;
|
||||||
uint32_t alive;
|
uint32_t alive;
|
||||||
MqttMessage message;
|
MqttMessage message;
|
||||||
|
|
||||||
@@ -199,7 +238,7 @@ class MqttClient
|
|||||||
// (this is the case when MqttBroker isn't used except here)
|
// (this is the case when MqttBroker isn't used except here)
|
||||||
MqttBroker* parent=nullptr; // connection to local broker
|
MqttBroker* parent=nullptr; // connection to local broker
|
||||||
|
|
||||||
WiFiClient* client=nullptr; // connection to mqtt client or to remote broker
|
TcpClient* client=nullptr; // connection to mqtt client or to remote broker
|
||||||
std::set<Topic> subscriptions;
|
std::set<Topic> subscriptions;
|
||||||
std::string clientId;
|
std::string clientId;
|
||||||
CallBack callback = nullptr;
|
CallBack callback = nullptr;
|
||||||
@@ -218,12 +257,10 @@ class MqttBroker
|
|||||||
MqttBroker(uint16_t port);
|
MqttBroker(uint16_t port);
|
||||||
~MqttBroker();
|
~MqttBroker();
|
||||||
|
|
||||||
void begin() { server.begin(); }
|
void begin() { server->begin(); }
|
||||||
void loop();
|
void loop();
|
||||||
|
|
||||||
uint8_t port() const { return server.port(); }
|
void connect(const std::string& host, uint16_t port=1883);
|
||||||
|
|
||||||
void connect(std::string host, uint32_t port=1883);
|
|
||||||
bool connected() const { return state == Connected; }
|
bool connected() const { return state == Connected; }
|
||||||
|
|
||||||
size_t clientsCount() const { return clients.size(); }
|
size_t clientsCount() const { return clients.size(); }
|
||||||
@@ -241,6 +278,7 @@ class MqttBroker
|
|||||||
private:
|
private:
|
||||||
friend class MqttClient;
|
friend class MqttClient;
|
||||||
|
|
||||||
|
static void onClient(void*, TcpClient*);
|
||||||
bool checkUser(const char* user, uint8_t len) const
|
bool checkUser(const char* user, uint8_t len) const
|
||||||
{ return compareString(auth_user, user, len); }
|
{ return compareString(auth_user, user, len); }
|
||||||
|
|
||||||
@@ -248,7 +286,9 @@ class MqttBroker
|
|||||||
{ return compareString(auth_password, password, len); }
|
{ return compareString(auth_password, password, len); }
|
||||||
|
|
||||||
|
|
||||||
MqttError publish(const MqttClient* source, const Topic& topic, MqttMessage& msg);
|
MqttError publish(const MqttClient* source, const Topic& topic, const MqttMessage& msg) const;
|
||||||
|
|
||||||
|
MqttError subscribe(const Topic& topic, uint8_t qos);
|
||||||
|
|
||||||
// For clients that are added not by the broker itself
|
// For clients that are added not by the broker itself
|
||||||
void addClient(MqttClient* client);
|
void addClient(MqttClient* client);
|
||||||
@@ -256,7 +296,7 @@ class MqttBroker
|
|||||||
|
|
||||||
bool compareString(const char* good, const char* str, uint8_t str_len) const;
|
bool compareString(const char* good, const char* str, uint8_t str_len) const;
|
||||||
std::vector<MqttClient*> clients;
|
std::vector<MqttClient*> clients;
|
||||||
WiFiServer server;
|
TcpServer* server;
|
||||||
|
|
||||||
const char* auth_user = "guest";
|
const char* auth_user = "guest";
|
||||||
const char* auth_password = "guest";
|
const char* auth_password = "guest";
|
||||||
|
|||||||
20
tests/Makefile
Normal file
20
tests/Makefile
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
tests:
|
||||||
|
set -e; \
|
||||||
|
for i in *-tests/Makefile; do \
|
||||||
|
echo '==== Making:' $$(dirname $$i); \
|
||||||
|
$(MAKE) -C $$(dirname $$i) -j; \
|
||||||
|
done
|
||||||
|
|
||||||
|
runtests: tests
|
||||||
|
set -e; \
|
||||||
|
for i in *-tests/Makefile; do \
|
||||||
|
echo '==== Running:' $$(dirname $$i); \
|
||||||
|
$$(dirname $$i)/$$(dirname $$i).out; \
|
||||||
|
done
|
||||||
|
|
||||||
|
clean:
|
||||||
|
set -e; \
|
||||||
|
for i in *-tests/Makefile; do \
|
||||||
|
echo '==== Cleaning:' $$(dirname $$i); \
|
||||||
|
$(MAKE) -C $$(dirname $$i) clean; \
|
||||||
|
done
|
||||||
7
tests/local-tests/Makefile
Normal file
7
tests/local-tests/Makefile
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||||
|
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||||
|
|
||||||
|
APP_NAME := local-tests
|
||||||
|
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
|
||||||
|
ESP_LIBS = ESP8266WiFi ESPAsyncTCP
|
||||||
|
include ../../../EspMock/EspMock.mk
|
||||||
@@ -3,9 +3,12 @@
|
|||||||
#include <map>
|
#include <map>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* TinyMqtt local unit tests.
|
* TinyMqtt local unit tests.
|
||||||
*
|
*
|
||||||
* No wifi connection 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 namespace std;
|
||||||
@@ -14,27 +17,36 @@ MqttBroker broker(1883);
|
|||||||
|
|
||||||
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
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)
|
void onPublish(const MqttClient* srce, const Topic& topic, const char* payload, size_t length)
|
||||||
{
|
{
|
||||||
if (srce)
|
if (srce)
|
||||||
published[srce->id()][topic]++;
|
published[srce->id()][topic]++;
|
||||||
|
lastPayload = payload;
|
||||||
|
lastLength = length;
|
||||||
}
|
}
|
||||||
|
|
||||||
test(local_client_should_unregister_when_destroyed)
|
test(local_client_should_unregister_when_destroyed)
|
||||||
{
|
{
|
||||||
|
return;
|
||||||
assertEqual(broker.clientsCount(), (size_t)0);
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
{
|
{
|
||||||
MqttClient client(&broker);
|
MqttClient client;
|
||||||
assertEqual(broker.clientsCount(), (size_t)1);
|
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);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#if 0
|
||||||
test(local_connect)
|
test(local_connect)
|
||||||
{
|
{
|
||||||
assertEqual(broker.clientsCount(), (size_t)0);
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
MqttClient client(&broker);
|
MqttClient client;
|
||||||
assertTrue(client.connected());
|
assertTrue(client.connected());
|
||||||
assertEqual(broker.clientsCount(), (size_t)1);
|
assertEqual(broker.clientsCount(), (size_t)1);
|
||||||
}
|
}
|
||||||
@@ -44,12 +56,12 @@ test(local_publish_should_be_dispatched)
|
|||||||
published.clear();
|
published.clear();
|
||||||
assertEqual(broker.clientsCount(), (size_t)0);
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
MqttClient subscriber(&broker);
|
MqttClient subscriber;
|
||||||
subscriber.subscribe("a/b");
|
subscriber.subscribe("a/b");
|
||||||
subscriber.subscribe("a/c");
|
subscriber.subscribe("a/c");
|
||||||
subscriber.setCallback(onPublish);
|
subscriber.setCallback(onPublish);
|
||||||
|
|
||||||
MqttClient publisher(&broker);
|
MqttClient publisher;
|
||||||
publisher.publish("a/b");
|
publisher.publish("a/b");
|
||||||
publisher.publish("a/c");
|
publisher.publish("a/c");
|
||||||
publisher.publish("a/c");
|
publisher.publish("a/c");
|
||||||
@@ -64,16 +76,16 @@ test(local_publish_should_be_dispatched_to_local_clients)
|
|||||||
published.clear();
|
published.clear();
|
||||||
assertEqual(broker.clientsCount(), (size_t)0);
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
MqttClient subscriber_a(&broker, "A");
|
MqttClient subscriber_a("A");
|
||||||
subscriber_a.setCallback(onPublish);
|
subscriber_a.setCallback(onPublish);
|
||||||
subscriber_a.subscribe("a/b");
|
subscriber_a.subscribe("a/b");
|
||||||
subscriber_a.subscribe("a/c");
|
subscriber_a.subscribe("a/c");
|
||||||
|
|
||||||
MqttClient subscriber_b(&broker, "B");
|
MqttClient subscriber_b("B");
|
||||||
subscriber_b.setCallback(onPublish);
|
subscriber_b.setCallback(onPublish);
|
||||||
subscriber_b.subscribe("a/b");
|
subscriber_b.subscribe("a/b");
|
||||||
|
|
||||||
MqttClient publisher(&broker);
|
MqttClient publisher;
|
||||||
publisher.publish("a/b");
|
publisher.publish("a/b");
|
||||||
publisher.publish("a/c");
|
publisher.publish("a/c");
|
||||||
|
|
||||||
@@ -89,15 +101,16 @@ test(local_unsubscribe)
|
|||||||
published.clear();
|
published.clear();
|
||||||
assertEqual(broker.clientsCount(), (size_t)0);
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
MqttClient subscriber(&broker);
|
MqttClient subscriber;
|
||||||
subscriber.setCallback(onPublish);
|
subscriber.setCallback(onPublish);
|
||||||
subscriber.subscribe("a/b");
|
subscriber.subscribe("a/b");
|
||||||
|
|
||||||
MqttClient publisher(&broker);
|
MqttClient publisher;
|
||||||
publisher.publish("a/b");
|
publisher.publish("a/b");
|
||||||
|
|
||||||
// subscriber.unsubscribe("a/b"); TODO not yet implemented
|
subscriber.unsubscribe("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
|
assertTrue(published[""]["a/b"] == 1); // Only one publish has been received
|
||||||
@@ -108,31 +121,32 @@ test(local_nocallback_when_destroyed)
|
|||||||
published.clear();
|
published.clear();
|
||||||
assertEqual(broker.clientsCount(), (size_t)0);
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
|
MqttClient publisher;
|
||||||
{
|
{
|
||||||
MqttClient subscriber(&broker);
|
MqttClient subscriber;
|
||||||
subscriber.setCallback(onPublish);
|
subscriber.setCallback(onPublish);
|
||||||
subscriber.subscribe("a/b");
|
subscriber.subscribe("a/b");
|
||||||
|
publisher.publish("a/b");
|
||||||
}
|
}
|
||||||
|
|
||||||
MqttClient publisher(&broker);
|
|
||||||
publisher.publish("a/b");
|
publisher.publish("a/b");
|
||||||
|
|
||||||
assertEqual(published.size(), (size_t)0); // Only one publish has been received
|
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||||
}
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
//----------------------------------------------------------------------------
|
//----------------------------------------------------------------------------
|
||||||
// setup() and loop()
|
// setup() and loop()
|
||||||
void setup() {
|
void setup() {
|
||||||
delay(1000);
|
delay(1000);
|
||||||
Serial.begin(115200);
|
Serial.begin(115200);
|
||||||
while(!Serial);
|
while(!Serial);
|
||||||
|
|
||||||
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
|
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
|
||||||
}
|
}
|
||||||
|
|
||||||
void loop() {
|
void loop() {
|
||||||
aunit::TestRunner::run();
|
aunit::TestRunner::run();
|
||||||
|
|
||||||
if (Serial.available()) ESP.reset();
|
if (Serial.available()) ESP.reset();
|
||||||
}
|
}
|
||||||
7
tests/nowifi-tests/Makefile
Normal file
7
tests/nowifi-tests/Makefile
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||||
|
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||||
|
|
||||||
|
APP_NAME := nowifi-tests
|
||||||
|
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
|
||||||
|
ESP_LIBS = ESP8266WiFi ESPAsyncTCP
|
||||||
|
include ../../../EspMock/EspMock.mk
|
||||||
166
tests/nowifi-tests/nowifi-tests.ino
Normal file
166
tests/nowifi-tests/nowifi-tests.ino
Normal file
@@ -0,0 +1,166 @@
|
|||||||
|
#include <AUnit.h>
|
||||||
|
#include <TinyMqtt.h>
|
||||||
|
#include <map>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TinyMqtt nowifi unit tests.
|
||||||
|
*
|
||||||
|
* No wifi connection unit tests.
|
||||||
|
* Checks with a local broker. Clients must connect to the local broker
|
||||||
|
**/
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
MqttBroker broker(1883);
|
||||||
|
|
||||||
|
std::map<std::string, std::map<Topic, int>> published; // map[client_id] => map[topic] = count
|
||||||
|
|
||||||
|
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);
|
||||||
|
lastPayload = strdup(payload);
|
||||||
|
lastLength = length;
|
||||||
|
}
|
||||||
|
|
||||||
|
test(nowifi_client_should_unregister_when_destroyed)
|
||||||
|
{
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
{
|
||||||
|
MqttClient client(&broker);
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)1);
|
||||||
|
}
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(nowifi_connect)
|
||||||
|
{
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
|
MqttClient client(&broker);
|
||||||
|
assertTrue(client.connected());
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)1);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(nowifi_publish_should_be_dispatched)
|
||||||
|
{
|
||||||
|
published.clear();
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
|
MqttClient subscriber(&broker);
|
||||||
|
subscriber.subscribe("a/b");
|
||||||
|
subscriber.subscribe("a/c");
|
||||||
|
subscriber.setCallback(onPublish);
|
||||||
|
|
||||||
|
MqttClient publisher(&broker);
|
||||||
|
publisher.publish("a/b");
|
||||||
|
publisher.publish("a/c");
|
||||||
|
publisher.publish("a/c");
|
||||||
|
|
||||||
|
assertEqual(published.size(), (size_t)1); // 1 client has received something
|
||||||
|
assertEqual(published[""]["a/b"], 1);
|
||||||
|
assertEqual(published[""]["a/c"], 2);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(nowifi_publish_should_be_dispatched_to_clients)
|
||||||
|
{
|
||||||
|
published.clear();
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
|
MqttClient subscriber_a(&broker, "A");
|
||||||
|
subscriber_a.setCallback(onPublish);
|
||||||
|
subscriber_a.subscribe("a/b");
|
||||||
|
subscriber_a.subscribe("a/c");
|
||||||
|
|
||||||
|
MqttClient subscriber_b(&broker, "B");
|
||||||
|
subscriber_b.setCallback(onPublish);
|
||||||
|
subscriber_b.subscribe("a/b");
|
||||||
|
|
||||||
|
MqttClient publisher(&broker);
|
||||||
|
publisher.publish("a/b"); // A and B should receive this
|
||||||
|
publisher.publish("a/c"); // A should receive this
|
||||||
|
|
||||||
|
assertEqual(published.size(), (size_t)2); // 2 clients have received something
|
||||||
|
assertEqual(published["A"]["a/b"], 1);
|
||||||
|
assertEqual(published["A"]["a/c"], 1);
|
||||||
|
assertEqual(published["B"]["a/b"], 1);
|
||||||
|
assertEqual(published["B"]["a/c"], 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(nowifi_unsubscribe)
|
||||||
|
{
|
||||||
|
published.clear();
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
|
MqttClient subscriber(&broker);
|
||||||
|
subscriber.setCallback(onPublish);
|
||||||
|
subscriber.subscribe("a/b");
|
||||||
|
|
||||||
|
MqttClient publisher(&broker);
|
||||||
|
publisher.publish("a/b"); // This publish is received
|
||||||
|
|
||||||
|
subscriber.unsubscribe("a/b");
|
||||||
|
|
||||||
|
publisher.publish("a/b"); // Those one, no (unsubscribed)
|
||||||
|
publisher.publish("a/b");
|
||||||
|
|
||||||
|
assertEqual(published[""]["a/b"], 1); // Only one publish has been received
|
||||||
|
}
|
||||||
|
|
||||||
|
test(nowifi_nocallback_when_destroyed)
|
||||||
|
{
|
||||||
|
published.clear();
|
||||||
|
assertEqual(broker.clientsCount(), (size_t)0);
|
||||||
|
|
||||||
|
MqttClient publisher(&broker);
|
||||||
|
|
||||||
|
{
|
||||||
|
MqttClient subscriber(&broker);
|
||||||
|
subscriber.setCallback(onPublish);
|
||||||
|
subscriber.subscribe("a/b");
|
||||||
|
publisher.publish("a/b");
|
||||||
|
}
|
||||||
|
|
||||||
|
publisher.publish("a/b");
|
||||||
|
|
||||||
|
assertEqual(published.size(), (size_t)1); // Only one publish has been received
|
||||||
|
}
|
||||||
|
|
||||||
|
test(nowifi_payload_nullptr)
|
||||||
|
{
|
||||||
|
published.clear();
|
||||||
|
|
||||||
|
const char* payload="abcd";
|
||||||
|
|
||||||
|
MqttClient subscriber(&broker);
|
||||||
|
subscriber.setCallback(onPublish);
|
||||||
|
subscriber.subscribe("a/b");
|
||||||
|
|
||||||
|
MqttClient publisher(&broker);
|
||||||
|
publisher.publish("a/b", payload, strlen(payload)); // This publish is received
|
||||||
|
|
||||||
|
// coming from MqttClient::publish(...)
|
||||||
|
assertEqual(payload, lastPayload);
|
||||||
|
assertEqual(lastLength, (size_t)4);
|
||||||
|
}
|
||||||
|
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
// setup() and loop()
|
||||||
|
void setup() {
|
||||||
|
delay(1000);
|
||||||
|
Serial.begin(115200);
|
||||||
|
while(!Serial);
|
||||||
|
|
||||||
|
Serial.println("=============[ NO WIFI CONNECTION TinyMqtt TESTS ]========================");
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
aunit::TestRunner::run();
|
||||||
|
|
||||||
|
if (Serial.available()) ESP.reset();
|
||||||
|
}
|
||||||
6
tests/result.json
Normal file
6
tests/result.json
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
"schemaVersion" : 1,
|
||||||
|
"label" : "tests",
|
||||||
|
"message" : "Message content",
|
||||||
|
"color": "red"
|
||||||
|
}
|
||||||
2
tests/result.yaml
Normal file
2
tests/result.yaml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
result: 1
|
||||||
|
insert: "passed"
|
||||||
7
tests/string-indexer-tests/Makefile
Normal file
7
tests/string-indexer-tests/Makefile
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# See https://github.com/bxparks/EpoxyDuino for documentation about this
|
||||||
|
# Makefile to compile and run Arduino programs natively on Linux or MacOS.
|
||||||
|
|
||||||
|
APP_NAME := string-indexer-tests
|
||||||
|
ARDUINO_LIBS := AUnit AceCommon AceTime TinyMqtt EspMock
|
||||||
|
ESP_LIBS = ESP8266WiFi ESPAsyncTCP
|
||||||
|
include ../../../EspMock/EspMock.mk
|
||||||
109
tests/string-indexer-tests/string-indexer-tests.ino
Normal file
109
tests/string-indexer-tests/string-indexer-tests.ino
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
#include <AUnit.h>
|
||||||
|
#include <StringIndexer.h>
|
||||||
|
#include <map>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TinyMqtt / StringIndexer unit tests.
|
||||||
|
*
|
||||||
|
**/
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
test(indexer_empty)
|
||||||
|
{
|
||||||
|
assertEqual(StringIndexer::count(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_strings_deleted_should_empty_indexer)
|
||||||
|
{
|
||||||
|
assertTrue(StringIndexer::count()==0);
|
||||||
|
{
|
||||||
|
IndexedString one("one");
|
||||||
|
assertEqual(StringIndexer::count(), 1);
|
||||||
|
IndexedString two("two");
|
||||||
|
assertEqual(StringIndexer::count(), 2);
|
||||||
|
IndexedString three("three");
|
||||||
|
assertEqual(StringIndexer::count(), 3);
|
||||||
|
IndexedString four("four");
|
||||||
|
assertEqual(StringIndexer::count(), 4);
|
||||||
|
}
|
||||||
|
assertEqual(StringIndexer::count(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_same_strings_count_as_one)
|
||||||
|
{
|
||||||
|
IndexedString one ("one");
|
||||||
|
IndexedString two ("one");
|
||||||
|
IndexedString three("one");
|
||||||
|
IndexedString fourt("one");
|
||||||
|
|
||||||
|
assertEqual(StringIndexer::count(), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_size_of_indexed_string)
|
||||||
|
{
|
||||||
|
assertEqual(sizeof(IndexedString), (size_t)1);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_different_strings_are_different)
|
||||||
|
{
|
||||||
|
IndexedString one("one");
|
||||||
|
IndexedString two("two");
|
||||||
|
|
||||||
|
assertFalse(one == two);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_same_strings_should_equal)
|
||||||
|
{
|
||||||
|
IndexedString one("one");
|
||||||
|
IndexedString two("one");
|
||||||
|
|
||||||
|
assertTrue(one == two);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_indexed_operator_eq)
|
||||||
|
{
|
||||||
|
IndexedString one("one");
|
||||||
|
{
|
||||||
|
IndexedString same = one;
|
||||||
|
assertTrue(one == same);
|
||||||
|
assertEqual(StringIndexer::count(), 1);
|
||||||
|
}
|
||||||
|
assertEqual(StringIndexer::count(), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_get_string)
|
||||||
|
{
|
||||||
|
std::string sone("one");
|
||||||
|
IndexedString one(sone);
|
||||||
|
|
||||||
|
assertTrue(sone==one.str());
|
||||||
|
}
|
||||||
|
|
||||||
|
test(indexer_get_index)
|
||||||
|
{
|
||||||
|
IndexedString one1("one");
|
||||||
|
IndexedString one2("one");
|
||||||
|
IndexedString two1("two");
|
||||||
|
IndexedString two2("two");
|
||||||
|
|
||||||
|
assertTrue(one1.getIndex() == one2.getIndex());
|
||||||
|
assertTrue(two1.getIndex() == two2.getIndex());
|
||||||
|
assertTrue(one1.getIndex() != two1.getIndex());
|
||||||
|
}
|
||||||
|
|
||||||
|
//----------------------------------------------------------------------------
|
||||||
|
// setup() and loop()
|
||||||
|
void setup() {
|
||||||
|
delay(1000);
|
||||||
|
Serial.begin(115200);
|
||||||
|
while(!Serial);
|
||||||
|
|
||||||
|
Serial.println("=============[ TinyMqtt StringIndexer TESTS ]========================");
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
aunit::TestRunner::run();
|
||||||
|
|
||||||
|
if (Serial.available()) ESP.reset();
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user