Skip to content

Commit

Permalink
Mqtt5 General Availability (#536)
Browse files Browse the repository at this point in the history
* remove dev preview disclaimer

* update awscrt to 0.20.0

* kick ci

---------

Co-authored-by: Bret Ambrose <[email protected]>
  • Loading branch information
xiazhvera and bretambrose authored Dec 14, 2023
1 parent 13ca9a0 commit c6fcdbe
Show file tree
Hide file tree
Showing 6 changed files with 1 addition and 14 deletions.
5 changes: 0 additions & 5 deletions documents/MQTT5_Userguide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# MQTT 5
# Table of Contents

* [Developer Preview Disclaimer](#developer-preview-disclaimer)
* [Introduction](#introduction)
* [MQTT5 differences relative to MQTT311 implementation](#mqtt5-differences-relative-to-mqtt311-implementation)
* [Major Changes](#major-changes)
Expand All @@ -24,10 +23,6 @@
* [Unsubscribe](#unsubscribe)
* [Publish](#publish)
* [MQTT5 Best Practices](#mqtt5-best-practices)
## **Developer Preview Disclaimer**
MQTT5 support is currently in **developer preview**. We encourage feedback at all times, but feedback during the preview window is especially valuable in shaping the final product. During the preview period we may make backwards-incompatible changes to the public API, but in general, this is something we will try our best to avoid.

The MQTT5 client cannot yet be used with the AWS IoT MQTT services (Shadow, Jobs, Identity). This is a shortcoming that we hope to address in the near future.

## **Introduction**

Expand Down
2 changes: 0 additions & 2 deletions samples/mqtt5_custom_authorizer_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ You will need to setup your Custom Authorizer so that the lambda function return

MQTT5 introduces additional features and enhancements that improve the development experience with MQTT. You can read more about MQTT5 in the Python V2 SDK by checking out the [MQTT5 user guide](../documents/MQTT5_Userguide.md).

Note: MQTT5 support is currently in **developer preview**. We encourage feedback at all times, but feedback during the preview window is especially valuable in shaping the final product. During the preview period we may make backwards-incompatible changes to the public API, but in general, this is something we will try our best to avoid.

Your IoT Core Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.

<details>
Expand Down
2 changes: 0 additions & 2 deletions samples/mqtt5_pkcs11_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ This sample is similar to the [MQTT5 PubSub](./mqtt5_pubsub.md) sample with how

MQTT5 introduces additional features and enhancements that improve the development experience with MQTT. You can read more about MQTT5 in the Python V2 SDK by checking out the [MQTT5 user guide](../documents/MQTT5_Userguide.md).

Note: MQTT5 support is currently in **developer preview**. We encourage feedback at all times, but feedback during the preview window is especially valuable in shaping the final product. During the preview period we may make backwards-incompatible changes to the public API, but in general, this is something we will try our best to avoid.

**WARNING: Unix (Linux) only**. Currently, TLS integration with PKCS#11 is only available on Unix devices.

Your IoT Core Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect. Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.
Expand Down
2 changes: 0 additions & 2 deletions samples/mqtt5_pubsub.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ for AWS IoT to send and receive messages through an MQTT connection using MQTT5.

MQTT5 introduces additional features and enhancements that improve the development experience with MQTT. You can read more about MQTT5 in the Python V2 SDK by checking out the [MQTT5 user guide](../documents/MQTT5_Userguide.md).

Note: MQTT5 support is currently in **developer preview**. We encourage feedback at all times, but feedback during the preview window is especially valuable in shaping the final product. During the preview period we may make backwards-incompatible changes to the public API, but in general, this is something we will try our best to avoid.

Your IoT Core Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) must provide privileges for this sample to connect, subscribe, publish, and receive. Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.

<details>
Expand Down
2 changes: 0 additions & 2 deletions samples/mqtt5_shared_subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ for AWS IoT to send and receive messages over a MQTT5 connection using a shared

MQTT5 introduces additional features and enhancements that improve the development experience with MQTT. You can read more about MQTT5 in the Python V2 SDK by checking out the [MQTT5 user guide](../documents/MQTT5_Userguide.md).

Note: MQTT5 support is currently in **developer preview**. We encourage feedback at all times, but feedback during the preview window is especially valuable in shaping the final product. During the preview period we may make backwards-incompatible changes to the public API, but in general, this is something we will try our best to avoid.

[Shared Subscriptions](https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html#mqtt5-shared-subscription) allow IoT devices to connect to a group where messages sent to a topic are then relayed to the group in a round-robin-like fashion. This is useful for distributing message load across multiple subscribing MQTT5 clients automatically. This is helpful for load balancing when you have many messages that need to be processed.

Shared Subscriptions rely on a group name/identifier, which tells the MQTT5 broker/server which IoT devices to treat as a group for message distribution. This is done when subscribing by formatting the subscription topic like the following: `$share/<ShareName>/<TopicFilter>`.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def _load_version():
"Operating System :: OS Independent",
],
install_requires=[
'awscrt==0.19.17',
'awscrt==0.20.0',
],
python_requires='>=3.7',
)

0 comments on commit c6fcdbe

Please sign in to comment.