Options
All
  • Public
  • Public/Protected
  • All
Menu

aws-iot-device-sdk-v2 - v1.0.0-dev

AWS IoT SDK for Javascript v2

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:

Installation

Minimum Requirements

  • Node 10.x+

Common Run Time

The aws-crt package can be installed via npm

npm install aws-crt

Install from npm

npm install aws-iot-device-sdk-v2

Build from source

npm install

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.2.4, 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.

Samples

Samples README

Getting Help

Use the following sources for information :

  • Check api and developer guides.
  • Check for similar issues already opened.

If you still can’t find a solution to your problem open an issue

Giving Feedback and Contributions

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.

More Resources

Integration with AWS IoT Services such as Device Shadow and Jobs is provided by code that been generated from a model of the service.

License

This library is licensed under the Apache 2.0 License.

Generated using TypeDoc