428eb51850
clients can now connect to outside. bug fixed for broker (pings etc.) crashes fixed when clients where removed More examples added (the tinymqtt-test is great)
58 lines
2.4 KiB
Markdown
58 lines
2.4 KiB
Markdown
# TinyMqtt
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ESP 8266 is a small and very capable Mqtt Broker and Client
|
|
|
|
## Features
|
|
|
|
- Act as as a mqtt broker and/or a mqtt client
|
|
- Mqtt 3.1.1 / Qos 0 supported
|
|
- Standalone (can work without WiFi) (degraded/local mode)
|
|
- Brokers can connect to another broker and becomes then a
|
|
proxy for clients that are connected to it.
|
|
- zeroconf, this is a strange but very powerful mode where
|
|
all brokers tries to connect together on the same local network.
|
|
|
|
## 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, 3k is needed per client which would make more than 10 clients critical.
|
|
* MqttMessage uses a buffer 256 bytes which is usually far than needed.
|
|
|
|
## Quickstart
|
|
|
|
* install [Streaming library](https://github.com/janelia-arduino/Streaming)
|
|
* install [TinyMqtt library](https://github.com/hsaturn/TinyMqtt)
|
|
* modify <libraries/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
|
|
zerofonf clients to connect to broker on 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.
|
|
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).
|