jbobotek / azure-iot-preview

A lightweight layer for Azure RTOS that adds native connectivity to Azure IoT cloud services

Azure RTOS SDK for Azure IoT

This repository contains SDK for Azure IoT services. SDK uses ThreadX and NetXDuo to connect to Azure IoT.

Documentation

Documentation for this library can be found here: Link

Key Features

✔️ feature available ✔️* feature partially available (see Description for details) ✖️ feature planned but not supported

Feature	Azure RTOS SDK for Azure IoT services	Description
Send device-to-cloud message	✔️	Send device-to-cloud messages to IoT Hub with the option to add custom message properties.
Receive cloud-to-device messages	✔️	Receive cloud-to-device messages and associated properties from IoT Hub.
Device Twins	✔️	IoT Hub persists a device twin for each device that you connect to IoT Hub. The device can perform operations like get twin document, subscribe to desired property updates.
Direct Methods	✔️	IoT Hub gives you the ability to invoke direct methods on devices from the cloud.
DPS - Device Provisioning Service	✔️	This SDK supports connecting your device to the Device Provisioning Service via, for example, individual enrollment using an X.509 leaf certificate.
Protocol	MQTT	The Azure RTOS SDK for Azure IoT services supports only MQTT.
Plug and Play	Coming Soon	IoT Plug and Play Preview enables solution developers to integrate devices with their solutions without writing any embedded code.

Building and using the library

Prerequisites

Install the following tools:

• CMake version 3.13.0 or later
• GCC compilers for arm-none-eabi
• Ninja

Cloning the repo

$ git clone https://github.com/azure-rtos/azure-iot-preview.git
$ git submodule update --init

Building Sample

$ cd samples
$ cmake -GNinja -Bbuild -DCMAKE_TOOLCHAIN_FILE=./cmake/cortex_m4.cmake .
$ cmake --build ./build

Repository Structure and Usage

Branches & Releases

The master branch has the most recent code with all new features and bug fixes. It does not represent the latest General Availability (GA) release of the library.

Releases

Each official release (preview or GA) will be tagged to mark the commit and published to the Github releases tab, e.g. v6.0_beta1.

Directory layout

- azure_iot
- docs
- nx_cloud
- samples
  - cmake
  - lib
    - netxduo
    - threadx
  - ports/cortex_m4/gnu
  - ports/cortex_m7/gnu
  - sample_azure_iot_embedded_sdk

Sample projects

The following ZIP files can be downloaded from the Release associated with this repository:

• Azure_RTOS_6.0_ATSAME54-XPRO_IAR_Embedded_SDK_Sample_2020_05_20.zip
• Azure_RTOS_6.0_ATSAME54-XPRO_MPLAB_Embedded_SDK_Sample_2020_05_20.zip
• Azure_RTOS_6.0_MIMXRT1060_IAR_Embedded_SDK_Sample_2020_05_20.zip
• Azure_RTOS_6.0_MIMXRT1060_MCUXpresso_Embedded_SDK_Sample_2020_05_20.zip
• Azure_RTOS_6.0_STM32F746G-DISCO_IAR_Embedded_SDK_Sample_2020_05_20.zip
• Azure_RTOS_6.0_STM32F746G-DISCO_STM32CubeIDE_Embedded_SDK_Sample_2020_05_20.zip
• Azure_RTOS_6.0_STM32L475-DISCO_IAR_Embedded_SDK_Sample_2020_05_20.zip
• Azure_RTOS_6.0_STM32L475-DISCO_STM32CubeIDE_Embedded_SDK_Sample_2020_05_20.zip

NOTE: These zip files are completely self-contained and include appropriate code from the other Azure RTOS repositories. Please refer to the LICENSE.txt file in each ZIP file for licensing requirements.

Security

Azure RTOS provides OEMs with components to secure communication and to create code and data isolation using underlying MCU/MPU hardware protection mechanisms. It is ultimately the responsibility of the device builder to ensure the device fully meets the evolving security requirements associated with its specific use case.

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 guideline for the corresponding repo.

For general support, please post a question to Stack Overflow using the threadx and azure-rtos tags.