Skip to content

Commit a650a52

Browse files
authored
Merge branch 'main' into release_candidate
2 parents 05c3ed5 + a6ed3a6 commit a650a52

40 files changed

+449
-228
lines changed

.github/workflows/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ jobs:
77
deploy:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/checkout@v2
11-
- uses: actions/setup-python@v2
10+
- uses: actions/checkout@v3
11+
- uses: actions/setup-python@v4
1212
with:
1313
python-version: 3.x
1414
- run: pip install mkdocs-material mkdocs-monorepo-plugin

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Thanks:
5252
Documentation
5353
--------------
5454

55-
* **[RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/)** - A detail guide describing all the various software features of the RTK product line. Essentially it is a manual for the firmware in this repository.
55+
* **[RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/)** - A detail guide describing all the various software features of the RTK product line. Essentially it is a manual for the firmware in this repository.
5656
* **[RTK Facet L-Band Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide)** - Hookup guide for the SparkFun RTK Facet L-Band.
5757
* **[RTK Facet Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide)** - Hookup guide for the SparkFun RTK Facet.
5858
* **[RTK Express Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide)** - Hookup guide for the SparkFun RTK Express and Express Plus.

docs/configure_base.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,36 @@ Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. Y
112112

113113
For users who return to the same base position or monument, the coordinates can be saved to a 'Commonly Used Coordinates' list. A nickname and the X/Y/Z positions are saved to the list. Any record on the list can be loaded from the list into the X/Y/Z fields allowing quick switching without the need to hand record or re-enter coordinates from day-to-day repositioning of the base.
114114

115+
## RTCM Message Rates
116+
117+
![The RTCM Menu under Base](img/SparkFun%20RTK%20Base%20Survey%20In.png)
118+
119+
When the device is in Base mode, the fix rate is set to 1Hz. This will override any Rover setting.
120+
121+
![The list of supported RTCM messages](img/SparkFun%20RTK%20-%20Base%20RTCM%20Rates%20Menu.png)
122+
123+
Additionally, RTCM messages are generated at a rate of 1Hz. If lower RTCM rates are desired the RTCM Rates menu can be used to modify the rates of any supported RTCM message. This can be helpful when using longer-range radios that have lower bandwidth.
124+
125+
## Supported Lat/Long Coordinate Formats
126+
127+
![Entering coordinates in alternate formats](img/SparkFun%20RTK%20-%20Alternate%20Coordinate%20Types%20for%20Fixed%20Base.png)
128+
129+
When entering coordinates for a fixed Base in Geodetic format, the following formats are supported:
130+
131+
* DD.ddddddddd (ie -105.184774720, 40.090335429)
132+
* DDMM.mmmmmmm (ie -10511.0864832)
133+
* DD MM.mmmmmmm (ie 40 05.42013)
134+
* DD-MM.mmmmmmm (40-05.42013)
135+
* DDMMSS.ssssss (-1051105.188992)
136+
* DD MM SS.ssssss (-105 11 05.188992)
137+
* DD-MM-SS.ssssss (40-05-25.2075)
138+
139+
![Coordinate formats in the Base serial menu](img/SparkFun%20RTK%20-%20Alternate%20Coordinate%20Types%20for%20Fixed%20Base%20Serial.png)
140+
141+
These coordinate formats are automatically detected and converted as needed. The coordinates are displayed in the format they are entered. If a different format is desired, the coordinate display format can be changed via the serial Base menu.
142+
143+
For more information about coordinate formats, check out this [online converter](https://www.earthpoint.us/convert.aspx).
144+
115145
## Assisted Base
116146

117147
An Assisted Base is where a temporary base is set up to Survey-In its location but is simultaneously provided RTCM corrections so that its Survey-In is done with very precise readings. An assisted base running a Survey-In removes much of the relative inaccuracies from a Rover-Base system. We've found an Assisted Base varies as little as 50mm RMS between intra-day tests, with accuracy within 65mm of a PPP of the same location, same day.

docs/configure_data_logging.md

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
44

55
## WiFi Interface
66

7-
Because of the nature of these controls, the AP config page is different than the terminal menu.
8-
9-
![System Config Menu on WiFi AP Config Page](img/SparkFun%20RTK%20System%20and%20Data%20Logging%20Configuration.png)
10-
11-
*System Config Menu on WiFi AP Config Page*
12-
13-
### System Initial State
14-
15-
At power on, the device will enter either Rover or Base state.
16-
17-
### Log to SD
18-
19-
If a microSD card is detected, all messages will be logged.
20-
21-
### Max Log Time
22-
23-
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.
24-
25-
### Max Log Length
26-
27-
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.
28-
29-
### Start New Log
30-
31-
Pressing the 'Start New Log' button will close the current log. A new log will be opened when the AP Config page is closed and the unit restarts. 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.
32-
33-
### Bluetooth Protocol
34-
35-
By default, the RTK products use Bluetooth v2.0 SPP (Serial Port Profile) to connect to data collectors. Nearly all data collectors support this protocol. The RTK product line also supports BLE (Bluetooth Low Energy). The BLE protocol has a variety of improvements but very few data collectors support it.
36-
37-
**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.
38-
39-
### Enable Factory Defaults
40-
41-
Factory Defaults will erase any user settings and reset the internal receiver to stock settings. Any logs on SD are maintained. To prevent accidental reset the checkbox must first be checked before the button is pressed.
42-
43-
### SD Card
44-
45-
Various stats for the SD card are shown.
46-
47-
### Update Firmware
48-
49-
New firmware may be uploaded via WiFi to the unit. See [Updating Firmware from WiFi](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-wifi) for more information.
50-
51-
### Reset Counter
52-
53-
A counter is displayed indicating the number of non-power-on-resets since the last power-on.
7+
Please see the System Menu [WiFi Interface](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system/#wifi-interface).
548

559
## Serial Interface
5610

docs/configure_gnss.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The ZED-F9P is immensely configurable. The RTK device will, by default, put the
66

77
The GNSS Configuration menu allows a user to change the report rate, dynamic model, and select which constellations should be used for fix calculations.
88

9-
[![GNSS Configuration menu](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_WiFi_Config_-_GNSS_Config.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_WiFi_Config_-_GNSS_Config.jpg)
9+
![GNSS Configuration menu](img/SparkFun%20RTK%20-%20GNSS%20Menu.png)
1010

1111
*The most common settings on the RTK Device WiFi AP Config*
1212

@@ -28,6 +28,16 @@ Note: When in **Base** mode, the measurement frequency is set to 1Hz. This is be
2828

2929
The Dynamic Model can be changed but it is recommended to leave it as *Portable*. For more information, please refer to the [ZED-F9P Integration Manual](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/ZED-F9P_IntegrationManual__UBX-18010802_.pdf).
3030

31+
## Min SV Elevation and C/N0
32+
33+
![Elevation and C/N0](img/SparkFun%20RTK%20-%20GNSS%20Menu.png)
34+
35+
*GNSS menu showing Minimum SV Elevation and C/N0*
36+
37+
A minimum elevation is set in degrees. If a satellite is detected that is below this elevation, it will be *excluded* from any GNSS position calculation.
38+
39+
A minimum C/N0 is set in dB. If a satellite is detected that is below this signal strength, it will be *excluded* from any GNSS position calculation.
40+
3141
## Constellations Menu
3242

3343
[![Enable or disable the constellations used for fixes](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Receiver_Constellations.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Receiver_Constellations.jpg)

docs/configure_messages.md

Lines changed: 143 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -47,25 +47,145 @@ Each message rate input controls which messages are disabled (0) and how often t
4747

4848
**Note:** The message report rate is the *number of fixes* between message reports. In the image above, with GSV set to 4, the NMEA GSV message will be produced once every 4 fixes. Because the device defaults to a 4Hz fix rate, the GSV message will appear once per second.
4949

50-
The following 67 messages are supported for Bluetooth output and logging:
50+
The following 120 messages are supported for Bluetooth output and logging:
5151

5252
<table class="table">
5353
<table>
5454
<COLGROUP><COL WIDTH=200><COL WIDTH=200><COL WIDTH=200></COLGROUP>
5555
<tr>
56-
<td>&#8226; NMEA-GSA</td>
57-
<td>&#8226; NMEA-GST</td>
58-
<td>&#8226; NMEA-GSV</td>
56+
<td>&#8226; NMEA-DTM</td>
57+
<td>&#8226; NMEA-GBS</td>
58+
<td>&#8226; NMEA-GGA</td>
5959
</tr>
6060
<tr>
61-
<td>&#8226; NMEA-RMC</td>
62-
<td>&#8226; NMEA-VLW</td>
63-
<td>&#8226; NMEA-VTG</td>
61+
<td>&#8226; NMEA-GLL</td>
62+
<td>&#8226; NMEA-GNS</td>
63+
<td>&#8226; NMEA-GRS</td>
6464
</tr>
6565
<tr>
66+
<td>&#8226; NMEA-GSA</td>
67+
<td>&#8226; NMEA-GST</td>
68+
<td>&#8226; NMEA-GSV</td>
69+
</tr>
70+
<tr>
71+
<td>&#8226; NMEA-RLM</td>
72+
<td>&#8226; NMEA-RMC</td>
73+
<td>&#8226; NMEA-THS</td>
74+
</tr>
75+
<tr>
76+
<td>&#8226; NMEA-VLW</td>
77+
<td>&#8226; NMEA-VTG</td>
6678
<td>&#8226; NMEA-ZDA</td>
79+
</tr>
80+
<tr>
81+
<td>&#8226; NMEA-NAV2-GGA</td>
82+
<td>&#8226; NMEA-NAV2-GLL</td>
83+
<td>&#8226; NMEA-NAV2-GNS</td>
84+
</tr>
85+
<tr>
86+
<td>&#8226; NMEA-NAV2-GSA</td>
87+
<td>&#8226; NMEA-NAV2-RMC</td>
88+
<td>&#8226; NMEA-NAV2-VTG</td>
89+
</tr>
90+
<tr>
91+
<td>&#8226; NMEA-NAV2-ZDA</td>
92+
<td>&#8226; PUBX-POLYP</td>
93+
<td>&#8226; PUBX-POLYS</td>
94+
</tr>
95+
<tr>
96+
<td>&#8226; PUBX-POLYT</td>
97+
<td>&#8226; RTCM3x-1005</td>
98+
<td>&#8226; RTCM3x-1074</td>
99+
</tr>
100+
<tr>
101+
<td>&#8226; RTCM3x-1077</td>
102+
<td>&#8226; RTCM3x-1084</td>
103+
<td>&#8226; RTCM3x-1087</td>
104+
</tr>
105+
<tr>
106+
<td>&#8226; RTCM3x-1094</td>
107+
<td>&#8226; RTCM3x-1097</td>
108+
<td>&#8226; RTCM3x-1124</td>
109+
</tr>
110+
<tr>
111+
<td>&#8226; RTCM3x-1127</td>
112+
<td>&#8226; RTCM3x-1230</td>
113+
<td>&#8226; RTCM3x-4072-0</td>
114+
</tr>
115+
<tr>
116+
<td>&#8226; RTCM3x-4072-1</td>
117+
<td>&#8226; ESF-ALG</td>
118+
<td>&#8226; ESF-INS</td>
119+
</tr>
120+
<tr>
121+
<td>&#8226; ESF-MEAS</td>
122+
<td>&#8226; ESF-RAW</td>
123+
<td>&#8226; ESF-STATUS</td>
124+
</tr>
125+
<tr>
126+
<td>&#8226; MON-COMMS</td>
127+
<td>&#8226; MON-HW2</td>
128+
<td>&#8226; MON-HW3</td>
129+
</tr>
130+
<tr>
131+
<td>&#8226; MON-HW</td>
132+
<td>&#8226; MON-IO</td>
133+
<td>&#8226; MON-MSGPP</td>
134+
</tr>
135+
<tr>
136+
<td>&#8226; MON-RF</td>
137+
<td>&#8226; MON-RXBUF</td>
138+
<td>&#8226; MON-RXR</td>
139+
</tr>
140+
<tr>
141+
<td>&#8226; MON-SPAN</td>
142+
<td>&#8226; MON-SYS</td>
143+
<td>&#8226; MON-TXBUF</td>
144+
</tr>
145+
<tr>
146+
<td>&#8226; NAV2-CLOCK</td>
147+
<td>&#8226; NAV2-COV</td>
148+
<td>&#8226; NAV2-DOP</td>
149+
</tr>
150+
<tr>
151+
<td>&#8226; NAV2-EELL</td>
152+
<td>&#8226; NAV2-EOE</td>
153+
<td>&#8226; NAV2-POSECEF</td>
154+
</tr>
155+
<tr>
156+
<td>&#8226; NAV2-POSLLH</td>
157+
<td>&#8226; NAV2-PVAT</td>
158+
<td>&#8226; NAV2-PVT</td>
159+
</tr>
160+
<tr>
161+
<td>&#8226; NAV2-SAT</td>
162+
<td>&#8226; NAV2-SBAS</td>
163+
<td>&#8226; NAV2-SIG</td>
164+
</tr>
165+
<tr>
166+
<td>&#8226; NAV2-STATUS</td>
167+
<td>&#8226; NAV2-TIMEBDS</td>
168+
<td>&#8226; NAV2-TIMEGAL</td>
169+
</tr>
170+
<tr>
171+
<td>&#8226; NAV2-TIMEGLO</td>
172+
<td>&#8226; NAV2-TIMEGPS</td>
173+
<td>&#8226; NAV2-TIMELS</td>
174+
</tr>
175+
<tr>
176+
<td>&#8226; NAV2-TIMEQZSS</td>
177+
<td>&#8226; NAV2-TIMEUTC</td>
178+
<td>&#8226; NAV2-VELECEF</td>
179+
</tr>
180+
<tr>
181+
<td>&#8226; NAV2-VELNED</td>
182+
<td>&#8226; NAV-ATT</td>
67183
<td>&#8226; NAV-CLOCK</td>
184+
</tr>
185+
<tr>
186+
<td>&#8226; NAV-COV</td>
68187
<td>&#8226; NAV-DOP</td>
188+
<td>&#8226; NAV-EELL</td>
69189
</tr>
70190
<tr>
71191
<td>&#8226; NAV-EOE</td>
@@ -78,32 +198,42 @@ The following 67 messages are supported for Bluetooth output and logging:
78198
<td>&#8226; NAV-ORB</td>
79199
</tr>
80200
<tr>
201+
<td>&#8226; NAV-PL</td>
81202
<td>&#8226; NAV-POSECEF</td>
82203
<td>&#8226; NAV-POSLLH</td>
83-
<td>&#8226; NAV-PVT</td>
84204
</tr>
85205
<tr>
206+
<td>&#8226; NAV-PVAT</td>
207+
<td>&#8226; NAV-PVT</td>
86208
<td>&#8226; NAV-RELPOSNED</td>
209+
</tr>
210+
<tr>
87211
<td>&#8226; NAV-SAT</td>
212+
<td>&#8226; NAV-SBAS</td>
88213
<td>&#8226; NAV-SIG</td>
89214
</tr>
90215
<tr>
216+
<td>&#8226; NAV-SLAS</td>
91217
<td>&#8226; NAV-STATUS</td>
92218
<td>&#8226; NAV-SVIN</td>
93-
<td>&#8226; NAV-TIMEBDS</td>
94219
</tr>
95220
<tr>
221+
<td>&#8226; NAV-TIMEBDS</td>
96222
<td>&#8226; NAV-TIMEGAL</td>
97223
<td>&#8226; NAV-TIMEGLO</td>
98-
<td>&#8226; NAV-TIMEGPS</td>
99224
</tr>
100225
<tr>
226+
<td>&#8226; NAV-TIMEGPS</td>
101227
<td>&#8226; NAV-TIMELS</td>
228+
<td>&#8226; NAV-TIMEQZSS</td>
229+
</tr>
230+
<tr>
102231
<td>&#8226; NAV-TIMEUTC</td>
103232
<td>&#8226; NAV-VELECEF</td>
233+
<td>&#8226; NAV-VELNED</td>
104234
</tr>
105235
<tr>
106-
<td>&#8226; NAV-VELNED</td>
236+
<td>&#8226; RXM-COR</td>
107237
<td>&#8226; RXM-MEASX</td>
108238
<td>&#8226; RXM-RAWX</td>
109239
</tr>
@@ -113,50 +243,16 @@ The following 67 messages are supported for Bluetooth output and logging:
113243
<td>&#8226; RXM-SFRBX</td>
114244
</tr>
115245
<tr>
116-
<td>&#8226; MON-COMMS</td>
117-
<td>&#8226; MON-HW2</td>
118-
<td>&#8226; MON-HW3</td>
119-
</tr>
120-
<tr>
121-
<td>&#8226; MON-HW</td>
122-
<td>&#8226; MON-IO</td>
123-
<td>&#8226; MON-MSGPP</td>
124-
</tr>
125-
<tr>
126-
<td>&#8226; MON-RF</td>
127-
<td>&#8226; MON-RXBUF</td>
128-
<td>&#8226; MON-RXR</td>
129-
</tr>
130-
<tr>
131-
<td>&#8226; MON-TXBUF</td>
246+
<td>&#8226; RXM-SPARTN</td>
132247
<td>&#8226; TIM-TM2</td>
133248
<td>&#8226; TIM-TP</td>
134249
</tr>
135250
<tr>
136251
<td>&#8226; TIM-VRFY</td>
137-
<td>&#8226; RTCM3x-1005</td>
138-
<td>&#8226; RTCM3x-1074</td>
139-
</tr>
140-
<tr>
141-
<td>&#8226; RTCM3x-1077</td>
142-
<td>&#8226; RTCM3x-1084</td>
143-
<td>&#8226; RTCM3x-1087</td>
144-
</tr>
145-
<tr>
146-
<td>&#8226; RTCM3x-1094</td>
147-
<td>&#8226; RTCM3x-1097</td>
148-
<td>&#8226; RTCM3x-1124</td>
149-
</tr>
150-
<tr>
151-
<td>&#8226; RTCM3x-1127</td>
152-
<td>&#8226; RTCM3x-1230</td>
153-
<td>&#8226; RTCM3x-4072-0</td>
154-
</tr>
155-
<tr>
156-
<td>&#8226; RTCM3x-4072-1</td>
157252
<td></td>
158253
<td></td>
159254
</tr>
255+
160256
</table></table>
161257

162258
## Turn off all messages

0 commit comments

Comments
 (0)