aws-iot-device-sdk-v2
Advanced tools
This document provides information about the AWS IoT device SDK for Javascript V2.
If you have any issues or feature requests, please file an issue or pull request.
This SDK is built on the AWS Common Runtime, a collection of libraries (aws-c-common, aws-c-io, aws-c-mqtt, aws-c-http, aws-c-cal ...) written in C to be cross-platform, high-performance, secure, and reliable. The libraries are bound to JS by the awscrt package.
Jump To:
In the coming months, the v2 IoT SDK will be updating its Node baseline from 10.16 to 14. A discussion thread has been created for any questions or feedback you may have. We do not yet have a concrete timeline for when the update will happen.
The SDK now supports Greengrass IPC. See the Greengrass IPC User Guide or the API Documentation for more information.
The SDK now supports MQTT5. See the MQTT5 User Guide or the API Documentation for NodeJS or the browser for more information. There is also a MQTT5 sample for NodeJS and a MQTT5 sample for the browser.
For use with Node, the following are required:
node -v to check Node version.# Navigate to the Javascript project you want to add the
# Javascript V2 SDK to.
cd <your javascript project here>
# Install the V2 SDK.
npm install aws-iot-device-sdk-v2
# Now you can use the Javascript V2 SDK in your project.
# Create a workspace directory to hold all the SDK files.
mkdir sdk-workspace
cd sdk-workspace
# Clone the repository to access the samples.
git clone https://github.com/aws/aws-iot-device-sdk-js-v2.git
# Install the SDK.
cd aws-iot-device-sdk-js-v2
npm install
# Then you can run the samples following the instructions in the samples README.
# Create a workspace directory to hold all the SDK files.
mkdir sdk-workspace
cd sdk-workspace
# Clone the CRT repository.
# (Use the latest version of the CRT here instead of "v1.12.4").
git clone --branch v1.12.4 --recurse-submodules https://github.com/awslabs/aws-crt-nodejs.git
# Ensure all submodules are properly updated.
cd aws-crt-nodejs
git submodule update --init --recursive
cd ..
# Clone the SDK repository.
git clone --recursive https://github.com/aws/aws-iot-device-sdk-js-v2.git
# Ensure all submodules are properly updated.
cd aws-iot-device-sdk-js-v2
git submodule update --init --recursive
# Install the CRT.
npm install ../aws-crt-nodejs
# Install the SDK.
npm install
# Then you can run the samples following the instructions in the samples README.
The best way to interact with our team is through GitHub. You can open an issue and choose from one of our templates for guidance, bug reports, or feature requests. You may also find help on community resources such as StackOverFlow with the tag #aws-iot or If you have a support plan with AWS Support, you can also create a new support case.
Please make sure to check out our resources too before opening an issue:
We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels.
This library is licensed under the Apache 2.0 License.
Latest released version: v1.15.0
FAQs
NodeJS API for the AWS IoT service
The npm package aws-iot-device-sdk-v2 receives a total of 32,309 weekly downloads. As such, aws-iot-device-sdk-v2 popularity was classified as popular.
We found that aws-iot-device-sdk-v2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.