mgillespie/TinyMqtt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rewrite examples

Browse Source
This commit is contained in:
hsaturn
2021-04-12 00:23:08 +02:00
parent ce896f02c4
commit 5d313bbf5e
5 changed files with 61 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
examples/client-with-wifi/client-with-wifi.ino
View File

@@ -1,6 +1,8 @@
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
/**
* Local broker that accept connections and two local clients
*
*
* +-----------------------------+
* | ESP |
@@ -9,9 +11,10 @@
* | | +--------+ |
* | | ^ |
* | | | |
* | v v |
* | +----------+ +----------+ |
* | | internal | | internal | |
* | | | | -----
* | v v | ---
* | +----------+ +----------+ | -
* | | internal | | internal | +-------* Wifi
* | | client | | client | |
* | +----------+ +----------+ |
* | |

30
examples/client-without-wifi/client-without-wifi.ino
View File

@@ -1,12 +1,30 @@
#include <TinyMqtt.h> // https://github.com/hsaturn/TinyMqtt
/** 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
* of MQTT, and once connected still continue to work with others.
*
*/
*
* +-----------------------------+
* | ESP |
* | +--------+ |
* | +-------->| 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";

10
examples/simple-broker/simple-broker.ino
View File

@@ -5,6 +5,16 @@
#define PORT 1883
MqttBroker broker(PORT);
/** Basic Mqtt Broker
*
* +-----------------------------+
* | ESP |
* | +--------+ |
* | | broker | | 1883 <--- External client/s
* | +--------+ |
* | |
* +-----------------------------+
*
void setup()
{
Serial.begin(115200);

18
examples/simple-client/simple-client.ino
View File

@@ -1,9 +1,21 @@
#include "TinyMqtt.h" // https://github.com/hsaturn/TinyMqtt
/** Simple Client
/** Simple Client (The simplest configuration)
*
*
* +--------+
* +------>| broker |<--- < Other client
* | +--------+
* |
* +-----------------+
* | ESP | |
* | +----------+ |
* | | internal | |
* | | client | |
* | +----------+ |
* | |
* +-----------------+
*
* This is the simplest Mqtt client configuration
*
* 1 - edit my_credentials.h to setup wifi essid/password
* 2 - change BROKER values (or keep emqx.io test broker)
*

13
examples/tinymqtt-test/tinymqtt-test.ino
View File

@@ -5,18 +5,13 @@
#include <sstream>
#include <map>
/**
/** Very complex example
* Console allowing to make any kind of test.
*
* pros - Reduces internal latency (when publish is received by the same ESP)
* - Reduces wifi traffic
* - No need to have an external broker
* - can still report to a 'main' broker (TODO see documentation that have to be written)
* - accepts external clients
*
* cons - Takes more memory
* - a bit hard to understand
* Upload the sketch, the use the terminal.
* Press H for mini help.
*
* TODO examples of scripts
*/
#include <my_credentials.h>