Skip to content

Commit

Permalink
Update the Device Client Readme with Named Shadow feature links (#159)
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshGandhi-AWS authored Aug 10, 2021
1 parent 0034fc6 commit e3453e5
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@
* [Fleet Provisioning Feature](source/fleetprovisioning/README.md)
* [Device Defender Feature](source/devicedefender/README.md)
* [Secure Tunneling Feature](source/tunneling/README.md)
* [Named Shdow Feature](source/shadow/README.md)
- [Sample Shadow Feature](source/shadow#sample-shadow)
- [Config Shadow Feature](source/shadow#config-shadow)
* [Logging](source/logging/README.md)
* Samples:
* [Samples](source/samples/):
- [MQTT Pub/Sub Sample Feature](source/samples/pubsub/README.md)
* [Doxygen Documentation](docs/README.md)
* [Additional Resources](#additional-resources)
Expand Down Expand Up @@ -43,7 +46,7 @@ The modular IoT Device Client consists of a “base client” and discrete “cl
[Secure Tunneling feature](https://aws.amazon.com/iot-device-management/features/#Secure_Tunneling) in the AWS IoT Device Management service.
* The client-side Device Defender feature enables you to collect standard [Device Side Metrics](https://docs.aws.amazon.com/iot/latest/developerguide/detect-device-side-metrics.html) when you use the [Rules
Detect feature](https://docs.aws.amazon.com/iot/latest/developerguide/detect-device-side-metrics.html) in the AWS IoT Device Defender service.
* The client-side Fleet Provisioning feature enables you to replace provisional credentials with device-specific ones
* The client-side [Fleet Provisioning feature](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html) enables you to replace provisional credentials with device-specific ones
when you onboard a fleet of devices to AWS IoT Core. It creates a device specific certificate and private key, and registers the device on AWS IoT Core.
### List of Supported Platforms
The AWS IoT Device Client currently works on IoT devices with common microprocessors (x86_64, ARM architectures), and common Linux software environments (Debian, Ubuntu, and RHEL).
Expand Down Expand Up @@ -95,6 +98,8 @@ cd ../

### Running the tests
```
cmake ../
cmake --build . --target test-aws-iot-device-client
./build/test/test-aws-iot-device-client
```
### Advanced Compilation
Expand All @@ -110,6 +115,7 @@ cd ../
[Fleet Provisioning Feature Readme](source/fleetprovisioning/README.md)
[Device Defender Feature Readme](source/devicedefender/README.md)
[Secure Tunneling Feature Readme](source/tunneling/README.md)
[Name Shadow Feature Readme](source/shadow/README.md)

## AWS IoT Device Client Samples
[MQTT Pub/Sub Sample Feature](source/samples/pubsub/README.md)
Expand Down
3 changes: 2 additions & 1 deletion docs/CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ field by running `aws iot describe-endpoint` on the CLI.

`thing-name` *or* `--thing-name`: This is the name for your thing. It should be unique across your regional AWS account.

Next [File and Directory Permission Requirements](docs/PERMISSIONS.md)
**Next**: [File and Directory Permission Requirements](PERMISSIONS.md)

[*Back To The Top*](#config)
2 changes: 1 addition & 1 deletion docs/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ You can use the following command to see all of the CLI options available for th
./aws-iot-device-client --help
```

Next [Configuring the AWS IoT Device Client](docs/CONFIG.md)
Next [Configuring the AWS IoT Device Client](CONFIG.md)
[*Back To The Top*](#setup)
2 changes: 1 addition & 1 deletion source/tunneling/SecureTunnelingFeature.h
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ namespace Aws
* \brief Used by the logger to specify that log messages are coming from the Secure Tunneling
* feature
*/
static constexpr char TAG[] = "SecureTunneling.cpp";
static constexpr char TAG[] = "SecureTunnelingFeature.cpp";

/**
* \brief Format string for forming the secure tunneling data plain endpoint
Expand Down

0 comments on commit e3453e5

Please sign in to comment.