Add steps to configure port for AWS, Azure, and ThingSpeak; minor grammatical errors; minor formatting changes

bboyho · bboyho · commit f3db8a0a63e1 · 2023-08-04T00:23:05.000-06:00
diff --git a/docs/example_aws.md b/docs/example_aws.md
@@ -156,7 +156,7 @@ The specifics for the AWS IoT Thing must be configured. This includes the follow
 
 ### Server Name/Hostname
 
-This value is obtained from the AWS IoT Device page for the created device. When on this page, select the ***Device Shadows*** tab, and then select the ***Classic Shadow*** shadow, which is listed.
+This value is obtained from the AWS IoT Device page for the created device. When on this page, select the ***Device Shadows*** tab, and then select the ***Classic Shadow*** shadow, which is listed. Note a secure connection is used, so the port for the connection is `8883`.
 
 <div style="text-align: center">
   <a href="../assets/iot_aws_iot_dev_attr.png"><img src="../assets/iot_aws_iot_dev_attr.png" alt="Shadow Details"></a>
@@ -195,11 +195,13 @@ This value was downloaded as a file during the creation process. The contents of
 
 ## Setting Properties
 
-The above property values must be set on the DataLogger before use. They can be passed on via a JSON file that is loaded by the system at startup. For the DataLogger IoT example outlined in this document, the entries in the settings JSON file are as follows:
+The above property values must be set on the DataLogger before use. They can be passed on via a JSON file that is loaded by the system at startup. Of course, you can also manually set the values using the menu system like the previous MQTT example.
+
+For the DataLogger IoT example outlined in this document, the entries in the settings JSON file are as follows:
 
 ```json
 "AWS IoT": {
-    "Enabled": false,
+    "Enabled": true,
     "Port": 8883,
     "Server": "avgpd2wdr5s6u-ats.iot.us-east-1.amazonaws.com",
     "MQTT Topic": "$aws/things/TestThing23/shadow/update",
@@ -216,6 +218,10 @@ The above property values must be set on the DataLogger before use. They can be
   },
 ```
 
+Besides updating the `Server`, `MQTT Topic`, `Client Name`, `CA Cert Filename`, `Client Cert Filename`, and `Client Key Filename`, you will need to also ensure that the `port` is set to `8883`. The default in certain firmware versions is currently `1883`. You will need to adjust the port value to properly connect to the [AWS IoT service](https://aws.amazon.com/about-aws/whats-new/2018/02/aws-iot-core-now-supports-mqtt-connections-with-certificate-based-client-authentication-on-port-443/). Don't forget to enable AWS IoT service by setting the value to `true`.
+
+If the JSON file is saved in the microSD card, you will need to load the credentials to the DataLogger IoT. Of course, you can manually update the values through the command line as well to save the credentials to the ESP32's persistent memory.
+
 ## Operation
 
 Once the device is configured and running, updates in AWS IoT are listed in the ***Activity*** tab of the devices page. For the test device in this document, this page looks like:
diff --git a/docs/example_azure.md b/docs/example_azure.md
@@ -14,7 +14,7 @@ The following is covered by this document:
 * Securely connecting the device
 * How data is posted from the DataLogger IoT to the Azure Device
 
-Currently, the Azure IoT device connection is is a single direction - it is used to post data from the hardware to the Azure IoT Device. Configuration information from Azure IoT to the DataLogger IoT is currently not implemented.
+Currently, the Azure IoT device connection is a single direction - it is used to post data from the hardware to the Azure IoT Device. Configuration information from Azure IoT to the DataLogger IoT is currently not implemented.
 
 
 
@@ -102,7 +102,7 @@ Once the DataLogger IoT is integrated into the application, the specifics for th
 
 ### Server Name/Hostname
 
-This value is hostname of the created IoT Hub and is obtained from the Overview page of the IoT Hub.
+This value is hostname of the created IoT Hub and is obtained from the Overview page of the IoT Hub. Note a secure connection is used, so the port for the connection is `8883`.
 
 <div style="text-align: center">
   <a href="../assets/iot_az_iot_hub_details.png"><img src="../assets/iot_az_iot_hub_details.png" alt="Hub Details"></a>
@@ -144,11 +144,13 @@ The file to download is the ***Baltimore CyberTrust Root*** entry in the **Root
 
 ## Setting Properties
 
-The above property values must be set on the DataLogger IoT before use. They can be set via a JSON file that is loaded by the system at startup. For the example outlined in this document, the entries in the settings JSON file are as follows:
+The above property values must be set on the DataLogger IoT before use. They can be set via a JSON file that is loaded by the system at startup. Of course, you can also manually set the values using the menu system like the previous MQTT example.
+
+For the example outlined in this document, the entries in the settings JSON file are as follows:
 
 ```json
 "Azure IoT": {
-    "Enabled": false,
+    "Enabled": true,
     "Port": 8883,
     "Server": "sparkfun-datalogger-hub.azure-devices.net",
     "MQTT Topic": "",
@@ -162,6 +164,9 @@ The above property values must be set on the DataLogger IoT before use. They can
   },
 ```
 
+Besides updating the `Server`, `Device Key`, `Device ID`, and `CA Cert Filename`, you will need to also ensure that the `port` is set to `8883`. The default in certain firmware versions is currently `1883`. You will need to adjust the port value to properly connect to the Azure IoT service.
+
+If the JSON file is saved in the microSD card, you will need to load the credentials to the DataLogger IoT. Of course, you can manually update the values through the command line as well to save the credentials to the ESP32's persistent memory.
 
 
 ## Operation and Monitoring
diff --git a/docs/example_http.md b/docs/example_http.md
@@ -125,9 +125,9 @@ If a JSON file is being used as an option to import settings into the DataLogger
 
 Where:
 
-* `Enabled` - set to true to enable the connection
-* `URL` - Set to the URL for the connection
-* `CA Cert Filename` - set to the cert filename on the SD card if being used.
+* `Enabled` - Set to `true` to enable the connection.
+* `URL` - Set to the URL for the connection.
+* `CA Cert Filename` - Set to the cert filename on the SD card if being used.
 
 
 
@@ -140,7 +140,7 @@ In this example, a simple HTTP Server is creating using Node JS, and the HTTP co
 
 ### The Server
 
-The following javascript/node code creates a HTTP server on port 8090, and outputs received data to the console.
+The following javascript/node code creates a HTTP server on port `8090`, and outputs received data to the console.
 
 ```javascript
 var http = require('http');
diff --git a/docs/example_mqtt.md b/docs/example_mqtt.md
@@ -144,14 +144,14 @@ If a JSON file is being used as an option to import settings into the DataLogger
 
 Where:
 
-* `Enabled` - set to true to enable the connection
-* `Port` - Set to the broker port
-* `Server` - The MQTT broker server
-* `MQTT Topic` - The topic to publish to
-* `Client Name` - optional client name
-* `Buffer Size` - internal transfer buffer size
-* `Username` - Broker user name if being used
-* `Password` - Broker password if being used
+* `Enabled` - Set to `true` to enable the connection.
+* `Port` - Set to the broker port.
+* `Server` - The MQTT broker server.
+* `MQTT Topic` - The topic to publish to.
+* `Client Name` - Optional client name.
+* `Buffer Size` - Internal transfer buffer size.
+* `Username` - Broker user name if being used.
+* `Password` - Broker password if being used.
 
 ## Testing the MQTT Connection
 
diff --git a/docs/example_thingspeak.md b/docs/example_thingspeak.md
@@ -94,7 +94,7 @@ On the presented dialog, enter a name for the MQTT connection and in the **Autho
 </div>
 
 !!! note
-    When the MQTT device is created, a set of credentials (Client ID, Username and Password) is provided. **Copy or download** these values, since the password in not accessible after this step.
+    When the MQTT device is created, a set of credentials (Client ID, Username, and Password) is provided. **Copy or download** these values, since the password in not accessible after this step.
 
 The selected Channel is then listed in the **Authorized Channel** table. Ensure that the Allow Publish and Allow Subscribe attributes are enabled for the added channel.
 
@@ -140,7 +140,7 @@ The Username is found under MQTT connection details listed in the ***Devices > M
 
 ### Password
 
-The connection password was provided when the MQTT device was created. If you lost this value, you can regenerate a password in the for the connection on the MQTT Device information page.
+The connection password was provided when the MQTT device was created. If you lost this value, you can regenerate a password on the MQTT Device information page.
 
 
 
@@ -158,7 +158,7 @@ The above property values must be set on the DataLogger IoT before use. They can
 
 ```json
 "ThingSpeak MQTT": {
-    "Enabled": false,
+    "Enabled": true,
     "Port": 8883,
     "Server": "mqtt3.thingspeak.com",
     "MQTT Topic": "",
@@ -174,7 +174,9 @@ The above property values must be set on the DataLogger IoT before use. They can
 !!! note
     The **Channels** value is a list of **[DEVICE NAME]=[Channel ID]** pairs. Each pair is separated by a comma.
 
+Besides updating the `Server`, `Client Name`, `Username`, `Password`, `CA Cert Filename`, and `Channels`, you will need to also ensure that the `port` is set to `8883`. The default in certain firmware versions is currently `1883`. You will need to adjust the port value to properly connect to the ThingSpeak service.
 
+If the JSON file is saved in the microSD card, you will need to load the credentials to the DataLogger IoT. Of course, you can manually update the values through the command line as well to save the credentials to the ESP32's persistent memory.
 
 
 ## Monitoring Output
