Skip to content

Commit 5dc4b2f

Browse files
committed
Docs update
1 parent 0dd096c commit 5dc4b2f

15 files changed

+725
-228
lines changed

docs/configure_base.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
#Configure Base
2+
3+
The RTK Facet 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. These differences are the correction values passed to the Rover so that the Rover can have millimeter level accuracy.
4+
5+
There are two types of bases: *Surveyed* and *Fixed*. A surveyed base is often a temporary base setup in the field. Called a 'Survey-In', this is less accurate but requires only 60 seconds to complete. The 'Fixed' base is much more accurate but the precise location at which the antenna is located must be known. A fixed base is often a structure with an antenna bolted to the side. Raw satellite signals are gathered for a few hours then processed using Precision Point Position. We have a variety of tutorials that go into depth on these subjects but all you need to know is that the RTK Facet supports both Survey-In and Fixed Base techniques.
6+
7+
<!-- tutorials_by_id(813, 815, 1362, 1363) -->
8+
9+
The Base Menu allows the user to select between Survey-In or Fixed Base setups.
10+
11+
-> [![Dos CMD window showing Base menu optionns](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Base_Menu.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Base_Menu.jpg) <-
12+
13+
In **Survey-In** mode, the minimum observation time and Mean 3D Standard Deviation can be set. The defaults are 60s and 5m as directed by u-blox. The device will wait for the position accuracy to be better than 1 meter before a Survey-In is started. Don't be fooled; setting the observation time to 4 hours or an initial positional accuracy of 0.3m is not going to significantly improve the accuracy of the survey - use [PPP](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station#gather-raw-gnss-data) instead.
14+
15+
In **Fixed** mode, the coordinates of the antenna need to be sent. These can be entered in ECEF or Geographic coordinates. Whenever a user enters Base mode by pressing the SETUP button the GNSS receiver will immediately go into base mode with these coordinates and immediately begin outputting RTCM correction data.
16+
17+
#### NTRIP Server
18+
19+
**NTRIP** is where the real fun begins. The Base needs a method for getting the correction data to the Rover. This can be done using radios but that's limited to a few kilometers at best. If you've got WiFi reception, use the internet!
20+
21+
Enabling NTRIP will present a handful of new options seen below:
22+
23+
-> [![SparkFun RTK Facet NTRIP Settings](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Base_Menu_-_Fixed_NTRIP.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Base_Menu_-_Fixed_NTRIP.jpg) <-
24+
25+
-> *Settings for the NTRIP Server* <-
26+
27+
This is a new and powerful feature of the RTK Facet. The RTK Facet can be configured to transmit its RTCM directly over WiFi to the user's mountpoint. This eliminates the need for a radio link.
28+
29+
Once the NTRIP server is enabled you will need a handful of credentials:
30+
31+
* Local WiFi SSID and password
32+
* A casting service such as [RTK2Go](http://www.rtk2go.com) or [Emlid](http://caster.emlid.com) (the port is almost always 2101)
33+
* A mount point and password
34+
35+
-> [![NTRIP Server Connected](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Device_Configuration_-_NTRIP_Server_Broadcasting_v11.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Device_Configuration_-_NTRIP_Server_Broadcasting_v11.jpg) <-
36+
37+
-> *NTRIP Server Connected!* <-
38+
39+
With these credentials set, RTK Facet will attempt to connect to WiFi, your caster of choice, and begin transmitting the RTCM data over WiFi. We tried to make it as easy as possible.
40+
41+
-> [![Transmitting to mount point](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Device_Configuration_-_NTRIP_Server_Broadcasting_Bytes_v11.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_Device_Configuration_-_NTRIP_Server_Broadcasting_Bytes_v11.jpg) <-
42+
43+
Every second a few hundred bytes, up to ~2k, will be transmitted to your mount point.

docs/configure_data_logging.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Configure Data Logging Menu
2+
3+
-> [![RTK Facet Data Logging Configuration Menu](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Logging_Cyclic.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Logging_Cyclic.jpg) <-
4+
5+
-> *RTK Facet Data Logging Configuration Menu* <-
6+
7+
Pressing 5 will enter the Logging Menu. This menu will report the status of the microSD card. While you can enable logging, you cannot begin logging until a microSD card is inserted. Any FAT16 or FAT32 formatted microSD card up to 32GB will work. We regularly use the [SparkX brand 1GB cards](https://www.sparkfun.com/products/15107) but note that these log files can get very large (>500MB) so plan accordingly.
8+
9+
* Option 1 will enable/disable logging. If logging is enabled, all messages from the ZED-F9P will be recorded to microSD. A log file is created at power on with the format *SFE_Facet_YYMMDD_HHMMSS.txt* based on current GPS data/time.
10+
* Option 2 allows a user to set the max logging time. This is convenient to determine the location of a fixed antenna or a receiver on a repeatable landmark. Set the RTK Facet to log RAWX data for 10 hours, convert to RINEX, run through an observation processing station and you’ll get the corrected position with <10mm accuracy. Please see the [How to Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station) tutorial for more information.
11+
* Option 3 allows a user to set the max logging length in minutes. Every 'max long length' amount of time the current log will be closed and a new log will be started. This is known as cyclic logging and is convenient on *very* long surveys (ie, months or years) to prevent logs from getting too unwieldy and helps limit the risk of log corruption. This will continue until the unit is powered down or the *max logging time* is reached.
12+
13+
Note: If you are wanting to log RAWX sentences to create RINEX files useful for post processing the position of the receiver please see the GNSS Configuration Menu. For more information on how to use a RAWX GNSS log to get higher accuracy base location please see the [How to Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station#gather-raw-gnss-data) tutorial.

docs/configure_gnss_receiver.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Configure GNSS Receiver
2+
3+
Pressing 1 will bring up the GNSS Receiver configuration menu. The ZED-F9P is immensely configurable. The RTK Facet will, by default, put the ZED-F9P into the most common configuration for rover/base RTK for use with *SW Maps*.
4+
5+
The GNSS Receiver menu allows a user to change the report rate, dynamic model, and select which constellations should be used for fix calculations.
6+
7+
-> [![GNSS menu showing measurement rates and dynamic model](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_ReceiverNTRIP.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_ReceiverNTRIP.jpg) <-
8+
9+
-> *GNSS menu showing measurement rates and dynamic model* <-
10+
11+
**Measurement Frequency** can be set by either Hz or by seconds between measurements. Some users need many measurements per second; the RTK Facet supports up to 20Hz with RTK enabled. Some users are doing very long static surveys that require many seconds between measurements; RTK Facet supports up to 8255 seconds (137 minutes) between readings.
12+
13+
Note: When in base mode, measurement frequency is set to 1Hz. This is because RTK transmission does not benefit from faster updates, nor does logging of RAWX for PPP.
14+
15+
The **Dynamic Model** can be changed but it is recommended to leave as *Portable*. For more information, please refer to the [ZED-F9P Integration Manual](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/ZED-F9P_IntegrationManual__UBX-18010802_.pdf).
16+
17+
-> [![Enable or disable the constellations used for fixes](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Receiver_Constellations.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_Receiver_Constellations.jpg) <-
18+
19+
-> *Enable or disable the constellations used for fixes* <-
20+
21+
**Constellations Menu:** The ZED-F9P is capable of tracking 184 channels across four constellations and two bands (L1/L2) including GPS (USA), Galileo (EU), BeiDou (China), and GLONASS (Russia). SBAS (satellite-based augmentation system) is also supported. By fault, all constellations are used. Some users may want to study, log, or monitor a subset. Disabling a constellation will cause the ZED to ignore those signals when calculating a location fix.
22+
23+
-> [![NTRIP Client enabled showing settings](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_ReceiverNTRIP.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_ExpressPlus_ReceiverNTRIP.jpg) <-
24+
25+
-> *NTRIP Client enabled showing settings* <-
26+
27+
**Toggle NTRIP Client:** The SparkFun RTK devices can obtain their correction data over a few different methods:
28+
29+
* Bluetooth - This is the most common. An app running on a tablet or phone has an NTRIP client built into it. Once the phone is connected over Bluetooth SPP, the RTCM is sent from the phone to the RTK device.
30+
* Radio - A base RTK unit and a rover have serial radios plugged into the **RADIO** port. RTCM data generated by the base station is set over the radio to the rover.
31+
* WiFi - The rover uses WiFi to be an NTRIP Client and connect to an NTRIP Caster. By enabling NTRIP Client, the RTK device will *disable* Bluetooth and instead use WiFi to connect to the caster of your choice. This is helpful in situations where a 'headless' system (no phone or tablet) is needed and the rover will be near a WiFi access point.
32+
33+
Once the NTRIP Client is enabled you will need a handful of credentials:
34+
35+
* Local WiFi SSID and password
36+
* A casting service and port such as [RTK2Go](http://rtk2go.com/) or [Emlid](https://emlid.com/ntrip-caster/) (the port is almost always 2101)
37+
* A mount point and password
38+
39+
With these credentials set, RTK Facet will attempt to connect to WiFi, then connect to your caster of choice, and then begin downloading the RTCM data over WiFi. We tried to make it as easy as possible. Every second a few hundred bytes, up to ~2k, will be downloaded from the mount point you've entered. Remember, the rover must be in WiFi range to connect in this mode.
40+
41+
-> [![Rover with Active NTRIP Client Connection](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Rover_NTRIP_Client_Connection.png)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Rover_NTRIP_Client_Connection.png) <-
42+
43+
-> *Rover with Active NTRIP Client Connection* <-
44+
45+
Once the device connects to WiFi, it will attempt to connect to the user's chosen NTRIP Caster. If WiFi or the NTRIP connection fails, the rover will return to normal operation.

docs/configure_lband.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# LBand Menu
2+
3+
**Note:** This section only applies to RTK Facet *LBand* products. Regular RTK Facet products do not have LBand antennas or receivers built in.
4+
5+
-> [![LBand 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) <-
6+
7+
-> *LBand Menu showing Home WiFi credentials* <-
8+
9+
*RTK Facet LBand* products are equipped with a special antenna and extra receiver to decrypted the LBand corrections using the PointPerfect service from u-blox. The LBand 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.
10+
11+
LBand decryption keys are valid for a maximum of 56 days. During that time, the RTK Facet LBand 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 LBand will attempt to log in to the 'Home' WiFi at each power on. If WiFi is not available, it will continue normal operation.
12+
13+
-> [![Display showing 14 days until LBand 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) <-
14+
15+
-> *Display showing 14 days until LBand Keys Expire* <-
16+
17+
The unit will display various messages to aid the user in obtaining keys as needed.
18+
19+
-> [![Three pronged satellite dish indicating LBand 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) <-
20+
21+
-> *Three pronged satellite dish indicating LBand reception* <-
22+
23+
Upon successful reception and decryption of LBand 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.
24+
25+
26+
-> [![LBand 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) <-
27+
28+
-> *LBand Menu showing Home WiFi credentials* <-
29+
30+
In addition to allowing the entry of WiFi credentials, the LBand Menu will display the Device ID. This is needed when a SparkFun RTK Facet LBand product needs to be added to the PointPerfect system. This is normally taken care of when you purchase the LBand 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+
32+
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.
33+
34+
* Option '1' disables the use of LBand corrections.
35+
36+
* Option '2' or '3' enables the entry of WiFi credentials used for obtaining new keys from the PointPerfect API.
37+
38+
* Option '4' disables the automatic attempts at WiFi connections when key expiry is less than 28 days.
39+
40+
* Option '5' will trigger an immediate attempt to connect over WiFi and update the keys.
41+
42+
* Option 'k' will bring up the Manual Key Entry menu.
43+
44+
-> [![Manual Key Entry menu](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBand_ManualKeysA.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_LBand_ManualKeysA.jpg) <-
45+
46+
-> *Manual Key Entry Menu* <-
47+
48+
Because of the length and complexity of the keys, we do not recommend you manually enter them. This menu is most helpful for displaying the current keys.
49+
50+
Option '1' will allow a user to enter their own Device Profile Token. This is the token that is used to provision a device on a PointPerfect account. By default, users may use the SparkFun token but must pay SparkFun for the annual service fee. If an organization would like to administer their own devices, the token can be changed here.
51+

docs/configure_messages.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Messages Menu
2+
3+
-> [![The Messages configuration menu](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Messages_Menu.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Messages_Menu.jpg) <-
4+
5+
-> *The messages configuration menu* <-
6+
7+
From this menu a user can control the output of various NMEA, RTCM, RXM, and other messages. Any enabled message will be broadcast over Bluetooth *and* recorded to SD (if available).
8+
9+
Because of the large number of configurations possible, we provide a few common settings:
10+
11+
* Reset to Surveying Defaults (NMEAx5)
12+
* Reset to PPP Logging Defaults (NMEAx5 + RXMx2)
13+
* Turn off all messages
14+
* Turn on all messages
15+
16+
**Reset to Surveying Defaults (NMEAx5)** will turn off all messages and enable the following messages:
17+
18+
* NMEA-GGA, NMEA-SGA, NMEA-GST, NMEA-GSV, NMEA-RMC
19+
20+
These five NMEA sentences are commonly used with SW Maps for general surveying.
21+
22+
**Reset to PPP Logging Defaults (NMEAx5 + RXMx2)** will turn off all messages and enable the following messages:
23+
24+
* NMEA-GGA, NMEA-SGA, NMEA-GST, NMEA-GSV, NMEA-RMC, RXM-RAWX, RXM-SFRBX
25+
26+
These seven sentences are commonly used when logging and doing Precise Point Positioning (PPP) or Post Processed Kinematics (PPK). You can read more about PPP [here](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station).
27+
28+
**Turn off all messages** will turn off all messages. This is handy for advanced users who need to start from a blank slate.
29+
30+
**Turn on all messages** will turn on all messages. This is a setting used for firmware testing and should not be needed in normal use.
31+
32+
-> [![Configuring the NMEA messages](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Messages_Menu_-_NMEA.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Messages_Menu_-_NMEA.jpg) <-
33+
34+
-> *Configuring the NMEA messages* <-
35+
36+
As mentioned is the microSD section of the [Hardware Overview](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide/all#hardware-overview) there are a large number of messages supported. Each message sub menu will present the user with the ability to set the message report rate.
37+
38+
Note: The message report rate is the *number of fixes* between message reports. In the image above, with GSV set to 4, the NMEA GSV message will be produced once every 4 fixes. Because the device defaults to 4Hz fix rate, the GSV message will appear once per second.

0 commit comments

Comments
 (0)