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
+14-31Lines changed: 14 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,13 @@
1
1
# AWS IoT Device SDK for Java v2
2
2
3
-
The AWS IoT Device SDK for Java v2 connects your Java applications and devices to the AWS IoT platform. Built on the AWS Common Runtime, 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, Fleet Provisioning, and Commands.
3
+
The AWS IoT Device SDK for Java v2 connects your Java 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, Fleet Provisioning, and Commands.
**Supported Platforms**: Linux, Windows 10+, macOS 10.15+, [Android](./documents/ANDROID.md)
6
6
7
7
*__Topics:__*
8
8
*[Features](#features)
9
-
*[Using SDK](#using-sdk)
9
+
*[Installation](#installation)
10
+
*[Minimum Requirements](#minimum-requirements)
10
11
*[Getting Started](#getting-started)
11
12
*[Samples](samples)
12
13
*[MQTT5 User Guide](./documents/MQTT5_Userguide.md)
@@ -17,20 +18,19 @@ The AWS IoT Device SDK for Java v2 connects your Java applications and devices t
17
18
18
19
The primary purpose of the AWS IoT Device SDK for Java 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:
19
20
20
-
*Built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html)for high performance and minimal footprint
21
+
*Integrated service clients for AWS IoT Core services
21
22
* Secure device connections to AWS IoT Core using MQTT protocol including MQTT 5.0
22
23
* Support for [multiple authentication methods and connection types](./documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method)
23
24
* Android [support](./documents/ANDROID.md)
24
-
* First-class support for AWS IoT Core services.
25
25
26
26
#### Supported AWS IoT Core services
27
27
28
-
* The [AWS IoT Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) service adds shadows to AWS IoT thing objects.
29
-
* The [AWS IoT Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html)allows to define a set of remote operations that can be sent to and run on one or more devices connected to AWS IoT.
30
-
* The [AWS IoT fleet provisioning](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html)can generate and securely deliver device certificates and private keys to IoT devices when they connect to AWS IoT for the first time.
31
-
* The [AWS IoT Device Management commands](https://docs.aws.amazon.com/iot/latest/developerguide/iot-remote-command.html)allows to send an instruction from the cloud to a device that's connected to AWS IoT.
28
+
* The [AWS IoT Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html) service manages device state information in the cloud.
29
+
* The [AWS IoT Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html)service sends remote operations to connected devices.
30
+
* The [AWS IoT fleet provisioning](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html)service generates and delivers device certificates automatically.
31
+
* The [AWS IoT Device Management commands](https://docs.aws.amazon.com/iot/latest/developerguide/iot-remote-command.html)service sends instructions from the cloud to connected devices.
32
32
33
-
## Using SDK
33
+
## Installation
34
34
35
35
The recommended way to use the AWS IoT Device SDK for Java v2 in your project is to consume it from Maven Central.
36
36
@@ -61,27 +61,7 @@ Look up the latest SDK version here: https://github.com/aws/aws-iot-device-sdk-j
61
61
62
62
### Building AWS IoT SDK from source
63
63
64
-
```sh
65
-
# Create a workspace directory to hold all the SDK files
If you wish to use the latest CRT release, rather than the latest tested with the IoT SDK, you can run the following command before running `mvn clean install`:
If you also need to build AWS CRT Java from source, visit [AWS CRT Java](https://github.com/awslabs/aws-crt-java?tab=readme-ov-file#platform) project for instructions.
64
+
See the [Development Guide](./documents/DEVELOPING.md) for detailed instructions on building from source and using local builds.
85
65
86
66
## Getting Started
87
67
@@ -117,6 +97,9 @@ If you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupp
117
97
118
98
#### Mac-Only TLS Behavior
119
99
100
+
> [!NOTE]
101
+
> This SDK does not support TLS 1.3 on macOS. Support for TLS 1.3 on macOS is planned for a future release.
102
+
120
103
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:
0 commit comments