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: documents/FAQ.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ To enable logging in the samples, you will need to set the following system prop
35
35
For example, to run `BasicPubSub` with logging you could use the following:
36
36
37
37
```sh
38
-
mvn compile exec:java -pl samples/mqtt/mqtt5x509 -Daws.crt.debugnative=true -Daws.crt.log.level=Debug -Daws.crt.log.destionation=Stdout -Dexec.mainClass=pubsub.PubSub -Dexec.args='--endpoint <endpoint> --cert <path to cert> --key <path to key>'
38
+
mvn compile exec:java -pl samples/Mqtt/Mqtt5X509 -Daws.crt.debugnative=true -Daws.crt.log.level=Debug -Daws.crt.log.destionation=Stdout -Dexec.mainClass=pubsub.PubSub -Dexec.args='--endpoint <endpoint> --cert <path to cert> --key <path to key>'
39
39
```
40
40
41
41
You can also enable [CloudWatch logging](https://docs.aws.amazon.com/iot/latest/developerguide/cloud-watch-logs.html) for IoT which will provide you with additional information that is not available on the client side sdk.
Copy file name to clipboardExpand all lines: samples/README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,42 +12,42 @@ This directory contains sample applications for [aws-iot-device-sdk-java-v2](../
12
12
13
13
## Samples
14
14
### MQTT5 Client Samples
15
-
##### MQTT5 is the recommended MQTT Client. Additional infomration and usage instructions can be found in the [MQTT5 User Guide](../documents/MQTT5_Userguide.md). The samples below will create an MQTT5 client, connect using the selected method, subscribe to a topic, publish to the topic, and then disconnect.
15
+
##### MQTT5 is the recommended MQTT Client. Additional infomration and usage instructions can be found in the [MQTT5 User Guide](../documents/Mqtt5_Userguide.md). The samples below will create an MQTT5 client, connect using the selected method, subscribe to a topic, publish to the topic, and then disconnect.
16
16
| MQTT5 Client Sample | Description |
17
17
|--------|-------------|
18
-
| [X509-based mutual TLS](./mqtt/mqtt5x509/README.md) | Demonstrates connecting to AWS IoT Core using X.509 certificates and private keys.
19
-
|[Websockets with Sigv4 authentication](./mqtt/mqtt5awswebsocket/README.md)| Shows how to authenticate over websockets using AWS Signature Version 4 credentials. |
20
-
| [AWS Signed Custom Authorizer Lambda Function](./mqtt/mqtt5customauthsigned/README.md) | Connecting with a signed Lambda-backed custom authorizer.
21
-
| [AWS Unsigned Custom Authorizer Lambda Function](./mqtt/mqtt5customauthunsigned/README.md) | Connecting with an unsigned Lambda-backed custom authorizer.
22
-
|[PKCS11](./mqtt/mqtt5pkcs11/README.md)| Demonstrates connecting using a hardware security module (HSM) or smartcard with PKCS#11. |
18
+
| [X509-based mutual TLS](./Mqtt/Mqtt5X509/README.md) | Demonstrates connecting to AWS IoT Core using X.509 certificates and private keys.
19
+
|[Websockets with Sigv4 authentication](./Mqtt/Mqtt5AwsWebsocket/README.md)| Shows how to authenticate over websockets using AWS Signature Version 4 credentials. |
20
+
| [AWS Signed Custom Authorizer Lambda Function](./Mqtt/Mqtt5CustomAuthSigned/README.md) | Connecting with a signed Lambda-backed custom authorizer.
21
+
| [AWS Unsigned Custom Authorizer Lambda Function](./Mqtt/Mqtt5CustomAuthUnsigned/README.md) | Connecting with an unsigned Lambda-backed custom authorizer.
22
+
|[PKCS11](./Mqtt/Mqtt5Pkcs11/README.md)| Demonstrates connecting using a hardware security module (HSM) or smartcard with PKCS#11. |
23
23
| [Other Connection Methods](../documents/MQTT5_Userguide.md#how-to-create-an-mqtt5-client-based-on-desired-connection-method) | More connection methods are available for review in the MQTT5 Userguide
24
24
25
25
### Service Client Samples
26
26
##### AWS offers a number of IoT related services using MQTT. The samples below demonstrate how to use the service clients provided by the SDK to interact with those services.
27
27
| Service Client Sample | Description |
28
28
|--------|-------------|
29
-
|[Basic Fleet Provisioning](./serviceclients/provisioning/basic/README.md)| Provision a device using the Fleet Provisioning template. |
|[Shadow Sandbox](./ServiceClients/ShadowSandbox/README.md)| Sandbox sample to manage and sync device state using the IoT Device Shadow service. |
32
+
|[Jobs Sandbox](./ServiceClients/JobsSandbox/README.md)| Sandbox sample to receive and execute remote operations sent from the Jobs service. |
33
+
|[Commands Sandbox](./ServiceClients/CommandsSandbox/README.md)| Sandbox sample to demonstrante Commands service. |
34
34
35
35
### Greengrass Samples
36
36
##### Samples that interact with [AWS Greengrass](https://aws.amazon.com/greengrass/).
37
37
| Greengrass Sample | Description |
38
38
|--------|-------------|
39
-
|[Greengrass Discovery](./greengrass/discovery/README.md)| Discover and connect to a local Greengrass core. |
40
-
|[Greengrass IPC](./greengrass/greengrassipc/README.md)| Demonstrates Inter-Process Communication (IPC) with Greengrass components. |
39
+
|[Greengrass Discovery](./Greengrass/Discovery/README.md)| Discover and connect to a local Greengrass core. |
40
+
|[Greengrass IPC](./Greengrass/GreengrassIPC/README.md)| Demonstrates Inter-Process Communication (IPC) with Greengrass components. |
41
41
42
42
### Instructions
43
43
44
44
First, install `aws-iot-device-sdk-java-v2`. Installation instructions for the SDK are [Provided Here](../README.md#installation).
45
45
46
-
Each sample's README contains prerequisites, arguments, and detailed instructions. For example, the [MQTT X509 Sample README](./mqtt/mqtt5x509/README.md) instructs to run the sample with the following command:
46
+
Each sample's README contains prerequisites, arguments, and detailed instructions. For example, the [MQTT X509 Sample README](./Mqtt/Mqtt5x509/README.md) instructs to run the sample with the following command:
47
47
48
48
```sh
49
49
mvn compile exec:java \
50
-
-pl samples/mqtt/mqtt5x509 \
50
+
-pl samples/Mqtt/Mqtt5x509 \
51
51
-Dexec.args="\
52
52
--endpoint <ENDPOINT> \
53
53
--cert <PATH TO CERTIFICATE FILE> \
@@ -60,7 +60,7 @@ If you want to run a sample using the latest release of the SDK, instead of comp
60
60
61
61
```sh
62
62
mvn -P latest-release compile exec:java \
63
-
-pl samples/mqtt/mqtt5x509 \
63
+
-pl samples/Mqtt/Mqtt5X509 \
64
64
-Dexec.args="\
65
65
--endpoint <ENDPOINT> \
66
66
--cert <PATH TO CERTIFICATE FILE> \
@@ -74,7 +74,7 @@ This will run the sample using the latest released version of the SDK rather tha
74
74
All samples will show their options and arguments by passing in `--help`. For example:
As per normal, replace the `<>` parameters with the proper values. Notice that we provided substitution values for the two parameters in the template body, `DeviceLocation` and `SerialNumber`.
0 commit comments