Documentation Status Discord Build Status

Access to Microsoft Azure IoT from a CircuitPython device. This library can perform device messaging services (cloud-to-device, device-to-cloud), device services, and job services.


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

Create an instance of an Azure IoT Hub (you’ll need your SAS Token).

my_hub = IOT_HUB(wifi, 'Azure_IOT_Hub_Name', 'Azure_IOT_Hub_SAS_Token', 'Azure_Device_Identifier')

Send a device-to-cloud message

my_hub.send_device_message('Hello Azure IoT!')

Enumerate all devices on an Azure IOT Hub

hub_devices = my_hub.get_devices()

Get information about the current device on an Azure IoT Hub

device_info = my_hub.get_device()

Get information about the current device’s device twin

twin_info = my_hub.get_device_twin()

Update the current device’s device twin properties



Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-azureiot --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

Indices and tables