Skip to content

Commit 80bc557

Browse files
committed
Docs overhaul
Move docs into sub groups. Add PDF download. Change static links to relative. Unify image usage and size. Add edit and PDF download buttons.
1 parent db90be2 commit 80bc557

File tree

264 files changed

+433
-1134
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

264 files changed

+433
-1134
lines changed

.github/workflows/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ jobs:
1212
with:
1313
python-version: 3.x
1414
- run: pip install mkdocs-material mkdocs-monorepo-plugin
15+
- run: pip install mkdocs-with-pdf
1516
- run: mkdocs gh-deploy --force
-136 KB
Binary file not shown.
-176 KB
Binary file not shown.
-66.8 KB
Binary file not shown.
-172 KB
Binary file not shown.
-36.1 KB
Binary file not shown.
-479 KB
Binary file not shown.

docs/accuracy_verification.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Accuracy Verification
22

3-
Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Supported](img/GreenDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](img/GreenDot.png) / Reference Station: ![Feature Supported](img/GreenDot.png)
3+
Surveyor: ![Feature Supported](img/Icons/GreenDot.png) / Express: ![Feature Supported](img/Icons/GreenDot.png) / Express Plus: ![Feature Supported](img/Icons/GreenDot.png) / Facet: ![Feature Supported](img/Icons/GreenDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Supported](img/Icons/GreenDot.png)
44

55
![Facet in the field](img/VerifyAccuracy/SparkFun%20Verify%20RTK%20-%2016%20Facet%20in%20the%20Field.jpg)
66

@@ -21,7 +21,7 @@ The process goes like this:
2121

2222
## Get Used to RTK
2323

24-
![RTK Fix Mode](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_Rover_RTK_Fixed.jpg)
24+
![RTK Fix Mode](img/Displays/SparkFun_RTK_Express_-_Display_-_Rover_RTK_Fixed.jpg)
2525

2626
*RTK Fix Mode*
2727

@@ -129,7 +129,7 @@ You will need to decide how cheap you want your setup to be. I went too cheap; m
129129

130130
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'.
131131

132-
![L-Band Facet ARP](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/2/5/8/3/SparkFun_RTK_Facet_L-Band_ARP.jpg)
132+
![L-Band Facet ARP](img/SparkFun_RTK_Facet_L-Band_ARP.jpg)
133133

134134
*L-Band Facet ARP*
135135

docs/configure_with_bluetooth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configure with Bluetooth
22

3-
Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Supported](img/GreenDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](img/GreenDot.png) / Reference Station: ![Feature Supported](img/GreenDot.png)
3+
Surveyor: ![Feature Supported](img/Icons/GreenDot.png) / Express: ![Feature Supported](img/Icons/GreenDot.png) / Express Plus: ![Feature Supported](img/Icons/GreenDot.png) / Facet: ![Feature Supported](img/Icons/GreenDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Supported](img/Icons/GreenDot.png)
44

55
![Configuration menu open over Bluetooth](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png)
66

docs/configure_with_serial.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Configure with Serial
22

3-
Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Supported](img/GreenDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](img/GreenDot.png) / Reference Station: ![Feature Supported](img/GreenDot.png)
3+
Surveyor: ![Feature Supported](img/Icons/GreenDot.png) / Express: ![Feature Supported](img/Icons/GreenDot.png) / Express Plus: ![Feature Supported](img/Icons/GreenDot.png) / Facet: ![Feature Supported](img/Icons/GreenDot.png) / Facet L-Band: ![Feature Supported](img/Icons/GreenDot.png) / Reference Station: ![Feature Supported](img/Icons/GreenDot.png)
44

55
**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.
66

77
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.
88

99
## RTK Surveyor / Express / Express+
1010

11-
[![RTK Surveyor Connectors and label](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/SparkFun_RTK_Surveyor_-_Connectors1.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/SparkFun_RTK_Surveyor_-_Connectors1.jpg)
11+
![RTK Surveyor Connectors and label](img/Serial/SparkFun_RTK_Surveyor_-_Connectors1.jpg)
1212

1313
*The SparkFun RTK Surveyor has a variety of connectors*
1414

@@ -18,13 +18,13 @@ Once connected a COM port will enumerate. Open the `Device Manager` in Windows a
1818

1919
## RTK Facet
2020

21-
[![RTK Facet USB C Connector](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Ports_-_USB.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Ports_-_USB.jpg)
21+
![RTK Facet USB C Connector](img/Serial/SparkFun_RTK_Facet_-_Ports_-_USB.jpg)
2222

2323
Connect the USB cable to the USB connector.
2424

2525
There is a USB hub built into the RTK Facet. When you attach the device to your computer it will enumerate two COM ports.
2626

27-
[![Two COM ports from one USB device](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Multiple_COM_Ports.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Multiple_COM_Ports.jpg)
27+
![Two COM ports from one USB device](img/Serial/SparkFun_RTK_Facet_-_Multiple_COM_Ports.jpg)
2828

2929
In the image above, the `USB Serial Device` is the ZED-F9P and the `USB-SERIAL CH340` is the ESP32.
3030

@@ -38,11 +38,11 @@ Configuring the ZED-F9P is done over the *USB Serial Device* port using [u-cente
3838

3939
## Terminal Window
4040

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.
4342

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.
4444

45-
[![Terminal showing menu](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_MainMenu.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_MainMenu.jpg)
45+
![Terminal showing menu](img/Terminal/SparkFun_RTK_ExpressPlus_MainMenu.jpg)
4646

4747
*Main Menu*
4848

@@ -58,3 +58,32 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
5858

5959
**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
6060

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+
![System status NMEA outputted to terminal](img/Terminal/SparkFun RTK System Status Trigger.png)
66+
67+
*Terminal showing System Status*
68+
69+
Below is an example system status report sentence:
70+
71+
> $GNTXT,01,01,05,202447.00,270522,0.380,29,40.090355193,-105.184764700,1560.56,3,0,86*71
72+
73+
* $GNTXT : Start of custom NMEA sentence
74+
* 01 : Number of sentences
75+
* 01 : Sentence number
76+
* 05 : Sentence type ID (5 is for System Status messages)
77+
* 202447.00 : Current hour, minute, second, milliseconds
78+
* 270522 : Current day, month, year
79+
* 0.380 : Current horizontal positional accuracy (m)
80+
* 29 : Satellites in view
81+
* 40.090355193 : Latitude
82+
* -105.184764700 : Longitude
83+
* 1560.56 : Altitude
84+
* 3 : Fix type (0 = no fix, 2 = 2D fix, 3 = 3D fix, 4 = 3D + Dead Reackoning, 5 = Time)
85+
* 0 : Carrier solution (0 = No RTK, 1 = RTK Float, 2 = RTK Fix)
86+
* 86 : Battery level (% remaining)
87+
* *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

Comments
 (0)