Skip to content

Commit 5f9b007

Browse files
committed
Update menu ports
1 parent 03930fb commit 5f9b007

File tree

2 files changed

+30
-20
lines changed

2 files changed

+30
-20
lines changed
19.9 KB
Loading

docs/menu_ports.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -61,23 +61,28 @@ Example NMEA output over USB
6161

6262
Available on devices that have an external **RADIO** port.
6363

64-
By default, the **Radio** 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.
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.
6565

6666
## Mux Channel
6767

6868
Available on devices that have a built-in multiplexer on the **DATA** port.
6969

70-
The **Data** port on the RTK Facet, Express, and Express Plus is very flexible. Internally the **Data** connector is connected to a digital mux allowing one of four software-selectable setups. By default, the Data port will be connected to the UART1 of the ZED-F9P and output any messages via serial.
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.
7171

72-
- **NMEA** - The TX pin outputs any enabled messages (NMEA, UBX, and RTCM) at a default of 460,800bps (configurable 9600 to 921600bps). The RX pin can receive RTCM for RTK and can also receive UBX configuration commands if desired.
73-
- **PPS/Trigger** - The TX pin outputs the pulse-per-second signal that is accurate to 30ns RMS. This pin can be configured as an extremely accurate time base. The pulse length and time between pulses are configurable down to 1us. The RX pin is connected to the EXTINT pin on the ZED-F9P allowing for events to be measured with incredibly accurate nano-second resolution. Useful for things like audio triangulation. See the [External Event Logging](#surveyor-data-port) section below and the Timemark section of the [ZED-F9P Integration Manual](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/ZED-F9P_IntegrationManual__UBX-18010802_.pdf) for more information.
74-
- **I2C** - (On Express, Facet, and Facet L-Band) 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.
75-
- **Wheel/Dir Encoder** - (On Express Plus) Connect the DATA port to the wheel tick inputs on 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.
76-
- **GPIO** - 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.
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.
7776

7877
## Data Port
7978

80-
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.
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>
84+
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.
8186

8287
<figure markdown>
8388
![Monitoring the COM ports on the ZED-F9P](./img/SparkFun_RTK_Express_-_Ports_Menu_MON-COMM_Overrun.jpg)
@@ -86,11 +91,11 @@ Monitoring the COM ports on the ZED-F9P
8691
</figcaption>
8792
</figure>
8893

89-
If you must run the data port at lower than 460800bps, 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 99%. The image above shows the UART1 becoming overwhelmed because the ZED cannot transmit at 115200bps fast enough.
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.
9095

91-
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.
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.
9297

93-
### Pulse Per Second
98+
### Pulse Per Second and External Trigger
9499

95100
<figure markdown>
96101
![Configuring the External Pulse and External Events](./img/WiFi Config/SparkFun%20RTK%20Ports%20PPS%20Config.png)
@@ -106,21 +111,26 @@ Port menu showing mux data port connections
106111
</figcaption>
107112
</figure>
108113

109-
When PPS/Event Trigger is selected, the Pulse-Per-Second output from the ZED-F9x is sent out of the TX pin of the DATA port. Once the RTK device has GNSS reception, this can be used as a *very* accurate time base.
110-
111-
The time between pulses can be configured down to 100ns (10MHz) with an accuracy of 30ns RMS and 60ns 99%. The pulse width and polarity are also configurable.
112-
113114
<figure markdown>
114-
![Wires connected to a SparkFun USB C to Serial adapter](./img/SparkFun_RTK_Facet_-_Data_Port_to_USB.jpg)
115+
![RTK Facet mosaic External Triggers](./img/Terminal/SparkFun_RTK_Facet_mosaic_External_Trigger.png)
115116
<figcaption markdown>
117+
Configuring the External Pulse and External Events on RTK Facet mosaic
116118
</figcaption>
117119
</figure>
118120

119-
For PPS, only the Black and Green 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.
121+
When **PPS OUT/Event Trigger In** is selected, the Pulse-Per-Second output from the GNSS is sent out of the TX pin of the DATA port. Once the RTK device has GNSS reception, this can be used as a *very* accurate time base.
122+
123+
The pulse width, frequency and polarity are configurable. The absolute timing accuracy depends on the GNSS.
124+
125+
The DATA port RX pin is routed to the GNSS EXTINT / EVENTA pin, allowing external events and triggers to be captured precisely. The absolute timing accuracy depends on the GNSS. For products using the u-blox ZED-F9P GNSS, the event timing is recorded in the UBX-TIM-TM2 binary message. On the mosaic-X5, the ExtEvent and ExtEventPVTCartesian SBF binary messages capture the timing and position of events.
126+
127+
For PPS, only the Black and Green wires are needed. For external events / triggers, only the Black and Orange wires are needed.
128+
129+
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.
120130

121131
- **Red** - 3.3V
122-
- **Green** - TX (output from the RTK device)
123-
- **Orange** - RX (input into the RTK device)
132+
- **Green** - TX (3.3V PPS output from the RTK device)
133+
- **Orange** - RX (3.3V external trigger input into the RTK device)
124134
- **Black** - GND
125135

126-
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.
136+
For products using the u-blox ZED-F9P GNSS, see the Timemark section of the [ZED-F9P Integration Manual](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/ZED-F9P_IntegrationManual__UBX-18010802_.pdf)

0 commit comments

Comments
 (0)