Skip to content

Commit a890761

Browse files
committed
Docs: Add factory reset via settings file
1 parent 188bb69 commit a890761

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

docs/configure_with_settings_file.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,14 @@ Surveyor: ![Feature Partially Supported](img/YellowDot.png) / Express: ![Feature
66

77
*SparkFun RTK Settings File*
88

9-
All system configuration can also be done by editing the *SFE_[Platform]_Settings_0.txt* file (example shown above) where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). This file is created when a microSD card is installed. The settings are clear text but there are no safety guards against setting illegal states. It is not recommended to use this method unless You Know What You're Doing®.
9+
All device settings are stored both in internal memory and an SD card if one is detected. The device will load the latest settings at each power on. If there is a discrepancy between the internal settings and a settings file then the settings file will be used. This allows a collection of RTK products to be identically configured using one 'golden' settings file loaded onto an SD card.
10+
11+
All system configuration can be done by editing the *SFE_[Platform]_Settings_0.txt* file (example shown above) where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). This file is created when a microSD card is installed. The settings are clear text but there are no safety guards against setting illegal states. It is not recommended to use this method unless You Know What You're Doing®.
12+
13+
## Forcing a Factory Reset
14+
15+
![Setting size of settings to -1 to force reset](<img/SparkFun RTK Settings File - Factory Reset.png>)
16+
17+
If the device has been configured into an unknown state the device can be reset to factory defaults. Power down the RTK device and remove the SD card. Using a computer and an SD card reader, open the SFE_[Platform]_Settings_0.txt file where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). Modify the **sizeOfSettings** value to -1 and save the file to the SD card. Reinsert the SD card into the RTK unit and power up the device. Upon power up, the device will display 'Factory Reset' while it clears the settings.
18+
19+
Note: A device may have multiple profiles, ie multiple settings files (SFE_Express_Settings_**0**.txt, SFE_Express_Settings_**1**.txt, etc). All settings files found on the SD card must be modified to guarantee the factory reset.
5.54 KB
Loading

docs/menu_system.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,6 @@ Factory Defaults will erase any user settings and reset the internal receiver to
100100

101101
If a device gets into an unknown state it can be returned to default settings. Press 'r' then 'y' to confirm. Factory Default will erase any user settings and reset the internal receiver to stock settings. Any settings file and commonly used coordinate files on the SD card associated with the current profile will be removed.
102102

103-
**Note:** Log files and any other files on the SD card are *not* removed or modified.
103+
**Note:** Log files and any other files on the SD card are *not* removed or modified.
104+
105+
Note: A factory reset can also be accomplished by editing the settings files. See Force a [Factory Reset](https://docs.sparkfun.com/SparkFun_RTK_Firmware/configure_with_settings_file/#forcing-a-factory-reset) for more information.

0 commit comments

Comments
 (0)