You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-13
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,15 @@
1
1
# AWS IoT Device SDK for Java v2
2
2
3
-
This document provides information about the AWS IoT device SDK for Java V2. This SDK is built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html)
3
+
The **AWS IoT Device SDK for Java v2** is a rewrite of SDK v1 with some great new features. It includes many updates,
4
+
such as support for new [AWS IoT Core services](#supported-aws-iot-core-services), more detailed information about client
5
+
status, and an offline operation queue control. You can use this SDK using Maven or any build system that supports
6
+
MavenCentral as an artifact source.
4
7
5
8
*__Jump To:__*
6
9
7
-
*[Installation](#installation)
10
+
*[Using SDK](#using-sdk)
11
+
*[Features](#features-in-v2)
12
+
*[Building from source](#building-from-source)
8
13
*[Android](./documents/ANDROID.md)
9
14
*[Samples](samples)
10
15
*[Mac-Only TLS Behavior](#mac-only-tls-behavior)
@@ -14,7 +19,7 @@ This document provides information about the AWS IoT device SDK for Java V2. Thi
14
19
*[MQTT5 User Guide](./documents/MQTT5_Userguide.md)
15
20
*[Migration Guide from the AWS IoT SDK for Java v1](./documents/MIGRATION_GUIDE.md)
16
21
17
-
## Installation
22
+
## Using SDK
18
23
19
24
### Minimum Requirements
20
25
@@ -24,13 +29,6 @@ This document provides information about the AWS IoT device SDK for Java V2. Thi
### Consuming IoT Device SDK from Maven in your application
35
33
36
34
Consuming this SDK via Maven is the preferred method of consuming it and using it within your application. To consume the Java V2 SDK in your application, add the following to your `pom.xml` dependencies:
@@ -43,13 +41,34 @@ Consuming this SDK via Maven is the preferred method of consuming it and using i
43
41
</dependency>
44
42
```
45
43
46
-
Replace `1.25.0` in `<version>1.25.0</version>` with the latest release version for the SDK.
47
-
Look up the latest SDK version here: https://github.com/aws/aws-iot-device-sdk-java-v2/releases
44
+
## Features in v2
45
+
46
+
* All operations are non-blocking.
47
+
* MQTT5 protocol.
48
+
* First-class support for AWS IoT Core services.
48
49
49
-
### Build IoT Device SDK from source
50
+
#### Supported AWS IoT Core services
51
+
52
+
* The [AWS IoT Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) service adds
53
+
shadows to AWS IoT thing objects.
54
+
* The [AWS IoT Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html) allows to define a set of remote
55
+
operations that can be sent to and run on one or more devices connected to AWS IoT.
56
+
*[Fleet Provisioning](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) (also known as Identity
57
+
Service) is another AWS IoT service that the v2 SDK provides access to. By using AWS IoT fleet provisioning, AWS IoT can
58
+
generate and securely deliver device certificates and private keys to your devices when they connect to AWS IoT for the
59
+
first time.
60
+
61
+
## Building from source
62
+
63
+
Requirements to build the AWS CRT locally
64
+
* C++ 11 or higher
65
+
* Clang 3.9+ or GCC 4.4+ or MSVC 2015+
66
+
* CMake 3.1+
50
67
51
68
[Install Maven and Set PATH](https://maven.apache.org/install.html)
52
69
70
+
See [step-by-step instructions](./documents/PREREQUISITES.md) for more details on configuring required tools.
71
+
53
72
```sh
54
73
# Create a workspace directory to hold all the SDK files
0 commit comments