https://github.com/angristan/aimeqtt
A MQTT 3 rust client
https://github.com/angristan/aimeqtt
mqtt rust tokio
Last synced: 7 months ago
JSON representation
A MQTT 3 rust client
- Host: GitHub
- URL: https://github.com/angristan/aimeqtt
- Owner: angristan
- License: mit
- Created: 2024-03-21T00:17:39.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-27T00:12:25.000Z (8 months ago)
- Last Synced: 2025-03-15T15:44:59.372Z (7 months ago)
- Topics: mqtt, rust, tokio
- Language: Rust
- Homepage:
- Size: 59.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aimeqtt
A MQTT 3.1.1 rust client.
Used as a learning ground for Rust, `tokio` and MQTT. Used in _production_ at my home for [teleinfo2mqtt-rs](https://github.com/angristan/teleinfo2mqtt-rs).
## Features
- Connect to a MQTT broker (`CONNECT`, `CONNACK`)
- Username/password support
- Send messages (`PUBLISH`)
- Receive messages (`SUBSCRIBE`, `SUBACK`, `PUBLISH`)
- Keep alive (`PINGREQ`, `PINGRESP`)
It only supports QoS 0 for now.
## Design
The library has two main components:
- the parsing and serialization of MQTT TCP packets, which are binary-encoded
- the client itself, which handles the connection to the broker and the internal flow of messages
It is designed around an event loop using tokio's `tokio::net::TcpStream` for the TCP connection to the broker and `tokio::sync::mpsc` channels for internal communication.
Here is a questionable attempt at a flowchart:
```mermaid
graph TB
Start[Start] --> ConnectBroker{Connect to MQTT broker}
ConnectBroker -->|Success| SendConnect[Send CONNECT message]
ConnectBroker -->|Failure| Retry[Wait 5 seconds and retry]
Retry --> ConnectBroker
SendConnect --> EventLoop{Event Loop}
EventLoop -->|Ping tick for keep alive| SendPingReq[Send PINGREQ packet to TCP channel]
EventLoop -->|Received PUBLISH message from channel| SendPublish[Send PUBLISH packet to TCP channel]
EventLoop -->|Received packet from TCP channel| SendRawPacket[Send TCP packet to TCP stream]
EventLoop -->|TCP stream ready to read| ReadResponse{Read broker response}
SendPingReq --> EventLoop
SendPublish --> EventLoop
SendRawPacket --> EventLoop
ReadResponse -->|Success| ParsePacket[Parse packet and handle accordingly]
ReadResponse -->|Failure| Reconnect[Break and reconnect]
ParsePacket --> EventLoop
Reconnect --> ConnectBroker
```
## Usage
```rust
#[tokio::main]
async fn main() {
let broker_host = "127.0.0.1";
let broker_port = 1883;
let mqtt_client_options = client::ClientOptions::new(broker_host.to_string(), broker_port)
.with_keep_alive(60);
let mut mqtt_client = client::new(mqtt_client_options).await;
loop {
mqtt_client
.publish("foo/bar".to_string(), "Hello!".to_string())
.expect("Failed to send message");
tokio::time::sleep(Duration::from_secs(5)).await;
}
}
```
## MQTT specs
I relied on the following resources to implement the MQTT packets:
- https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html
- https://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html