Skip to content

Commit 8e437e4

Browse files
committed
Docs update
1 parent 876eddc commit 8e437e4

File tree

6 files changed

+83
-22
lines changed

6 files changed

+83
-22
lines changed

docs/configure_with_serial.md

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,66 @@ Compatibility Icons
2121
!!! note
2222
Any serial menu that is shown below can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
2323

24-
To configure an RTK device using serial attach a [USB C cable](https://www.sparkfun.com/products/15425) to the device.
24+
## USB Connection
2525

26-
## RTK Torch
26+
<figure markdown>
27+
28+
![Terminal showing the main menu](<./img/Terminal/SparkFun RTK Everywhere - Main Menu.png>)
29+
<figcaption markdown>
30+
The Main Menu
31+
</figcaption>
32+
</figure>
33+
34+
To configure an RTK device using serial attach a [USB C cable](https://www.sparkfun.com/products/25630) to the device. Any USB C cable should work. Connect your device to a computer and you should see a Serial port appear. Open this port at 115200bps using your favorite terminal program and press any key to open the Main Menu.
35+
36+
### RTK EVK
37+
38+
<figure markdown>
39+
40+
![SparkFun RTK EVK connectors](<./img/EVK/SparkFun RTK EVK Front.png>)
41+
<figcaption markdown>
42+
SparkFun RTK EVK connectors
43+
</figcaption>
44+
</figure>
45+
46+
The connector labeled **CONFIG ESP32** is used for Serial Configuration. For an in depth review of the EVK hardware, please see the [SparkFun RTK EVK Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_EVK/hardware_overview/).
47+
48+
### RTK Facet mosaic
49+
50+
<figure markdown>
51+
52+
![SparkFun RTK Facet mosaic connectors](<./img/Facet/SparkFun RTK Facet mosaic Connectors.png>)
53+
<figcaption markdown>
54+
SparkFun RTK Facet mosaic connectors
55+
</figcaption>
56+
</figure>
57+
58+
The connector labeled **USB** is used for Serial Configuration and charging.
59+
60+
### RTK Postcard
2761

2862
<figure markdown>
63+
64+
![SparkFun RTK Postcard connectors](<./img/Postcard/SparkFun RTK PostCard Ports.png>)
65+
<figcaption markdown>
66+
SparkFun RTK Postcard connectors
67+
</figcaption>
68+
</figure>
69+
70+
<figure markdown>
71+
72+
![SparkFun RTK Postcard connectors](<./img/Postcard/SparkFun RTK PostCard USB Channels.png>)
73+
<figcaption markdown>
74+
SparkFun RTK Postcard serial channels
75+
</figcaption>
76+
</figure>
77+
78+
The DATA port on the RTK Postcard is the USB C connector. This connection creates two serial ports. **SERIAL-A** is used for [Serial Configuration](configure_with_serial.md). **SERIAL-B** is connected to the DATA port of the LG290P to receive NMEA and other data directly. The DATA port is also used for [updating the firmware](firmware_update_lg290p.md) on the LG290P.
79+
80+
### RTK Torch
81+
82+
<figure markdown>
83+
2984
[![The USB Connector on the RTK Torch](./img/RTK-Torch_Buttons_Back-Small.png)](./img/RTK-Torch_Buttons_Back.png)
3085
<figcaption markdown>
3186
The USB Connector on the RTK Torch
@@ -35,6 +90,7 @@ The USB Connector on the RTK Torch
3590
Pull back the silicone cover and insert a USB C and power on the device. Once the device is powered on, open the `Device Manager` in Windows and look under the Ports branch to see what COM port the device is assigned to.
3691

3792
<figure markdown>
93+
3894
![SparkFun RTK Torch Two Enumerated Ports](./img/Torch/RTK-Torch_Two-COM-Ports.png)
3995
<figcaption markdown>
4096
SparkFun RTK Torch Two Enumerated Ports
@@ -53,7 +109,8 @@ Open a terminal window at 115200bps; you should see various status messages ever
53109
Note that some Windows terminal programs (e.g. Tera Term) may reboot the RTK device when the terminal connection is closed. You can disconnect the USB cable first to prevent this from happening.
54110

55111
<figure markdown>
56-
![Terminal showing the main menu](./img/Terminal/SparkFun RTK Everywhere - Main Menu.png)
112+
113+
![Terminal showing the main menu](<./img/Terminal/SparkFun RTK Everywhere - Main Menu.png>)
57114
<figcaption markdown>
58115
The Main Menu
59116
</figcaption>
@@ -69,7 +126,8 @@ Pressing '1' or 's' for example, will open those submenus.
69126
The menus will timeout after 10 minutes of inactivity, so if you do not press a key the device will exit the menu and return to reporting status messages.
70127

71128
<figure markdown>
72-
![Configuration menu open over Bluetooth](./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Exit%20BEM.png)
129+
130+
![Configuration menu open over Bluetooth](<./img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Exit%20BEM.png>)
73131
<figcaption markdown>
74132
Configuration menu via Bluetooth
75133
</figcaption>
471 KB
Loading
Loading
Loading

docs/menu_gnss.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Compatibility Icons
1818

1919
</div>
2020

21-
The SparkFun RTK product line is immensely configurable. The RTK device will, by default, put the GNSS receiver into the most common configuration for rover/base RTK for use with *SW Maps* and other GIS applications.
21+
The SparkFun RTK product line is immensely configurable. The RTK device will, by default, put the GNSS receiver into the most common configuration for rover/base RTK for use with most GIS applications.
2222

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

@@ -111,6 +111,7 @@ Compatibility Icons
111111

112112
- EVK: :material-radiobox-blank:{ .support-none title="Feature Not Supported" }
113113
- Facet mosaic: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
114+
- Postcard: :material-radiobox-blank:{ .support-none title="Feature Not Supported" }
114115
- Torch: :material-radiobox-marked:{ .support-full title="Feature Supported" }
115116

116117
</div>

docs/menu_ports.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Compatibility Icons
2020

2121
<figure markdown>
2222

23-
![Setting the baud rate of the ports](<./img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Express_Ports_Config.jpg>)
23+
![Setting the baud rate of the ports](<./img/WiFi Config/SparkFun RTK Ports Config.png>)
2424
<figcaption markdown>
2525
Setting the baud rates of the two available external ports
2626
</figcaption>
@@ -30,7 +30,7 @@ Setting the baud rates of the two available external ports
3030

3131
![Baud rate configuration of Radio and Data ports](<./img/Terminal/SparkFun_RTK_Express_-_Ports_Menu.jpg>)
3232
<figcaption markdown>
33-
Baud rate configuration of Radio and Data ports
33+
Baud rate configuration of the RADIO and DATA ports
3434
</figcaption>
3535
</figure>
3636

@@ -41,21 +41,13 @@ The RADIO and DATA ports vary between RTK devices:
4141
* The RTK Postcard has both RADIO and DATA ports.
4242
* The RTK EVK has only a RADIO port.
4343

44-
<figure markdown>
45-
46-
![RADIO and DATA ports on the RTK Postacrd](<./img/Postcard/SparkFun RTK PostCard Ports.png>)
47-
<figcaption markdown>
48-
RADIO and DATA ports on the RTK Postacrd
49-
</figcaption>
50-
</figure>
51-
5244
## Radio Port
5345

5446
Available on devices that have an external **RADIO** port.
5547

56-
The **RADIO** port is connected directly to GNSS UART. Depending on the platform, the port is set to 57600bps to match the [Serial Telemetry Radios](https://www.sparkfun.com/products/19032) that are recommended to be used with the RTK Facet (it is a plug-and-play solution). This can be set from 4800bps to 921600bps.
48+
The **RADIO** port is connected directly to a UART on the GNSS receiver allowing output of NMEA or RTCM, and receiving RTCM corrections. Depending on the platform, the port is set to 57600bps to match the [Serial Telemetry Radios](https://www.sparkfun.com/products/19032) that are recommended to be used with the RTK Facet (it is a plug-and-play solution). This can be set from 4800bps to 921600bps.
5749

58-
The default for the RTK Postcard is 115200bps.
50+
The default RADIO baud rate for the RTK Postcard is 115200bps.
5951

6052
## Data Port
6153

@@ -67,7 +59,7 @@ DATA port connected to a SparkFun USB C to Serial adapter
6759
</figcaption>
6860
</figure>
6961

70-
The **DATA** port can be configured from 4800bps to 921600bps. The default depends on the GNSS model: e.g. 460800bps on LG290P, 230400 on other models. The default rate was chosen to support applications where a large number of messages are enabled and a large amount of data is sent. If you need to decrease the baud rate to 115200bps or other on the ZED-F9P, be sure to monitor the MON-COMM message within u-center for buffer overruns. A baud rate of 115200bps and the NMEA+RXM default configuration at 4Hz *will* cause buffer overruns.
62+
The **DATA** port can be configured from 4800bps to 921600bps. The default depends on the GNSS model: e.g. 460800bps on LG290P, 230400bps on other models. The default rate was chosen to support applications where a large number of messages are enabled and a large amount of data is sent. If you need to decrease the baud rate to 115200bps or other on the ZED-F9P, be sure to monitor the MON-COMM message within u-center for buffer overruns. A baud rate of 115200bps and the NMEA+RXM default configuration at 4Hz *will* cause buffer overruns.
7163

7264
<figure markdown>
7365

@@ -83,9 +75,19 @@ Most applications do not need to plug anything into the **DATA** port. Most user
8375

8476
### Postcard USB Ports
8577

78+
<figure markdown>
79+
80+
![RADIO and DATA ports on the RTK Postacrd](<./img/Postcard/SparkFun RTK PostCard Ports.png>)
81+
<figcaption markdown>
82+
RADIO and DATA ports on the RTK Postacrd
83+
</figcaption>
84+
</figure>
85+
86+
87+
8688
![alt text](<img/Postcard/SparkFun RTK PostCard USB Channels.png>)
8789

88-
The DATA port on the RTK Postcard is the USB C connector. This connection creates two serial ports. **SERIAL-A** is used for Serial Configuration. **SERIAL-B** is connected to the DATA port of the LG290P to receive NMEA and other data directly.
90+
The DATA port on the RTK Postcard is the USB C connector. This connection creates two serial ports. **SERIAL-A** is used for [Serial Configuration](configure_with_serial.md). **SERIAL-B** is connected to the DATA port of the LG290P to receive NMEA and other data directly. The DATA port is also used for [updating the firmware](firmware_update_lg290p.md) on the LG290P.
8991

9092
## Output GNSS Data over USB
9193

@@ -108,13 +110,13 @@ Example NMEA output over USB
108110

109111
## Limit RADIO Port Output to RTCM
110112

111-
Enabling this option will turn off all data output except for the minimum RTCM messages necessary for RTK work. This is helpful in situations where a telemetry radio is used for connecting a Rover to a Base. Extra NMEA and binary data can tax a radio link and may cause the link to become intermittent or fail.
113+
Enabling this option will turn off all data output to the RADIO port except for the minimum RTCM messages necessary for RTK work. This is helpful in situations where a telemetry radio is used for connecting a Rover to a Base. Extra NMEA and binary data can tax a radio link and may cause the link to become intermittent or fail.
112114

113115
## Allow Incoming Corrections on COM/UART
114116

115-
Disable this to block corrections on the given port.
117+
Disable this feature to block corrections on the given port.
116118

117-
If a GNSS receiver gets corrections from multiple sources (WiFi, Bluetooth, serial, etc) it can lead to unpredictable outcomes. To avoid this, RTK Everywhere firmware includes a sophisticated 'corrections controller' to give priority to the various sources, discarding any lower priority corrections sources that are detected. See the [Corrections Priority](menu_corrections_priorities.md) section for more information. Because the RTK Everywhere firmware cannot directly filter out corrections from a direct serial connection, this option allows a user to disable that correction source directly.
119+
If a GNSS receiver gets corrections from multiple sources (WiFi, Bluetooth, serial, etc) it can lead to unpredictable outcomes. To avoid this, RTK Everywhere firmware includes a sophisticated 'corrections controller' to give priority to the various sources, discarding any lower priority corrections sources that are detected. See the [Corrections Priority](menu_corrections_priorities.md) section for more information. Because the RTK Everywhere firmware cannot filter out corrections from a serial connection, this option allows a user to disable that correction source that may .
118120

119121
## Mux Channel
120122

0 commit comments

Comments
 (0)