This document provides information about the AWS IoT Device SDK v2 for Python.
If you have any issues or feature requests, please file an issue or pull request.
API documentation: https://aws.github.io/aws-iot-device-sdk-python-v2/
This SDK is built on the AWS Common Runtime, a collection of libraries
(aws-c-common,
aws-c-io,
aws-c-mqtt,
aws-c-compression,
aws-c-http,
aws-c-cal,
aws-c-auth,
s2n ...) written in C to be
cross-platform, high-performance, secure, and reliable. The libraries are bound
to Python by the awscrt package (PyPI) (Github).
Jump To:
- Installation
- Mac-Only TLS Behavior
- Samples
- Getting Help
- Giving Feedback and Contributions
- More Resources
- Python 3.5+
python3 -m pip install awsiotsdk
git clone https://github.com/aws/aws-iot-device-sdk-python-v2.git
python3 -m pip install ./aws-iot-device-sdk-python-v2
awsiotsdk depends on awscrt, which makes use of C extensions. Precompiled wheels are downloaded when installing on major platforms (Mac, Windows, Linux, Raspbian. If wheels are unavailable for your platform, your machine must compile some C libraries. If you encounter issues, install the following and try again:
sudo apt-get update
sudo apt-get install cmake
sudo apt-get install libssl-dev
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.3.2, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:
static: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.
Use the following sources for information :
- Check api and developer guides.
- Check for similar issues already opened.
If you still can’t find a solution to your problem open an issue
We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels.
- Contributions Guidelines
- Articulate your feature request or upvote existing ones on our Issues page.
- Submit Issues
Integration with AWS IoT Services such as Device Shadow and Jobs is provided by code that been generated from a model of the service.
This library is licensed under the Apache 2.0 License.