git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/tools/aws_config_quick_start/README.md

   1 ## Script to setup the AWS resources through command line\r
   2 \r
   3 This script automates the process of [Prerequisites](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-prereqs.html) and the configuring the files `aws_iot_demo_profile.h` to connect to AWS IoT.\r
   4 \r
   5 Make sure you have `aws cli` configured on your machine with access_key, secret_key and region.\r
   6 \r
   7 Open the file `configure.json` and fill in the following details:\r
   8 * afr_source_dir : The path of the amazon-freertos directory. By default, this is set to the top level of this repo (../..).\r
   9 * thing_name : Name of the thing you want to create\r
  10 \r
  11 **Options to use with the script**\r
  12 1. To setup your Thing, and update credentials file, type the command: `python SetupAWS.py setup`\r
  13 2. To cleanup the Thing you created with the script, and revert changes in credentials file, type the command: `python SetupAWS.py cleanup`\r
  14 3. To only create thing, certificate and policy, type the command: `python SetupAWS.py prereq`\r
  15 4. To update the files `aws_iot_demo_profile.h` with thing name and the certificate keys, type the command `python SetupAWS.py update_creds`\r
  16 5. To delete the thing, certificate and policy created by the script, type the command: `python SetupAWS.py delete_prereq`\r
  17 6. To revert the changes in the file `aws_iot_demo_profile.h`, type the command: `python SetupAWS.py cleanup_creds`\r
  18 7. To list your certificates, type the command: `python SetupAWS.py list_certificates`\r
  19 8. To list your policies, type the command: `python SetupAWS.py list_policies`\r
  20 9. To list your things, type the command: `python SetupAWS.py list_things`