Skip to content

Latest commit

 

History

History
106 lines (70 loc) · 7.45 KB

readme.md

File metadata and controls

106 lines (70 loc) · 7.45 KB

Build Status

Critical Upcoming Change Notice

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.

Components

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.
  • Provisioning Device Client Library: to connect devices to the Azure IoT Provisioning Service. API Reference

Samples

Device Library Samples

npm Package List

Azure IoT Hub Device Client Libraries

Name npm package
Device Client npm version
MQTT Transport npm version
AMQP Transport npm version
HTTP Transport npm version

Azure IoT Hub Device Provisioning Service: Device Client Libraries

Name npm package
Device Client npm version
MQTT Transport npm version
AMQP Transport npm version
HTTP Transport npm version
TPM Security Client npm version
x509 Security Client npm version

Working from Source Code

If you want to modify or contribute changes to the SDK, then you can build the libraries following these instructions.

How to Contribute

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

Platform Compatibility

The Azure IoT SDK for Node.js supports active LTS, maintainence LTS, and current releases of the Node.js runtime.

Support

The Azure IoT Hub Device Client supported releases is outlined in the following table.

Refer to the Azure IoT Device SDK lifecycle and support for details on the different supported stages.

Release Category End-of-life
1.18.2 Active -

Read More


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.

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.