AWS IoT Device SDK for JavaScript v2

The AWS IoT Device SDK for JavaScript v2 connects your JavaScript applications and devices to the AWS IoT platform. It handles the complexities of secure communication, authentication, and device management so you can focus on your IoT solution. The SDK makes it easy to use AWS IoT services like Device Shadows, Jobs, and Fleet Provisioning.

Supported Platforms: Linux, Windows 11+, macOS 14+

Note: The SDK is known to work on older platform versions, but we only guarantee compatibility for the platforms listed above.

Topics:

• Features
• Installation
  • Minimum Requirements
  • Installing from npm
• Getting Started
• Samples
• MQTT5 User Guide
• Getting Help
• Resources

Features

The primary purpose of the AWS IoT Device SDK for JavaScript v2 is to simplify the process of connecting devices to AWS IoT Core and interacting with AWS IoT services on various platforms. The SDK provides:

• Integrated service clients for AWS IoT Core services
• Secure device connections to AWS IoT Core using MQTT protocol including MQTT 5.0
• Support for multiple authentication methods and connection types

Supported AWS IoT Core services

• The AWS IoT Device Shadow service manages device state information in the cloud.
• The AWS IoT Jobs service sends remote operations to connected devices.
• The AWS IoT fleet provisioning service generates and delivers device certificates automatically.

Installation

The recommended way to use the AWS IoT Device SDK for JavaScript v2 in your project is to install it from npm.

Minimum Requirements

To develop applications with the AWS IoT Device SDK for JavaScript v2, you need:

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

See detailed setup instructions for more information.

Installing from npm

Navigate to your JavaScript project directory and install the SDK:

cd <your-javascript-project>
npm install aws-iot-device-sdk-v2

Building from source

See the Development Guide for detailed instructions on building from source and using local builds.

Getting Started

To get started with the AWS IoT Device SDK for JavaScript v2:

1. Install the SDK - See the Installation section for installation details

2. Choose your connection method - The SDK supports multiple authentication methods including X.509 certificates, AWS credentials, and custom authentication. MQTT5 User Guide connection section provides more guidance

3. Follow a complete example - Check out the samples directory

4. Learn MQTT5 features - For advanced usage and configuration options, see the MQTT5 User Guide

The samples provide ready-to-run code with detailed setup instructions for each authentication method and use case.

Samples

Check out the samples directory for working code examples that demonstrate:

• Basic MQTT connection and messaging
• AWS IoT Device Shadow operations
• AWS IoT Jobs
• AWS IoT Fleet provisioning

The samples provide ready-to-run code with detailed setup instructions for each authentication method and use case.

Getting Help

The best way to interact with our team is through GitHub.

• Open discussion: Share ideas and solutions with the SDK community
• Search issues: Find created issues for answers based on a topic
• Create an issue: New feature request or file a bug

If you have a support plan with AWS Support, you can also create a new support case.

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.

Resources

Check out our resources for additional guidance too before opening an issue:

• FAQ
• AWS IoT Core Developer Guide
• MQTT5 User Guide
• API Docs
• AWS IoT Core Documentation
• Dev Blog
• Migration Guide from the AWS IoT SDK for JavaScript v1
• Contributions Guidelines

License

This library is licensed under the Apache 2.0 License.

Latest released version: v1.23.1