Microsoft Azure Sphere Device REST APIs for Python

Notice to users: This is a pre v1.0 package - there may be changes over the coming weeks which may include package name and API. This README will be updated to indicate any changes.

Microsoft Azure Sphere Device REST APIs for Python enables users to interact with an Azure Sphere device using REST APIs.

Installation

You can find Microsoft Azure Sphere Device REST APIs for Python on PyPi.

1. If you haven't already, install and/or upgrade the pip of your Python environment to a recent version.
2. Run pip install microsoft-azure-sphere-deviceapi.

Versions

This library follows Semantic Versioning.

Usage

Before using Microsoft Azure Sphere Device REST APIs for Python, you must install the Azure Sphere SDK.

• To install the Azure Sphere SDK on Windows, follow the Windows Quickstart.
• To install the Azure Sphere SDK on Linux, follow the Linux Quickstart.

Sample

The display_ip_deviceid sample gets the list of attached devices, displays the device IP address, and device ID.

Active device IP address

By default, this package will target Azure Sphere devices with IP address 192.168.35.2. To change the active Azure Sphere device, call set_active_device_ip_address API as below:

from microsoft_azure_sphere_deviceapi import devices
devices.set_active_device_ip_address("<Device_Ip_Address")

Documentation

Microsoft Azure Sphere Device REST APIs for Python documentation is available at Azure Sphere Device REST APIs Docs.

Supported host operating systems

• Windows 10 and 11
• Ubuntu 18.04 and 20.04