Skip to content

Commit 99798a1

Browse files
committed
Update TCP/UDP docs
1 parent 7ab1ada commit 99798a1

File tree

3 files changed

+31
-22
lines changed

3 files changed

+31
-22
lines changed
Loading
Loading

docs/menu_tcp_udp.md

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,36 +20,45 @@ Compatibility Icons
2020

2121
NMEA data is generally consumed by a GIS application or Data Collector. These messages can be transmitted over a variety of transport methods. This section focuses on the delivery of NMEA messages via TCP and UDP.
2222

23-
<figure markdown>
24-
![TCP/UDP Menu showing various TCP/UDP Client and Server options](./img/Terminal/SparkFun RTK Everywhere - TCP-UDP Menu.png)
25-
<figcaption markdown>
26-
TCP/UDP Menu showing various Client and Server options
27-
</figcaption>
28-
</figure>
23+
<p align="center">
24+
<img src="img/Terminal/SparkFun RTK Everywhere - TCP-UDP Menu.png" alt="TCP/UDP Menu showing various Client and Server options">
25+
</p>
2926

30-
## TCP Client and Server
27+
*<p align="center">TCP/UDP Menu showing various Client and Server options</p>*
28+
29+
<p align="center">
30+
<img src="img/WiFi Config/SparkFun RTK Config - TCP Port.png" alt="TCP/UDP settings using Web Config">
31+
</p>
3132

32-
The RTK device supports connection over TCP. The TCP Client sits on top of the network layer (WiFi or Ethernet) and sends position data to one or more computers or cell phones for display. Some Data Collector software (such as [Vespucci](gis_software.md#vespucci)) requires that the SparkFun RTK device connect as a TCP Client. Other software (such as [QGIS](gis_software.md#qgis)) requires that the SparkFun RTK device acts as a TCP Server. Both are supported.
33+
*<p align="center">TCP/UDP settings using Web Config</p>*
3334

34-
!!! note
35-
Currently for WiFi: TCP is only supported while connected to local WiFi, not AP mode. This means the device will need to be connected to a WiFi network, such as a mobile hotspot, before TCP connections can occur.
35+
## TCP Client and Server
3636

37-
<figure markdown>
38-
![TCP Port Entry](./img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20TCP%20Port.png)
39-
<figcaption markdown>
40-
</figcaption>
41-
</figure>
37+
The RTK device supports connection over TCP. The TCP Client sits on top of the network layer (WiFi in general, and Ethernet/Cellular on the EVK) and sends position data to one or more computers or cell phones for display. Some Data Collector software (such as [Vespucci](gis_software.md#vespucci)) requires that the SparkFun RTK device connect as a TCP Client. Other software (such as [QGIS](gis_software.md#qgis)) requires that the SparkFun RTK device acts as a TCP Server. Both are supported.
4238

4339
If either Client or Server is enabled, a port can be designated. By default, the port is 2947 (registered as [*GPS Daemon request/response*](https://tcp-udp-ports.com/port-2948.htm)) but any port 0 to 65535 is supported.
4440

45-
<figure markdown>
46-
![Ethernet TCP Client connection](./img/Terminal/TCP_Client.gif)
47-
<figcaption markdown>
48-
</figcaption>
49-
</figure>
5041

51-
The above animation was generated using [TCP_Server.py](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/Firmware/Tools/TCP_Server.py).
42+
<p align="center">
43+
<img src="img/Terminal/TCP_Client.gif" alt="Ethernet TCP Client connection">
44+
</p>
45+
46+
*<p align="center">Ethernet TCP Client connection</p>*
47+
48+
The above animation was generated using [TCP_Server.py](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/Firmware/Tools/TCP_Server.py) and demonstrates connecting to an RTK device over TCP from a desktop.
5249

5350
## UDP Server
5451

55-
NMEA messages can also be broadcast via UDP on Ethernet and WiFi, rather than TCP. If enabled, the UDP Server will begin broadcasting NMEA data over the specific port (default 10110).
52+
NMEA messages can also be broadcast via UDP rather than TCP. If enabled, the UDP Server will begin broadcasting NMEA data over the specific port (default 10110).
53+
54+
## NTRIP Caster
55+
56+
If enabled, incoming TCP connections will be answered as if the device is an NTRIP Caster and return a mount table with only one mount point. In this mode NTRIP Clients can connect directly to the RTK device without the need for a 3rd party NTRIP Caster such as RTK2Go or Emlid. This is most often used when a base RTK device is in AP or WiFi Station mode, and a rover is connected to a cell phone that is on the same WiFi network. A GIS app can then use its built in NTRIP Client to connect to the base's NTRIP Caster.
57+
58+
## MDNS
59+
60+
Multicast DNS allows other devices on the same network to discover this device using 'rtk.local' as its address. When MDNS is enabled, and the RTK device is acting in WiFi AP mode for configuration, typing 'rtk.local' into a browser will connect that browser to the RTK device without having to know or type in the full IP address.
61+
62+
## Broadcast TCP/UDP over WiFi or AP
63+
64+
TCP Server and UDP Server can connect over a local WiFi network, or by becoming an Access Point (hosting its own WiFi network) that client devices can connect to. Use option **a** to select between the type of WiFi to use for TCP/UDP Server broadcasting.

0 commit comments

Comments
 (0)