diff --git a/README.md b/README.md index 272c8eb52..f4b5bfd89 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,27 @@ The line of RTK Everywhere products offered by SparkFun all run identical firmwa - + + - + + - + +
SparkFun RTK Torch (GPS-24672)SparkFun RTK Torch (GPS-25662)SparkFun RTK EVK (GPS-24342)
Hookup GuideHookup GuideHookup Guide
-The [SparkFun RTK Torch](https://www.sparkfun.com/products/24672) is a centimeter-level GNSS receiver. With RTK enabled, these devices can output your location with 8mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/accuracy_verification/) at up to 20Hz! +The [SparkFun RTK Torch](https://www.sparkfun.com/products/25662) is a centimeter-level GNSS receiver. With RTK enabled, these devices can output your location with 8mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/accuracy_verification/) at up to 20Hz. It supports Galileo E6 HAS and has built-in tilt compensation too! + +The [SparkFun RTK EVK](https://www.sparkfun.com/products/24342) is the perfect development platform for your fixed or mobile high-precision positioning and navigation needs. We called it the EVK (Evaluation Kit) as it truly covers all the options: L1 + L2 RTK GNSS, with L-Band correction built-in. Regarding connectivity, the SparkFun RTK EVK has it all: WiFi / Bluetooth®, Ethernet and LTE cellular! This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware) and the firmware that runs on the SparkFun RTK product line including: -* [SparkFun RTK Torch](https://www.sparkfun.com/products/24672) +* [SparkFun RTK Torch](https://www.sparkfun.com/products/25662) +* [SparkFun RTK EVK](https://www.sparkfun.com/products/24342) For compiled binaries of the firmware, please see [SparkFun RTK Everywhere Firmware Binaries](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware_Binaries). diff --git a/docs/accuracy_verification.md b/docs/accuracy_verification.md index 14ee07c6e..5f1add5f2 100644 --- a/docs/accuracy_verification.md +++ b/docs/accuracy_verification.md @@ -1,6 +1,6 @@ # Accuracy Verification -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![Facet in the field](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2016%20Facet%20in%20the%20Field.jpg) diff --git a/docs/configure_with_bluetooth.md b/docs/configure_with_bluetooth.md index 86aa52d5b..28b1ca4d8 100644 --- a/docs/configure_with_bluetooth.md +++ b/docs/configure_with_bluetooth.md @@ -1,6 +1,6 @@ # Configure with Bluetooth -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![Configuration menu open over Bluetooth](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png) diff --git a/docs/configure_with_serial.md b/docs/configure_with_serial.md index 82d936344..3816e0ed2 100644 --- a/docs/configure_with_serial.md +++ b/docs/configure_with_serial.md @@ -1,6 +1,6 @@ # Configure with Serial -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) **Note:** Any serial menu that is shown below can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information. diff --git a/docs/configure_with_settings_file.md b/docs/configure_with_settings_file.md index 164066c68..5d3d6454c 100644 --- a/docs/configure_with_settings_file.md +++ b/docs/configure_with_settings_file.md @@ -1,6 +1,6 @@ # Configure with Settings File -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![SparkFun RTK Facet Settings File](img/SparkFun_RTK_Express_-_Settings_File.jpg) diff --git a/docs/configure_with_ucenter.md b/docs/configure_with_ucenter.md index 727486514..afa2f902b 100644 --- a/docs/configure_with_ucenter.md +++ b/docs/configure_with_ucenter.md @@ -1,6 +1,6 @@ # Configure with u-center -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) On devices that have a u-blox GNSS receiver, the ZED-F9P GNSS module can be configured independently using the u-center software from u-blox by connecting a USB cable to the *Config u-blox* USB connector. Settings can be saved to the module between power cycles. For more information please see SparkFun’s [Getting Started with u-center by u-blox](https://learn.sparkfun.com/tutorials/getting-started-with-u-center-for-u-blox/all). diff --git a/docs/configure_with_wifi.md b/docs/configure_with_wifi.md index e663aa6a0..7bde4b8d7 100644 --- a/docs/configure_with_wifi.md +++ b/docs/configure_with_wifi.md @@ -1,6 +1,6 @@ # Configure with WiFi -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![SparkFun RTK WiFi Configuration Interface]() diff --git a/docs/connecting_bluetooth.md b/docs/connecting_bluetooth.md index a0e34475f..c59e47e0d 100644 --- a/docs/connecting_bluetooth.md +++ b/docs/connecting_bluetooth.md @@ -1,6 +1,6 @@ # Connecting Bluetooth -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) SparkFun RTK devices transmit full NMEA sentences over Bluetooth serial port profile (SPP) at 2Hz and 115200bps. This means that nearly any GIS application that can receive NMEA data over a serial port (almost all do) can be used with SparkFun RTK devices. As long as your end system can open a serial port over Bluetooth (also known as SPP) your system can retrieve industry-standard NMEA positional data. The following steps show how to connect an external tablet, or cell phone to the RTK device so that any serial port-based GIS application can be used. diff --git a/docs/correction_sources.md b/docs/correction_sources.md index 4521004ac..05b872835 100644 --- a/docs/correction_sources.md +++ b/docs/correction_sources.md @@ -1,6 +1,6 @@ # Correction Sources -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) To get millimeter accuracy we need to provide the RTK unit with correction values. Corrections, often called RTCM, help the RTK unit refine its position calculations. RTCM (Radio Technical Commission for Maritime Services) can be obtained from a variety of sources but they fall into three buckets: Commercial, Public, and Civilian Reference Stations. diff --git a/docs/correction_transport.md b/docs/correction_transport.md index e1b7442be..37dd97166 100644 --- a/docs/correction_transport.md +++ b/docs/correction_transport.md @@ -6,7 +6,7 @@ RTK calculations require RTCM data to be delivered approximately once per second ## WiFi -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![NTRIP Server setup]() @@ -20,9 +20,9 @@ WiFi broadcasting is the most common transport method of getting RTCM correction Similarly, any SparkFun RTK device can be set up as an [NTRIP Client](menu_gnss.md#ntrip-client). The RTK device will connect to the local WiFi and begin downloading the RTCM data from the given NTRIP Caster and RTK Fix will be achieved. This is useful only if the Rover remains in RF range of a WiFi access point. Because of the limited range, we recommend using a cell phone's hotspot feature rather than a stationary WiFi access point for NTRIP Clients. -## Cellular +## Cellular - Via Cellphone -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![SW Maps NTRIP Client](img/SWMaps/SW_Maps_-_NTRIP_Client.jpg) @@ -32,9 +32,18 @@ Shown above are SW Map's NTRIP Client Settings. Nearly all GIS applications have Cellular can even be used in Base mode. We have seen some very inventive users use an old cell phone as a WiFi access point. The base unit is configured as an NTRIP Server with the cellphone's WiFi AP credentials. The base performs a survey-in, connects to the WiFi, and the RTCM data is pushed over WiFi, over cellular, to an NTRIP Caster. +## Cellular - Built-In + +Torch: ![Feature Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png) + +The RTK EVK has built-in cellular via a u-blox LARA-R6001D. However, the RTK Everywhere firmware does not yet support cellular. Adding it is on our roadmap. Stay tuned for updates! Meanwhile, we do have a stand-alone EVK code example which will connect to PointPerfect localized distribution via cellular: + + * [EVK example 8_5_PointPerfect_MQTT](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_5_PointPerfect_MQTT) + * [EVK example 8_6_PointPerfect_MQTT_WiFi_ETH_Cellular](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Example_Sketches/8_6_PointPerfect_MQTT_WiFi_ETH_Cellular) + ## L-Band -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) What if you are in the field, far away from WiFi, cellular, radio, or any other data connection? Look to the sky! @@ -42,11 +51,11 @@ A variety of companies provide GNSS RTK corrections broadcast from satellites ov These corrections are not as accurate as a fixed base station, and the corrections can require a monthly subscription fee, but you cannot beat the ease of use! -L-Band reception requires specialized RF receivers capable of demodulating the satellite transmissions. Currently, the [RTK Facet L-Band](https://www.sparkfun.com/products/20000) is the only product that supports L-Band correction reception. +L-Band reception requires specialized RF receivers capable of demodulating the satellite transmissions. The RTK EVK has a built-in NEO-D9S corrections receiver. The RTK Everywhere firmware supports this and will tune the NEO-D9S to the correct frequency if you are in the US or EU. The PointPerfect L-Band corrections are encrypted and require a subscription and valid keys in order to work. The EVK comes with a one month free subscription to PointPerfect L-Band + IP, providing built-in support for L-Band corrections and IP corrections via Ethernet or WiFi. ## Serial Radios -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![Two serial radios](img/Corrections/19032-SiK_Telemetry_Radio_V3_-_915MHz__100mW-01.jpg) @@ -58,6 +67,8 @@ On SparkFun RTK products that have an external radio port, a [4-pin to 6-pin cab ![Radio attached to RTK device](img/Corrections/SparkFun_RTK_Surveyor_-_Radio.jpg) +The RTK EVK has screw cage terminals providing access to the ZED-F9P UART2 TX2 and RX2 pins. 3.3V power is provided too, but not 5V. For 5V radios, you may need an additional power source. + These radios attach nicely to the back or bottom of an RTK device. The benefit of a serial telemetry radio link is that you do not need to configure anything; simply plug two radios onto two RTK devices and turn them on. @@ -66,7 +77,7 @@ The downside to serial telemetry radios is that they generally have a much short ## Ethernet -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) Ethernet-equipped RTK devices send and receive correction data via Ethernet. diff --git a/docs/displays.md b/docs/displays.md index 19f30ad30..573675b53 100644 --- a/docs/displays.md +++ b/docs/displays.md @@ -1,6 +1,6 @@ # Displays -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) 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. @@ -80,7 +80,7 @@ Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. Y ## L-Band -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) L-Band decryption keys are valid for a maximum of 56 days. During that time, the RTK Facet L-Band can operate normally without the need for WiFi access. However, when the keys are set to expire in 28 days or less, the RTK Facet L-Band will attempt to log in to the 'Home' WiFi at each power on. If WiFi is not available, it will continue normal operation. @@ -98,18 +98,15 @@ Upon successful reception and decryption of L-Band corrections, the satellite di ## Antenna Detection -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) On devices that support it, open circuit and short circuit detection is available on the GNSS antenna connection. -![Reference Station indicating antenna open circuit](img/Displays/Antenna_Open.png) +![RTK EVK indicating antenna open circuit](img/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg) -*Reference Station with the GNSS antenna disconnected (open circuit)* +*RTK EVK with the GNSS antenna disconnected (open circuit)* -![Reference Station indicating antenna short circuit](img/Displays/Antenna_Short.png) +![RTK EVK indicating antenna short circuit](img/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg) -*Reference Station with a GNSS antenna cable fault (short circuit)* +*RTK EVK with a GNSS antenna cable fault (short circuit)* -When and ethernet-equipped RTK device is in Network Time Protocol (NTP) mode, the display also shows a clock symbol - as shown above. The value next to the clock symbol is the Time Accuracy Estimate (tAcc) from the UBX-NAV-PVT message. - -Note: tAcc is the time accuracy estimate for the navigation position solution. The timing accuracy of the TP pulse is significantly better than this. We show the tAcc as we believe it is more meaningful than the TIM-TP time pulse quantization error (qErr) - which is generally zero. diff --git a/docs/embeddedsystem_connection.md b/docs/embeddedsystem_connection.md index b9a0d5dba..65cd39647 100644 --- a/docs/embeddedsystem_connection.md +++ b/docs/embeddedsystem_connection.md @@ -4,13 +4,13 @@ Many applications using the RTK products will use a 3rd party GIS application or ## USB -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) Most SparkFun RTK devices have a USB port for programming and status reports. This USB port can also be configured to output full NMEA/RTCM output that can be used to create a wired connection to an embedded system. See [Output GNSS Data over USB](menu_ports.md#output-gnss-data-over-usb) for more information. ## DATA Port -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png) For this example, we will connect the output from the **DATA** port of an RTK Facet to a [USB to Serial adapter](https://www.sparkfun.com/products/15096) so that we can view the serial data over a terminal connection. @@ -37,7 +37,7 @@ The parsing of NMEA sentences is straightforward and left to the reader. There a ## External Terminals -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) On devices that support it, external screw terminals provide direct access to the GNSS TX and RX signals via the 3.5mm screw terminal I/O header: @@ -47,4 +47,4 @@ On devices that support it, external screw terminals provide direct access to th * RX2 : u-blox ZED-F9P UART2 receive: 3.3V INPUT -Please see the [Reference Station Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-reference-station-hookup-guide#hardware-overview) for more details. \ No newline at end of file +Please see the [EVK Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_EVK/hardware_overview/#zed-f9p-secondary-uart-port) for more details. \ No newline at end of file diff --git a/docs/firmware_update.md b/docs/firmware_update.md index 6b27dd10e..771acb0ff 100644 --- a/docs/firmware_update.md +++ b/docs/firmware_update.md @@ -1,6 +1,6 @@ # Update Firmware -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) The device has two primary firmwares: diff --git a/docs/gis_software_android.md b/docs/gis_software_android.md index ffdbcb082..356db6ccf 100644 --- a/docs/gis_software_android.md +++ b/docs/gis_software_android.md @@ -1,6 +1,6 @@ # Android -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) While we recommend [SW Maps for Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_android/#sw-maps), there are a variety of 3rd party apps available for GIS and surveying for [Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_android/), [iOS](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_ios/), and [Windows](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_windows/). We will cover a few examples below that should give you an idea of how to get the incoming NMEA data into the software of your choice. diff --git a/docs/gis_software_ios.md b/docs/gis_software_ios.md index c42ec2508..1040d6d72 100644 --- a/docs/gis_software_ios.md +++ b/docs/gis_software_ios.md @@ -1,6 +1,6 @@ # iOS -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) There are a variety of 3rd party apps available for GIS and surveying for [Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_android/), [iOS](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_ios/), and [Windows](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_windows/). We will cover a few examples below that should give you an idea of how to get the incoming NMEA data into the software of your choice. diff --git a/docs/gis_software_windows.md b/docs/gis_software_windows.md index 51c451094..e3ed44dc4 100644 --- a/docs/gis_software_windows.md +++ b/docs/gis_software_windows.md @@ -1,6 +1,6 @@ # Windows -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) There are a variety of 3rd party apps available for GIS and surveying for [Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_android/), [iOS](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_ios/), and [Windows](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/gis_software_windows/). We will cover a few examples below that should give you an idea of how to get the incoming NMEA data into the software of your choice. diff --git a/docs/img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif b/docs/img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif new file mode 100644 index 000000000..b2017b0d9 Binary files /dev/null and b/docs/img/24342-RTK-EVK-Action-Screen_GIF_750ms.gif differ diff --git a/docs/img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg b/docs/img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg new file mode 100644 index 000000000..08039c56e Binary files /dev/null and b/docs/img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Open_Highlighted.jpg differ diff --git a/docs/img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg b/docs/img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg new file mode 100644 index 000000000..fffaa0156 Binary files /dev/null and b/docs/img/Displays/SparkFun-RTK-EVK-OLED_Antenna_Short_Highlighted.jpg differ diff --git a/docs/img/SparkFun_EVK_SWMaps_iOS_1.png b/docs/img/SparkFun_EVK_SWMaps_iOS_1.png new file mode 100644 index 000000000..b3f07ec33 Binary files /dev/null and b/docs/img/SparkFun_EVK_SWMaps_iOS_1.png differ diff --git a/docs/img/SparkFun_EVK_SWMaps_iOS_2.png b/docs/img/SparkFun_EVK_SWMaps_iOS_2.png new file mode 100644 index 000000000..0345a708e Binary files /dev/null and b/docs/img/SparkFun_EVK_SWMaps_iOS_2.png differ diff --git a/docs/img/SparkFun_RTK_EVK.jpg b/docs/img/SparkFun_RTK_EVK.jpg new file mode 100644 index 000000000..89c367100 Binary files /dev/null and b/docs/img/SparkFun_RTK_EVK.jpg differ diff --git a/docs/img/SparkFun_RTK_EVK.png b/docs/img/SparkFun_RTK_EVK.png new file mode 100644 index 000000000..f959399d1 Binary files /dev/null and b/docs/img/SparkFun_RTK_EVK.png differ diff --git a/docs/img/SparkFun_RTK_EVK_Kit.jpg b/docs/img/SparkFun_RTK_EVK_Kit.jpg new file mode 100644 index 000000000..d319695a8 Binary files /dev/null and b/docs/img/SparkFun_RTK_EVK_Kit.jpg differ diff --git a/docs/img/Terminal/Ethernet_DHCP.png b/docs/img/Terminal/Ethernet_DHCP.png index 632da78a0..b58647ca3 100644 Binary files a/docs/img/Terminal/Ethernet_DHCP.png and b/docs/img/Terminal/Ethernet_DHCP.png differ diff --git a/docs/img/Terminal/Ethernet_Fixed_IP.png b/docs/img/Terminal/Ethernet_Fixed_IP.png index 7dd3f35d1..870a482de 100644 Binary files a/docs/img/Terminal/Ethernet_Fixed_IP.png and b/docs/img/Terminal/Ethernet_Fixed_IP.png differ diff --git a/docs/img/WiFi Config/SparkFun RTK PointPerfect Config.png b/docs/img/WiFi Config/SparkFun RTK PointPerfect Config.png index 87279f7dc..6bbbdf70a 100644 Binary files a/docs/img/WiFi Config/SparkFun RTK PointPerfect Config.png and b/docs/img/WiFi Config/SparkFun RTK PointPerfect Config.png differ diff --git a/docs/index.md b/docs/index.md index 1fa11f0a9..63457f0be 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,13 +6,16 @@ The line of RTK Everywhere products offered by SparkFun all run identical firmwa - + + - + + +
SparkFun RTK Torch (GPS-26250)SparkFun RTK Torch (GPS-25662)SparkFun RTK EVK (GPS-24342)
Hookup GuideHookup Guide
@@ -24,6 +27,7 @@ There are multiple ways to configure an RTK product: * [WiFi](configure_with_wifi.md) - Good for in-field changes * [Serial Terminal](configure_with_serial.md) - Requires a computer but allows for all configuration settings * [Settings File](configure_with_settings_file.md) - Used for configuring multiple RTK devices identically +* [Ethernet](configure_with_ethernet.md) - RTK EVK only The Bluetooth or Serial Terminal methods are recommended for most advanced configurations. Most, but not all settings are also available over WiFi but can be tricky to input via mobile phone. diff --git a/docs/intro.md b/docs/intro.md index 532f9e088..98d915345 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -8,3 +8,8 @@ Which device are you using? * [RTK Torch Quick Start](quickstart-torch.md) * [RTK Torch Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_Torch/) + +[![RTK EVK](img/SparkFun_RTK_EVK.png)](quickstart-evk.md) + +* [RTK EVK Quick Start](quickstart-evk.md) +* [RTK EVK Hookup Guide](https://docs.sparkfun.com/SparkFun_RTK_EVK/) diff --git a/docs/menu_base.md b/docs/menu_base.md index 170e58158..e0d0adc40 100644 --- a/docs/menu_base.md +++ b/docs/menu_base.md @@ -1,6 +1,6 @@ # Base Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) In addition to providing accurate local location fixes, SparkFun RTK devices can also serve as a correction source, also called a *Base*. The Base doesn't move and 'knows' where it is so it can calculate the discrepancies between the signals it is receiving and what it should be receiving. Said differently, the 'Base' is told where it is, and that it's not moving. If the GPS signals say otherwise, the Base knows there was a disturbance in the ~~Force~~ ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter-level accuracy. diff --git a/docs/menu_corrections_priorities.md b/docs/menu_corrections_priorities.md index bea46efd6..3bb89e58c 100644 --- a/docs/menu_corrections_priorities.md +++ b/docs/menu_corrections_priorities.md @@ -1,6 +1,6 @@ # Corrections Priorities -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![RTK Corrections Priorities Menu]() diff --git a/docs/menu_data_logging.md b/docs/menu_data_logging.md index b27e652e7..6e06c1f01 100644 --- a/docs/menu_data_logging.md +++ b/docs/menu_data_logging.md @@ -1,6 +1,6 @@ # Data Logging Menu -Torch: ![Feature Supported](img/Icons/RedDot.png) +Torch: ![Feature Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) **Note:** Not all devices support external SD (ie, RTK Torch). This section applies only to devices that support an external SD card, and have one inserted. diff --git a/docs/menu_debug_hardware.md b/docs/menu_debug_hardware.md index 2e4ba8728..ce70a3bb1 100644 --- a/docs/menu_debug_hardware.md +++ b/docs/menu_debug_hardware.md @@ -1,5 +1,5 @@ # Debug Hardware Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) TODO diff --git a/docs/menu_debug_network.md b/docs/menu_debug_network.md index df367dfca..cc042de63 100644 --- a/docs/menu_debug_network.md +++ b/docs/menu_debug_network.md @@ -1,5 +1,5 @@ # Debug Network Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) TODO diff --git a/docs/menu_debug_periodic_print.md b/docs/menu_debug_periodic_print.md index 38103d740..805338993 100644 --- a/docs/menu_debug_periodic_print.md +++ b/docs/menu_debug_periodic_print.md @@ -1,5 +1,5 @@ # Configure Periodic Print Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) TODO \ No newline at end of file diff --git a/docs/menu_debug_rtk_operation.md b/docs/menu_debug_rtk_operation.md index 87a2d5daf..404df3523 100644 --- a/docs/menu_debug_rtk_operation.md +++ b/docs/menu_debug_rtk_operation.md @@ -1,5 +1,5 @@ # Configure RTK Operation Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) TODO \ No newline at end of file diff --git a/docs/menu_debug_software.md b/docs/menu_debug_software.md index 552c53ee3..bacfd1f33 100644 --- a/docs/menu_debug_software.md +++ b/docs/menu_debug_software.md @@ -1,5 +1,5 @@ # Debug Software Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) TODO \ No newline at end of file diff --git a/docs/menu_ethernet.md b/docs/menu_ethernet.md index bf6e1b2b6..75409d5d4 100644 --- a/docs/menu_ethernet.md +++ b/docs/menu_ethernet.md @@ -1,6 +1,6 @@ # Ethernet Menu -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) An Ethernet-equipped RTK device sends and receives NTRIP correction data via Ethernet. It can also send NMEA and RTCM navigation messages to an external TCP Server via Ethernet. It also has a dedicated Configure-Via-Ethernet (*Cfg Eth*) mode which is accessed via the MODE button and OLED display. @@ -14,12 +14,4 @@ By default, the RTK device will use DHCP to request an IP Address from the netwo *The Reference Station Ethernet menu - with a fixed IP address selected* -## Ethernet TCP Client - -Ethernet-equipped RTK devices can act as an Ethernet TCP Client, sending NMEA and / or UBX data to a remote TCP Server. This is similar to the WiFi TCP Client mode on our other RTK products, but the data can be sent to any server based on its IP Address or URL. E.g. to connect to a local machine via its IP Address, select option "c" and then enter the IP Address using option "h" - -![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). \ No newline at end of file +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 diff --git a/docs/menu_firmware.md b/docs/menu_firmware.md index 0269e16e6..771c539cc 100644 --- a/docs/menu_firmware.md +++ b/docs/menu_firmware.md @@ -1,6 +1,6 @@ # Firmware Update Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![Firmware update menu]() diff --git a/docs/menu_gnss.md b/docs/menu_gnss.md index b60187f24..ea56ae835 100644 --- a/docs/menu_gnss.md +++ b/docs/menu_gnss.md @@ -1,6 +1,6 @@ # GNSS Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) The SparkFun RTK product line is immensely configurable. The RTK device will, by default, put the GNSS receiver into the most common configuration for rover/base RTK for use with *SW Maps* and other GIS applications. diff --git a/docs/menu_messages.md b/docs/menu_messages.md index f4583f234..830992ba2 100644 --- a/docs/menu_messages.md +++ b/docs/menu_messages.md @@ -1,6 +1,6 @@ # Messages Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![Message rate configuration]() diff --git a/docs/menu_ntp.md b/docs/menu_ntp.md index 08a92dcbc..9de6bae78 100644 --- a/docs/menu_ntp.md +++ b/docs/menu_ntp.md @@ -1,6 +1,6 @@ # Network Time Protocol Menu -Torch: ![Feature Not Supported](img/Icons/RedDot.png) +Torch: ![Feature Not Supported](img/Icons/RedDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) Ethernet-equipped RTK devices can act as an Ethernet Network Time Protocol (NTP) server. @@ -29,15 +29,17 @@ This exchange is repeated typically five times, before the client synchronizes i Having your own NTP server on your network allows tighter clock synchronization as the network latency is minimized. -Ethernet-equipped RTK devices can be placed into dedicated NTP mode, by pressing the **MODE** button until NTP is highlighted in the display and pausing there. +Ethernet-equipped RTK devices can be placed into dedicated NTP mode, by clicking the **MODE** button until NTP is highlighted in the display and double-clicking there. ![Animation of selecting NTP mode]() *Selecting NTP mode* -Ethernet-equipped RTK devices will first synchronize its Real Time Clock (RTC) using the very accurate time provided by the u-blox GNSS module. The module's Time Pulse (Pulse-Per-Second) signal is connected to the ESP32 as an interrupt. The ESP32's RTC is synchronized to Universal Time Coordinate (UTC) on the rising edge of the TP signal using the time contained in the UBX-TIM-TP message. +An Ethernet-equipped RTK device will first synchronize its Real Time Clock (RTC) using the very accurate time provided by the u-blox GNSS module. The module's Time Pulse (Pulse-Per-Second) signal is connected to the ESP32 as an interrupt. The ESP32's RTC is synchronized to Universal Time Coordinate (UTC) on the rising edge of the TP signal using the time contained in the UBX-TIM-TP message. -The WIZnet W5500 interrupt signal is also connected to the ESP32, allowing the ESP32 to accurately log when each NTP request arrives. +When an Ethernet-equipped RTK device is in Network Time Protocol (NTP) mode, the display also shows a clock symbol - as shown above. The value next to the clock symbol is the Time Accuracy Estimate (tAcc) from the UBX-NAV-PVT message. + +Note: tAcc is the time accuracy estimate for the navigation position solution. The timing accuracy of the TP pulse is significantly better than this. We show the tAcc as we believe it is more meaningful than the TIM-TP time pulse quantization error (qErr) - which is generally zero. The RTK device will respond to each NTP request within a few 10s of milliseconds. diff --git a/docs/menu_pointperfect.md b/docs/menu_pointperfect.md index 6a23e22cc..59bd4aa41 100644 --- a/docs/menu_pointperfect.md +++ b/docs/menu_pointperfect.md @@ -1,6 +1,6 @@ # PointPerfect Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![PointPerfect Menu]() @@ -20,7 +20,7 @@ SparkFun RTK devices are equipped to get corrections from a service called Point PointPerfect has the following benefits and challenges: -* Most SparkFun RTK devices come with either a pre-paid subscription or one month of free access to PointPerfect. Please see the product details for your device. [Go here](https://www.sparkfun.com/rtk_torch_registration) to enable or renew your subscription. +* Most SparkFun RTK devices come with either a pre-paid subscription or one month of free access to PointPerfect. Please see the product details for your device. [Go here for RTK Torch](https://www.sparkfun.com/rtk_torch_registration) to enable or renew your subscription. [Go here for RTK EVK](https://www.sparkfun.com/rtk_evk_registration) subscriptions. * A SparkFun RTK device can obtain RTK Fix anywhere there is [coverage](https://www.u-blox.com/en/pointperfect-service-coverage). This includes the US contiguous 48 states, the EU, Korea, as well as parts of Australia, Brazil, and Canada. Note: L-Band coverage is not available in some of these areas. * You don't need to be near a base station - the PPP-RTK model covers entire continents. * Because PointPerfect uses a model instead of a dedicated base station, it is cheaper. However, the RTK Fix is not as accurate (3-6cm) as compared to getting corrections from a dedicated base station (2cm or better but depends on the baseline distance). @@ -30,7 +30,7 @@ PointPerfect corrections are obtained by two methods: * **L-Band**: Corrections are transmitted from a geosynchronous satellite. Coverage areas are limited to the US contiguous 48 states and the EU. This delivery method requires special equipment (see the [RTK Facet L-Band](https://www.sparkfun.com/products/20000) for more information). No cellular or internet connection is required. -* **IP**: Corrections are transmitted over the internet. The RTK device will need access to a WiFi network. This is most commonly a hotspot on a cell phone so this delivery method is generally confined to areas with cellular and/or WiFi coverage. +* **IP**: Corrections are transmitted over the internet. The RTK device will need access to a WiFi or Ethernet network. For WiFi, this is most commonly a hotspot on a cell phone so this delivery method is generally confined to areas with cellular and/or other WiFi coverage. ## Registration @@ -38,7 +38,11 @@ PointPerfect corrections are obtained by two methods: *Three stickers showing Device ID and QR code to registration page* -All SparkFun RTK products must be registered before they are allowed on the PointPerfect network. To facilitate this, most products ship with a printed Device ID sticker and registration QR code included with the product. The QR code will prefill the registration page with the device's unique ID. If you do not have these materials, don't worry! Please visit the [registration page](https://www.sparkfun.com/rtk_torch_registration) and [obtain your device ID](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#obtaining-the-device-id) through the software interface. +All SparkFun RTK products must be registered before they are allowed on the PointPerfect network. To facilitate this, most products ship with a printed Device ID sticker and registration QR code included with the product. The QR code will prefill the registration page with the device's unique ID. If you do not have these materials, don't worry! + +* **RTK Torch:** please visit the [RTK Torch registration page](https://www.sparkfun.com/rtk_torch_registration) and [obtain your device ID](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#obtaining-the-device-id) through the software interface. + +* **RTK EVK:** please visit the [RTK EVK registration page](https://www.sparkfun.com/rtk_evk_registration) and [obtain your device ID](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#obtaining-the-device-id) through the software interface. ## Keys @@ -70,7 +74,7 @@ The *Days until keys expire* inform the user how many days the unit has until it * **3** - Trigger an immediate attempt to connect over WiFi and provision the device (if no keys are available) or update the keys (if provisioning has already been completed). -* **4** - Display the Device ID. This is needed when a SparkFun RTK device needs to be added to the PointPerfect system. This is needed when first registering the device, or modifying a subscription. [Go here](https://www.sparkfun.com/rtk_torch_registration) to manage subscriptions. +* **4** - Display the Device ID. This is needed when a SparkFun RTK device needs to be added to the PointPerfect system. This is needed when first registering the device, or modifying a subscription. [Go here for RTK Torch](https://www.sparkfun.com/rtk_torch_registration) to enable or renew your subscription. [Go here for RTK EVK](https://www.sparkfun.com/rtk_evk_registration) subscriptions. * **c** - Clear the current keys. @@ -122,7 +126,7 @@ This message is seen when no WiFi network credentials (SSID and password) have b This device is not whitelisted. Please contact support@sparkfun.com to get your subscription activated. Please reference device ID: [device ID] -This message is seen whenever the PointPerfect service is not aware of the given device. Please use the [subscription form](https://www.sparkfun.com/rtk_torch_registration) or contact support@sparkfun.com with your device ID (see [Obtaining the Device ID](menu_pointperfect.md#obtaining-the-device-id) above). +This message is seen whenever the PointPerfect service is not aware of the given device. Please use the subscription form or contact support@sparkfun.com with your device ID (see [Obtaining the Device ID](#obtaining-the-device-id) above). [Go here for RTK Torch](https://www.sparkfun.com/rtk_torch_registration) subscriptions. [Go here for RTK EVK](https://www.sparkfun.com/rtk_evk_registration) subscriptions. ### Device Deactivated diff --git a/docs/menu_ports.md b/docs/menu_ports.md index 46317fee8..6dde26a91 100644 --- a/docs/menu_ports.md +++ b/docs/menu_ports.md @@ -1,6 +1,6 @@ # Ports Menu -Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) +Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) / EVK: ![Feature Supported](img/Icons/YellowDot.png) ![Setting the baud rate of the ports]() diff --git a/docs/menu_radios.md b/docs/menu_radios.md index d7bf1003c..8b05f002a 100644 --- a/docs/menu_radios.md +++ b/docs/menu_radios.md @@ -2,7 +2,7 @@ ## ESP-Now -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![Radio menu showing ESP-Now]() @@ -28,7 +28,7 @@ ESP-Now is a free radio included in every RTK product and works well, but it has ![Pairing Menu](img/Displays/SparkFun%20RTK%20Radio%20E-Pair.png) -On devices that have a display, pressing the Power/Setup button will display the various submenus. Pausing on E-Pair will put the unit into ESP-Now pairing mode. If another RTK device is detected nearby in pairing mode, they will exchange MAC addresses and pair with each other. Multiple Rover units can be paired to a Base in the same fashion. +On devices that have a display, clicking the Mode button will display the various submenus. Double-clicking on E-Pair will put the unit into ESP-Now pairing mode. If another RTK device is detected nearby in pairing mode, they will exchange MAC addresses and pair with each other. Multiple Rover units can be paired to a Base in the same fashion. ![Radio menu during AP-Config]() diff --git a/docs/menu_system.md b/docs/menu_system.md index f78ee922b..bf0aa90f4 100644 --- a/docs/menu_system.md +++ b/docs/menu_system.md @@ -1,6 +1,6 @@ # System Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![System Menu accessed over serial]() diff --git a/docs/menu_tcp_udp.md b/docs/menu_tcp_udp.md index 9cbb4e7b9..8b1ceffc3 100644 --- a/docs/menu_tcp_udp.md +++ b/docs/menu_tcp_udp.md @@ -1,6 +1,6 @@ # TCP/UDP Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) 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. @@ -10,14 +10,20 @@ NMEA data is generally consumed by a GIS application or Data Collector. These me ## TCP Client and Server -The RTK device supports connection over TCP. The TCP Client sits on top of the network layer 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. +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. -**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. +**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. ![TCP Port Entry](img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20TCP%20Port.png) 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). + ## UDP Server -NMEA messages can also be sent via UDP rather than TCP. If enabled, the UDP Server will begin broadcasting NMEA data over the specific port (default 10110). +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). diff --git a/docs/menu_tilt.md b/docs/menu_tilt.md index 0dba53667..6e3b9ec17 100644 --- a/docs/menu_tilt.md +++ b/docs/menu_tilt.md @@ -1,6 +1,6 @@ # Tilt Compensation Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png) ![Tilt Compensation menu]() diff --git a/docs/menu_userprofiles.md b/docs/menu_userprofiles.md index e7bd02e17..be512d2bb 100644 --- a/docs/menu_userprofiles.md +++ b/docs/menu_userprofiles.md @@ -1,6 +1,6 @@ # User Profiles Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![List of user profiles]() diff --git a/docs/menu_wifi.md b/docs/menu_wifi.md index 3d3cb72ee..3a9181741 100644 --- a/docs/menu_wifi.md +++ b/docs/menu_wifi.md @@ -1,6 +1,6 @@ # WiFi Menu -Torch: ![Feature Supported](img/Icons/GreenDot.png) +Torch: ![Feature Supported](img/Icons/GreenDot.png) / EVK: ![Feature Supported](img/Icons/GreenDot.png) ![WiFi Network Entry]() diff --git a/docs/quickstart-evk.md b/docs/quickstart-evk.md new file mode 100644 index 000000000..45cdceaf8 --- /dev/null +++ b/docs/quickstart-evk.md @@ -0,0 +1,175 @@ +# Quick Start - RTK EVK + +![RTK EVK](img/SparkFun_RTK_EVK.png) + +This quick start guide will get you started in 10 minutes or less. For the full product manual, please proceed to the [**Introduction**](index.md). + +Are you using [Android](#android) or [iOS](#ios)? + +## Android + +1. Download [SW Maps](https://play.google.com/store/apps/details?id=np.com.softwel.swmaps). This may not be the GIS software you intend to do your data collection, but SW Maps is free and makes sure everything is working correctly out of the box. + + ![Download SW Maps]() + + *Download SW Maps for Android* + +2. Connect the antennas. + + * The RTK EVK has its own [hookup guide](http://docs.sparkfun.com/SparkFun_RTK_EVK/) which has a dedicated section on [hardware hookup](https://docs.sparkfun.com/SparkFun_RTK_EVK/hardware_hookup/). As a minimum: + * Position the L1/L2/L5 GNSS antenna outside, with a clear view of the sky + * Connect the GNSS antenna to the EVK using the supplied TNC-SMA cable + * Attach the combined WiFi and Bluetooth® antenna + + ![RTK EVK kit]() + + *Figure 1* + +3. Provide power. + + * Connect a power source. The EVK can be powered by: either of the two USB-C ports on the front panel; Power-over-Ethernet; or a DC voltage source (9V-36V) via the VIN screw terminals on the rear. + * The simplest way is to connect the provided USB power supply to one of the USB-C ports using the provided cable. + * The EVK will power on and begin to acquire satellites. + + ![RTK EVK assembled]() + + *Figure 2* + +4. From your cell phone, open Bluetooth settings and pair it with a new device. You will see a list of available Bluetooth devices. Select the ‘EVK Rover-3AF1’. The '3AF1' is the last four digits of the device's MAC address and will vary depending on the device (Figure 3). + + ![List of Bluetooth devices on Android]() + + *Figure 3* + +5. Once paired, open SW Maps. Select ‘New Project’ and give your project a name like ‘RTK Project’. + +6. Press the SW Maps icon in the top left corner of the home screen and select **Bluetooth GNSS**. You should see the ‘EVK Rover-3AF1’ in the list. Select it. Confirm that the *Instrument Model* is **SparkFun RTK**, then press the ‘Connect’ button in the bottom left corner (Figure 4). SW Maps will show a warning that the instrument height is 0m. That’s ok. + + ![SW Map list of Bluetooth devices]() + + *Figure 4* + +7. Make sure the GNSS antenna is outside with a clear view of the sky. GNSS doesn’t work indoors or near windows. Press the SW Maps icon in the top left corner of the home screen and select **GNSS Status**. Within about 30 seconds you should see 10 or more satellites in view (SIV) (Figure 5). More SIV is better. We regularly see 30 or more SIV. The horizontal positional accuracy (HPA) will decrease as more satellites are acquired. The lower the HPA the more accurate your position. + + ![RTK GNSS Status Window]() + + *Figure 5* + +To improve the accuracy (down to 1.4cm), you now need to enable the PointPerfect corrections. Continue reading the [RTK Crash Course](#rtk-crash-course). + +## iOS + +The software options for Apple iOS are much more limited because Apple products do not support Bluetooth SPP. That's ok! The SparkFun RTK products support Bluetooth Low Energy (BLE) which *does* work with iOS. + +1. Download [SW Maps for iOS](https://apps.apple.com/us/app/sw-maps/id6444248083). This may not be the GIS software you intend to do your data collection, but SW Maps is free and makes sure everything is working correctly out of the box. + + ![SW Maps for Apple]() + + *Download SW Maps for iOS* + +2. Connect the antennas. + + * The RTK EVK has its own [hookup guide](http://docs.sparkfun.com/SparkFun_RTK_EVK/) which has a dedicated section on [hardware hookup](https://docs.sparkfun.com/SparkFun_RTK_EVK/hardware_hookup/). As a minimum: + * Position the L1/L2/L5 GNSS antenna outside, with a clear view of the sky + * Connect the GNSS antenna to the EVK using the supplied TNC-SMA cable + * Attach the combined WiFi and Bluetooth® antenna + + ![RTK EVK kit]() + + *Figure 1* + +3. Provide power. + + * Connect a power source. The EVK can be powered by: either of the two USB-C ports on the front panel; Power-over-Ethernet; or a DC voltage source (9V-36V) via the VIN screw terminals on the rear. + * The simplest way is to connect the provided USB power supply to one of the USB-C ports using the provided cable. + * The EVK will power on and begin to acquire satellites. + + ![RTK EVK assembled]() + + *Figure 2* + +4. Open SW Maps. Select ‘New Project’ and give your project a name like ‘RTK Project’. + +5. Press the SW Maps icon in the top left corner of the home screen and select *Bluetooth GNSS*. You will need to agree to allow a Bluetooth connection. Set the *Instrument Model* to **Generic NMEA (Bluetooth LE)**. Press 'Scan' and your RTK device should appear. + + ![RTK EVK SW Maps (iOS)]() + + *Figure 3* + +6. Select it then press the ‘Connect’ button in the bottom right corner. + + ![RTK EVK SW Maps (iOS)]() + + *Figure 4* + +7. Make sure the GNSS antenna is outside with a clear view of the sky. GNSS doesn’t work indoors or near windows. Press the SW Maps icon in the top left corner of the home screen and select **GNSS Status**. Within about 30 seconds you should see 10 or more satellites in view (SIV) (Figure 5). More SIV is better. We regularly see 30 or more SIV. The horizontal positional accuracy (HPA) will decrease as more satellites are acquired. The lower the HPA the more accurate your position. + + ![RTK GNSS Status Window]() + + *Figure 5* + +To improve the accuracy (down to 1.4cm), you now need to enable the PointPerfect corrections. Continue reading the [RTK Crash Course](#rtk-crash-course). + +## RTK Crash Course + +To get centimeter accuracy we need to provide the RTK unit with correction values. Corrections, often called RTCM, help the RTK unit refine its position calculations. RTCM (Radio Technical Commission for Maritime Services) can be obtained from a variety of sources but they fall into three buckets: Commercial, Public, and Civilian Reference Stations. + +See [Corrections Sources](correction_sources.md) for a breakdown of the options and the pros and cons of each. For this quickstart, we'll be showing you how to enable PointPerfect corrections using your one month free subscription to the L-Band + IP service. + +## PointPerfect Corrections + +One of the great features of the RTK EVK is that it has the ability to get corrections from PointPerfect over Ethernet or WiFi. No need for NTRIP credentials! [Contact SparkFun](https://www.sparkfun.com/rtk_evk_registration) with your device ID, pay a monthly fee of $60 per month (as of this writing) and your device will obtain credentials and start receiving corrections anywhere there is coverage. $60 per month sounds like a lot, but this is a subscription to the premium PointPerfect L-Band + IP service. The subscription allows you to use IP-based corrections over Ethernet or WiFi, and L-Band corrections using the built-in NEO-D9S L-Band receiver. We really like u-blox's new Localized Distribution service where IP corrections are generated for your exact location, improving performance and minimising your network traffic. + +[![PointPerfect Coverage map including L-Band and IP delivery methods]()](https://www.u-blox.com/en/pointperfect-service-coverage) + +*PointPerfect Coverage map including L-Band and IP delivery methods* + +The PointPerfect IP service is available for various areas of the globe including the contiguous US, EU, South Korea, as well as parts of Brazil, Australia, and Canada. See the [coverage map](https://www.u-blox.com/en/pointperfect-service-coverage) for specifics; the RTK EVK is compatible with all areas as it supports both L-Band and IP coverage). + +Steps to use PointPerfect: + +1. [Register](https://www.sparkfun.com/rtk_evk_registration) the device with SparkFun by entering the device ID (this is the ID seen on the [printed stickers](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#registration) included in the kit). It can take up to two business days for registration to complete. + +2. Put the RTK EVK into WiFi config mode by clicking the Mode button on the front panel. The first click opens the mode menu, successive clicks select the next menu option. Keep clicking until **Cfg WiFi** is highlighted, then do a quick double-click to select it. + + ![SparkFun RTK EVK Mode Menu]() + + *SparkFun RTK EVK Mode Menu* + +3. From your phone, connect to the WiFi network *RTK Config*. You should be redirected to the WiFi Config page. If you are not, open a browser (Chrome is preferred) and type **rtk.local** into the address bar. The IP Address will be **192.168.4.1**. + + ![SparkFun RTK WiFi Configuration Interface]() + + *SparkFun RTK WiFi Configuration Interface* + +4. Under the *WiFi Configuration* menu, give the device WiFi credentials for your local WiFi. This can be the cellphone hotspot if local WiFi is not available. If you will be using Ethernet, you can skip this step. + + ![WiFi Menu containing one network]() + + *WiFi Menu containing one network* + +5. Under the *PointPerfect Configuration* menu, **Enable PointPefect Corrections** and select your **Geographic Region**. If desired, enable **Localized Corrections** and **AssistNow**. + + ![PointPerfect Configuration Menu]() + + *PointPerfect Configuration Menu* + +6. Click **Save Configuration**. The device will record all settings in a few seconds. Then press **Exit and Reset**. The unit will now reboot. + + ![Saving and All Saved notifications]() + + *Saving... then All Saved* + +After the reboot, the device will connect to WiFi using your credentials. If you are using Ethernet instead, ensure the Ethernet cable is connected. The RTK will connect to PointPerfect, obtain keys, and begin applying corrections. Assuming your antenna is outside, after a few minutes of receiving PointPerfect corrections the device will enter RTK Float, then RTK Fix (usually under 3 minutes). Connect to the RTK EVK over SW Maps (or other) and view your position with millimeter accuracy! + +![SW Maps showing accuracy]() + +*SW Maps showing positional accuracy* + +## Common Gotchas + +* High-precision GNSS works best with a clear view of the sky; it does not work indoors or near a window. GNSS performance is generally *not* affected by clouds or storms. Trees and buildings *can* degrade performance but usually only in very thick canopies or very near tall building walls. GNSS reception is very possible in dense urban centers with skyscrapers but high-precision RTK may be impossible. + +* The location reported by the RTK device is the location of the antenna element. Lat and Long are fairly easy to obtain but if you're capturing altitude be sure to do additional reading on ARPs (antenna reference points) and how to account for the antenna height in your data collection software. + +* An internet connection is required for most types of RTK. RTCM corrections can be transmitted over other types of connections (such as serial telemetry radios). The RTK EVK also supports PointPerfect L-Band through the built-in NEO-D9S corrections receiver. The L-Band corrections are encrypted and keys are required but, once your unit has them, corrections will be available for up to eight weeks. See [Correction Transport](correction_transport.md) for more details. diff --git a/docs/quickstart-torch.md b/docs/quickstart-torch.md index ec817f1ee..884c98893 100644 --- a/docs/quickstart-torch.md +++ b/docs/quickstart-torch.md @@ -4,7 +4,7 @@ This quick start guide will get you started in 10 minutes or less. For the full product manual, please proceed to the [**Introduction**](index.md). -Are you using [Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#android) or [iOS](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#ios)? +Are you using [Android](#android) or [iOS](#ios)? ## Android @@ -28,29 +28,29 @@ Are you using [Android](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmwa *Figure 2* -5. From your cell phone, open Bluetooth settings and pair it with a new device. You will see a list of available Bluetooth devices. Select the ‘Torch Rover-3AF1’. The '3AF1' is the last four digits of the device's MAC address and will vary depending on the device (Figure 4). +5. From your cell phone, open Bluetooth settings and pair it with a new device. You will see a list of available Bluetooth devices. Select the ‘Torch Rover-3AF1’. The '3AF1' is the last four digits of the device's MAC address and will vary depending on the device (Figure 3). ![List of Bluetooth devices on Android]() - *Figure 4* + *Figure 3* 6. Once paired, open SW Maps. Select ‘New Project’ and give your project a name like ‘RTK Project’. -7. Press the SW Maps icon in the top left corner of the home screen and select **Bluetooth GNSS**. You should see the Torch Rover-3AF1’ in the list. Select it. Confirm that the *Instrument Model* is **SparkFun RTK**, then press the ‘Connect’ button in the bottom left corner (Figure 5). SW Maps will show a warning that the instrument height is 0m. That’s ok. +7. Press the SW Maps icon in the top left corner of the home screen and select **Bluetooth GNSS**. You should see the ‘Torch Rover-3AF1’ in the list. Select it. Confirm that the *Instrument Model* is **SparkFun RTK**, then press the ‘Connect’ button in the bottom left corner (Figure 4). SW Maps will show a warning that the instrument height is 0m. That’s ok. ![SW Map list of Bluetooth devices]() - *Figure 5* + *Figure 4* 8. Once connected, have a look at the Bluetooth LED on the RTK device. You should see the LED turn solid. You’re connected! -9. Now put the device outside with a clear view of the sky. GNSS doesn’t work indoors or near windows. Press the SW Maps icon in the top left corner of the home screen and select **GNSS Status**. Within about 30 seconds you should see 10 or more satellites in view (SIV) (Figure 6). More SIV is better. We regularly see 30 or more SIV. The horizontal positional accuracy (HPA) will start at around 10 meters and begin to decrease. The lower the HPA the more accurate your position. This accuracy is around 2m in normal mode. +9. Now put the device outside with a clear view of the sky. GNSS doesn’t work indoors or near windows. Press the SW Maps icon in the top left corner of the home screen and select **GNSS Status**. Within about 30 seconds you should see 10 or more satellites in view (SIV) (Figure 5). More SIV is better. We regularly see 30 or more SIV. The horizontal positional accuracy (HPA) will start at around 10 meters and begin to decrease. The lower the HPA the more accurate your position. This accuracy is around 2m in normal mode. ![RTK GNSS Status Window]() - *Figure 6* + *Figure 5* -You can now use your RTK device to measure points with good (meter) accuracy. If you need extreme accuracy (down to 8mm) continue reading the [RTK Crash Course](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#rtk-crash-course). +You can now use your RTK device to measure points with good (meter) accuracy. If you need extreme accuracy (down to 8mm) continue reading the [RTK Crash Course](#rtk-crash-course). ## iOS @@ -88,7 +88,7 @@ The software options for Apple iOS are much more limited because Apple products *Figure 3* -You can now use your RTK device to measure points with good (meter) accuracy. If you need extreme accuracy (down to 8mm) continue reading the [RTK Crash Course](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/intro/#rtk-crash-course). +You can now use your RTK device to measure points with good (meter) accuracy. If you need extreme accuracy (down to 8mm) continue reading the [RTK Crash Course](#rtk-crash-course). ## RTK Crash Course @@ -111,38 +111,39 @@ Steps to use PointPerfect: 1. [Register](https://www.sparkfun.com/rtk_torch_registration) the device with SparkFun by entering the device ID (this is the ID seen on the [printed stickers](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_pointperfect/#registration) included in the kit). It can take up to two business days for registration to complete. 2. Power on the RTK Torch by pressing and holding the power button for around 4 seconds. The device will emit a short beep and illuminate the LEDs. + 3. Put the RTK Torch into WiFi config mode by double-tapping the power button. You will hear two beeps indicating it is ready to connect to. +4. From your phone, connect to the WiFi network *RTK Config*. You should be redirected to the WiFi Config page. If you are not, open a browser (Chrome is preferred) and type **rtk.local** into the address bar. + ![SparkFun RTK WiFi Configuration Interface]() *SparkFun RTK WiFi Configuration Interface* -4. From your phone, connect to the WiFi network *RTK Config*. You should be redirected to the WiFi Config page. If you are not, open a browser (Chrome is preferred) and type **rtk.local** into the address bar. +5. Under the *WiFi Configuration* menu, give the device WiFi credentials for your local WiFi. This can be the cellphone hotspot if local WiFi is not available. ![WiFi Menu containing one network]() *WiFi Menu containing one network* -6. Under the *WiFi Configuration* menu, give the device WiFi credentials for your local WiFi. This can be the cellphone hotspot if local WiFi is not available. +6. Under the *PointPerfect Configuration* menu, **Enable PointPefect Corrections** and select your **Geographic Region**. ![PointPerfect Configuration Menu]() *PointPerfect Configuration Menu* -7. Under the *PointPerfect Configuration* menu, **Enable PointPefect Corrections**. +7. Click **Save Configuration**. The device will record all settings in a few seconds. Then press **Exit and Reset**. The unit will now reboot. ![Saving and All Saved notifications]() *Saving... then All Saved* -8. Click **Save Configuration**. The device will record all settings in a few seconds. Then press **Exit and Reset**. The unit will now reboot. +After the reboot, the device will connect to WiFi, obtain keys, and begin applying corrections. Assuming you are outside, after a few minutes of receiving PointPerfect corrections to the device, connect to the RTK Torch over SW Maps (or other) and the device will enter RTK Float, then RTK Fix (usually under 3 minutes). You can now take positional readings with millimeter accuracy! ![SW Maps showing accuracy]() *SW Maps showing positional accuracy* -After the reboot, the device will connect to WiFi, obtain keys, and begin applying corrections. Assuming you are outside, after a few minutes of receiving PointPerfect corrections to the device, connect to the RTK Torch over SW Maps (or other) and the device will enter RTK Float, then RTK Fix (usually under 3 minutes). You can now take positional readings with millimeter accuracy! - ## NTRIP Example If you decide to use a service that provides NTRIP (as opposed to PointPerfect) we need to feed that data into your SparkFun RTK device. In this example, we will use PointOneNav and SW Maps. diff --git a/docs/repair.md b/docs/repair.md index 9a87c5f58..83f9037bd 100644 --- a/docs/repair.md +++ b/docs/repair.md @@ -1,6 +1,6 @@ # Disassembly / Repair -Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) +Torch: ![Feature Partially Supported](img/Icons/YellowDot.png) / EVK: ![Feature Supported](img/Icons/RedDot.png) The RTK product line is fully open-source hardware. This allows users to view schematics, code, and repair manuals. This section documents how to safely disassemble the RTK Facet and Torch. diff --git a/mkdocs.yml b/mkdocs.yml index 03ed97491..fdd407604 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -128,6 +128,7 @@ nav: - Introduction: index.md - Quick Start: - quickstart-torch.md + - quickstart-evk.md - connecting_bluetooth.md - GIS Software: - gis_software_android.md @@ -139,6 +140,7 @@ nav: - configure_with_settings_file.md - configure_with_ucenter.md - configure_with_wifi.md + - configure_with_ethernet.md - Configuration Menus: - menu_base.md - menu_corrections_priorities.md