Merge pull request #53 from FreeRTOS/LienNguyen2910-patch-1

Lien nguyen2910 patch 1

Author: cobusve

Common/cli/ReadMe.md

@@ -0,0 +1,51 @@
+### Command Line Interface (CLI)
+The CLI interface is used to provision the device. There is a python script to automatically provision the device and register Thing into cloud.
+See [ Getting Started Guide ](../../Getting_Started_Guide.md)
+
+### Other Unix-like utilities
+The following other utilities are also available in this image:
+
+```
+ps
+    List the status of all running tasks and related runtime statistics.
+
+kill
+    kill [ -SIGNAME ] <Task ID>
+        Signal a task with the named signal and the specified task id.
+
+    kill [ -n ] <Task ID>
+        Signal a task with the given signal number and the specified task id.
+
+killall
+    killall [ -SIGNAME ] <Task Name>
+    killall [ -n ] <Task Name>
+        Signal a task with a given name with the signal number or signal name given.
+
+heapstat
+    heapstat [-b | --byte]
+        Display heap statistics in bytes.
+
+    heapstat -h | -k | --kibi
+        Display heap statistics in Kibibytes (KiB).
+
+    heapstat -m | --mebi
+        Display heap statistics in Mebibytes (MiB).
+
+    heapstat --kilo
+        Display heap statistics in Kilobytes (KB).
+
+    heapstat --mega
+        Display heap statistics in Megabytes (MB).
+
+reset
+    Reset (reboot) the system.
+
+uptime
+    Display system uptime.
+
+rngtest <number of bytes>
+    Read the specified number of bytes from the rng and output them base64 encoded.
+
+assert
+   Cause a failed assertion.
+```

Common/crypto/ReadMe.md

@@ -0,0 +1,41 @@
+### PkiObject API
+The PkiObject API takes care of some of the mundane tasks in converting between different representations of cryptographic objects such as public keys, private keys, and certificates.
+
+Files located in this folder belong to the PkiObject module.
+
+This API can be accessed via the `pki` CLI command which is implemented in the `Common/cli/cli_pki.c` file.
+```
+pki:
+    Perform public/private key operations.
+    Usage:
+    pki <verb> <object> <args>
+        Valid verbs are { generate, import, export, list }
+        Valid object types are { key, csr, cert }
+        Arguments should be specified in --<arg_name> <value>
+
+    pki generate key <label_public> <label_private> <algorithm> <algorithm_param>
+        Generates a new private key to be stored in the specified labels
+
+    pki generate csr <label>
+        Generates a new Certificate Signing Request using the private key
+        with the specified label.
+        If no label is specified, the default tls private key is used.
+
+    pki generate cert <cert_label> <private_key_label>
+        Generate a new self-signed certificate
+
+    pki import cert <label>
+        Import a certificate into the given slot. The certificate should be
+        copied into the terminal in PEM format, ending with two blank lines.
+
+    pki export cert <label>
+        Export the certificate with the given label in pem format.
+        When no label is specified, the default certificate is exported.
+
+    pki import key <label>
+        Import a public key into the given slot. The key should be
+        copied into the terminal in PEM format, ending with two blank lines.
+
+    pki export key <label>
+        Export the public portion of the key with the specified label.
+```

Common/kvstore/ReadMe.md

@@ -0,0 +1,31 @@
+### Key-Value Store
+The key-value store located in this folder is used to store runtime configuration values in non-volatile flash memory.
+By default, the kvstore interface can be used to read and write the following items:
+* WiFi SSID
+* WiFi Password
+* Thing Name (MQTT Device ID)
+* MQTT Endpoint
+* MQTT Port
+* Time High Water Mark.
+
+The kvstore api is accessible via the CLI using the "conf" command.
+```
+> help conf
+conf:
+    Get/ Set/ Commit runtime configuration values
+    Usage:
+    conf get
+        Outputs the value of all runtime config options supported by the system.
+
+    conf get <key>
+        Outputs the current value of a given runtime config item.
+
+    conf set <key> <value>
+        Set the value of a given runtime config item. This change is staged
+        in volatile memory until a commit operation occurs.
+
+    conf commit
+        Commit staged config changes to nonvolatile memory.
+```
+
+Additional runtime configuration keys can be added in the [Common/config/kvstore_config.h](Common/config/kvstore_config.h) file.