aws-iot-device-sdk-v2
Advanced tools
Comparing version 1.2.1 to 1.2.2
@@ -0,1 +1,5 @@ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
import { io } from 'aws-crt'; | ||
@@ -2,0 +6,0 @@ import * as model from './model'; |
"use strict"; | ||
/* Copyright 2010-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
@@ -16,0 +7,0 @@ if (k2 === undefined) k2 = k; |
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
/** | ||
* Describes an IoT endpoint that a device can connect to | ||
@@ -3,0 +7,0 @@ * |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
@@ -16,0 +7,0 @@ exports.DiscoverResponse = exports.GGGroup = exports.GGCore = exports.ConnectivityInfo = void 0; |
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
/** | ||
* @moduledefinition aws-iot-device-sdk | ||
@@ -8,3 +12,3 @@ */ | ||
import * as iotshadow from './iotshadow/iotshadowclient'; | ||
import { mqtt } from "aws-crt"; | ||
export { iotidentity, greengrass, iotjobs, iotshadow, mqtt }; | ||
import { mqtt, auth, http, io, iot } from 'aws-crt'; | ||
export { iotidentity, greengrass, iotjobs, iotshadow, mqtt, auth, http, io, iot }; |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
@@ -35,3 +26,3 @@ if (k2 === undefined) k2 = k; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.mqtt = exports.iotshadow = exports.iotjobs = exports.greengrass = exports.iotidentity = void 0; | ||
exports.iot = exports.io = exports.http = exports.auth = exports.mqtt = exports.iotshadow = exports.iotjobs = exports.greengrass = exports.iotidentity = void 0; | ||
/** | ||
@@ -50,2 +41,6 @@ * @moduledefinition aws-iot-device-sdk | ||
Object.defineProperty(exports, "mqtt", { enumerable: true, get: function () { return aws_crt_1.mqtt; } }); | ||
Object.defineProperty(exports, "auth", { enumerable: true, get: function () { return aws_crt_1.auth; } }); | ||
Object.defineProperty(exports, "http", { enumerable: true, get: function () { return aws_crt_1.http; } }); | ||
Object.defineProperty(exports, "io", { enumerable: true, get: function () { return aws_crt_1.io; } }); | ||
Object.defineProperty(exports, "iot", { enumerable: true, get: function () { return aws_crt_1.iot; } }); | ||
//# sourceMappingURL=index.js.map |
@@ -0,1 +1,5 @@ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
import * as model from "./model"; | ||
@@ -2,0 +6,0 @@ import { mqtt } from "aws-crt"; |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
* This file is generated | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
@@ -18,0 +7,0 @@ if (k2 === undefined) k2 = k; |
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
/** | ||
* @module aws-iot-device-sdk | ||
@@ -3,0 +7,0 @@ * @category IotIdentity |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
* This file is generated | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
//# sourceMappingURL=model.js.map |
@@ -0,1 +1,5 @@ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
import * as model from "./model"; | ||
@@ -2,0 +6,0 @@ import { mqtt } from "aws-crt"; |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
* This file is generated | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
@@ -18,0 +7,0 @@ if (k2 === undefined) k2 = k; |
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
/** | ||
* @module aws-iot-device-sdk | ||
@@ -3,0 +7,0 @@ * @category IotJobs |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
* This file is generated | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
@@ -18,0 +7,0 @@ exports.JobStatus = exports.RejectedErrorCode = void 0; |
@@ -0,1 +1,5 @@ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
import * as model from "./model"; | ||
@@ -2,0 +6,0 @@ import { mqtt } from "aws-crt"; |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
* This file is generated | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
@@ -18,0 +7,0 @@ if (k2 === undefined) k2 = k; |
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
/** | ||
* @module aws-iot-device-sdk | ||
@@ -3,0 +7,0 @@ * @category IotShadow |
"use strict"; | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
* This file is generated | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
//# sourceMappingURL=model.js.map |
@@ -1,14 +0,5 @@ | ||
/* Copyright 2010-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
@@ -15,0 +6,0 @@ import { io, http, CrtError } from 'aws-crt'; |
@@ -1,14 +0,5 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
@@ -15,0 +6,0 @@ import { isArray } from 'util'; |
@@ -1,14 +0,5 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
*/ | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
@@ -24,3 +15,3 @@ /** | ||
import { mqtt } from "aws-crt"; | ||
import { mqtt, auth, http, io, iot } from 'aws-crt'; | ||
@@ -32,3 +23,7 @@ export { | ||
iotshadow, | ||
mqtt | ||
mqtt, | ||
auth, | ||
http, | ||
io, | ||
iot | ||
} |
@@ -1,17 +0,6 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
* This file is generated | ||
*/ | ||
import * as model from "./model"; | ||
@@ -18,0 +7,0 @@ import { mqtt } from "aws-crt"; |
@@ -1,18 +0,7 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
* This file is generated | ||
*/ | ||
/** | ||
@@ -19,0 +8,0 @@ * @module aws-iot-device-sdk |
@@ -1,17 +0,6 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
* This file is generated | ||
*/ | ||
import * as model from "./model"; | ||
@@ -18,0 +7,0 @@ import { mqtt } from "aws-crt"; |
@@ -1,17 +0,6 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
* This file is generated | ||
*/ | ||
/** | ||
@@ -18,0 +7,0 @@ * @module aws-iot-device-sdk |
@@ -1,17 +0,6 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
* This file is generated | ||
*/ | ||
import * as model from "./model"; | ||
@@ -18,0 +7,0 @@ import { mqtt } from "aws-crt"; |
@@ -1,18 +0,7 @@ | ||
/* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"). | ||
* You may not use this file except in compliance with the License. | ||
* A copy of the License is located at | ||
* | ||
* http://aws.amazon.com/apache2.0 | ||
* | ||
* or in the "license" file accompanying this file. This file is distributed | ||
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
* express or implied. See the License for the specific language governing | ||
* permissions and limitations under the License. | ||
/** | ||
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
* SPDX-License-Identifier: Apache-2.0. | ||
*/ | ||
* This file is generated | ||
*/ | ||
/** | ||
@@ -19,0 +8,0 @@ * @module aws-iot-device-sdk |
{ | ||
"name": "aws-iot-device-sdk-v2", | ||
"version": "1.2.1", | ||
"version": "1.2.2", | ||
"description": "NodeJS API for the AWS IoT service", | ||
@@ -5,0 +5,0 @@ "homepage": "https://github.com/aws/aws-iot-device-sdk-js-v2", |
198
README.md
# AWS IoT SDK for Javascript v2 | ||
This document provides information about the AWS IoT device SDK for Javascript V2. | ||
Next generation AWS IoT Client SDK for Javascript. | ||
If you have any issues or feature requests, please file an issue or pull request. | ||
This project is in **GENERAL AVAILABILITY**. 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 | ||
([1](https://github.com/awslabs/aws-c-common), | ||
[2](https://github.com/awslabs/aws-c-io), | ||
[3](https://github.com/awslabs/aws-c-mqtt), | ||
[4](https://github.com/awslabs/aws-c-http), | ||
[5](https://github.com/awslabs/aws-c-cal) ...) written in C to be | ||
([aws-c-common](https://github.com/awslabs/aws-c-common), | ||
[aws-c-io](https://github.com/awslabs/aws-c-io), | ||
[aws-c-mqtt](https://github.com/awslabs/aws-c-mqtt), | ||
[aws-c-http](https://github.com/awslabs/aws-c-http), | ||
[aws-c-cal](https://github.com/awslabs/aws-c-cal) ...) written in C to be | ||
cross-platform, high-performance, secure, and reliable. The libraries are bound | ||
to JS by the [awscrt](https://github.com/awslabs/aws-crt-nodejs) package. | ||
The aws-crt package can be installed via npm | ||
``` | ||
npm install aws-crt | ||
``` | ||
*__Jump To:__* | ||
* [Installation](#Installation) | ||
* [Samples](samples) | ||
* [Getting Help](#Getting-Help) | ||
* [Giving Feedback and Contributions](#Giving-Feedback-and-Contributions) | ||
* [More Resources](#More-Resources) | ||
Integration with AWS IoT Services such as | ||
[Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) | ||
and [Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html) | ||
is provided by code that been generated from a model of the service. | ||
[API Documentation](https://aws.github.io/aws-iot-device-sdk-js-v2/globals.html) | ||
# Installation | ||
## Minimum Requirements | ||
## Installation | ||
### Minimum Requirements | ||
* Node 10.x+ | ||
## Install from npm | ||
### 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 | ||
### Build from source | ||
``` | ||
@@ -43,144 +44,45 @@ npm install | ||
# Samples | ||
## node/pub_sub | ||
This sample uses the | ||
[Message Broker](https://docs.aws.amazon.com/iot/latest/developerguide/iot-message-broker.html) | ||
for AWS IoT to send and receive messages | ||
through an MQTT connection. On startup, the device connects to the server, | ||
subscribes to a topic, and begins publishing messages to that topic. | ||
The device should receive those same messages back from the message broker, | ||
since it is subscribed to that same topic. | ||
Status updates are continually printed to the console. | ||
## Samples | ||
Source: `samples/node/pub_sub` | ||
[Samples README](samples) | ||
Run the sample like this: | ||
``` | ||
npm install | ||
node dist/index.js --endpoint <endpoint> --root-ca <file> --cert <file> --key <file> | ||
``` | ||
Your Thing's | ||
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) | ||
must provide privileges for this sample to connect, subscribe, publish, | ||
and receive. | ||
<details> | ||
<summary>(see sample policy)</summary> | ||
<pre> | ||
{ | ||
"Version": "2012-10-17", | ||
"Statement": [ | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"iot:Publish", | ||
"iot:Receive" | ||
], | ||
"Resource": [ | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/samples/test" | ||
] | ||
}, | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"iot:Subscribe" | ||
], | ||
"Resource": [ | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topicfilter/samples/test" | ||
] | ||
}, | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"iot:Connect" | ||
], | ||
"Resource": [ | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:client/samples-client-id" | ||
] | ||
} | ||
] | ||
} | ||
</pre> | ||
</details> | ||
## Getting Help | ||
## node/basic_discovery | ||
Use the following sources for information : | ||
This sample intended for use directly with the | ||
[Getting Started with AWS IoT Greengrass](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-gs.html) guide. | ||
* Check api and developer guides. | ||
* Check for similar issues already opened. | ||
## fleet provisioning | ||
If you still can’t find a solution to your problem open an [issue](https://github.com/aws/aws-iot-device-sdk-js-v2/issues) | ||
This sample uses the AWS IoT | ||
[Fleet provisioning](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) | ||
to provision devices using either a CSR or KeysAndcertificate and subsequently calls RegisterThing. | ||
On startup, the script subscribes to topics based on the request type of either CSR or Keys topics, | ||
publishes the request to corresponding topic and calls RegisterThing. | ||
Source: `samples/node/fleet_provisioning` | ||
## Giving Feedback and Contributions | ||
Run the sample using CreateKeysAndCertificate: | ||
``` | ||
cd ~/samples/node/fleet_provisioning | ||
npm install | ||
node ./index.js --endpoint <endpoint> --ca_file <file> --cert <file> --key <file> --template_name <template name> --template_parameters <template parameters> | ||
``` | ||
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. | ||
Run the sample using CreateCertificateFromCsr: | ||
``` | ||
cd ~/samples/node/fleet_provisioning | ||
npm install | ||
node ./index.js --endpoint <endpoint> --ca_file <file> --cert <file> --key <file> --template_name <template name> --template_parameters <template parameters> --csr_file <csr file> | ||
``` | ||
* [Contributions Guidelines](master/CONTRIBUTING.md) | ||
* Articulate your feature request or upvote existing ones on our [Issues](https://github.com/aws/aws-iot-device-sdk-js-v2/issues?q=is%3Aissue+is%3Aopen+label%3Afeature-request) page. | ||
* Submit [Issues](https://github.com/aws/aws-iot-device-sdk-js-v2/issues) | ||
Your Thing's | ||
[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) | ||
must provide privileges for this sample to connect, subscribe, publish, | ||
and receive. | ||
<details> | ||
<summary>(see sample policy)</summary> | ||
<pre> | ||
{ | ||
"Version": "2012-10-17", | ||
"Statement": [ | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"iot:Publish" | ||
], | ||
"Resource": [ | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/certificates/create/json", | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/certificates/create-from-csr/json", | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/provisioning-templates/<b>templatename<b>/provision/json" | ||
] | ||
}, | ||
{ | ||
"Effect": "Allow", | ||
"Action": [ | ||
"iot:Receive", | ||
"iot:Subscribe" | ||
], | ||
"Resource": [ | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/certificates/create/json/accepted", | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/certificates/create/json/rejected", | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/certificates/create-from-csr/json/accepted", | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/certificates/create-from-csr/json/rejected", | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/provisioning-templates/<b>templatename<b>/provision/json/accepted", | ||
"arn:aws:iot:<b>region</b>:<b>account</b>:topic/$aws/provisioning-templates/<b>templatename<b>/provision/json/rejected" | ||
] | ||
}, | ||
{ | ||
"Effect": "Allow", | ||
"Action": "iot:Connect", | ||
"Resource": "arn:aws:iot:<b>region</b>:<b>account</b>:client/samples-client-id" | ||
} | ||
] | ||
} | ||
</pre> | ||
</details> | ||
## More Resources | ||
* [AWS IoT Core Documentation](https://docs.aws.amazon.com/iot/) | ||
* [Developer Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) ([source](https://github.com/awsdocs/aws-iot-docs)) | ||
* [Issues](https://github.com/aws/aws-iot-device-sdk-js-v2/issues) | ||
* [Dev Blog](https://aws.amazon.com/blogs/?awsf.blog-master-iot=category-internet-of-things%23amazon-freertos%7Ccategory-internet-of-things%23aws-greengrass%7Ccategory-internet-of-things%23aws-iot-analytics%7Ccategory-internet-of-things%23aws-iot-button%7Ccategory-internet-of-things%23aws-iot-device-defender%7Ccategory-internet-of-things%23aws-iot-device-management%7Ccategory-internet-of-things%23aws-iot-platform) | ||
* [API Documentation](https://aws.github.io/aws-iot-device-sdk-js-v2/globals.html) | ||
Integration with AWS IoT Services such as | ||
[Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) | ||
and [Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html) | ||
is provided by code that been generated from a model of the service. | ||
# License | ||
This library is licensed under the Apache 2.0 License. | ||
This library is licensed under the Apache 2.0 License. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
2407437
9119
87