You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This document provides information about the AWS IoT Device SDK v2 for Python. This SDK is built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html)
5
+
The AWS IoT Device SDK for Python v2 connects your Python applications and devices to AWS IoT. Built on the AWS Common Runtime, it handles the complexities of secure communication, authentication, and device management so you can focus on your IoT solution. The SDK makes it easy to use AWS IoT services like Device Shadows, Jobs, and Fleet Provisioning.
*[MQTT5 User Guide](./documents/MQTT5_Userguide.md)
15
-
*[Migration Guide from the AWS IoT SDK for Python v1](./documents/MIGRATION_GUIDE.md)
15
+
*[Getting Help](#getting-help)
16
+
*[Resources](#resources)
17
+
18
+
## Features
19
+
20
+
The primary purpose of the AWS IoT Device SDK for Python v2 is to simplify the process of connecting devices to AWS IoT Core and interacting with AWS IoT services on various platforms. The SDK provides:
21
+
22
+
* Built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html) for high performance and minimal footprint
23
+
* Secure device connections to AWS IoT Core using MQTT protocol including MQTT 5.0
24
+
* Support for [multiple authentication methods and connection types](./documents/MQTT5_Userguide.md#how-to-create-an-mqtt5-client-based-on-desired-connection-method)
25
+
* First-class support for AWS IoT Core services
16
26
27
+
#### Supported AWS IoT Core services
17
28
18
-
## Installation
29
+
* The [AWS IoT Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) service adds shadows to AWS IoT thing objects.
30
+
* The [AWS IoT Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html) allows to define a set of remote operations that can be sent to and run on one or more devices connected to AWS IoT.
31
+
* The [AWS IoT fleet provisioning](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) can generate and securely deliver device certificates and private keys to IoT devices when they connect to AWS IoT for the first time.
32
+
33
+
## Using SDK
34
+
35
+
The recommended way to use the AWS IoT Device SDK for Python v2 in your project is to install it from PyPI.
19
36
20
37
### Minimum Requirements
38
+
39
+
To develop applications with the AWS IoT Device SDK for Python v2, you need:
To get started with the AWS IoT Device SDK for Python v2:
82
+
83
+
1.**Install the SDK** - See the [Using SDK](#using-sdk) section for installation details
84
+
85
+
2.**Choose your connection method** - The SDK supports multiple authentication methods including X.509 certificates, AWS credentials, and custom authentication
86
+
87
+
3.**Follow a complete example** - Check out the [samples](samples) directory for working code examples that demonstrate:
88
+
- Basic MQTT connection and messaging
89
+
- Device Shadow operations
90
+
- AWS IoT Jobs
91
+
- Fleet provisioning
92
+
93
+
4.**Learn MQTT5 features** - For advanced usage and configuration options, see the [MQTT5 User Guide](./documents/MQTT5_Userguide.md)
94
+
95
+
The samples provide ready-to-run code with detailed setup instructions for each authentication method and use case.
96
+
59
97
## Samples
60
98
61
-
[Samples README](samples)
99
+
Check out the [samples](samples) directory for working code examples that demonstrate:
100
+
- Basic MQTT connection and messaging
101
+
- AWS IoT Device Shadow operations
102
+
- AWS IoT Jobs
103
+
- AWS IoT Fleet provisioning
104
+
105
+
The samples provide ready-to-run code with detailed setup instructions for each authentication method and use case.
62
106
63
-
### Mac-Only TLS Behavior
107
+
## Getting Help
108
+
109
+
The best way to interact with our team is through GitHub.
110
+
* Open [discussion](https://github.com/aws/aws-iot-device-sdk-python-v2/discussions): Share ideas and solutions with the SDK community
111
+
* Search [issues](https://github.com/aws/aws-iot-device-sdk-python-v2/issues): Find created issues for answers based on a topic
112
+
* Create an [issue](https://github.com/aws/aws-iot-device-sdk-python-v2/issues/new/choose): New feature request or file a bug
113
+
114
+
If you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case.
115
+
116
+
#### Mac-Only TLS Behavior
64
117
65
118
Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.7.3, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:
66
119
67
120
```
68
121
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
69
122
```
70
123
71
-
## Getting Help
72
-
73
-
The best way to interact with our team is through GitHub. You can open a [discussion](https://github.com/aws/aws-iot-device-sdk-python-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-python-v2/issues/new/choose) for bug reports, or feature requests. You may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-iot) with the tag [#aws-iot](https://stackoverflow.com/questions/tagged/aws-iot) or if you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case.
124
+
## Resources
74
125
75
-
Please make sure to check out our resources too before opening an issue:
126
+
Check out our resources for additional guidance too before opening an issue:
0 commit comments