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

Readme rewritten

Browse Source
This commit is contained in:
hsaturn
2021-03-21 11:50:23 +01:00
parent d052f6b55a
commit 17fabeae79
1 changed files with 37 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -1,14 +1,40 @@
# TinyMqtt # TinyMqtt
ESP 8266 is a very capable Mqtt Broker and Client ESP 8266 is a very capable and small Mqtt Broker and Client
Here are the features ## Features
- mqtt client can Works without WiFi (local mode) in a unique ESP
Thus, publishes and subscribes are possible and allows - Act as as a mqtt broker and/or a mqtt client
minimal (degraded) function of a single module. - Mqtt 3.1.1 / Qos 0 supported
- broker can connect to another broker and becomes then a - Standalone (can work without WiFi) (degraded/local mode)
- Brokers can connect to another broker and becomes then a
proxy for clients that are connected to it. proxy for clients that are connected to it.
- zeroconf, this is a strange but very powerful mode - zeroconf, this is a strange but very powerful mode where
where each ESP is a a broker and scans the local network. all brokers tries to connect together on the same local network.
After a while one ESP becomes the 'master'
and all ESP are connected together. The master can die ## Quickstart
whithout breaking the system.
- install Streaming library
- install TinyMqtt library
- modify <TinyMqtt/src/my_credentials.h> (wifi setup)
## Examples
| Example | Description |
| ---------------------------- | --------------------------------- |
| client-without-wifi | standalone example |
| simple-client | Connect the ESP to an external Mqtt broker |
| simple-broker | Simple Mqtt broker with your ESP |
| tinymqtt-test | Complex console example |
- tinymqtt-test : This is a complex sketch with a terminal console
that allows to add clients publish, connect etc with interpreted commands.
## Standalone mode (zeroconf)
-> The zeroconf mode is not yet implemented
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.
No problem if the master dies, a new master will be choosen soon.
## License
Gnu GPL 3.0, see [LICENSE](https://github.com/hsaturn/TinyMqtt/blob/main/LICENSE).