All Azure IoT SDK users are advised to be aware of upcoming TLS certificate changes for Azure IoT Hub and Device Provisioning Service that will impact the SDK's ability to connect to these services. In October 2022, both services will migrate from the current Baltimore CyberTrust CA Root to the DigiCert Global G2 CA root. There will be a transition period beforehand where your IoT devices must have both the Baltimore and Digicert public certificates installed in their certificate store in order to prevent connectivity issues.
Devices with only the Baltimore public certificate installed will lose the ability to connect to Azure IoT hub and Device Provisioning Service in October 2022.
To prepare for this change, make sure your device's certificate store has both of these public certificates installed.
For a more in depth explanation as to why the IoT services are doing this, please see this article.
Click here to learn how Azure IoT can empower the digital transformation of your organization.
Introduction to Azure IoT Hub: Follow this guide to learn how to set up an IoT Hub and IoT Hub devices.
Try a Device Sample: Create a basic Node.js application following one of the device client library samples provided.
The Azure IoT Node.js SDK enables developers to create IoT solutions written in Node.js for the Azure IoT platform. It is composed of the following client libraries:
- Device Client Library: to connect devices and IoT Edge modules to Azure IoT Hub. API Reference | README | Configuration Options
- Note: IoT Edge for Node.js is scoped to Linux containers & devices only. Learn more about using Linux containers for IoT edge on Windows devices.
- Service Client Library: enables developing back-end applications making use of Azure IoT Hub. API Reference
- Provisioning Device Client Library: to connect devices to the Azure IoT Provisioning Service. API Reference
- Provisioning Service Client Library: enables developing back-end applications making use of the Azure IoT Provisioning Service. API Reference
| Device Library Samples | Service Library Samples |
|---|
Azure IoT Hub Device Client Libraries
| Name | npm package |
|---|---|
| Device Client |  |
| MQTT Transport |  |
| AMQP Transport |  |
| HTTP Transport |  |
Azure IoT Hub Service Client Libraries
| Name | npm package |
|---|---|
| Service SDK |  |
Azure IoT Hub Device Provisioning Service: Device Client Libraries
| Name | npm package |
|---|---|
| Device Client |  |
| MQTT Transport |  |
| AMQP Transport |  |
| HTTP Transport |  |
| TPM Security Client |  |
| x509 Security Client |  |
Azure IoT Hub Device Provisioning Service: Service Client Libraries
| Name | npm package |
|---|---|
| Service SDK |  |
If you want to modify or contribute changes to the SDK, then you can build the libraries following these instructions.
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.
- 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.
The Azure IoT SDK for Node.js supports the LTS and Current versions of the Node.js runtime.
The Node SDK offers releases for new features, critical bug fixes, and Long Term Support (LTS). NPM package versioning follows semantic versioning, x.y.z. or major.minor.patch. Any time the version is updated, it will be tagged x.y.z.
New features and critical bug fixes (including security updates) will be released on the main branch. These releases will be tagged using the date formatted yyyy-mm-dd. A feature release will bump the minor version and reset the patch version to 0. A critical bug fix will bump the patch version only.
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.
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 package versions released
| NPM Package | Github Branch | LTS Status | LTS Start Date | Maintenance End Date | Removed Date |
|---|---|---|---|---|---|
| 1.17.x | lts_07_2020 | Active | 2020-07-28 | 2022-01-31 | 2022-06-30 |
We have extended the life of the current LTS. A new LTS will be available in January 2022.
1 All scheduled dates are subject to change by the Azure IoT SDK team.
New LTS branches will generally be released around the midpoint of the current LTS.
- Azure IoT Hub documentation
- Prepare your development environment to use the Azure IoT device SDK for Node.js
- Setup IoT Hub
- Node.js API reference: Service SDK
- Node.js API reference: Device SDK
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.
Microsoft collects performance and usage information which may be used to provide and improve Microsoft products and services and enhance your experience. To learn more, review the privacy statement.