You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration.md
-78Lines changed: 0 additions & 78 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -211,84 +211,6 @@ In the Application Settings Menu, users will be able to configure the addressabl
211
211
!!! note
212
212
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.
213
213
214
-
### General: Save Settings
215
-
216
-
In the Settings menu, select the Save Settings menu. As of firmware v01.01.01, the JSON output buffer size is now user configurable. This will be under option "**JSON File Buffer Size**" when in the Save Settings Menu.
In the Save Settings Menu, users will be able to save, restore, or clear any preferences in memory (i.e. persistent storage) or a saved file to a fallback device (i.e. microSD card). Note that any passwords and secret keys are not saved in the save settings file. You will need to manually enter those values in the file saved on the microSD card.
224
-
225
-
***Fallback Restore** - If unable to restore settings, use the fallback source (JSON File)
226
-
***Fallback Save** - Save settings also saves on the fallback storage (JSON File)
227
-
***JSON File Buffer Size** - The size in bytes used for the internal I/O buffer
228
-
***Save Settings** - Save current settings to persistent storage
229
-
***Restore Settings** - Restore saved settings
230
-
***Clear Settings** - Erase the saved settings on the device
231
-
***Save to Fallback** - Save System Settings to the fallback storage (JSON File)
232
-
***Restore from Fallback** - Restore system settings from the fallback storage (JSON File)
233
-
234
-
If you have the Fallback Save enabled or selected the option **Save to Fallback**, you will notice an additional file called **datalogger.json** saved in the microSD card. This is the fallback file that is saved. Using a text editor, you can edit this file to adjust the settings or provide WiFi credentials, certificates, and keys. You can use option ```7``` to restore the settings on your DataLogger IoT.
235
-
236
-
237
-
/// caption
238
-
Fallback File
239
-
///
240
-
241
-
When finished, you will need to exit the menus so that the DataLogger IoT saves the changes. Send a ```b``` to exit out this menu, ```b``` to exit out of the DataLogger IoT settings, and ```x``` to exit out of the main menu.
242
-
243
-
### General: Time Sources
244
-
245
-
!!! note
246
-
Make sure to connect the ESP32-WROOM to a 2.4GHz WiFi network and ensure that is not a guest network that requires you to sign in.
247
-
248
-
In the Settings Menu, select the time reference sources. As of firmware v01.01.01, time zone support is at the clock level, not tied to NTP. The option to adjust the Time Zone is moved to the Time Sources menu.
249
-
250
-
251
-
/// caption
252
-
Time Source Menu
253
-
///
254
-
255
-
In this menu, you will have options to update the primary reference clock, update interval, add a secondary reference clock, and update it's interval. By default, the primary reference clock is set to use the Network Time Protocol (NTP). To synchronization the time, you will need to connect to a 2.4GHz WiFi network in order to update the time. To add a secondary clock, make sure to connect a compatible Qwiic-enabled devices that can keep track of time (i.e. Qwiic Real Time Clock Module - RV-8803 or a Qwiic-enabled u-blox GNSS module).
256
-
257
-
To adjust the time zone, you will need to enter a POSIX timezone string variable. Try [checking out this CSV in this GitHub repo](https://github.com/nayarsystems/posix_tz_db/blob/master/zones.csv) and searching for the timezone string variable in your area. For more information about [POSIX format specification check out this article from IBM](https://developer.ibm.com/articles/au-aix-posix/).
258
-
259
-
***The Time Zone** - Time zone setting string for the device
260
-
***Reference Clock** - The current reference clock source
261
-
***Update Interval** - Main clock update interval in minutes. 0 = No update
262
-
***Enable Clock Fallback** - Use a valid reference clock if the primary is not available
263
-
***Dependant Interval** - Connected depedant clock update interval in minutes. 0 = No update
264
-
***Update Connected** - Update connected clocks on main clock update
265
-
266
-
### Alternative Time Sources
267
-
268
-
As an alternative to using the NTP, users can also add a compatible Qwiic-enabled device that can keep track of time (i.e. Qwiic Real Time Clock Module - RV-8803 or a Qwiic-enabled u-blox GNSS module). These can be set as the primary or secondary clock.
269
-
270
-
271
-
/// caption
272
-
U-Blox GNSS Module Attached Via Qwiic
273
-
///
274
-
275
-
276
-
/// caption
277
-
Qwiic Real Time Clock Module - RV-8803 Attached Via Qwiic
278
-
///
279
-
280
-
Once attached, you will be prompted with additional options to select a primary reference clock.
If you are using a u-blox GNSS module, make sure that you have enough satellites in view. The option to add or configure the GNSS will not be available if there are not enough satellites in view. If you are using the Qwiic Real Time Clock Module - RV-8803, you may need to go into the device settings to manually adjust the date and time.
289
-
290
-
When finished, you will need to exit the menus so that the DataLogger IoT saves the changes. Send a ```b``` to exit out this menu, ```b``` to exit out of the DataLogger IoT settings, and ```x``` to exit out of the main menu.
291
-
292
214
### Logging: Logger
293
215
294
216
In the Settings menu, select the Logger menu to adjust how data is logged.
Used to save, restore and manage the system settings.
4
+
5
+
In the Save Settings Menu, users will be able to save, restore, or clear any preferences in memory (i.e. persistent storage) or a saved file to a fallback device (i.e. microSD card). Note that any passwords and secret keys are not saved in the save settings file. You will need to manually enter those values in the file saved on the microSD card.
6
+
7
+
When this item is selected, the following menu is prestned.
When this settings is enabled, if a normal setting restore operation fails on startup, a back source (JSON file) is used.
21
+
22
+
This is often used to restore backup settings when you reset the datalogger.
23
+
24
+
### Fallback Save
25
+
26
+
When enabled, when settings are saved to on-board storage, they are also saved to a JSON file located on the systems SD card.
27
+
28
+
### JSON File Buffer Size
29
+
30
+
The internal buffer used to I/O of the setting values.
31
+
32
+
## Functions
33
+
34
+
The following functions/actions are available in this menu:
35
+
36
+
### Save Settings
37
+
38
+
When called, the current settings are save to persistent, on-device storage.
39
+
40
+
### Restore Settings
41
+
42
+
Setting value are restored from on-device persistent storage.
43
+
44
+
### Clear Settings
45
+
46
+
Erases settings stored on the device.
47
+
48
+
This action does not reset the current *live* settings of the system. Do do this, restart the system immediatly after calling this action.
49
+
50
+
### Save to Fallback
51
+
52
+
Save the current setting values to the fallback setting system - a JSON file on the SD card.
53
+
54
+
### Restore from Fallback
55
+
56
+
When called, and a settings JSON file is available on the SD card, the settings on the SD card are restored and applied to the system.
57
+
58
+
## Editing the Fallback JSON File
59
+
60
+
If you have the Fallback Save enabled or selected the option **Save to Fallback**, you will notice an additional file called **datalogger.json** saved in the microSD card. This is the fallback file that is saved. Using a text editor, you can edit this file to adjust the settings or provide WiFi credentials, certificates, and keys. These values can then easily be *restore* for use by the system.
In the Settings Menu, select the time reference sources. As of firmware v01.01.01, time zone support is at the clock level, not tied to NTP. The option to adjust the Time Zone is moved to the Time Sources menu.
4
+
5
+
6
+
/// caption
7
+
Time Source Menu
8
+
///
9
+
10
+
In this menu, you will have options to update the primary reference clock, update interval, add a secondary reference clock, and update it's interval.
11
+
12
+
By default, the primary reference clock is set to use the Network Time Protocol (NTP). To synchronization the time, you will need to connect to a 2.4GHz WiFi network in order to update the time.
13
+
14
+
To add a secondary clock, make sure to connect a compatible Qwiic-enabled devices that can keep track of time (i.e. Qwiic Real Time Clock Module - RV-8803 or a Qwiic-enabled u-blox GNSS module).
15
+
16
+
## Time Configuration
17
+
18
+
The following settings are available:
19
+
20
+
### The Time Zone
21
+
22
+
The timezone to use for `local time` for the DataLoggerIoT.
23
+
24
+
To adjust the time zone, you will need to enter a POSIX timezone string variable. Try [checking out this CSV in this GitHub repo](https://github.com/nayarsystems/posix_tz_db/blob/master/zones.csv) and searching for the timezone string variable in your area. For more information about [POSIX format specification check out this article from IBM](https://developer.ibm.com/articles/au-aix-posix/).
25
+
26
+
### Reference Clock
27
+
28
+
The `time source` the DataLoggerIoT uses for time values.
29
+
30
+
### Update Interval
31
+
32
+
The time interval in minutes that the reference clock is used to update the DataLoggerIoT clock. Note - for an NTP source, this is handled automatically by the ESP32 platform.
33
+
34
+
### Enable Clock Fallback
35
+
36
+
If enabled, another clock source is used if the primary source is not available.
37
+
38
+
An example of this is when a network failure occurs and NTP is not available. In this case, a fallback time source (like an RTC) is used for time values.
39
+
40
+
### Dependant Interval
41
+
42
+
The interval in minutes used to update from the dependant clock. If `0`, the dependant clock is not used.
43
+
44
+
### Update Connected
45
+
46
+
If enabled, connected clocks are updated when the main system clock is updated.
47
+
48
+
## Alternative Time Sources
49
+
50
+
As an alternative to using the NTP, users can also add a compatible Qwiic-enabled device that can keep track of time (i.e. Qwiic Real Time Clock Module - RV-8803 or a Qwiic-enabled u-blox GNSS module). These can be set as the primary or secondary clock.
51
+
52
+
53
+
/// caption
54
+
U-Blox GNSS Module Attached Via Qwiic
55
+
///
56
+
57
+
58
+
/// caption
59
+
Qwiic Real Time Clock Module - RV-8803 Attached Via Qwiic
60
+
///
61
+
62
+
Once attached, you will be prompted with additional options to select a primary reference clock.
If you are using a u-blox GNSS module, make sure that you have enough satellites in view. The option to add or configure the GNSS will not be available if there are not enough satellites in view. If you are using the Qwiic Real Time Clock Module - RV-8803, you may need to go into the device settings to manually adjust the date and time.
0 commit comments