Skip to content

Commit 876eddc

Browse files
committed
Docs update
1 parent df9283c commit 876eddc

12 files changed

+119
-62
lines changed
Loading
Loading
240 KB
Loading
Loading
Loading
Loading
Loading
Loading

docs/menu_gnss.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,8 @@ The SparkFun RTK product line is immensely configurable. The RTK device will, by
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

2525
<figure markdown>
26-
![RTK Everywhere Main Menu](./img/Terminal/SparkFun RTK Everywhere - Main Menu.png)
27-
<figcaption markdown>
28-
RTK Everywhere main menu
29-
</figcaption>
30-
</figure>
3126

32-
Pressing any key will show the *Main Menu*. From the main menu, pressing 1 will bring up the *GNSS Receiver* configuration menu.
33-
34-
<figure markdown>
35-
![GNSS menu showing measurement rates and dynamic model](./img/Terminal/SparkFun RTK Everywhere - GNSS Receiver.png)
27+
![GNSS menu showing measurement rates and dynamic model](<./img/Terminal/SparkFun RTK Everywhere - GNSS Receiver.png>)
3628
<figcaption markdown>
3729
GNSS menu showing measurement rates and dynamic model
3830
</figcaption>
@@ -52,7 +44,8 @@ The Dynamic Model can be changed but it is recommended to leave it as *Survey*.
5244
## Min SV Elevation and C/N0
5345

5446
<figure markdown>
55-
![Elevation and C/N0](./img/Terminal/SparkFun RTK Everywhere - GNSS Receiver.png)
47+
48+
![Elevation and C/N0](<./img/Terminal/SparkFun RTK Everywhere - GNSS Receiver.png>)
5649
<figcaption markdown>
5750
GNSS menu showing Minimum SV Elevation and C/N0
5851
</figcaption>
@@ -65,7 +58,8 @@ A minimum C/N0 is set in dB. If a satellite is detected that is below this signa
6558
## Constellations Menu
6659

6760
<figure markdown>
68-
![Enable or disable the constellations used for fixes](./img/Terminal/SparkFun RTK Everywhere - GNSS Menu Constellations.png)
61+
62+
![Enable or disable the constellations used for fixes](<./img/Terminal/SparkFun RTK Everywhere - GNSS Menu Constellations.png>)
6963
<figcaption markdown>
7064
Enable or disable the constellations used for fixes
7165
</figcaption>
@@ -80,7 +74,8 @@ If supported by hardware, Galileo E6 corrections are enabled by default to suppo
8074
## NTRIP Client
8175

8276
<figure markdown>
83-
![NTRIP Client enabled showing settings](./img/Terminal/SparkFun RTK Everywhere - GNSS Receiver.png)
77+
78+
![NTRIP Client enabled showing settings](<./img/Terminal/SparkFun RTK Everywhere - GNSS Receiver.png>)
8479
<figcaption markdown>
8580
NTRIP Client enabled showing settings
8681
</figcaption>
@@ -121,7 +116,8 @@ Compatibility Icons
121116
</div>
122117

123118
<figure markdown>
124-
![Menu for controlling Multipath Mitigation](./img/Terminal/SparkFun RTK Everywhere - GNSS Multipath Mitigation.png)
119+
120+
![Menu for controlling Multipath Mitigation](<./img/Terminal/SparkFun RTK Everywhere - GNSS Multipath Mitigation.png>)
125121
<figcaption markdown>
126122
Menu for controlling Multipath Mitigation
127123
</figcaption>

docs/menu_ports.md

Lines changed: 72 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,106 +13,141 @@ Compatibility Icons
1313

1414
- EVK: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
1515
- Facet mosaic: :material-radiobox-marked:{ .support-full title="Feature Supported" }
16-
- Postcard: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
16+
- Postcard: :material-radiobox-marked:{ .support-full title="Feature Supported" }
1717
- Torch: :material-radiobox-indeterminate-variant:{ .support-partial title="Feature Partially Supported" }
1818

1919
</div>
2020

2121
<figure markdown>
22-
![Setting the baud rate of the ports](./img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Express_Ports_Config.jpg)
22+
23+
![Setting the baud rate of the ports](<./img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_Express_Ports_Config.jpg>)
2324
<figcaption markdown>
2425
Setting the baud rates of the two available external ports
2526
</figcaption>
2627
</figure>
2728

2829
<figure markdown>
29-
![Baud rate configuration of Radio and Data ports](./img/Terminal/SparkFun_RTK_Express_-_Ports_Menu.jpg)
30+
31+
![Baud rate configuration of Radio and Data ports](<./img/Terminal/SparkFun_RTK_Express_-_Ports_Menu.jpg>)
3032
<figcaption markdown>
3133
Baud rate configuration of Radio and Data ports
3234
</figcaption>
3335
</figure>
3436

35-
## Output GNSS Data over USB
37+
The RADIO and DATA ports vary between RTK devices:
38+
39+
* The RTK Facet mosaic L-Band has both RADIO and DATA ports.
40+
* The RTK Torch does not have a RADIO or DATA port, but can output NMEA over USB.
41+
* The RTK Postcard has both RADIO and DATA ports.
42+
* The RTK EVK has only a RADIO port.
3643

3744
<figure markdown>
38-
![Set output to GNSS data over USB Serial](./img/Terminal/SparkFun RTK Everywhere - Ports USB GNSS Output.png)
45+
46+
![RADIO and DATA ports on the RTK Postacrd](<./img/Postcard/SparkFun RTK PostCard Ports.png>)
3947
<figcaption markdown>
40-
Set output to GNSS data over USB Serial
48+
RADIO and DATA ports on the RTK Postacrd
4149
</figcaption>
4250
</figure>
4351

44-
Enabling **Output GNSS data to USB serial** will pipe all GNSS output (generally NMEA but also RTCM) to the USB serial connection. This permits a wired connection to be made on devices, such as the RTK Torch, that have only one external port (USB).
52+
## Radio Port
4553

46-
On RTK Facet mosaic, data can be output on the _USB1_ USB COM port.
54+
Available on devices that have an external **RADIO** port.
4755

48-
!!! note
49-
To exit this mode, press **+++** to open the configuration menu.
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.
5057

51-
Additionally, correction may be *sent* to the device over USB. RTCM corrections received over USB will follow the [Corrections Priority table](menu_corrections_priorities.md).
58+
The default for the RTK Postcard is 115200bps.
59+
60+
## Data Port
5261

5362
<figure markdown>
54-
![Example NMEA output over USB](./img/Terminal/SparkFun RTK Everywhere - Ports USB GNSS Output Example.png)
63+
64+
![DATA port connected to a SparkFun USB C to Serial adapter](<./img/SparkFun_RTK_Facet_-_Data_Port_to_USB.jpg>)
5565
<figcaption markdown>
56-
Example NMEA output over USB
66+
DATA port connected to a SparkFun USB C to Serial adapter
5767
</figcaption>
5868
</figure>
5969

60-
## Radio Port
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.
6171

62-
Available on devices that have an external **RADIO** port.
72+
<figure markdown>
6373

64-
The **RADIO** port is connected directly to GNSS UART. By default, 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.
74+
![Monitoring the COM ports on the ZED-F9P](<./img/SparkFun_RTK_Express_-_Ports_Menu_MON-COMM_Overrun.jpg>)
75+
<figcaption markdown>
76+
Monitoring the COM ports on the ZED-F9P
77+
</figcaption>
78+
</figure>
6579

66-
## Mux Channel
80+
If you must run the data port at lower speeds, and you need to enable a large number of messages and/or increase the fix frequency beyond 4Hz, be sure to verify that UART1 usage stays below 90%. The image above shows the UART1 becoming overwhelmed because the ZED cannot transmit at 115200bps fast enough.
6781

68-
Available on devices that have a built-in multiplexer on the **DATA** port.
82+
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.
6983

70-
The **DATA** port on the RTK Facet is very flexible. Internally the **DATA** connector is connected to a digital mux allowing one of four software-selectable setups. By default, the port will be connected to the GNSS UART and output any messages via serial.
84+
### Postcard USB Ports
7185

72-
- **GNSS TX Out/RX In** - The TX pin outputs any enabled messages (NMEA, RTCM and binary). If supported, the RX pin can receive RTCM for RTK and can also receive configuration commands.
73-
- **PPS OUT/Event Trigger In** - The TX pin outputs the pulse-per-second signal that is accurate to typically 30ns RMS. The RX pin is connected to the EXTINT pin on the ZED-F9P or EVENTA on the mosaic-X5, allowing events to be measured with incredibly accurate nano-second resolution. See the [Pulse Per Second and External Trigger](#pulse-per-second-and-external-trigger) section below for more information.
74-
- **I2C SDA/SCL** - The TX pin operates as SCL, RX pin as SDA on the I2C bus. This allows additional sensors to be connected to the I2C bus, typically sharing it with the GNSS and OLED. This is useful for custom applications where you are using your own firmware.
75-
- **ESP32 DAC Out/ADC In** - The TX pin operates as a DAC-capable GPIO on the ESP32. The RX pin operates as an ADC-capable input on the ESP32. This is useful for custom applications where you are using your own firmware. These pins have no function with the standard RTK Everywhere firmware.
86+
![alt text](<img/Postcard/SparkFun RTK PostCard USB Channels.png>)
7687

77-
## Data Port
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.
7889

79-
<figure markdown>
80-
![Wires connected to a SparkFun USB C to Serial adapter](./img/SparkFun_RTK_Facet_-_Data_Port_to_USB.jpg)
81-
<figcaption markdown>
82-
</figcaption>
83-
</figure>
90+
## Output GNSS Data over USB
91+
92+
Enabling **Output GNSS data to USB serial** will pipe all GNSS output (generally NMEA but also RTCM) to the USB serial connection. This permits a wired connection to be made on devices, such as the RTK Torch, that have only one external port (USB).
93+
94+
!!! note
95+
To exit this mode, press **+++** to open the configuration menu.
8496

85-
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.
97+
On RTK Facet mosaic, data can be output on the _USB1_ USB COM port.
98+
99+
Additionally, corrections may be *sent* to the device over USB. RTCM corrections received over USB will follow the [Corrections Priority table](menu_corrections_priorities.md).
86100

87101
<figure markdown>
88-
![Monitoring the COM ports on the ZED-F9P](./img/SparkFun_RTK_Express_-_Ports_Menu_MON-COMM_Overrun.jpg)
102+
103+
![Example NMEA output over USB](<./img/Terminal/SparkFun RTK Everywhere - Ports USB GNSS Output Example.png>)
89104
<figcaption markdown>
90-
Monitoring the COM ports on the ZED-F9P
105+
Example NMEA output over USB
91106
</figcaption>
92107
</figure>
93108

94-
If you must run the data port at lower speeds, and you need to enable a large number of messages and/or increase the fix frequency beyond 4Hz, be sure to verify that UART1 usage stays below 90%. The image above shows the UART1 becoming overwhelmed because the ZED cannot transmit at 115200bps fast enough.
109+
## Limit RADIO Port Output to RTCM
95110

96-
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.
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.
112+
113+
## Allow Incoming Corrections on COM/UART
114+
115+
Disable this to block corrections on the given port.
116+
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.
118+
119+
## Mux Channel
120+
121+
Available on devices that have a built-in multiplexer on the **DATA** port.
122+
123+
The **DATA** port on the RTK Facet is very flexible. Internally the **DATA** connector is connected to a digital mux allowing one of four software-selectable setups. By default, the port will be connected to the GNSS UART and output any messages via serial.
124+
125+
- **GNSS TX Out/RX In** - The TX pin outputs any enabled messages (NMEA, RTCM and binary). If supported, the RX pin can receive RTCM for RTK and can also receive configuration commands.
126+
- **PPS OUT/Event Trigger In** - The TX pin outputs the pulse-per-second signal that is accurate to typically 30ns RMS. The RX pin is connected to the EXTINT pin on the ZED-F9P or EVENTA on the mosaic-X5, allowing events to be measured with incredibly accurate nano-second resolution. See the [Pulse Per Second and External Trigger](#pulse-per-second-and-external-trigger) section below for more information.
127+
- **I2C SDA/SCL** - The TX pin operates as SCL, RX pin as SDA on the I2C bus. This allows additional sensors to be connected to the I2C bus, typically sharing it with the GNSS and OLED. This is useful for custom applications where you are using your own firmware.
128+
- **ESP32 DAC Out/ADC In** - The TX pin operates as a DAC-capable GPIO on the ESP32. The RX pin operates as an ADC-capable input on the ESP32. This is useful for custom applications where you are using your own firmware. These pins have no function with the standard RTK Everywhere firmware.
97129

98130
### Pulse Per Second and External Trigger
99131

100132
<figure markdown>
101-
![Configuring the External Pulse and External Events](./img/WiFi Config/SparkFun%20RTK%20Ports%20PPS%20Config.png)
133+
134+
![Configuring the External Pulse and External Events](<./img/WiFi Config/SparkFun%20RTK%20Ports%20PPS%20Config.png>)
102135
<figcaption markdown>
103136
Configuring the External Pulse and External Events over WiFi
104137
</figcaption>
105138
</figure>
106139

107140
<figure markdown>
108-
![RTK Mux Menu](./img/Terminal/SparkFun_RTK_Express_-_Ports_Menu_Mux.jpg)
141+
142+
![RTK Mux Menu](<./img/Terminal/SparkFun_RTK_Express_-_Ports_Menu_Mux.jpg>)
109143
<figcaption markdown>
110144
Port menu showing mux data port connections
111145
</figcaption>
112146
</figure>
113147

114148
<figure markdown>
115-
![RTK Facet mosaic External Triggers](./img/Terminal/SparkFun_RTK_Facet_mosaic_External_Trigger.png)
149+
150+
![RTK Facet mosaic External Triggers](<./img/Terminal/SparkFun_RTK_Facet_mosaic_External_Trigger.png>)
116151
<figcaption markdown>
117152
Configuring the External Pulse and External Events on RTK Facet mosaic
118153
</figcaption>

0 commit comments

Comments
 (0)