reiserwang/azure-iot-sdk


License: Other

Language: Python


Microsoft Azure IoT SDKs for Python

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

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

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.

Developing applications for Azure IoT

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

How to clone the repository

The repository is using 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

How to use the Azure IoT SDKs for Python

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
  • Building the libraries and working with the SDK code: follow these instructions.

Samples

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

Contribution, feedback and issues

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.

Support

If you are having issues using one of the packages or using the Azure IoT Hub service that go beyond simple bug fixes or help requests that would be dealt within the issues section of this project, the Microsoft Customer Support team will try and help out on a best effort basis. To engage Microsoft support, you can create a support ticket directly from the Azure portal. Escalated support requests for Azure IoT Hub SDKs development questions will only be available Monday thru Friday during normal coverage hours of 6 a.m. to 6 p.m. PST. Here is what you can expect Microsoft Support to be able to help with:

  • Client SDKs issues: If you are trying to compile and run the libraries on a supported platform, the Support team will be able to assist with troubleshooting or questions related to compiler issues and communications to and from the IoT Hub. They will also try to assist with questions related to porting to an unsupported platform, but will be limited in how much assistance can be provided. The team will be limited with trouble-shooting the hardware device itself or drivers and or specific properties on that device.
  • IoT Hub / Connectivity Issues: Communication from the device client to the Azure IoT Hub service and communication from the Azure IoT Hub service to the client. Or any other issues specifically related to the Azure IoT Hub.
  • Portal Issues: Issues related to the portal, that includes access, security, dashboard, devices, Alarms, Usage, Settings and Actions.
  • REST/API Issues: Using the IoT Hub REST/APIs that are documented in the documentation.

Read more

Long Term Support

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.

Schedule1

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

PIP Package Github Branch LTS Status LTS Start Date Maintenance End Date Removed Date
1.x.x lts_07_2017 Active 2017-07-01 2017-12-31 2018-06-30
  • 1 All scheduled dates are subject to change by the Azure IoT SDK team.

Planned Release Schedule


This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Project Statistics

Sourcerank 3
Repository Size 32.5 MB
Stars 0
Forks 0
Watchers 1
Open issues 0
Dependencies 18
Contributors 22
Tags 40
Created
Last updated
Last pushed

Top Contributors See all

Zoltan Varga Martin Regen Stefan Horst az-iot-builder-01 ewertons Olivier Bloch Dan Cristoloveanu Damien Pontifex John Spaith Pierre Cauchois tameraw Mark Radbourne Paymaun Ville Rantala Alexander Hirner Jon Gallant anporumb v-safa jasmineymlo Ilias Tsigkogiannis

Recent Tags See all

release_2017_08_14 August 14, 2017
release_2017_07_28 July 28, 2017
release_2017_07_17 July 17, 2017
release_2017_06_30 June 30, 2017
2017-06-06 June 06, 2017
release_2017_05_05 May 08, 2017
release_2017_04_24 April 24, 2017
2017-04-10 April 10, 2017
release_2017_03_27 March 27, 2017
release_2017_03_10 March 10, 2017
2017-02-24 February 25, 2017
2017-02-12 February 12, 2017
2017-01-30 January 30, 2017
2017-01-17 January 17, 2017
2017-01-06 January 06, 2017

Something wrong with this page? Make a suggestion

Last synced: 2018-01-17 06:41:50 UTC

Login to resync this repository