Skip to content

Commit 4bb9e41

Browse files
committed
Include Menu Options for Adjusting Menu Timeout and Terminal Baud Rate
1 parent 43cc1d7 commit 4bb9e41

File tree

3 files changed

+25
-11
lines changed

3 files changed

+25
-11
lines changed
Loading

docs/configuration.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -165,41 +165,55 @@ We'll go over each of these options below.
165165

166166
### General: Application Settings
167167

168-
In the Settings Menu, send a <kbd>1</kbd> to adjust the Application Settings.
168+
In the Settings Menu, send a <kbd>1</kbd> to adjust the Application Settings. As of firmware v01.00.02, users can now adjust the baud rate of the serial consol output and the menu system's timeout value.
169169

170170
<div style="text-align: center">
171-
<a href="../assets/SparkFun_Datalogger_IoT_Applications_Settings_Menu.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Applications_Settings_Menu.JPG" width="1000" height="667"></a>
171+
<a href="../assets/SparkFun_Datalogger_IoT_Applications_Settings_Menu_2.JPG"><img src="../assets/SparkFun_Datalogger_IoT_Applications_Settings_Menu_2.JPG" width="1000" height="667"></a>
172172
</div>
173173

174-
In the Application Settings Menu, users will be able to configure the WS2812's blue LED through software, microSD card's output format, serial console's output format, deep sleep parameters, and view the current settings of the DataLogger IoT similar to when the board was initialized. Depending on your preference and how you are logging data, you can adjust the data as CSV or JSON.
174+
In the Application Settings Menu, users will be able to configure the WS2812's LED through software, menu timeout, microSD card's output format, serial console's output format, terminal's baud rate, deep sleep parameters, and view the current settings of the DataLogger IoT similar to when the board was initialized. Depending on your preference and how you are logging data, you can adjust the data as CSV or JSON.
175175

176-
* <kbd>1</kbd> **LED Enabled** &mdash; Enable/Disable the on-board LED activity
176+
* <kbd>1</kbd> **LED Enabled** &mdash; Enable/Disable the on-board RGB LED activity
177177
* Accepts a boolean value:
178178
* <kbd>1</kbd> to enable (default)
179179
* <kbd>0</kbd> to disable
180-
* <kbd>2</kbd> **SD Card Format** &mdash; Enable and set the output format
180+
* <kbd>2</kbd> **Menu Timeout** &mdash; Inactivity timeout period for the menu system
181+
* Accepts the following values:
182+
* <kbd>1</kbd> 30 Seconds = 30
183+
* <kbd>2</kbd> 60 Seconds = 60
184+
* <kbd>3</kbd> 2 Minutes = 120
185+
* <kbd>4</kbd> 5 Minutes = 300
186+
* <kbd>5</kbd> 10 Minutes = 600
187+
* <kbd>b</kbd> Back
188+
* <kbd>3</kbd> **SD Card Format** &mdash; Enable and set the output format
181189
* Accepts the following values:
182190
* <kbd>1</kbd> to disable = 0
183191
* <kbd>2</kbd> CSV format (default) = 1
184192
* <kbd>3</kbd> JSON format = 2
185-
* <kbd>3</kbd> **Serial Console Format** &mdash; Enable and set the output format
193+
* <kbd>4</kbd> **Serial Console Format** &mdash; Enable and set the output format
186194
* Accepts the following values:
187195
* <kbd>1</kbd> to disable = 0
188196
* <kbd>2</kbd> CSV format (default) = 1
189197
* <kbd>3</kbd> JSON format = 2
190-
* <kbd>4</kbd> **Enable System Sleep** &mdash; If enabled, sleep the system
198+
* <kbd>5</kbd> **Terminal Baud Rate** &mdash; Update terminal baud rate. Changes take effect on restart.
199+
* Accepts an unsigned integer between **1200** to **50000**:
200+
* **115200** (default)
201+
* <kbd>6</kbd> **Enable System Sleep** &mdash; If enabled, sleep the system
191202
* Accepts a boolean value:
192203
* <kbd>1</kbd> to enable
193204
* <kbd>0</kbd> to disable (default)
194-
* <kbd>5</kbd> **Sleep Interval (sec)** &mdash; The interval the system will sleep for
205+
* <kbd>7</kbd> **Sleep Interval (sec)** &mdash; The interval the system will sleep for
195206
* Accepts an integer between <kbd>5</kbd> to <kbd>86400</kbd> :
196207
* <kbd>30</kbd> seconds (default)
197-
* <kbd>6</kbd> **Wake Interval (sec)** &mdash; The interval the system will operate between sleep period
208+
* <kbd>8</kbd> **Wake Interval (sec)** &mdash; The interval the system will operate between sleep period
198209
* Accepts an integer between <kbd>60</kbd> to <kbd>86400</kbd> :
199210
* <kbd>120</kbd> seconds (default)
200-
* <kbd>7</kbd> **About...** &mdash; Details about the system
211+
* <kbd>9</kbd> **About...** &mdash; Details about the system
201212
* <kbd>b</kbd> **Back**
202213

214+
!!! note
215+
Once the baud rate is changed and saved, make sure to adjust the baud rate of your serial terminal when the board is reset. If you forgot the baud rate, you can hold the BOOT button down for 20 seconds to erase the on-board preferences (besides the baud rate, this also includes any other settings that were saved) and restart the board.
216+
203217
When finished, you will need to exit the menus so that the DataLogger IoT saves the changes. Send a <kbd>b</kbd> to exit out this menu, <kbd>b</kbd> to exit out of the DataLogger IoT settings, and <kbd>x</kbd> to exit out of the main menu.
204218

205219
<div style="text-align: center">

docs/hardware_hookup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Now is a good time to attach a LiPo battery, if you want the DataLogger IoT to k
110110
You can connect one of our standard single cell LiPo batteries to the DataLogger IoT and power it for hours, days or weeks depending on what sensors you have attached and how often you log data. The DataLogger IoT has a built-in charger too which will charge your battery at **500mA** when USB-C is connected. Please make sure your battery capacity is at least 500mAh (0.5Ah); bad things will happen if you try to charge our smallest batteries at 500mA. The yellow CHG charging LED will light up while the battery is charging and will go out once charging is complete.
111111

112112
!!! danger "Warning"
113-
The MCP73831 charge IC on the board is used on a few SparkFun products. For more information about the CHG status LED, we recommend taking look at the the Hardware Overview. We also recommend taking a look at this tutorial for [Single Cell LiPo Battery Care](https://learn.sparkfun.com/tutorials/single-cell-lipo-battery-care).
113+
The MCP73831 charge IC on the board is used on a few SparkFun products. For more information about the CHG status LED, we recommend taking look at the Hardware Overview. We also recommend taking a look at this tutorial for [Single Cell LiPo Battery Care](https://learn.sparkfun.com/tutorials/single-cell-lipo-battery-care).
114114

115115

116116

0 commit comments

Comments
 (0)