From c6fcdbee652b80a2ba6f4745b2cc6b0f00eb6dd4 Mon Sep 17 00:00:00 2001 From: Vera Xia Date: Wed, 13 Dec 2023 16:46:29 -0800 Subject: [PATCH] Mqtt5 General Availability (#536) * remove dev preview disclaimer * update awscrt to 0.20.0 * kick ci --------- Co-authored-by: Bret Ambrose --- documents/MQTT5_Userguide.md | 5 ----- samples/mqtt5_custom_authorizer_connect.md | 2 -- samples/mqtt5_pkcs11_connect.md | 2 -- samples/mqtt5_pubsub.md | 2 -- samples/mqtt5_shared_subscription.md | 2 -- setup.py | 2 +- 6 files changed, 1 insertion(+), 14 deletions(-) diff --git a/documents/MQTT5_Userguide.md b/documents/MQTT5_Userguide.md index e325a912..188259fb 100644 --- a/documents/MQTT5_Userguide.md +++ b/documents/MQTT5_Userguide.md @@ -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) @@ -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** diff --git a/samples/mqtt5_custom_authorizer_connect.md b/samples/mqtt5_custom_authorizer_connect.md index de477ef6..1a5060db 100644 --- a/samples/mqtt5_custom_authorizer_connect.md +++ b/samples/mqtt5_custom_authorizer_connect.md @@ -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.
diff --git a/samples/mqtt5_pkcs11_connect.md b/samples/mqtt5_pkcs11_connect.md index 3180e0cc..4f82f956 100644 --- a/samples/mqtt5_pkcs11_connect.md +++ b/samples/mqtt5_pkcs11_connect.md @@ -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. diff --git a/samples/mqtt5_pubsub.md b/samples/mqtt5_pubsub.md index 4e7c0048..ae803659 100644 --- a/samples/mqtt5_pubsub.md +++ b/samples/mqtt5_pubsub.md @@ -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.
diff --git a/samples/mqtt5_shared_subscription.md b/samples/mqtt5_shared_subscription.md index 28e86370..a52c4193 100644 --- a/samples/mqtt5_shared_subscription.md +++ b/samples/mqtt5_shared_subscription.md @@ -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//`. diff --git a/setup.py b/setup.py index 482b07b6..4f9226fe 100644 --- a/setup.py +++ b/setup.py @@ -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', )