Skip to content

Commit c07edb4

Browse files
committed
Docs update
1 parent 2789612 commit c07edb4

11 files changed

+18
-94
lines changed

docs/SparkFun RTK Logging Menu.png

9.59 KB
Loading
101 KB
Loading
92 KB
Loading

docs/firmware_update.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The device has two primary firmwares:
99

1010
The device firmware is displayed in a variety of places:
1111

12-
* Power On
12+
* Power On (if a display is supported)
1313
* Serial Config Menu
1414
* WiFi Config
1515

@@ -44,6 +44,7 @@ The OTA method is generally recommended. For more information see [here](firmwar
4444
Remember, all SparkFun RTK devices are open source hardware meaning you have total access to the [firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) and [hardware](https://github.com/sparkfun/SparkFun_RTK_Facet). Be sure to check out each repo for the latest firmware and hardware information.
4545

4646
## Updating Firmware Over-The-Air
47+
4748
![Updating Firmware from WiFi config page](<img/WiFi Config/RTK-Firmware-Update-OTA.gif>)
4849

4950
*Updating the firmware via WiFi config page*
@@ -52,13 +53,13 @@ Remember, all SparkFun RTK devices are open source hardware meaning you have tot
5253

5354
*Updating the firmware via Firmware serial menu*
5455

55-
Introduced with version 3.0, firmware can be updated by pressing a button in the System Configuration section of the WiFi Config page, or over the Firmware menu of the serial interface. This makes checking and upgrading a unit very easy.
56+
Firmware can be updated in the System Configuration section of the WiFi Config page, or over the Firmware menu of the serial interface. This makes checking and upgrading a unit very easy.
5657

57-
Additionally, users may opt into checking for Beta firmware. This is the latest firmware that may have new features and is meant for testing. Beta firmware is not recommended for units deployed into the field as it may not be stable.
58+
Additionally, users may opt to check for Beta firmware. This is the latest firmware that may have new features and is meant for testing. Beta firmware is not recommended for units deployed into the field as it may not be stable.
5859

5960
If you have a device with firmware lower than v3.0, you will need to use the [GUI](firmware_update.md#updating-firmware-using-the-uploader-gui) or a method listed below to get to v3.x.
6061

61-
With version 3.10 automatic release firmware update is supported over WiFi. Enabling this feature is done using the serial firmware menu. The polling period is speified in minutes and defaults to once a day. The automatic firmware update only checks for and installs the current SparkFun released firmware versions over top of any:
62+
Automatic release firmware update is supported over WiFi. Enabling this feature is done using the serial firmware menu. The polling period is specified in minutes and defaults to once a day. The automatic firmware update only checks for and installs the current SparkFun released firmware versions over top of any:
6263

6364
* Older released versions (continual upgrade)
6465
* Beta firmware versions (newer or older, restore to released version)
9.59 KB
Loading
101 KB
Loading
92 KB
Loading

docs/menu_data_logging.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
# Data Logging Menu
22

3-
Surveyor: ![Feature Supported](img/Icons/GreenDot.png) / Express: ![Feature Supported](img/Icons/GreenDot.png) / Express Plus: ![Feature Supported](img/Icons/GreenDot.png) / Facet: ![Feature Supported](img/Icons/GreenDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Supported](img/Icons/GreenDot.png)
3+
Torch: ![Feature Supported](img/Icons/RedDot.png)
44

5-
## WiFi Interface
6-
7-
Please see the System Menu [WiFi Interface](menu_system.md#wifi-interface).
8-
9-
## Serial Interface
5+
**Note:** Not all devices support external SD (ie, RTK Torch). This section applies only to devices that support an external SD card, and have one inserted.
106

117
![RTK Data Logging Configuration Menu](img/Terminal/SparkFun%20RTK%20Logging%20Menu.png)
128

docs/menu_ports.md

Lines changed: 4 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Ports Menu
22

3-
Surveyor: ![Feature Partially Supported](img/Icons/YellowDot.png) / Express: ![Feature Supported](img/Icons/GreenDot.png) / Express Plus: ![Feature Supported](img/Icons/GreenDot.png) / Facet: ![Feature Supported](img/Icons/GreenDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Partially Supported](img/Icons/YellowDot.png)
3+
Torch: ![Feature Not Supported](img/Icons/RedDot.png)
44

5-
![Setting the baud rate of the ports](img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Express_Ports_Config.jpg)
5+
![Setting the baud rate of the ports](<img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Express_Ports_Config.jpg>)
66

77
*Setting the baud rates of the two available external ports*
88

9-
![Baud rate configuration of Radio and Data ports](img/Terminal/SparkFun_RTK_Express_-_Ports_Menu.jpg)
9+
![Baud rate configuration of Radio and Data ports](<img/Terminal/SparkFun_RTK_Express_-_Ports_Menu.jpg>)
1010

1111
*Baud rate configuration of Radio and Data ports*
1212

@@ -36,15 +36,9 @@ If you must run the data port at lower than 460800bps, and you need to enable a
3636

3737
Most applications do not need to plug anything into the **Data** port. Most users will get their NMEA position data over Bluetooth. However, this port can be useful for sending position data to an embedded microcontroller or single-board computer. The pinout is 3.3V / TX / RX / GND. **3.3V** is provided by this connector to power a remote device if needed. While the port is capable of sourcing up to 600mA, we do not recommend more than 300mA. This port should not be connected to a power source.
3838

39-
### Wheel Ticks
40-
41-
![Wheel/Direction Encoder drop down](img/WiFi Config/SparkFun%20RTK%20Ports%20Menu%20Mux%20Config.png)
42-
43-
*On the RTK Express Plus only.* This dropdown is made available if users wish to connect wheel ticks and a direction encoder as inputs to the ZED-F9R. This aids the Sensor Fusion engine for IMU based location fixes when installed in an automobile. Signals must be limited to 3.3V.
44-
4539
### Pulse Per Second
4640

47-
![Configuring the External Pulse and External Events](img/WiFi Config/SparkFun%20RTK%20Ports%20PPS%20Config.png)
41+
![Configuring the External Pulse and External Events](<img/WiFi Config/SparkFun%20RTK%20Ports%20PPS%20Config.png>)
4842

4943
*Configuring the External Pulse and External Events over WiFi*
5044

@@ -67,56 +61,3 @@ For PPS, only the Black and Green wires are needed. If you need to provide 3.3V
6761

6862
Similarly, the RX pin of the DATA port can be used for event logging. See [External Event Logging](menu_ports.md#external-event-logging) for more information.
6963

70-
### External Event Logging
71-
72-
![Three RTK Express with External Triggers](img/RTK%20Express%20with%20External%20Microphones.png)
73-
74-
*Three RTK Expresses wired with external microphones*
75-
76-
The external triggering system is a powerful feature enabling a variety of scientific applications. Above is three RTK Expresses wired with external microphones used in a 'popped balloon' audio triangulation experiment.
77-
78-
The ZED-F9P has the ability to mark a detected event with +/-30 *nanosecond accuracy*. When enabled, an event on the RX pin (a low-to-high or high-to-low transition) on the DATA port, will trigger a message in the log with a very accurate timestamp.
79-
80-
* **Red** - 3.3V
81-
* **Green** - TX (output from the RTK device)
82-
* **Orange** - RX (input into the RTK device)
83-
* **Black** - GND
84-
85-
![Wires connected to a SparkFun USB C to Serial adapter](img/SparkFun_RTK_Facet_-_Data_Port_to_USB.jpg)
86-
87-
For event logging, only the Black and Orange wires are needed. If you need to provide 3.3V to your system, the red wire can supply up to 600mA but we do not recommend sourcing more than 300mA.
88-
89-
![Configuring the External Pulse and External Events](img/WiFi Config/SparkFun%20RTK%20Ports%20PPS%20Config.png)
90-
91-
*Configuring the External Pulse and External Events over WiFi*
92-
93-
Be sure to select 'Enable External Event Logging' through the ports menu.
94-
95-
Events within the log have the following format:
96-
97-
> $GNTXT,numberOfSentences,sentenceNumber,CUSTOM_NMEA_TYPE_EVENT,triggerCount,towMsR,towSubMsR,accEst*CRC
98-
99-
For example:
100-
101-
$GNTXT,01,01,02,5,494326906,136292,31*74
102-
103-
Where
104-
105-
* $GNTXT: Custom NMEA text message
106-
* 01: numberOfSentences in this report
107-
* 01: sentenceNumber
108-
* 02: sentenceType - Externally triggered events are type 0x02
109-
* 5: triggerCount
110-
* 494326906: towMsR - Time Of Week of rising edge (ms)
111-
* 136292: towSubMsR - Millisecond fraction of Time Of Week of rising edge (ns)
112-
* 31: accEst - Accuracy estimate (ns)
113-
* 74: NMEA CRC
114-
115-
The event timestamps can be analyzed to precisely coordinate or triangulate a past event. In the case of the three RTK Expresses with microphones, the three units' locations were known with RTK 14mm accuracy. The air temperature was taken to obtain the speed of sound. From these data points, we can solve for the location of a sound such as a popped balloon.
116-
117-
## Surveyor Data Port
118-
119-
By default, the Data port is set to 460800bps and can be configured from 4800bps to 921600bps.
120-
121-
Note: The Data port does not output NMEA by default. The unit must be opened and the *Serial NMEA Connection* switch must be moved to 'Ext Connector'. See [Hardware Overview - Advanced Features](https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide/all#hardware-overview---advanced-features) for the location of the switch.
122-

docs/menu_system.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -90,27 +90,6 @@ The device can be in Rover, Base, or WiFi Config mode. The selected mode will be
9090

9191
**Note:** Bluetooth SPP cannot operate concurrently with ESP-Now radio transmissions. Therefore, if you plan to use the ESP-Now radio system to connect RTK products, the BLE protocol must be used to communicate over Bluetooth to data collectors. Alternatively, ESP-Now works concurrently with WiFi so connecting to a data collector over WiFi can be used.
9292

93-
94-
## SD Settings
95-
96-
On devices that have an SD socket, additional options will be shown to control logging.
97-
98-
### Log to SD
99-
100-
If a microSD card is detected, all messages will be logged.
101-
102-
### Max Log Time
103-
104-
Once the max log time is achieved, logging will cease. This is useful for limiting long-term, overnight, static surveys to a certain length of time. Default: 1440 minutes (24 hours). Limit: 1 to 2880 minutes.
105-
106-
### Max Log Length
107-
108-
Every 'max long length' amount of time the current log will be closed and a new log will be started. This is known as cyclic logging and is convenient on *very* long surveys (ie, months or years) to prevent logs from getting too unwieldy and helps limit the risk of log corruption. This will continue until the unit is powered down or the *max logging time* is reached.
109-
110-
### Start New Log
111-
112-
Pressing the 'Start New Log' button will close the current log. A new log will be opened immediately and the file name will be shown. This can be helpful in the field when a certain set of coordinates or feature marks need to be recorded in close proximity to one another. By dividing up the logs, the work can be more easily identified.
113-
11493
## Factory Reset
11594

11695
If a device gets into an unknown state it can be returned to default settings using the WiFi or Serial interfaces.

0 commit comments

Comments
 (0)