This repository contains the following:

• Microsoft Azure IoT Hub device SDK for C# to connect client devices to Azure IoT Hub with .NET
• Microsoft Azure IoT Hub service SDK for C# to manage your IoT Hub service instance from a back-end .NET application

The API reference documentation for .NET SDK is here.

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

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

• Using packages and libraries: The simplest way to use the Azure IoT SDKs is to use packages and libraries when available. Refer to this document on how to get Azure IoT SDKs for .NET using Nuget and build applications.
• 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-csharp.git

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

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

In the repository, you will find a set of simple samples that will help you get started:

• Device SDK samples
• Service SDK samples

The IoT Hub device SDK for .NET can be used with a broad range of OS platforms and devices.

Minimum requirements:

• .NET platform support (see https://dot.net for supported platforms)
• Device SDK: .NET Framework 4.5; .NET Standard 1.3; PCL

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.

For suggestions regarding the Azure IoT Services, please use https://feedback.azure.com/forums/321918-azure-iot

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:

• 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.

• Azure IoT Hub documentation
• Set up IoT Hub describes how to configure your Azure IoT Hub service.
• Manage IoT Hub describes how to provision devices in your Azure IoT Hub service.
• FAQ contains frequently asked questions about the SDKs and libraries.
• Azure Certified for IoT device catalog
• Set up your development environment to prepare your development environment as well as how to run the samples on Linux, Windows or other platforms.
• API reference documentation for .NET
• Get Started with IoT Hub using .NET

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.

Contains application development guides and device setup instructions.

Contains end-to-end tests.

Contains scripts used by the Continuous Integration system (Jenkins).

Contains the Azure IoT Provisioning client components.

Contains the SecurityProvider components for Hardware Security Modules.

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.

Contains source code for the Microsoft.Azure.Devices.Shared component. This component contains public API shared across the SDK.

Contains the source code for the Azure IoT Device Explorer tool.

Contains the TransportClient components.

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.