Skip to content

Commit cad806f

Browse files
committed
Minor Update to Tutorial
- Update Instructions for consistency with menu system and JSON file for each IoT Service - Add Notes - Fix formatting
1 parent d714b3c commit cad806f

9 files changed

+51
-26
lines changed

docs/example_aws.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -174,15 +174,16 @@ Selecting the ***Classic Shadow*** entry provides the Server Name/Hostname for t
174174
<a href="../assets/iot_aws_iot_shadow_details.png"><img src="../assets/iot_aws_iot_shadow_details.png" width="600" height="600" alt="Shadow Details"></a>
175175
</div>
176176

177-
Note: The server name is obtained from the Device Shadow URL entry
177+
!!! note
178+
The server name is obtained from the Device Shadow URL entry
178179

179180

180181

181182
### MQTT Topic
182183

183184
The MQTT topic value is based uses the ***MQTT topic prefix*** from above, and has the value ***update*** added to it. So for this example, the MQTT topic is:
184185

185-
```$aws/things/TestThing23/shadow/update```
186+
$aws/things/TestThing23/shadow/update
186187

187188

188189

@@ -212,9 +213,15 @@ This value was downloaded as a file during the creation process. The contents of
212213

213214
## Setting Properties
214215

215-
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.
216+
The above property values must be set on the DataLogger before use. They can be set manually by using the menu system like the previous MQTT example.
216217

217-
For the DataLogger IoT example outlined in this document, the entries in the settings JSON file are as follows:
218+
For users that are interested in using the menu system, you will need to open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Type <kbd>1</kbd> to enter the Settings menu. Then type <kbd>11</kbd> to enter the AWS IoT Menu. When the menu system for the AWS IoT connection is presented, you will need to configure the property values as listed in the JSON file. Saving the values through the menu system will save the credentials to the ESP32's persistent memory. The following options are displayed:
219+
220+
<div style="text-align: center">
221+
<a href="../assets/SparkFun_Datalogger_IoT_AWS_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_AWS_Menu.JPG" width="600" height="600" alt="AWS IoT Menu"></a>
222+
</div>
223+
224+
The alternative to using the menu system is a JSON file. These values can be set using 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:
218225

219226
```json
220227
"AWS IoT": {
@@ -235,11 +242,10 @@ For the DataLogger IoT example outlined in this document, the entries in the set
235242
},
236243
```
237244

238-
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 previous firmware versions was `1883`. As of firmware v01.00.04, the default is `8883`. 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`.
239-
240-
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.
241-
245+
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 previous firmware versions was `1883`. As of firmware v01.00.04, the default is `8883`. 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 can load the credentials to the DataLogger IoT.
242246

247+
!!! tip
248+
To load the values by the system at startup using a JSON file and microSD card, you will need to [configure the Save Settings](../configuration#general-save-settings). This JSON file will be created with the "**Save to Fallback**" option. Make sure to enable the AWS IoT as well.
243249

244250
## Operation
245251

docs/example_azure.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,15 @@ 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. Of course, you can also manually set the values using the menu system like the previous MQTT example.
147+
The above property values must be set on the DataLogger IoT before use. They can be set manually by using the menu system like the previous MQTT example.
148148

149-
For the example outlined in this document, the entries in the settings JSON file are as follows:
149+
For users that are interested in using the menu system, you will need to open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Type <kbd>1</kbd> to enter the Settings menu. Then type <kbd>13</kbd> to enter the Azure IoT Menu. When the menu system for the Azure IoT connection is presented, you will need to configure the property values as listed in the JSON file. Saving the values through the menu system will save the credentials to the ESP32's persistent memory. The following options are displayed:
150+
151+
<div style="text-align: center">
152+
<a href="../assets/SparkFun_Datalogger_IoT_Azure_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Azure_Menu.JPG" width="600" height="600" alt="Azure IoT Menu"></a>
153+
</div>
154+
155+
The alternative to using the menu system is a JSON file. These values can be set using 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:
150156

151157
```json
152158
"Azure IoT": {
@@ -164,10 +170,11 @@ For the example outlined in this document, the entries in the settings JSON file
164170
},
165171
```
166172

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 previous firmware versions was `1883`. As of firmware v01.00.04, the default is `8883`. You will need to adjust the port value to properly connect to the Azure IoT service.
173+
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 previous firmware versions was `1883`. As of firmware v01.00.04, the default is `8883`. You will need to adjust the port value to properly connect to the Azure IoT service. Don't forget to enable Azure IoT service by setting the value to `true`. If the JSON file is saved in the microSD card, you can load the credentials to the DataLogger IoT.
168174

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.
170175

176+
!!! tip
177+
To load the values by the system at startup using a JSON file and microSD card, you will need to [configure the Save Settings](../configuration#general-save-settings). This JSON file will be created with the "**Save to Fallback**" option. Make sure to enable the Azure IoT as well.
171178

172179

173180
## Operation and Monitoring

docs/example_http.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ These values are set using the standard DataLogger methods - the interactive men
7979

8080
### Menu System
8181

82-
When the menu system for the HTTP connection is presented, the following options are displayed:
82+
For users that are interested in using the menu system, you will need to open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Type <kbd>1</kbd> to enter the Settings menu. Then type <kbd>14</kbd> to enter the HTTP IoT Menu. When the menu system for the HTTP IoT connection is presented, you will need to configure the property values as listed in the JSON file. Saving the values through the menu system will save the credentials to the ESP32's persistent memory. The following options are displayed:
8383

8484
<div style="text-align: center">
8585
<a href="../assets/assets/SparkFun_Datalogger_IoT_HTTP_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_HTTP_Menu.JPG" width="600" height="600" alt="HTTP Menu"></a>
@@ -129,6 +129,11 @@ Where:
129129
* `URL` - Set to the URL for the connection.
130130
* `CA Cert Filename` - Set to the cert filename on the SD card if being used.
131131

132+
If the JSON file is saved in the microSD card, you can load the credentials to the DataLogger IoT.
133+
134+
!!! tip
135+
To load the values by the system at startup using a JSON file and microSD card, you will need to [configure the Save Settings](../configuration#general-save-settings). This JSON file will be created with the "**Save to Fallback**" option. Make sure to enable the HTTP IoT as well.
136+
132137

133138

134139
## Example - Connecting to a HTTP Server

docs/example_mqtt.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ These values are set using the standard DataLogger methods - the interactive men
9494

9595
We'll need to adjust the settings for the MQTT Client using the MQTT Menu System.
9696

97-
Open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Type <kbd>1</kbd> to enter the Settings menu. Then type <kbd>9</kbd> to enter the MQTT Client Menu. When the menu system for the MQTT connection is presented, the following options are displayed:
97+
For users that are interested in using the menu system, open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Type <kbd>1</kbd> to enter the Settings menu. Then type <kbd>9</kbd> to enter the MQTT Client Menu. When the menu system for the MQTT connection is presented, the following options are displayed:
9898

9999
<div style="text-align: center">
100100
<a href="../assets/SparkFun_Datalogger_IoT_MQTT_Client_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_MQTT_Client_Menu.JPG" width="600" height="600" alt="MQTT Menu"></a>
@@ -151,7 +151,8 @@ Where:
151151
* `Username` - Broker user name if being used.
152152
* `Password` - Broker password if being used.
153153

154-
154+
!!! tip
155+
To load the values by the system at startup using a JSON file and microSD card, you will need to [configure the Save Settings](../configuration#general-save-settings). This JSON file will be created with the "**Save to Fallback**" option. Make sure to enable the MQTT Client as well.
155156

156157
## Testing the MQTT Connection
157158

docs/example_thingspeak.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,15 @@ You can download the cert file for ThingSpeak.com page using a web-browser. Clic
154154

155155
## Setting Properties
156156

157-
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.
157+
The above property values must be set on the DataLogger IoT before use. They can be manually by using the menu system like the previous MQTT example.
158158

159-
For the ThingSpeak example outlined in this document, the entries in the settings JSON file are as follows:
159+
For users that are interested in using the menu system, you will need to open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Type <kbd>1</kbd> to enter the Settings menu. Then type <kbd>12</kbd> to enter the ThingSpeak MQTT Menu. When the menu system for the ThingSpeak MQTT connection is presented, you will need to configure the property values as listed in the JSON file. Saving the values through the menu system will save the credentials to the ESP32's persistent memory. The following options are displayed:
160+
161+
<div style="text-align: center">
162+
<a href="../assets/SparkFun_Datalogger_IoT_ThingSpeak_MQTT_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_ThingSpeak_MQTT_Menu.JPG" width="600" height="600" alt="ThingSpeak MQTT Menu"></a>
163+
</div>
164+
165+
The alternative to using the menu system is a JSON file. These values can be set using a JSON file that is loaded by the system at startup. For the ThingSpeak example outlined in this document, the entries in the settings JSON file are as follows:
160166

161167
```json
162168
"ThingSpeak MQTT": {
@@ -176,9 +182,10 @@ For the ThingSpeak example outlined in this document, the entries in the setting
176182
!!! note
177183
The **Channels** value is a list of **[DEVICE NAME]=[Channel ID]** pairs. Each pair is separated by a comma.
178184

179-
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 previous firmware versions was `1883`. As of firmware v01.00.04, the default is `8883`. You will need to adjust the port value to properly connect to the ThingSpeak service.
185+
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 previous firmware versions was `1883`. As of firmware v01.00.04, the default is `8883`. You will need to adjust the port value to properly connect to the ThingSpeak service. Don't forget to enable ThingSpeak MQTT service by setting the value to `true`. If the JSON file is saved in the microSD card, you can load the credentials to the DataLogger IoT.
180186

181-
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.
187+
!!! tip
188+
To load the values by the system at startup using a JSON file and microSD card, you will need to [configure the Save Settings](../configuration#general-save-settings). This JSON file will be created with the "**Save to Fallback**" option. Make sure to enable the ThingSpeak MQTT as well.
182189

183190

184191

docs/example_timestamp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Then send a <kbd>6</kbd> to adjust how data is logged.
1+
Open a Serial Terminal, connect to the COM port that your DataLogger enumerated to, and set it to **115200** baud. In this case, we connected to **COM13**. Press any key to enter the Main Menu. Type <kbd>1</kbd> to enter the Settings menu. Then send a <kbd>6</kbd> to adjust how data is logged.
22

33
<div style="text-align: center">
44
<a href="../assets/SparkFun_Datalogger_IoT_Logger_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Logger_Menu.JPG" width="600" height="600" alt="Logger Menu Options"></a>

docs/hardware_hookup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ In this section, we will go over how to connect to the SparkFun DataLogger IoT.
99

1010
For users that are interested in soldering to the edge of the board, we recommend [soldering](https://learn.sparkfun.com/tutorials/how-to-solder-through-hole-soldering) headers to the PTHs on the breakout for a permanent connection and using jumper wires. Of course, you could also solder wires to the breakout board as well. For a temporary connection during prototyping, you can use [IC hooks like these](https://www.sparkfun.com/products/9741).
1111

12-
<div class="grid cards hide col-4" markdown>
12+
<div class="grid cards col-4" markdown>
1313

1414
- <a href="https://learn.sparkfun.com/tutorials/how-to-solder-through-hole-soldering">
1515
<figure markdown>

docs/hardware_overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ The overall length and width with the antenna connector is about 1.66" x 2.00".
458458
<a href="../assets/board_files/DataLogger_IoT_9DoF/SparkFun_Datalogger_IoT_9DOF_Board_Dimensions.png"><img src="../assets/board_files/DataLogger_IoT_9DoF/SparkFun_Datalogger_IoT_9DOF_Board_Dimensions.png" width="600px" height="600px" alt="DataLogger IoT - 9DoF Board Dimensions"></a>
459459
</td>
460460
<td style="text-align: center; vertical-align: middle; border: solid 1px #cccccc;">
461-
<a href="../assets/board_files/DataLogger_IoT/SparkFun_DataLogger_IoT_Board_Dimensions.png/"><img src="../assets/board_files/DataLogger_IoT/SparkFun_DataLogger_IoT_Board_Dimensions.png" width="600px" height="600px" alt="DataLogger IoT Board Dimensions"></a>
461+
<a href="../assets/board_files/DataLogger_IoT/SparkFun_DataLogger_IoT_Board_Dimensions.png"><img src="../assets/board_files/DataLogger_IoT/SparkFun_DataLogger_IoT_Board_Dimensions.png" width="600px" height="600px" alt="DataLogger IoT Board Dimensions"></a>
462462
</td>
463463
</tr>
464464
<tr style="vertical-align:middle;">

docs/resources.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@ Now that you've successfully got your DataLogger IoT up and running, it's time t
44
* [Schematic (PDF)](../assets/board_files/DataLogger_IoT_9DoF/SparkFun_Datalogger_IoT_9DOF_Schematic_v11.pdf)
55
* [Eagle Files (ZIP)](../assets/board_files/DataLogger_IoT_9DoF/SparkFun_DataLogger_IoT_9DOF_v11.zip)
66
* [Board Dimensions (PNG)](../assets/board_files/DataLogger_IoT_9DoF/SparkFun_Datalogger_IoT_9DOF_Board_Dimensions.png)
7+
* [Fritzing Part (FZPZ)](https://github.com/sparkfun/Fritzing_Parts/blob/main/products/20594_sfe_datalogger_iot_9dof_esp32_fuel_gauge_imu_micro_sd_card_qwiic.fzpz)
78
* DataLogger IoT
89
* [Schematic (PDF)](../assets/board_files/DataLogger_IoT/SparkFun_DataLogger_IoT_Schematic_V11.pdf)
910
* [Eagle Files (ZIP)](../assets/board_files/DataLogger_IoT/SparkFun_DataLogger_IoT-V11.zip)
1011
* [Board Dimensions (PNG)](../assets/board_files/DataLogger_IoT/SparkFun_DataLogger_IoT_Board_Dimensions.png)
12+
* [Fritzing Part (FZPZ)](https://github.com/sparkfun/Fritzing_Parts/blob/main/products/22462_sfe_datalogger_iot_esp32_fuel_gauge_micro_sd_card_qwiic.fzpz)
1113
* [CH340 Drivers](https://learn.sparkfun.com/tutorials/how-to-install-ch340-drivers/all)
12-
* Fritzing Part
13-
* [DataLogger IoT - 9DoF (FZPZ)](https://github.com/sparkfun/Fritzing_Parts/blob/main/products/20594_sfe_datalogger_iot_9dof_esp32_fuel_gauge_imu_micro_sd_card_qwiic.fzpz)
14-
* [DataLogger IoT (FZPZ)](https://github.com/sparkfun/Fritzing_Parts/blob/main/products/22462_sfe_datalogger_iot_esp32_fuel_gauge_micro_sd_card_qwiic.fzpz)
1514
* [Firmware](https://github.com/sparkfun/SparkFun_DataLogger/releases)
1615
* GitHub Hardware Repo
1716
* [SparkFun DataLogger IoT - 9DoF](https://github.com/sparkfun/SparkFun_DataLogger_IoT_9DoF)
@@ -22,7 +21,7 @@ Now that you've successfully got your DataLogger IoT up and running, it's time t
2221

2322
Or check out these related blog posts.
2423

25-
<div class="grid cards hide col-4" markdown>
24+
<div class="grid cards col-4" markdown>
2625

2726
- <a href="https://www.sparkfun.com/news/6808">
2827
<figure markdown>

0 commit comments

Comments
 (0)