-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
21 changed files
with
460 additions
and
32 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+205 KB
docs/assets/SparkFun_Datalogger_IoT_Applications_Settings_Menu_2-v01p02p00.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+298 KB
...Datalogger_IoT_Initializing_WiFI_Connected_IoT_Web_Server_Enabled_v01p02p00.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+94.2 KB
...Fun_Datalogger_IoT_System_Restart_Factory_Restore_Update_Firmware_v01p02p00.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+140 KB
docs/assets/iot_web_server-Chrome_Browser-Available_Log_Files_IP_Address.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
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. | ||
|
||
The following is covered by this document: | ||
|
||
* How a user configures and uses the HTTP connection | ||
* Use examples | ||
|
||
### IoT Web Server Connection Setup | ||
|
||
To connect to the ESP32's IoT Web Server, the following information is needed: | ||
|
||
* The server name/address | ||
* _[optional]_ A username - if required | ||
* _[optional]_ A password - if required | ||
|
||
|
||
|
||
#### IoT Web Server Menu System | ||
|
||
We'll need to adjust the settings for the IoT Web Server. | ||
|
||
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: | ||
|
||
<div style="text-align: center"> | ||
<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> | ||
</div> | ||
|
||
The options are: | ||
|
||
* Enable/Disable the connection | ||
* Username | ||
* Password | ||
* Enable/Disable mDNS support | ||
* mDNS name | ||
|
||
At a minimum, you will just need to enable the connection. However, we recommend enabling mDNS support if it is supported in your network. | ||
|
||
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. | ||
|
||
|
||
|
||
### JSON File Entries | ||
|
||
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: | ||
|
||
```json | ||
"IoT Web Server": { | ||
"Enabled": false, | ||
"Username": "", | ||
"Password": "", | ||
"mDNS Support": false, | ||
"mDNS Name": "dataloggerAD6B8" | ||
}, | ||
``` | ||
|
||
Where: | ||
|
||
* `Enabled` - Set to `true` to enable the connection. | ||
* `Username` - Web server user name if being used. | ||
* `Password` - Web server password if being used. | ||
* `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. | ||
* `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. | ||
|
||
|
||
|
||
!!! tip | ||
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. | ||
|
||
|
||
|
||
### Connect and Download Log File | ||
|
||
!!! note | ||
You will need to make sure that the ESP32 is on the same network as your computer in order to access the log files. | ||
|
||
!!! note | ||
When authentication is enabled, some browsers might require a second login depending on user settings. | ||
|
||
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`". | ||
|
||
<div style="text-align: center"> | ||
<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> | ||
</div> | ||
|
||
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. | ||
|
||
<div style="text-align: center"> | ||
<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> | ||
</div> | ||
|
||
!!! note | ||
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. | ||
|
||
<div style="text-align: center"> | ||
<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> | ||
</div> | ||
|
||
Now that you have downloaded the log files, try graphing the data on a spreadsheet. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters