Skip to content

Commit 8028dcb

Browse files
authored
Merge pull request #438 from sparkfun/EVK_docs
EVK docs
2 parents c705645 + 562eb5a commit 8028dcb

7 files changed

+34
-10
lines changed

docs/displays.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported
44

55
A variety of RTK devices utilize a 0.96" or 1.3" high-contrast OLED display. While small, the display packs various situational data that can be helpful in the field. This section describes each possible display state.
66

7+
![RTK EVK - 1.3" OLED](img/Displays/SparkFun_RTK_EVK_LBand_Indicator.png)
8+
9+
*Rover mode on the RTK EVK's 1.3" OLED display*
10+
711
## Power On/Off
812

913
![Startup and Shutdown Screens](img/Displays/SparkFun_RTK_Facet_-_Display_On_Off.jpg)
@@ -28,6 +32,10 @@ If the power state of a device is not known (for example, because a display may
2832

2933
*Rover with location fix*
3034

35+
![RTK EVK with location fix and Ethernet connected](img/Displays/SparkFun_RTK_EVK_-_Main_Display_Icons.jpg)
36+
37+
*RTK EVK with location fix and Ethernet connected*
38+
3139
Upon power up the device will enter either Rover mode or Base mode. Above, the Rover mode is displayed.
3240

3341
* **MAC:** The MAC address of the internal Bluetooth module. This is helpful knowledge when attempting to connect to the device from your phone. This will change to a Bluetooth symbol once connected.
@@ -38,13 +46,18 @@ Upon power up the device will enter either Rover mode or Base mode. Above, the R
3846
* Standard (three lines) is shown when the standard 5 NMEA messages are being logged
3947
* PPP (capital P) is shown when the standard 5 NMEA + RAWX and SFRBX messages are recorded. This is most often used for post process positioning (PPP) and 12 to 24-hour logs for [fixed permanent bases](permanent_base.md).
4048
* Custom (capital C) is shown when a custom set of messages are being recorded (not standard, and not PPP).
49+
* **IP Address:** On the RTK EVK 1.3" OLED, the full Ethernet or WiFi IP Address is shown at the bottom left of the display.
4150

4251
## Rover RTK Fix
4352

4453
![Rover with RTK Fix and Bluetooth connected](img/Displays/SparkFun_RTK_Express_-_Display_-_Rover_RTK_Fixed.jpg)
4554

4655
*Rover with RTK Fix and Bluetooth connected*
4756

57+
![RTK EVK with RTK Fix and Ethernet connected](img/Displays/SparkFun_RTK_EVK_LBand_Indicator.png)
58+
59+
*RTK EVK with RTK Fix and Ethernet connected*
60+
4861
Once NTRIP is enabled on your phone or RTCM data is being streamed into the **Radio** port the device will gain an RTK Fix. You should see the HPA drop to 14mm with a double circle bulls-eye as shown above.
4962

5063
## Base Survey-In
@@ -94,6 +107,10 @@ The unit will display various messages to aid the user in obtaining keys as need
94107

95108
*Three-pronged satellite dish indicating L-Band reception*
96109

110+
![Three-pronged satellite dish indicating L-Band reception on RTK EVK](img/Displays/SparkFun_RTK_EVK_LBand_Indicator.png)
111+
112+
*Three-pronged satellite dish indicating L-Band reception on RTK EVK*
113+
97114
Upon successful reception and decryption of L-Band corrections, the satellite dish icon will increase to a three-pronged icon. As the unit's fix increases the cross-hair will indicate a basic 3D solution, a double blinking cross-hair will indicate a floating RTK solution, and a solid double cross-hair will indicate a fixed RTK solution.
98115

99116
## Antenna Detection
@@ -102,11 +119,11 @@ Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported
102119

103120
On devices that support it, open circuit and short circuit detection is available on the GNSS antenna connection.
104121

105-
![RTK EVK indicating antenna open circuit](img/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg)
122+
![RTK EVK indicating antenna open circuit](img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg)
106123

107124
*RTK EVK with the GNSS antenna disconnected (open circuit)*
108125

109-
![RTK EVK indicating antenna short circuit](img/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg)
126+
![RTK EVK indicating antenna short circuit](img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg)
110127

111128
*RTK EVK with a GNSS antenna cable fault (short circuit)*
112129

17.4 KB
Loading
27.8 KB
Loading
24.3 KB
Loading

docs/menu_ethernet.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@ An Ethernet-equipped RTK device sends and receives NTRIP correction data via Eth
66

77
By default, the RTK device will use DHCP to request an IP Address from the network Gateway. But you can optionally configure it with a fixed IP Address.
88

9-
![RTK Device in DHCP mode](img/Terminal/Ethernet_DHCP.png)
9+
When enabled, the "Ethernet / WiFi Failover" option allows the firmware to automatically switch from Ethernet to WiFi should Ethernet become unavailable. Should WiFi become unavailable, the firmware will reconnect to Ethernet if it is now available.
1010

11-
*The Reference Station Ethernet menu - with DHCP selected*
11+
![RTK EVK in DHCP mode](img/Terminal/Ethernet_DHCP.png)
1212

13-
![Reference Station in fixed IP address mode](img/Terminal/Ethernet_Fixed_IP.png)
13+
*The RTK EVK Ethernet menu - with DHCP selected*
1414

15-
*The Reference Station Ethernet menu - with a fixed IP address selected*
15+
![RTK EVK in fixed IP address mode](img/Terminal/Ethernet_Fixed_IP.png)
1616

17-
When enabled, the "Ethernet / WiFi Failover" option allows the firmware to automatically switch from Ethernet to WiFi should Ethernet become unavailable. Should WiFi become unavailable, the firmware will reconnect to Ethernet if it is now available.
17+
*The RTK EVK Ethernet menu - with a fixed IP address selected*
18+
19+
![RTK EVK Web Config - Ethernet Configuration](<img/WiFi Config/SparkFun RTK Web Config - Ethernet Configuration.png>)
20+
21+
*The RTK EVK Web Config page - Ethernet configuration with fixed IP address*

docs/menu_firmware.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](
66

77
*Firmware Update menu*
88

9-
From time to time SparkFun will release new firmware for the RTK product line to add and improve functionality. For most users, firmware can be upgraded over WiFi using the [OTA method](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_update/#updating-firmware-over-the-air).
9+
![RTK EVK Web Config - Firmware Update](<img/WiFi Config/SparkFun RTK Web Config - Firmware Update.png>)
10+
11+
*The RTK EVK Web Config page - firmware update*
12+
13+
From time to time SparkFun will release new firmware for the RTK product line to add and improve functionality. For most users, firmware can be upgraded over WiFi using the [OTA method](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/firmware_update/#updating-firmware-over-the-air). For RTK EVU users, updates via Ethernet are also possible.
1014

1115
The Firmware Update menu allows users to check for and install updates. Turning on *Automatic firmware updates* will cause the device to periodically check and install updates when they become available. This can be helpful for remote stations that cannot have manual interventions.
1216

17+
For more details, see [Update Firmware](firmware_update.md)

docs/menu_tcp_udp.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ The RTK device supports connection over TCP. The TCP Client sits on top of the n
1818

1919
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.
2020

21-
![Ethernet TCP Client configuration](img/Terminal/Ethernet_TCP_Client_1.png)
22-
2321
![Ethernet TCP Client connection](img/Terminal/TCP_Client.gif)
2422

2523
The above animation was generated using [TCP_Server.py](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/Firmware/Tools/TCP_Server.py).

0 commit comments

Comments
 (0)