Skip to content

anthonyvercolano/azure-iot-sdk-node

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

Getting Started

Why Azure IoT?

Click here to learn how Azure IoT can empower the digital transformation of your organization.

New to Azure IoT Hub?

Introduction to Azure IoT Hub: Follow this guide to learn how to set up an IoT Hub and IoT Hub devices.

New to the Azure IoT Node.JS SDK?

Try a Device Sample: Create a basic Node.js application following one of the device client library samples provided.

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

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

Platform Compatibility

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

Releases

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

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.

Read More


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.

About

A Node.js SDK for connecting devices to Microsoft Azure IoT services

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 60.9%
  • TypeScript 38.2%
  • Other 0.9%