Skip to content

Commit 5cf8d4b

Browse files
committed
finished the settigns settings doc
1 parent 5b0e6d5 commit 5cf8d4b

File tree

3 files changed

+75
-1
lines changed

3 files changed

+75
-1
lines changed
132 KB
Loading

docs/assets/img/settings_time.png

112 KB
Loading

docs/settings_settings.md

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,4 +167,78 @@ When selected, the user is prompted to restart the device/system. This is also a
167167

168168
#### Device Reset
169169

170-
When selected, the user is prompted to reset the device/system. A device reset erases the current saved settings values and restarts the board/system. This is also available using the `!reset-device` console command.
170+
When selected, the user is prompted to reset the device/system. A device reset erases the current saved settings values and restarts the board/system. This is also available using the `!reset-device` console command.
171+
172+
### Time Setup
173+
174+
By default the IOT Node - LoRaWAN is not connected to a timekeeping source and defaults to a start time value of January 1, 1970 (epoch value of 0). But if a time keeping device is added (GNSS or Real Time Clock), this page is used to set time parameters for the board.
175+
176+
The Time Setup property page has the following entries:
177+
178+
![Time Setup](assets/img/settings_time.png)
179+
180+
#### Time Zone
181+
182+
The timezone specification string to use for the system clock. By default, the Mountain Time zone (the zone of SparkFun) is used.
183+
184+
#### Reference Clock
185+
186+
If a reference clock device is connected to the IoT Node board, use this option to select this clock.
187+
188+
#### Update Interval
189+
190+
Specify how often the system clock is updated using the reference clock in minutes.
191+
192+
193+
#### Enable Clock Fallback
194+
195+
Adds a secondary reference clock to use if the primary clock becomes unavailable.
196+
197+
#### Dependant Interval
198+
199+
If a *dependant* clock is connected (a clock being set by the system clock), this value sets how often the dependant clock device is updated.
200+
201+
#### Update Connected
202+
203+
If enabled, any connected clocks have their time updated when the system clock is updated.
204+
205+
### Save Settings
206+
207+
The Save Settings system is designed to include a "fallback" settings system if available. Normally this might be a JSON file on a SDCard or similar device. At launch, this functionality is not available for the IoT Node - LoRaWAN board.
208+
209+
210+
The Save Settings property page has the following elements:
211+
212+
![Save Settings](assets/img/settings_save_settings.png)
213+
214+
#### Fallback Restore
215+
216+
If enabled, restore settings from the fallback system if the primary storage system is unavailable or empty.
217+
218+
#### Fallback Save
219+
220+
If enabled and a fallback device is available, saving settings to primary storage also saves them to the secondary device.
221+
222+
#### Buffer Size
223+
224+
The buffer size used for internal I/O operations. This is not used for the IoT Node Board.
225+
226+
#### Save Settings
227+
228+
When called, the current value of the systems settings is saved to the primary persistent storage system.
229+
230+
#### Restore Settings
231+
232+
When called, systems settings are restore from the primary storage system.
233+
234+
#### Clear Settings
235+
236+
When called, the primary (on board) settings storage is erased/reset.
237+
238+
#### Save to Fallback
239+
240+
If a fallback device is available, when this function is called, system settings are saved to the fallback device.
241+
242+
#### Restore from Fallback
243+
244+
If a fallback device is available, when this function is called, system settings are restored from the fallback device.

0 commit comments

Comments
 (0)