9193291da6
(doc) Add description of invalid cert e2e environment variables. |
||
|---|---|---|
| .github | ||
| build/tools | ||
| common | ||
| device | ||
| doc | ||
| e2etests | ||
| edge-e2e | ||
| longhaultests | ||
| network_e2e | ||
| provisioning | ||
| security | ||
| service | ||
| ts-e2e | ||
| vsts | ||
| .gitattributes | ||
| .gitignore | ||
| .jshintignore | ||
| .jshintrc | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| feature_matrix.md | ||
| lerna.json | ||
| lts_branches.png | ||
| mocha-reports.json | ||
| package.json | ||
| readme-modules.md | ||
| readme.md | ||
| thirdpartynotice.txt | ||
| tslint.json | ||
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:
- Azure IoT Hub Device SDK
- Azure IoT Hub Service SDK
- Azure IoT Hub Device Provisioning Service: Device SDK
- Azure IoT Hub Device Provisioning Service: Service SDK
- 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
- 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
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.