AWS IoT Device SDK for JavaScript v2

This document provides information about the AWS IoT device SDK for Javascript V2. This SDK is built on the AWS Common Runtime

Jump To:

• Installation
• Samples
• Mac-Only TLS Behavior
• Getting Help
• FAQ
• API Docs
• MQTT5 User Guide
• Migration Guide from the AWS IoT SDK for JavaScript v1

Installation

Minimum Requirements

For use with Node, the following are required:

• Node v14+
  • Run node -v to check Node version.
• CMake 3.1+

Step-by-step instructions

Build SDK in existing project with NPM

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

Build the V2 SDK from source

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

Samples

Samples README

Mac-Only TLS Behavior

Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.7.3, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:

static: certificate has an existing certificate-key pair that was previously imported into the Keychain.  Using key from Keychain instead of the one provided.

Getting Help

The best way to interact with our team is through GitHub. You can open a discussion for guidance questions or an issue for 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:

• FAQ
• API Docs
• IoT Guide (source)
• MQTT5 User Guide
• Check for similar Issues
• AWS IoT Core Documentation
• Dev Blog
• Integration with AWS IoT Services such as Device Shadow and Jobs is provided by code that been generated from a model of the service.
• Contributions Guidelines

License

This library is licensed under the Apache 2.0 License.

Latest released version: v1.21.1