Skip to content

Commit 5e6ad7c

Browse files
committed
Update Docs for v01.02.00 and Minor Grammatical Issues
_✓_ add more documentation based on firmware version v01.02.00 _✓_ add quick (!) commands _✓_ add information about new startup options _✓_ Update menus based on new options _✓_ Add information about Viewing and Downloading Log Files with IoT Web Server _✓_ Adjust minor grammar issues _✓_ Add links and buttons to direct users to examples
1 parent a705149 commit 5e6ad7c

21 files changed

+460
-32
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/configuration.md

+347-30
Large diffs are not rendered by default.

docs/example_CSV_to_spreadsheet.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,14 @@ At this point, we will assume that you have configured connected your devices to
2323
!!! note
2424
For users that require a timestamp with their datasets, make sure to [enable timestamp](https://docs.sparkfun.com/SparkFun_DataLogger/example_timestamp/).
2525

26-
When ready, remove power from the DataLogger IoT and eject the microSD card from the socket. Insert the microSD card into an adapter and connect to your computer.
26+
### Download the Log Files
27+
28+
Users can download the log files to your computer with the IoT Web Server. You will need to update firmware to v01.02.00 and enable this feature. For more information, check out the [previous example to view and download log files using the IoT web server](../example_iot_web_server/).
29+
30+
<div style="text-align: center"><a href="../example_iot_web_server" class="md-button">Examples: Viewing and Downloading Log Files using the IoT Web Server</a></div>
31+
32+
33+
Of course, users can follow the old school method and manually grab the files using a microSD card reader. When ready, remove power from the DataLogger IoT and eject the microSD card from the socket. Insert the microSD card into an adapter and connect to your computer.
2734

2835
<div style="text-align: center">
2936
<a href="https://cdn.sparkfun.com//assets/parts/7/6/3/6/11609-Action.jpg">

docs/example_iot_web_server.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
As of firmware v01.02.00, log files can be viewed and downloaded over a WiFi network! This saves you time by allowing you to download the files without the need to disconnect the DataLogger IoT and manually remove microSD card.
2+
3+
The following is covered by this document:
4+
5+
* How a user configures and uses the HTTP connection
6+
* Use examples
7+
8+
### IoT Web Server Connection Setup
9+
10+
To connect to the ESP32's IoT Web Server, the following information is needed:
11+
12+
* The server name/address
13+
* _[optional]_ A username - if required
14+
* _[optional]_ A password - if required
15+
16+
17+
18+
#### IoT Web Server Menu System
19+
20+
We'll need to adjust the settings for the IoT Web Server.
21+
22+
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>17</kbd> to enter the IoT Web Server Menu. When the menu system for the IoT Web Server is presented, the following options are displayed:
23+
24+
<div style="text-align: center">
25+
<a href="../assets/SparkFun_Datalogger_IoT_Web_Server_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Web_Server_Menu.JPG" width="600" height="600" alt="IoT Web Server Options"></a>
26+
</div>
27+
28+
The options are:
29+
30+
* Enable/Disable the connection
31+
* Username
32+
* Password
33+
* Enable/Disable mDNS support
34+
* mDNS name
35+
36+
At a minimum, you will just need to enable the connection. However, we recommend enabling mDNS support if it is supported in your network.
37+
38+
Once all these values are set, the system will serve the log files in your local 2.4GHz WiFi network following the JSON information structure noted below in this document.
39+
40+
41+
42+
### JSON File Entries
43+
44+
If a JSON file is being used as an option to import settings into the DataLogger IoT, the following entries are used for the IoT web server:
45+
46+
```json
47+
"IoT Web Server": {
48+
"Enabled": false,
49+
"Username": "",
50+
"Password": "",
51+
"mDNS Support": false,
52+
"mDNS Name": "dataloggerAD6B8"
53+
},
54+
```
55+
56+
Where:
57+
58+
* `Enabled` - Set to `true` to enable the connection.
59+
* `Username` - Web server user name if being used.
60+
* `Password` - Web server password if being used.
61+
* `mDNS Support` - Set to `true` if multicast DNS is supported. This allows you to enter the address as "`http://dataloggerXXXXX.local`" (where `XXXXX` is generated from the last 5x characters from your board ID) rather than typing the exact IP address of the ESP32.
62+
* `mDNS Name` - Multicast DNS name. In this case, the default name was set to `dataloggerAD6B8`. This name will be different depending on your DataLogger IoT's board ID so `AD6B8` will be different for your board.
63+
64+
65+
66+
!!! tip
67+
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.
68+
69+
70+
71+
### Connect and Download Log File
72+
73+
!!! note
74+
You will need to make sure that the ESP32 is on the same network as your computer in order to access the log files.
75+
76+
!!! note
77+
When authentication is enabled, some browsers might require a second login depending on user settings.
78+
79+
Once the web server is enabled and the settings are saved, you will need to reboot the DataLogger IoT. As the DatLogger initializes, it will connect to your WiFi Network. Take note of the mDNS address, in this case, it was "`http://dataloggerAD6B8.local`".
80+
81+
<div style="text-align: center">
82+
<a href="../assets/SparkFun_Datalogger_IoT_Initializing_WiFI_Connected_IoT_Web_Server_Enabled_v01p02p00.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Initializing_WiFI_Connected_IoT_Web_Server_Enabled_v01p02p00.JPG" width="600" height="600" alt="DataLogger IoT Initializing, WiFi Connected, Web Server Enabled"></a>
83+
</div>
84+
85+
Once the DataLogger IoT has finished initializing, open web browser. Connect the DataLogger IoT by entering the address "`http://dataloggerXXXXX.local`", where `XXXX` is the last 5x characters of your board ID. You will be presented with the log files available on the microSD card. Click on a log file to download and save it to your computer.
86+
87+
<div style="text-align: center">
88+
<a href="../assets/iot_web_server-Chrome_Browser-Available_Log_Files.JPG"><img src="../assets/iot_web_server-Chrome_Browser-Available_Log_Files.JPG" width="600" height="600" alt="Viewing Available Log Files through a Web Browser"></a>
89+
</div>
90+
91+
!!! note
92+
If mDNS is not supported, you can also enter the IP address of the Datalogger IoT into a web browser to view and download the log files.
93+
94+
<div style="text-align: center">
95+
<a href="../assets/iot_web_server-Chrome_Browser-Available_Log_Files_IP_Address.JPG"><img src="../assets/iot_web_server-Chrome_Browser-Available_Log_Files_IP_Address.JPG" width="600" height="600" alt="Viewing Available Log Files through a Web Browser using IP Address"></a>
96+
</div>
97+
98+
Now that you have downloaded the log files, try graphing the data on a spreadsheet.

docs/example_mqtt.md

+2
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@ Where:
154154
!!! tip
155155
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.
156156

157+
158+
157159
## Testing the MQTT Connection
158160

159161
Use of a MQTT connection is fairly straightforward - just requiring the entry of broker details into the connection settings.

docs/single_page.md

+3
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ icon: fontawesome/solid/scroll
5050
# Example - Arduino Cloud
5151
--8<-- "./docs/example_arduino_iot_cloud.md"
5252

53+
# Viewing and Downloading Log Files using the IoT Web Server
54+
--8<-- "./docs/example_iot_web_server.md"
55+
5356
# Example - How to Convert Comma Separated Values (CSV) to a Spreadsheet
5457
--8<-- "./docs/example_CSV_to_spreadsheet.md"
5558

docs/supported_devices.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DataLogger IoT Supported Devices
22

3-
The following table lists the devices/boards supported by the DataLogger IoT Boards, broken down by firmware version.
3+
The following lists the devices/boards supported by the DataLogger IoT boards. New drivers to support a device will be listed under the firmware version.
44

55

66

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ nav:
252252
- Azure: example_azure.md
253253
- HTTP: example_http.md
254254
- Arduino Cloud: example_arduino_iot_cloud.md
255+
- Viewing and Downloading Log Files using the IoT Web Server: example_iot_web_server.md
255256
- How to Convert Comma Separated Values (CSV) to a Spreadsheet: example_CSV_to_spreadsheet.md
256257
- Appendix - Supported Qwiic Devices: supported_devices.md
257258
- Resources: resources.md

0 commit comments

Comments
 (0)