diff --git a/docs/displays.md b/docs/displays.md index 573675b53..f9720197f 100644 --- a/docs/displays.md +++ b/docs/displays.md @@ -4,6 +4,10 @@ Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported 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. +![RTK EVK - 1.3" OLED](img/Displays/SparkFun_RTK_EVK_LBand_Indicator.png) + +*Rover mode on the RTK EVK's 1.3" OLED display* + ## Power On/Off ![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 *Rover with location fix* +![RTK EVK with location fix and Ethernet connected](img/Displays/SparkFun_RTK_EVK_-_Main_Display_Icons.jpg) + +*RTK EVK with location fix and Ethernet connected* + Upon power up the device will enter either Rover mode or Base mode. Above, the Rover mode is displayed. * **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,6 +46,7 @@ Upon power up the device will enter either Rover mode or Base mode. Above, the R * Standard (three lines) is shown when the standard 5 NMEA messages are being logged * 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). * Custom (capital C) is shown when a custom set of messages are being recorded (not standard, and not PPP). +* **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. ## Rover RTK Fix @@ -45,6 +54,10 @@ Upon power up the device will enter either Rover mode or Base mode. Above, the R *Rover with RTK Fix and Bluetooth connected* +![RTK EVK with RTK Fix and Ethernet connected](img/Displays/SparkFun_RTK_EVK_LBand_Indicator.png) + +*RTK EVK with RTK Fix and Ethernet connected* + 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. ## Base Survey-In @@ -94,6 +107,10 @@ The unit will display various messages to aid the user in obtaining keys as need *Three-pronged satellite dish indicating L-Band reception* +![Three-pronged satellite dish indicating L-Band reception on RTK EVK](img/Displays/SparkFun_RTK_EVK_LBand_Indicator.png) + +*Three-pronged satellite dish indicating L-Band reception on RTK EVK* + 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. ## Antenna Detection @@ -102,11 +119,11 @@ Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported On devices that support it, open circuit and short circuit detection is available on the GNSS antenna connection. -![RTK EVK indicating antenna open circuit](img/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg) +![RTK EVK indicating antenna open circuit](img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg) *RTK EVK with the GNSS antenna disconnected (open circuit)* -![RTK EVK indicating antenna short circuit](img/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg) +![RTK EVK indicating antenna short circuit](img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg) *RTK EVK with a GNSS antenna cable fault (short circuit)* diff --git a/docs/img/Displays/SparkFun_RTK_EVK_-_Main_Display_Icons.jpg b/docs/img/Displays/SparkFun_RTK_EVK_-_Main_Display_Icons.jpg new file mode 100644 index 000000000..61c2d281a Binary files /dev/null and b/docs/img/Displays/SparkFun_RTK_EVK_-_Main_Display_Icons.jpg differ diff --git a/docs/img/WiFi Config/SparkFun RTK Web Config - Ethernet Configuration.png b/docs/img/WiFi Config/SparkFun RTK Web Config - Ethernet Configuration.png new file mode 100644 index 000000000..bed27aab4 Binary files /dev/null and b/docs/img/WiFi Config/SparkFun RTK Web Config - Ethernet Configuration.png differ diff --git a/docs/img/WiFi Config/SparkFun RTK Web Config - Firmware Update.png b/docs/img/WiFi Config/SparkFun RTK Web Config - Firmware Update.png new file mode 100644 index 000000000..e80fd0670 Binary files /dev/null and b/docs/img/WiFi Config/SparkFun RTK Web Config - Firmware Update.png differ diff --git a/docs/menu_ethernet.md b/docs/menu_ethernet.md index 75409d5d4..45909d641 100644 --- a/docs/menu_ethernet.md +++ b/docs/menu_ethernet.md @@ -6,12 +6,16 @@ An Ethernet-equipped RTK device sends and receives NTRIP correction data via Eth 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. -![RTK Device in DHCP mode](img/Terminal/Ethernet_DHCP.png) +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. -*The Reference Station Ethernet menu - with DHCP selected* +![RTK EVK in DHCP mode](img/Terminal/Ethernet_DHCP.png) -![Reference Station in fixed IP address mode](img/Terminal/Ethernet_Fixed_IP.png) +*The RTK EVK Ethernet menu - with DHCP selected* -*The Reference Station Ethernet menu - with a fixed IP address selected* +![RTK EVK in fixed IP address mode](img/Terminal/Ethernet_Fixed_IP.png) -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. \ No newline at end of file +*The RTK EVK Ethernet menu - with a fixed IP address selected* + +![RTK EVK Web Config - Ethernet Configuration]() + +*The RTK EVK Web Config page - Ethernet configuration with fixed IP address* diff --git a/docs/menu_firmware.md b/docs/menu_firmware.md index 771c539cc..c5125c46f 100644 --- a/docs/menu_firmware.md +++ b/docs/menu_firmware.md @@ -6,7 +6,12 @@ Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported]( *Firmware Update menu* -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). +![RTK EVK Web Config - Firmware Update]() + +*The RTK EVK Web Config page - firmware update* + +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. 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. +For more details, see [Update Firmware](firmware_update.md) \ No newline at end of file diff --git a/docs/menu_tcp_udp.md b/docs/menu_tcp_udp.md index 8b1ceffc3..f170b45c6 100644 --- a/docs/menu_tcp_udp.md +++ b/docs/menu_tcp_udp.md @@ -18,8 +18,6 @@ The RTK device supports connection over TCP. The TCP Client sits on top of the n 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. -![Ethernet TCP Client configuration](img/Terminal/Ethernet_TCP_Client_1.png) - ![Ethernet TCP Client connection](img/Terminal/TCP_Client.gif) The above animation was generated using [TCP_Server.py](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/blob/main/Firmware/Tools/TCP_Server.py).