Skip to content

Commit b7889a4

Browse files
committed
Docs update
1 parent 23043af commit b7889a4

File tree

3 files changed

+16
-20
lines changed

3 files changed

+16
-20
lines changed

docs/configure_lband.md renamed to docs/configure_pointperfect.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,38 @@
1-
# L-Band Menu
1+
# PointPerect Menu
22

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

55
**Note:** This section only applies to RTK Facet *L-Band* products. Regular RTK Facet, Surveyor, Express, and Express Plus products do not have L-Band antennas or receivers built in.
66

7-
[![L-Band Menu showing Home WiFi credentials](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBandA.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBandA.jpg)
7+
![PointPerfect Menu showing Home WiFi credentials](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK PointPerfect Menu.png)
88

9-
*L-Band Menu showing Home WiFi credentials*
9+
*PointPerfect Menu showing Home WiFi credentials*
1010

11-
*RTK Facet L-Band* products are equipped with a special antenna and extra receiver to decrypted the L-Band corrections using the PointPerfect service from u-blox. The L-Band sub menu allows a user to enter their 'Home' WiFi settings. This WiFi SSID and password are used to regularly obtain the needed decryption keys from u-blox. This is normally your home WiFi or other accessible WiFi.
11+
*RTK Facet L-Band* products are equipped with a special antenna and extra receiver to decrypted the L-Band corrections using the PointPerfect service from u-blox. The PointPerfect sub menu allows a user to enter their 'Home' WiFi settings. This WiFi SSID and password are used to regularly obtain the needed decryption keys from u-blox. This is normally your home WiFi or other accessible WiFi.
1212

13-
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.
13+
PointPerfect 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.
1414

15-
[![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)
15+
[![Display showing 14 days until 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)
1616

17-
*Display showing 14 days until L-Band Keys Expire*
17+
*Display showing 14 days until keys expire*
1818

1919
The unit will display various messages to aid the user in obtaining keys as needed.
2020

2121
[![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)
2222

2323
*Three pronged satellite dish indicating L-Band reception*
2424

25-
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.
25+
Upon successful reception and decryption of PointPerfect 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.
2626

27+
![PointPerfect Menu showing Home WiFi credentials](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK PointPerfect Menu.png)
2728

28-
[![L-Band Menu showing Home WiFi credentials](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBandA.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBandA.jpg)
29+
*PointPerfect Menu showing Home WiFi credentials*
2930

30-
*L-Band Menu showing Home WiFi credentials*
31-
32-
In addition to allowing the entry of WiFi credentials, the L-Band Menu will display the Device ID. This is needed when a SparkFun RTK Facet L-Band product needs to be added to the PointPerfect system. This is normally taken care of when you purchase the L-Band unit with PointPerfect service added, but for customers who did not purchase the service and want to add it at a later date, this Device ID is what customer service needs.
31+
In addition to allowing the entry of WiFi credentials, the PointPerfect Menu will display the Device ID. This is needed when a SparkFun RTK Facet L-Band product needs to be added to the PointPerfect system. This is normally taken care of when you purchase the L-Band unit with PointPerfect service added, but for customers who did not purchase the service and want to add it at a later date, this Device ID is what customer service needs.
3332

3433
The *Days until keys expire* inform the user how many days the unit has until it needs to connect to WiFi to obtain new keys.
3534

36-
* Option '1' disables the use of L-Band corrections.
35+
* Option '1' disables the use of PointPerfect corrections.
3736

3837
* Option '2' or '3' enables the entry of WiFi credentials used for obtaining new keys from the PointPerfect API.
3938

docs/connecting_bluetooth.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ The best mobile app that we’ve found is the powerful, free, and easy to use *[
1414

1515
When powered on, the RTK product will broadcast itself as either '[Platform] Rover-5556' or '[Platform] Base-5556' depending on which state it is in. [Platform] is Facet, Express, Surveyor, etc. Discover and pair with this device from your phone or tablet. Once paired, open SW Maps.
1616

17-
[![alt text](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_Rover_Fixed.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Display_-_Rover_Fixed.jpg)
18-
1917
![Bluetooth MAC address B022 is shown in the upper left corner](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK Rover Display.png)
2018

21-
2219
*Bluetooth MAC address B022 is shown in the upper left corner*
2320

2421
**Note:** *B022* is the last four digits of your unit's MAC address and will be unique to the device in front of you. This is helpful in case there are multiple RTK devices within Bluetooth range.
@@ -47,13 +44,13 @@ Next we need to send RTCM correction data from the phone back to the RTK device
4744

4845
*NTRIP Connection - Not there? Be sure to select 'SparkFun RTK' was selected as the instrument*
4946

50-
Enter your NTRIP caster credentials and click connect. You will see bytes begin to transfer from your phone to the RTK Express. Within a few seconds the RTK Express will go from ~300mm accuracy to 14mm. Pretty nifty, no?
51-
5247
[![SW Maps NTRIP client](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/1/4/6/3/SW_Maps_-_NTRIP_Client.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/SW_Maps_-_NTRIP_Client.jpg)
5348

5449
*Connecting to an NTRIP Caster*
5550

56-
What's an NTRIP caster? In a nut shell it's a server that is sending out correction data every second. There are thousands of sites around the globe that calculate the perturbations in the ionosphere and troposphere that decrease the accuracy of GNSS accuracy. Once the inaccuracies are known, correction values are encoded into data packets in the RTCM format. You, the user, don't need to know how to decode or deal with RTCM, you simply need to get RTCM from a source within 10km of your location into the RTK Express. The NTRIP client logs into the server (also known as the NTRIP caster) and grabs that data, every second, and sends it over Bluetooth to the RTK Express.
51+
Enter your NTRIP Caster credentials and click connect. You will see bytes begin to transfer from your phone to the RTK Express. Within a few seconds the RTK Express will go from ~300mm accuracy to 14mm. Pretty nifty, no?
52+
53+
What's an NTRIP Caster? In a nut shell it's a server that is sending out correction data every second. There are thousands of sites around the globe that calculate the perturbations in the ionosphere and troposphere that decrease the accuracy of GNSS accuracy. Once the inaccuracies are known, correction values are encoded into data packets in the RTCM format. You, the user, don't need to know how to decode or deal with RTCM, you simply need to get RTCM from a source within 10km of your location into the RTK Express. The NTRIP client logs into the server (also known as the NTRIP caster) and grabs that data, every second, and sends it over Bluetooth to the RTK Express.
5754

5855
Don't have access to an NTRIP Caster? You can use a 2nd RTK product in operating in Base mode to provide the correction data. Checkout [Creating a Permanent Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/). If you're the DIY sort, you can create your own low cost base station using an ESP32 and a ZED-F9P breakout board. Checkout [How to Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station). If you'd just like a service, [Syklark](https://www.swiftnav.com/skylark) provides RTCM coverage for $49 a month (as of writing) and is extremely easy to setup and use. Remember, you can always use a 2nd RTK device in *Base* mode to provide RTCM correction data but it will less accurate than a fixed position caster.
5956

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ nav:
8888
- configure_ports.md
8989
- configure_data_logging.md
9090
- configure_profiles.md
91-
- configure_lband.md
91+
- configure_pointperfect.md
9292
- menu_system_status.md
9393
- system_status_report.md
9494
- permanent_base.md

0 commit comments

Comments
 (0)