Skip to content

Commit 00ecfb2

Browse files
committed
Docs. Add network menu. Alpha sort menus.
1 parent b6d2acd commit 00ecfb2

File tree

3 files changed

+34
-18
lines changed

3 files changed

+34
-18
lines changed

docs/menu_network.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Network Menu
2+
3+
Surveyor: ![Feature Supported](img/Icons/GreenDot.png) / Express: ![Feature Supported](img/Icons/GreenDot.png) / Express Plus: ![Feature Supported](img/Icons/GreenDot.png) / Facet: ![Feature Supported](img/Icons/GreenDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Supported](img/Icons/GreenDot.png)
4+
5+
![PVT Client and Server settings](<img/Terminal/SparkFun RTK Network Menu.png>)
6+
7+
*PVT Client and Server settings*
8+
9+
## PVT Client and Server
10+
11+
The RTK device supports connection over TCP (aka PVT Client and Server). 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.
12+
13+
**Note:** 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.
14+
15+
![TCP Port Entry](img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20TCP%20Port.png)
16+
17+
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.
18+
19+
![Ethernet TCP Client connection](img/Terminal/TCP_Client.gif)
20+
21+
The above animation was generated using [TCP_Server.py](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/Firmware/Tools/TCP_Server.py).
22+
23+
## UDP Server
24+
25+
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).

docs/menu_wifi.md

-10
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,6 @@ WiFi is used for the following features:
2323
* Device Configuration (WiFi mode only)
2424
* PointPerfect Key renewal (RTK Facet L-Band only)
2525

26-
## TCP Client and Server
27-
28-
The RTK device supports connection over TCP. 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.
29-
30-
**Note:** Currently 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.
31-
32-
![TCP Port Entry](img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20TCP%20Port.png)
33-
34-
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://en.wikipedia.org/wiki/Gpsd)) but any port 0 to 65535 is supported.
35-
3626
## Configure Mode: AP vs WiFi
3727

3828
![Configure Mode in WiFi menu](img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20Configure%20Mode.png)

mkdocs.yml

+9-8
Original file line numberDiff line numberDiff line change
@@ -139,20 +139,21 @@ nav:
139139
- configure_with_settings_file.md
140140
- configure_with_ucenter.md
141141
- Configuration Menus:
142+
- menu_base.md
143+
- menu_data_logging.md
144+
- menu_debug.md
145+
- menu_ethernet.md
142146
- menu_gnss.md
143147
- menu_messages.md
144-
- menu_base.md
145-
- menu_wifi.md
148+
- menu_network.md
149+
- menu_ntp.md
150+
- menu_pointperfect.md
146151
- menu_ports.md
147-
- menu_data_logging.md
148152
- menu_profiles.md
149-
- menu_pointperfect.md
150-
- menu_sensor.md
151153
- menu_radios.md
154+
- menu_sensor.md
152155
- menu_system.md
153-
- menu_ethernet.md
154-
- menu_ntp.md
155-
- menu_debug.md
156+
- menu_wifi.md
156157
- Hardware:
157158
- firmware_update.md
158159
- displays.md

0 commit comments

Comments
 (0)