minimq

Crates.iominimq
lib.rsminimq
version0.9.0
sourcesrc
created_at2020-08-27 07:57:25.452181
updated_at2024-04-29 14:30:57.042848
descriptionA minimal MQTT5 client designed for no_std platforms
homepagehttps://github.com/quartiq/minimq
repositoryhttps://github.com/quartiq/minimq
max_upload_size
id281318
size223,052
Robert J├Ârdens (jordens)

documentation

https://docs.rs/minimq

README

QUARTIQ Matrix Chat Continuous Integration

Minimq

Minimq provides a minimal MQTTv5 client and message parsing for the MQTT version 5 protocol. It leverages the embedded-nal to operate on top of any TCP stack implementation and is actively used with both smoltcp and and the W5500 hardware network stack.

Minimq provides a simple, no_std interface to connect to an MQTT broker to publish messages and subscribe to topics.

Features

Minimq supports all of the fundamental operations of MQTT, such as message subscription and publication. Below is a detailed list of features, indicating what aspects are supported:

  • Publication at all quality-of-service levels (at-most-once, at-least-once, and exactly-once)
  • Retained messages
  • Connection will messages
  • Session state reconnection and republication
  • Topic subscriptions at all quality-of-service levels
  • Subscription option flags
  • Zero-copy message deserialization
  • Serde-compatible MQTT message serialization and deserialization

If there are features that you would like to have that are not yet supported, we are always accepting pull requests to extend Minimq's capabilities.

Minimq also provides convenient APIs to implement request-response interfaces over MQTT leveraging the ResponseTopic and CorrelationData properties for in-bound and out-bound messages.

Smoltcp Support

If using smoltcp, check out the smoltcp-nal to quickly create an interface that can be used by Minimq.

Examples

An example usage of Minimq that can be run on a desktop PC can be found in tests/integration_test.rs

Commit count: 493

cargo fmt