A Node.js SDK for connecting devices to Microsoft Azure IoT services
JavaScript TypeScript Other
Clone or download
Permalink
Failed to load latest commit information.
.github Export ModuleClient May 23, 2018
build/tools Bump package versions for release 2018-8-9 Aug 9, 2018
common Bump package versions for release 2018-8-9 Aug 9, 2018
device Bump package versions for release 2018-8-9 Aug 9, 2018
doc Migrate to lerna Jul 9, 2018
e2etests Bump package versions for release 2018-8-9 Aug 9, 2018
longhaultests Update dependencies and fix security warnings and tests Jul 10, 2018
network_e2e Docker-based network connection tests for windows Apr 11, 2017
provisioning Bump package versions for release 2018-8-9 Aug 9, 2018
security Bump package versions for release 2018-8-9 Aug 9, 2018
service Bump package versions for release 2018-8-9 Aug 9, 2018
ts-e2e Increase/Clean up e2e timeouts. need to be at least 60 seconds for de… Mar 30, 2018
.gitattributes Add license, readme, contribution guidelines and build files Nov 15, 2016
.gitignore Migrate to lerna Jul 9, 2018
.jshintignore [Node.js] Add code coverage reporting Feb 22, 2016
.jshintrc Improve Node.js build Oct 20, 2015
CODE_OF_CONDUCT.md Add code of conduct file Oct 17, 2017
LICENSE Add license, readme, contribution guidelines and build files Nov 15, 2016
feature_matrix.md Update readmes and templates with support information and other main … Mar 16, 2018
lerna.json Migrate to lerna Jul 9, 2018
lts_branches.png Update LTS document Jul 8, 2017
package.json Migrate to lerna Jul 9, 2018
readme-modules.md module and edge samples Mar 30, 2018
readme.md Update readmes and templates with support information and other main … Mar 16, 2018
thirdpartynotice.txt Add license, readme, contribution guidelines and build files Nov 15, 2016
tslint.json azure-iot-common port to TypeScript May 3, 2017

readme.md

Microsoft Azure IoT SDK for Node.js

This repository contains the following SDKs:

  • Azure IoT Hub Device SDK: to connect devices to Azure IoT Hub. API Reference
  • Azure IoT Hub Service SDK: enables developing back-end applications making use of Azure IoT Hub. API Reference
  • Azure IoT Hub Provisioning Device SDK: to connect devices to the Azure IoT Hub Provisioning Service. API Reference
  • Azure IoT Hub Provisioning Service SDK: enables developing back-end applications making use of the Azure IoT Provisioning Service. API Reference

Developing applications for Azure IoT

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

How to use the Azure IoT SDKs for Node.js

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.

The SDK team publishes the SDKs as npm packages:

  • Working with the SDKs code: if you are working with the SDK's code to modify it or to contribute changes, then you can clone the repository and build the libraries following these instructions.

Need Support?

  • Have a feature request for SDKs? Please post it on User Voice to help us prioritize
  • Have a technical question? Ask on Stack Overflow with tag "azure-iot-hub"
  • Need Support? Every customer with an active Azure subscription has access to support with guaranteed response time. Consider submitting a ticket and get assistance from Microsoft support team
  • Found a bug? Please help us fix it by thoroughly documenting it and filing an issue.

Key features and roadmap

Here's a feature matrix that will help you understand what feature is supported with which protocol.

Samples

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

Platforms compatibility

The Azure IoT SDK for Node.js should work with versions of Node.js as old as v0.10.x. this being said, a lot of dependencies are slowly dropping support for these older versions and we really have no control over that.

It is recommended to update to at least Node.js v4.x.x.

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.

Looking for SDKs for other languages/platforms?

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 package versions released

NPM Package Github Branch LTS Status LTS Start Date Maintenance End Date Removed Date
1.3.x lts_02_2018 Active 2018-02-16 2018-08-16 2019-02-16
  • 1 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 opencode@microsoft.com with any additional questions or comments.