Skip to content

Mqtt protocol v5 definition [DO NOT MERGE] #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Mqtt protocol v5 definition [DO NOT MERGE] #84

wants to merge 3 commits into from

Conversation

danielmeza
Copy link

@danielmeza danielmeza commented Jul 30, 2025 •
edited
Loading

Define MQTT v5 protocol traits and base structs. as part of #83 and esp-rs/esp-idf-svc#589

This initial implementation covers the current MQTT v5 for IDF 5.3.

Some key design drivers:

  • Clients should be able to coexist since a device could be connected to different server with different versions.
  • Protocols should be able to be fixed or augmented without affect each other (regardless IDF use the same base API for both clients)
  • Client should be able to be created and started in separated processes/time this way consumers will be able to gracefully start the client (Ex, after wifi has been connected)
  • Client should be able to disconnect and report the disconnect reason.
  • No breaking changes should be introduced in the current v3 client.
  • Migration should be easy to perform from existing v3 client, to reduce the adoption overhead/friction.
  • Client should be easy to be distingue.

By following the previous drivers I came to this initial PR, I will be glad to adapt or change these drivers as needed as well as the implementation.

Please lest follow the discussion of this in the IDF implementation PR so we can see how this abstraction is been used and have a full picture view.

Please DO NOT MERGE until we agree a proper API and complete the esp-idf-svc implementation.

@danielmeza
Add MQTT 5.0 protocol support with client5 module
0427e2b 
Introduces a new 'mqtt_protocol_v5' feature and the src/mqtt/client5.rs module implementing MQTT 5.0 protocol traits, property configs, and error codes. Updates src/mqtt.rs and src/mqtt/client.rs to integrate v5-specific APIs and types, enabling advanced MQTT 5.0 features such as user properties, message metadata, and extended event handling.
@danielmeza
Add Default impls and make property configs optional in MQTT v5
be4460a 
Added Default implementations for PublishPropertyConfig, SubscribePropertyConfig, UnsubscribePropertyConfig, and DisconnectPropertyConfig. Updated Client and Publish traits (and their async variants) to accept Option<T> for property config parameters, making them optional. This improves API ergonomics and allows callers to omit property configs when not needed.
@danielmeza danielmeza changed the title Mqtt protocol v5 Mqtt protocol v5 definition Jul 30, 2025
@danielmeza danielmeza changed the title Mqtt protocol v5 definition Mqtt protocol v5 definition [DO NOT MERGE] Jul 30, 2025
@danielmeza danielmeza mentioned this pull request Jul 30, 2025
Open
4 tasks
@danielmeza
Refactor user properties API for MQTT v5
ec80d8d 
Updated the Event trait and UserPropertyList trait to use Vec<UserPropertyItem> instead of Box<dyn UserPropertyList> and adjusted lifetimes for better ergonomics and type safety. This simplifies the interface for accessing user properties in MQTT v5 and improves compatibility with standard collections.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@danielmeza