Skip to content

Commit f3db8a0

Browse files
committed
Add steps to configure port for AWS, Azure, and ThingSpeak; minor grammatical errors; minor formatting changes
1 parent 2e05c36 commit f3db8a0

File tree

5 files changed

+35
-22
lines changed

5 files changed

+35
-22
lines changed

docs/example_aws.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ The specifics for the AWS IoT Thing must be configured. This includes the follow
156156

157157
### Server Name/Hostname
158158

159-
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.
159+
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`.
160160

161161
<div style="text-align: center">
162162
<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
195195

196196
## Setting Properties
197197

198-
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:
198+
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.
199+
200+
For the DataLogger IoT example outlined in this document, the entries in the settings JSON file are as follows:
199201

200202
```json
201203
"AWS IoT": {
202-
"Enabled": false,
204+
"Enabled": true,
203205
"Port": 8883,
204206
"Server": "avgpd2wdr5s6u-ats.iot.us-east-1.amazonaws.com",
205207
"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
216218
},
217219
```
218220

221+
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`.
222+
223+
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.
224+
219225
## Operation
220226

221227
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:

docs/example_azure.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The following is covered by this document:
1414
* Securely connecting the device
1515
* How data is posted from the DataLogger IoT to the Azure Device
1616

17-
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.
17+
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.
1818

1919

2020

@@ -102,7 +102,7 @@ Once the DataLogger IoT is integrated into the application, the specifics for th
102102

103103
### Server Name/Hostname
104104

105-
This value is hostname of the created IoT Hub and is obtained from the Overview page of the IoT Hub.
105+
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`.
106106

107107
<div style="text-align: center">
108108
<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
144144

145145
## Setting Properties
146146

147-
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:
147+
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.
148+
149+
For the example outlined in this document, the entries in the settings JSON file are as follows:
148150

149151
```json
150152
"Azure IoT": {
151-
"Enabled": false,
153+
"Enabled": true,
152154
"Port": 8883,
153155
"Server": "sparkfun-datalogger-hub.azure-devices.net",
154156
"MQTT Topic": "",
@@ -162,6 +164,9 @@ The above property values must be set on the DataLogger IoT before use. They can
162164
},
163165
```
164166

167+
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.
168+
169+
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.
165170

166171

167172
## Operation and Monitoring

docs/example_http.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ If a JSON file is being used as an option to import settings into the DataLogger
125125

126126
Where:
127127

128-
* `Enabled` - set to true to enable the connection
129-
* `URL` - Set to the URL for the connection
130-
* `CA Cert Filename` - set to the cert filename on the SD card if being used.
128+
* `Enabled` - Set to `true` to enable the connection.
129+
* `URL` - Set to the URL for the connection.
130+
* `CA Cert Filename` - Set to the cert filename on the SD card if being used.
131131

132132

133133

@@ -140,7 +140,7 @@ In this example, a simple HTTP Server is creating using Node JS, and the HTTP co
140140

141141
### The Server
142142

143-
The following javascript/node code creates a HTTP server on port 8090, and outputs received data to the console.
143+
The following javascript/node code creates a HTTP server on port `8090`, and outputs received data to the console.
144144

145145
```javascript
146146
var http = require('http');

docs/example_mqtt.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -144,14 +144,14 @@ If a JSON file is being used as an option to import settings into the DataLogger
144144

145145
Where:
146146

147-
* `Enabled` - set to true to enable the connection
148-
* `Port` - Set to the broker port
149-
* `Server` - The MQTT broker server
150-
* `MQTT Topic` - The topic to publish to
151-
* `Client Name` - optional client name
152-
* `Buffer Size` - internal transfer buffer size
153-
* `Username` - Broker user name if being used
154-
* `Password` - Broker password if being used
147+
* `Enabled` - Set to `true` to enable the connection.
148+
* `Port` - Set to the broker port.
149+
* `Server` - The MQTT broker server.
150+
* `MQTT Topic` - The topic to publish to.
151+
* `Client Name` - Optional client name.
152+
* `Buffer Size` - Internal transfer buffer size.
153+
* `Username` - Broker user name if being used.
154+
* `Password` - Broker password if being used.
155155

156156
## Testing the MQTT Connection
157157

docs/example_thingspeak.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ On the presented dialog, enter a name for the MQTT connection and in the **Autho
9494
</div>
9595

9696
!!! note
97-
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.
97+
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.
9898

9999
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.
100100

@@ -140,7 +140,7 @@ The Username is found under MQTT connection details listed in the ***Devices > M
140140

141141
### Password
142142

143-
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.
143+
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.
144144

145145

146146

@@ -158,7 +158,7 @@ The above property values must be set on the DataLogger IoT before use. They can
158158

159159
```json
160160
"ThingSpeak MQTT": {
161-
"Enabled": false,
161+
"Enabled": true,
162162
"Port": 8883,
163163
"Server": "mqtt3.thingspeak.com",
164164
"MQTT Topic": "",
@@ -174,7 +174,9 @@ The above property values must be set on the DataLogger IoT before use. They can
174174
!!! note
175175
The **Channels** value is a list of **[DEVICE NAME]=[Channel ID]** pairs. Each pair is separated by a comma.
176176

177+
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.
177178

179+
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.
178180

179181

180182
## Monitoring Output

0 commit comments

Comments
 (0)