This repository contains the following:

• Azure IoT Hub Device SDK for Python: to connect client devices to Azure IoT Hub
• Azure IoT Hub Service SDK for Python: enables developing back-end applications for Azure IoT
• Azure IoT Hub Provisioning Device SDK for Python: to connect client devices to Azure IoT Hub Provisioning Service
• Azure IoT Hub Provisioning Service SDK for Python: enables developing back-end applications for Azure IoT Hub Provisioning Service

To create and manage an instance of IoT Hub in your Azure subscription using Python, you can use the Azure IoT Hub management library for Python. Read more here.

To manage all your Azure resources using Python, you can leverate the Azure CLI v2.

To find SDKs in other languages for Azure IoT, please refer to the azure-iot-sdks repository.

The current version of the Azure IoT SDK for Python is a wrapper over our C SDK. It is generated using the Boost library. Because of that, it comes with several significant limitations:

• Boost and other C dependencies should be installed on the system for the PIP package to work, or the SDK to be built.
• Only a handful of "golden configurations" OS images are supported by the PIP package, because they have the right dependency tree:
  • Ubuntu 16:04 + Python 3.5 (or 2.7) + libboost-python-dev + libcurl4-openssl-dev + python3-dev (or python-dev for 2.7)
  • Windows 10: Python 3.6 corresponding to your CPU architecture (the default download on python.org is x86 and will not work if running on x64)
  • Raspbian Stretch: + Python 3.5 or 2.7 + libboost-python-dev + libcurl4-openssl-dev + python3-dev (or python-dev for 2.7)
  • Mac OS: Python 3.7.0 (or 2.7) + libboost-1.67 + curl 7.61.1 (all installed via homebrew) Any other distribution/OS probably embed different versions of boost & dependencies which won't work and will result in an ImportError at runtime.

The dockerfiles folder in this repository provides examples of configurations that successfully build the SDK or run the pip packages. We would absolutely welcome contributions to this folder to add more configurations.

my version is not in this list and I need support: you always have the option of rebuilding the sdk.

We are fully aware that this is a less than ideal situation and we are currently working on a full python implementation that will have the wide platform support that is expected of any respectable python library. While we intend to support this wrapper-based version of the SDK until the new one is full-featured, we will be deprecating it shortly thereafter. We will update this readme with the link to the new preview version when it is available.

Visit Azure IoT Dev Center to learn more about developing applications for Azure IoT.

Devices and data sources in an IoT solution can range from a simple network-connected sensor to a powerful, standalone computing device. Devices may have limited processing capability, memory, communication bandwidth, and communication protocol support. The IoT device SDKs enable you to implement client applications for a wide variety of devices.

• Using PyPI package on Windows, Linux (Ubuntu) or Raspberry Pi: the simplest way to use the Azure IoT SDK for Python to develop device apps on Windows is to leverage the PyPI package which you can install following these instructions.
• Clone the repository: This repository uses GitHub Submodules for its dependencies. In order to automatically clone these submodules, you need to use the --recursive option as described here:

git clone --recursive https://github.com/Azure/azure-iot-sdk-python.git

If you have downloaded the zip instead of cloning the repository, you will need to run the following command to restore submodules:

git submodule update --init --recursive

• Building the libraries and working with the SDK code: follow these instructions.

✔️ feature available ✖️ feature planned but not supported ➖ no support planned

✔️ feature available ✖️ feature planned but not supported ➖ no support planned

This repository contains provisioning device client SDK for the Device Provisioning Service. Provisioning service SDK for Python is work in progress. Please see provisoning service SDK in Node.js, Java and .NET in the meantime.

✔️ feature available ✖️ feature planned but not supported ➖ no support planned

This repository contains various Python sample applications that illustrate how to use the Microsoft Azure IoT SDKs for Python.

• Device SDK samples
• Service SDK samples

If you encounter any bugs, have suggestions for new features or if you would like to become an active contributor to this project please follow the instructions provided in the contribution guidelines.

• Have a feature request for SDKs? Please post it on User Voice to help us prioritize.
• Have a technical question? Ask on Stack Overflow with tag "azure-iot-hub".
• Need Support? Every customer with an active Azure subscription has access to support with guaranteed response time. Consider submitting a ticket and get assistance from Microsoft support team
• Found a bug? Please help us fix it by thoroughly documenting it and filing an issue on GitHub (C, Java, .NET, Node.js, Python).

• Azure IoT Hub documentation
• Prepare your development environment to use the Azure IoT device SDK for C
• Setup IoT Hub

This folder contains platform-specific build scripts for the client libraries and dependent components.

Contains Azure IoT Hub client components that provide the raw messaging capabilities of the library. Refer to the API documentation and samples for information on how to use it.

This folder contains application development guides and device setup instructions.

This folder contains scripts to build and run Python SDK provided proper environmental variables are set

Contains libraries that enable interactions with the IoT Hub service to perform operations such as sending messages to devices and managing the device identity registry.

The project offers a Long Term Support (LTS) version to allow users that do not need the latest features to be shielded from unwanted changes.

A new LTS version will be created every 6 months. The lifetime of an LTS branch is currently planned for one year. LTS branches receive all bug fixes that fall in one of these categories:

• security bugfixes
• critical bugfixes (crashes, memory leaks, etc.)

No new features or improvements will be picked up in an LTS branch.

LTS branches are named lts_mm_yyyy, where mm and yyyy are the month and year when the branch was created. An example of such a branch is lts_07_2017.

Below is a table showing the mapping of the LTS branches to the packages released

• ¹ All scheduled dates are subject to change by the Azure IoT SDK team.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Microsoft collects performance and usage information which may be used to provide and improve Microsoft products and services and enhance your experience. To learn more, review the privacy statement.