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
- Getting Help
- FAQ
- API Docs
- MQTT5 User Guide
- Migration Guide from the AWS IoT SDK for JavaScript v1
For use with Node, the following are required:
- Node v14+
- Run
node -v
to check Node version.
- Run
- CMake 3.1+
# 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.
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
This library is licensed under the Apache 2.0 License.
Latest released version: v1.20.0