Skip to content

Commit 5f3bd85

Browse files
committed
Update docs
1 parent 5345e9b commit 5f3bd85

File tree

5 files changed

+62
-12
lines changed

5 files changed

+62
-12
lines changed

docs/configure_with_wifi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express Plus: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Facet: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
44

5-
Starting with firmware v1.7, WiFi based configuration is supported. For more information about updating the firmware on your device, please see [Firmware Updates and Customization](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide/all#firmware-updates-and-customization).
5+
Starting with firmware v1.7, WiFi 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/).
66

77
The RTK device will present a webpage that is viewable from either a desktop/laptop with WiFi or a cell phone. For advanced configurations, a desktop is recommended. For quick in-field changes, a cell phone works great.
88

99
[![Desktop vs Phone display size configuration](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Desktop_vs_Phone_Config.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Desktop_vs_Phone_Config.jpg)
1010

1111
*Desktop vs Phone display size configuration*
1212

13-
## RTK Express / Facet
13+
## RTK Express / Express Plus / Facet
1414
To get into WiFi configuration follow these steps:
1515

16-
1. Power on the RTK Express or Facet.
16+
1. Power on the RTK Express, Express Plus, or Facet.
1717
2. Once the device has started press the Setup button repeatedly until the *Config* menu is highlighted.
1818
3. The display will blink a WiFi icon indicating it is waiting for incoming connections.
1919
4. Connect to WiFi network named ‘RTK Config’.

docs/displays.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
The RTK Facet has a 0.96" high-contrast OLED display. While small, it packs various situational data that can be helpful in the field. We will walk you through each display.
1+
Surveyor: ![Feature Partially Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/YellowDot.png) / Express: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express Plus: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Facet: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
22

3-
### Power On/Off
3+
The RTK Facet, Express, and Express Plus utilize a 0.96" high-contrast OLED display. While small, it packs various situational data that can be helpful in the field. We will walk you through each display.
4+
5+
## Power On/Off
46

57
[![Startup and Shutdown Screens](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Display_On_Off.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Display_On_Off.jpg)
68

79
*RTK Facet Startup and Shutdown Screens*
810

911
Press and hold the power button until the display illuminates to turn on the device. Similarly, press and hold the power button to turn off the device.
1012

11-
### Rover Fix
13+
The device's firmware version is shown during the Power On display.
14+
15+
## Rover Fix
1216

1317
[![Rover with location fix](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Main_Display_Icons.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Main_Display_Icons.jpg)
1418

@@ -22,23 +26,23 @@ Upon power up the device will enter either Rover mode or Base mode. Above, the R
2226
* **Model:** This icon will change depending on the selected dynamic model: Portable (default) Pedestrian, Sea, Bike, Stationary, etc.
2327
* **Log:** This icon will remain animated while the log file is increasing. This is a good visual indication that you have an SD card inserted and RTK Facet can successfully record to it.
2428

25-
### Rover RTK Fix
29+
## Rover RTK Fix
2630

2731
[![Rover with RTK Fix and Bluetooth connected](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_Rover_RTK_Fixed.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_Rover_RTK_Fixed.jpg)
2832

2933
*Rover with RTK Fix and Bluetooth connected*
3034

3135
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.
3236

33-
### Base Survey-In
37+
## Base Survey-In
3438

3539
[![RTK Facet in Survey-In Mode](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_Survey-In.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_Survey-In.jpg)
3640

3741
*RTK Facet in Survey-In Mode*
3842

3943
Pressing the Setup button will change the device to Base mode. If the device is configured for *Survey-In* base mode, a flag icon will be shown and the survey will begin. The mean standard deviation will be shown as well as the time elapsed. For most Survey-In setups, the survey will complete when both 60 seconds have elapsed *and* a mean of 5m or less is obtained.
4044

41-
### Base Transmitting
45+
## Base Transmitting
4246

4347
[![RTK Facet in Fixed Transmit Mode](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_FixedBase-Xmitting.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_FixedBase-Xmitting.jpg)
4448

@@ -48,7 +52,7 @@ Once the *survey-in* is complete the device enters RTCM Transmit mode. The numbe
4852

4953
The *Fixed Base* mode is similar but uses a structure icon (shown above) to indicate a fixed base.
5054

51-
### Base Transmitting NTRIP
55+
## Base Transmitting NTRIP
5256

5357
If the NTRIP server is enabled the device will first attempt to connect over WiFi. The WiFi icon will blink until a WiFi connection is obtained. If the WiFi icon continually blinks be sure to check your SSID and PW for the local WiFi.
5458

@@ -59,4 +63,24 @@ If the NTRIP server is enabled the device will first attempt to connect over WiF
5963

6064
Once WiFi connects the device will attempt to connect to the NTRIP mount point. Once successful the display will show 'Casting' along with a solid WiFi icon. The number of successful RTCM transmissions will increase every second.
6165

62-
Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. You should not need to know the location information of the base so Bluetooth should not be needed. If necessary, USB can be connected to the USB port to view detailed location and ZED-F9P configuration information.
66+
Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. You should not need to know the location information of the base so Bluetooth should not be needed. If necessary, USB can be connected to the USB port to view detailed location and ZED-F9P configuration information.
67+
68+
## L-Band
69+
70+
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.
71+
72+
[![Display showing 14 days until L-Band Keys Expire](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBand_DayToExpire.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBand_DayToExpire.jpg)
73+
74+
*Display showing 14 days until L-Band Keys Expire*
75+
76+
The unit will display various messages to aid the user in obtaining keys as needed.
77+
78+
[![Three pronged satellite dish indicating L-Band reception](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBand_Indicator.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBand_Indicator.jpg)
79+
80+
*Three pronged satellite dish indicating L-Band reception*
81+
82+
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.
83+
84+
## Adding a Display to the RTK Surveyor
85+
86+
While the RTK Surveyor works very well using only LEDs, it is possible to add an external display. The [SparkFun Micro OLED Breakout (Qwiic)](https://www.sparkfun.com/products/14532) can be attached to the Qwiic connector on the end of the Surveyor. At power on, the display will be automatically detected and used.
11.4 KB
Loading

docs/system_status_reporting.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# System Reporting
2+
3+
Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express Plus: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Facet: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
4+
5+
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.
6+
7+
![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK System Status Trigger.png)
8+
9+
*Terminal showing System Status*
10+
11+
> $GNTXT,01,01,05,202447.00,270522,0.380,29,40.090355193,-105.184764700,1560.56,3,0,86*71
12+
* $GNTXT : Start of custom NMEA sentence
13+
* 01 : Number of sentences
14+
* 01 : Sentence number
15+
* 05 : Sentence type ID (5 is for System Status messages)
16+
* 202447.00 : Current hour, minute, second, milliseconds
17+
* 270522 : Current day, month, year
18+
* 0.380 : Current horizontal positional accuracy (m)
19+
* 29 : Satellites in view
20+
* 40.090355193 : Latitude
21+
* -105.184764700 : Longitude
22+
* 1560.56 : Altitude
23+
* 3 : Fix type (0 = no fix, 2 = 2D fix, 3 = 3D fix, 4 = 3D + Dead Reackoning, 5 = Time)
24+
* 0 : Carrier solution (0 = No RTK, 1 = RTK Float, 2 = RTK Fix)
25+
* 86 : Battery level (% remaining)

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ extra:
7575
nav:
7676
- RTK Firmware:
7777
- firmware_intro.md
78+
- displays.md
7879
- system_configuration.md
7980
- configure_with_wifi.md
8081
- configure_with_serial.md
@@ -88,7 +89,7 @@ nav:
8889
- configure_profiles.md
8990
- configure_lband.md
9091
- menu_system_status.md
91-
- displays.md
92+
- system_status_reporting.md
9293
- firmware_update.md
9394
- Hardware Specifics:
9495
- hardware_rtk_surveyor.md

0 commit comments

Comments
 (0)