You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#zed-f9x-firmware) for more information about the firmware that runs the ZED-F9x Receiver.
3
+
This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-u-blox-firmware) for more information about the firmware that runs the ZED-F9x Receiver.
4
4
5
5
***RTK_Surveyor** - The main firmware for the RTK Surveyor
6
6
***Test Sketches** - Various sketches used in the making of the main firmware. Used internally to verify different features. Reader beware.
7
7
8
8
## Compilation Instructions
9
9
10
-
See [Compiling Source](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#compiling-source) for detailed steps.
10
+
See [Compiling Source](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#compiling-source) for detailed steps.
The [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443), [SparkFun RTK Express](https://www.sparkfun.com/products/18442), [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590), [SparkFun RTK Facet](https://www.sparkfun.com/products/19029), and [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) are centimeter-level GNSS receivers. With RTK enabled, these devices can output your location with 14mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Firmware/accuracy_verification/) at up to 20Hz!
37
+
The [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443), [SparkFun RTK Express](https://www.sparkfun.com/products/18442), [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590), [SparkFun RTK Facet](https://www.sparkfun.com/products/19029), [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) and [SparkFun RTK Reference Station](https://www.sparkfun.com/products/22429) are centimeter-level GNSS receivers. With RTK enabled, these devices can output your location with 14mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Firmware/accuracy_verification/) at up to 20Hz!
29
38
30
-
This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/) and the firmware that runs on the SparkFun RTK product line including:
39
+
This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware) and the firmware that runs on the SparkFun RTK product line including:
***[RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/)** - A detail guide describing all the various software features of the RTK product line. Essentially it is a manual for the firmware in this repository.
56
67
***[RTK Facet L-Band Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-l-band-hookup-guide)** - Hookup guide for the SparkFun RTK Facet L-Band.
57
68
***[RTK Facet Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide)** - Hookup guide for the SparkFun RTK Facet.
69
+
***[RTK Reference Station Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-reference-station-hookup-guide)** - Hookup guide for the SparkFun RTK Reference Station.
58
70
***[RTK Express Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-express-hookup-guide)** - Hookup guide for the SparkFun RTK Express and Express Plus.
59
71
***[RTK Surveyor Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide)** - Hookup guide for the SparkFun RTK Surveyor.
60
72
@@ -63,7 +75,7 @@ Repository Contents
63
75
64
76
***/Firmware** - Source code for SparkFun RTK firmware as well as various feature unit tests
65
77
***/Graphics** - Original bitmap icons for the display
66
-
***/docs** - Markdown pages for the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/)
78
+
***/docs** - Markdown pages for the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/)
Before we can consider doing anything in the field, we need to get really comfortable using the RTK product. Verify you can get your device into RTK Fix mode. This includes setting up a permanent base and/or using a service like Skylark to provide the correction data to the RTK product. Before planning a trip to the field get used to using the RTK product in Rover mode with NTRIP corrections being passed over Bluetooth to your device.
29
29
30
30
## Locate GPS Monument
31
31
32
-
32
+
[](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2017%20Surveyor%20Monument - Big.jpg)
33
33
34
34
*A common metal surveyor's mark*
35
35
@@ -129,7 +129,7 @@ You will need to decide how cheap you want your setup to be. I went too cheap; m
129
129
130
130
Find the monument and locate your Facet (or RTK Surveyor, Express, Express Plus, Facet L-Band, etc) over the monument. Using a tape measure or other tool, measure the distance from the top of the monument to the bottom of the Facet. In this example, it was 45 ¾” or 1162mm. Obviously, millimeters matter here but don't let 'perfection' be the enemy of 'done'.
6
6
7
7
*Configuration menu via Bluetooth*
8
8
9
-
Starting with firmware v3.0, Bluetooth-based configuration is supported. For more information about updating the firmware on your device, please see [Updating RTK Firmware](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/).
9
+
Starting with firmware v3.0, Bluetooth-based configuration is supported. For more information about updating the firmware on your device, please see [Updating RTK Firmware](firmware_update.md).
10
10
11
11
The RTK device will be a discoverable Bluetooth device (both BT SPP and BLE are supported). For information about Bluetooth pairing, please see [Connecting Bluetooth](connecting_bluetooth.md).
**Note:** Starting with v3.0 of the firmware any serial menu that is shown 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.
6
6
7
7
To configure an RTK device using serial attach a [USB C cable](https://www.sparkfun.com/products/15425) to the device. The device can be on or off.
8
8
9
9
## RTK Surveyor / Express / Express+
10
10
11
-
[](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/SparkFun_RTK_Surveyor_-_Connectors1.jpg)
11
+
12
12
13
13
*The SparkFun RTK Surveyor has a variety of connectors*
14
14
@@ -18,13 +18,13 @@ Once connected a COM port will enumerate. Open the `Device Manager` in Windows a
18
18
19
19
## RTK Facet
20
20
21
-
[](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Ports_-_USB.jpg)
21
+
22
22
23
23
Connect the USB cable to the USB connector.
24
24
25
25
There is a USB hub built into the RTK Facet. When you attach the device to your computer it will enumerate two COM ports.
26
26
27
-
[](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Multiple_COM_Ports.jpg)
27
+
28
28
29
29
In the image above, the `USB Serial Device` is the ZED-F9P and the `USB-SERIAL CH340` is the ESP32.
30
30
@@ -38,11 +38,11 @@ Configuring the ZED-F9P is done over the *USB Serial Device* port using [u-cente
38
38
39
39
## Terminal Window
40
40
41
-
Open a terminal window at 115200bps; you should see various status messages every second. Press any key to open the configuration menu. Not sure how to use a terminal? Check out our [Serial](https://learn.sparkfun.com/tutorials/terminal-basics) Terminal Basics](https://learn.sparkfun.com/tutorials/terminal-basics) tutorial.
42
-
Note that some Windows terminal programs (e.g. Tera Term) may reboot the Facet when the terminal connection is closed. You can disconnect the USB cable first to prevent this from happening.
41
+
Open a terminal window at 115200bps; you should see various status messages every second. Press any key to open the configuration menu. Not sure how to use a terminal? Check out our [Serial Terminal Basics](https://learn.sparkfun.com/tutorials/terminal-basics) tutorial.
43
42
43
+
Note that some Windows terminal programs (e.g. Tera Term) may reboot the Facet when the terminal connection is closed. You can disconnect the USB cable first to prevent this from happening.
@@ -58,3 +58,32 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
58
58
59
59
**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
60
60
61
+
## System Report
62
+
63
+
Sending the `~` character to the device over the serial port will trigger a system status report. This is a custom NMEA-style sentence, complete with CRC.
64
+
65
+
66
+
67
+
*Terminal showing System Status*
68
+
69
+
Below is an example system status report sentence:
**71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
88
+
89
+
**Note:** This is a custom NMEA sentence, can vary in length, and may exceed the [maximum permitted sentence length](https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf) of 61 characters.
0 commit comments