Skip to content

Commit 52b5bc7

Browse files
committed
Add GIS software docs
1 parent 0fb3ac4 commit 52b5bc7

23 files changed

+160
-23
lines changed

docs/connecting_bluetooth.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,54 +4,58 @@ Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkF
44

55
The RTK products transmit full NMEA sentences over Bluetooth serial port profile (SPP) at 4Hz and 115200bps. This means that nearly any GIS application that can receive NMEA data over serial port (almost all do) can be used with the RTK Express. As long as your device can open a serial port over Bluetooth (also known as SPP) your device can retrieve industry standard NMEA positional data. The following steps show how to use SW Maps but the same steps can be followed to connect any serial port based GIS application.
66

7-
## SW Maps
7+
## Android
88

9-
The best mobile app that we’ve found is the powerful, free, and easy to use *[SW Maps](https://play.google.com/store/apps/details?id=np.com.softwel.swmaps)* by Softwel. You’ll need an Android phone or tablet with Bluetooth. What makes SW Maps truly powerful is its built-in NTRIP client. This is a fancy way of saying that we’ll be showing you how to get RTCM correction data over the cellular network.
9+
[![Pairing with the RTK Express over Bluetooth](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/1/8/5/7/RTK_Express_-_Bluetooth_Connect.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/RTK_Express_-_Bluetooth_Connect.jpg)
1010

11-
![SW Maps with RTK Fix](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK SWMaps GNSS Status.png)
11+
*Pairing with the 'Express Rover-5556' over Bluetooth*
1212

13-
*SW Maps with RTK Fix*
13+
Open Android's system settings and find the 'Bluetooth' or 'Connected devices' options. Scan for devices and pair with the device in the list that matches the Bluetooth MAC address on your RTK device.
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-
![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)
17+
![Bluetooth MAC address B022 is shown in the upper left corner](/docs/img/SparkFun%20RTK%20Rover%20Display.png)
1818

1919
*Bluetooth MAC address B022 is shown in the upper left corner*
2020

2121
**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.
2222

23-
[![Pairing with the RTK Express over Bluetooth](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/1/8/5/7/RTK_Express_-_Bluetooth_Connect.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/RTK_Express_-_Bluetooth_Connect.jpg)
23+
## Windows
2424

25-
*Pairing with the 'Express Rover-5556' over Bluetooth*
25+
Open settings and navigate to Bluetooth. Click **Add device**.
2626

27-
Open Android's system settings and find the 'Bluetooth' or 'Connected devices' options. Scan for devices and pair with the device in the list that matches the Bluetooth MAC address on your RTK device.
27+
![Adding Bluetooth Device](img/Bluetooth/SparkFun%20RTK%20Software%20-%20Add%20Bluetooth%20Device.jpg)
28+
29+
*Adding Bluetooth Device*
2830

29-
![List of BT Devices in SW Maps](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK SWMaps Bluetooth Connect.png)
31+
Click Bluetooth 'Mice, Keyboards, ...'
3032

31-
*List of available Bluetooth devices*
33+
![Viewing available Bluetooth Devices](img/Bluetooth/SparkFun%20RTK%20Software%20-%20Add%20Bluetooth%20Device%202.jpg)
3234

33-
From SW Map's main menu, select *Bluetooth GNSS*. This will display a list of available Bluetooth devices. Select the Rover or Base you just paired with. If your are taking height measurements (altitude) in addition to position (lat/long) be sure to enter the height of your antenna off the ground including any [ARP offsets](https://geodesy.noaa.gov/ANTCAL/FAQ.xhtml#faq4) of your antenna (should be printed on the side).
35+
*Viewing available Bluetooth Devices*
3436

35-
Click on 'CONNECT' to open a Bluetooth connection. Assuming this process takes a few seconds, you should immediately have a location fix.
37+
Click on the RTK device. 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.
3638

37-
## NTRIP Client
39+
![Bluetooth MAC address B022 is shown in the upper left corner](img/SparkFun%20RTK%20Rover%20Display.png)
3840

39-
If you’re using a serial radio for your correction data, you can skip this part.
41+
*Bluetooth MAC address B022 is shown in the upper left corner*
42+
43+
**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.
4044

41-
Next we need to send RTCM correction data from the phone back to the RTK device so that it can improve its fix accuracy. This is the amazing power of the SparkFun RTK products and SW Maps. Your phone can be the radio link! From the main SW Maps menu select NTRIP Client. Not there? Be sure the 'SparkFun RTK' instrument was automatically selected connecting. Disconnect and change the instrument to 'SparkFun RTK' to enable the NTRIP Connection option.
45+
![Bluetooth Connection Success](img/Bluetooth/SparkFun%20RTK%20Software%20-%20Add%20Bluetooth%20Device%203.jpg)
4246

43-
[![SW Maps NTRIP Connection menu](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/1/4/6/3/SparkFun_RTK_Surveyor_-_SW_Maps_NTRIP_Connection.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/SparkFun_RTK_Surveyor_-_SW_Maps_NTRIP_Connection.jpg)
47+
*Bluetooth Connection Success*
4448

45-
*NTRIP Connection - Not there? Be sure to select 'SparkFun RTK' was selected as the instrument*
49+
The device will begin pairing. After a few seconds, Windows should report that you are ready to go.
4650

47-
[![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)
51+
![Bluetooth COM ports](img/Bluetooth/SparkFun%20RTK%20Software%20-%20Add%20Bluetooth%20Device%204.jpg)
4852

49-
*Connecting to an NTRIP Caster*
53+
*Bluetooth COM ports*
5054

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?
55+
The device is now paired and a series of COM ports will be added under 'Device Manager'.
5256

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.
57+
![NMEA received over the Bluetooth COM port](img/Bluetooth/SparkFun%20RTK%20Software%20-%20Add%20Bluetooth%20Device%205.jpg)
5458

55-
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.
59+
*NMEA received over the Bluetooth COM port*
5660

57-
Once you have a full RTK fix you'll notice the location bubble in SW Maps turns to green. Just for fun, rock your rover monopole back and forth on a fixed point. You'll see your location accurately reflected in SW Maps. Millimeter location precision is a truly staggering thing.
61+
If neccessary, you can open a terminal connection to one of the COM ports. Because the Bluetooth driver creates multiple COM ports, it's impossible to tell which is the serial stream so it's easiest to just try each port until you see a stream of NMEA sentences (shown above). You're all set! Be sure to close out the terminal window so that other software can use that COM port.

docs/gis_software.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# GIS Software
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) / Facet L-Band: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
4+
5+
While we recommend SW Maps for Android, there are a variety of 3rd party apps available for GIS and surveying. We will cover a few examples below that should give you an idea of how to get the incoming NMEA data over Bluetooth into the software of your choice.
6+
7+
Note: SparkFun is a hardware company; we don't use GIS software for our primary job. While we've stumbled our way through these software packages, we assume you, the professional will know how to use the software once it's clear how to get data from the RTK device into the GIS product.
8+
9+
## SW Maps
10+
11+
![List of BT Devices in SW Maps](img/SparkFun%20RTK%20SWMaps%20Bluetooth%20Connect.png)
12+
13+
*List of available Bluetooth devices*
14+
15+
The best mobile app that we’ve found is the powerful, free, and easy to use *[SW Maps](https://play.google.com/store/apps/details?id=np.com.softwel.swmaps)* by Softwel. You’ll need an Android phone or tablet with Bluetooth. What makes SW Maps truly powerful is its built-in NTRIP client. This is a fancy way of saying that we’ll be showing you how to get RTCM correction data over the cellular network.
16+
17+
![SW Maps with RTK Fix](img/SparkFun%20RTK%20SWMaps%20GNSS%20Status.png)
18+
19+
*SW Maps with RTK Fix*
20+
21+
From SW Map's main menu, select *Bluetooth GNSS*. This will display a list of available Bluetooth devices. Select the Rover or Base you just paired with. If your are taking height measurements (altitude) in addition to position (lat/long) be sure to enter the height of your antenna off the ground including any [ARP offsets](https://geodesy.noaa.gov/ANTCAL/FAQ.xhtml#faq4) of your antenna (should be printed on the side).
22+
23+
Click on 'CONNECT' to open a Bluetooth connection. Assuming this process takes a few seconds, you should immediately have a location fix.
24+
25+
### NTRIP Client
26+
27+
If you’re using a serial radio to connect a Base to a Rover for your correction data, you can skip this part.
28+
29+
We need to send RTCM correction data from the phone back to the RTK device so that it can improve its fix accuracy. This is the amazing power of the SparkFun RTK products and SW Maps. Your phone can be the radio link! From the main SW Maps menu select NTRIP Client. Not there? Be sure the 'SparkFun RTK' instrument was automatically selected connecting. Disconnect and change the instrument to 'SparkFun RTK' to enable the NTRIP Connection option.
30+
31+
[![SW Maps NTRIP Connection menu](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/1/4/6/3/SparkFun_RTK_Surveyor_-_SW_Maps_NTRIP_Connection.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/SparkFun_RTK_Surveyor_-_SW_Maps_NTRIP_Connection.jpg)
32+
33+
*NTRIP Connection - Not there? Be sure to select 'SparkFun RTK' was selected as the instrument*
34+
35+
[![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)
36+
37+
*Connecting to an NTRIP Caster*
38+
39+
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?
40+
41+
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.
42+
43+
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.
44+
45+
Once you have a full RTK fix you'll notice the location bubble in SW Maps turns to green. Just for fun, rock your rover monopole back and forth on a fixed point. You'll see your location accurately reflected in SW Maps. Millimeter location precision is a truly staggering thing.
46+
47+
## SurvPC
48+
49+
Note: The company behind SurvPC, Carlson Software, is rather hostile to competitors of their $18,000 devices, so be warned.
50+
51+
Be sure your device is paired over Bluetooth.
52+
53+
![Equip Sub Menu](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Equip%20Menu.jpg)
54+
55+
*Equip Sub Menu*
56+
57+
Select the *Equip* sub menu then `GPS Rover`
58+
59+
![Select NMEA GPS Receiver](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Rover%20NMEA.jpg)
60+
Install SurvPC and open the Equip menu.
61+
62+
*Select NMEA GPS Receiver*
63+
64+
From the drop down, select `NMEA GPS Receiver`. We asked SurvPC how we might add the SparkFun line of RTK products and the Global Sales Director of Carlson Software said:
65+
66+
> We don’t approve of you on use Carlson SurvPC to drive your GNSS and the reason be we would take all the support calls. We have been down this road with other cheap GNSS receives where the manufacture always blamed SurvPC as the problem and never their GNSS receive when it was their GNSS receiver. DO NOT promote SurvPC with your GNSS receiver.
67+
68+
*Typos as copied*
69+
70+
So, ya, don't call Carlson Software if you run into problems. [Call us instead!](https://www.sparkfun.com/support#ContactUs) Our customer service is friendlier.
71+
72+
![Select Model: DGPS](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Rover%20DGPS.jpg)
73+
74+
*Select Model: DGPS*
75+
76+
Select DGPS if you'd like to connect to an NTRIP Caster. If you are using the RTK Facet L-Band, or do not need RTK fix precision, leave the model as Generic.
77+
78+
![Bluetooth Settings](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Rover%20Comms.jpg)
79+
80+
*Bluetooth Settings Button*
81+
82+
From the `Comms` submenu, click the Blueooth settings button.
83+
84+
![SurvPC Bluetooth Devices](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Rover%20Find%20Device.jpg)
85+
86+
*SurvPC Bluetooth Devices*
87+
88+
Click `Find Device`.
89+
90+
![List of Paired Bluetooth Devices](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Rover%20Select%20Bluetooth%20Device.jpg)
91+
92+
*List of Paired Bluetooth Devices*
93+
94+
You will be shown a list of devices that have been paired. Select the RTK device you want to connect to.
95+
96+
![Connect to Device](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Rover%20Select%20Bluetooth%20Device%20With%20MAC.jpg)
97+
98+
*Connect to Device*
99+
100+
Click the `Connect Bluetooth` button, shown in red in the top right corner. The software will begin a connection to the RTK device. You'll see the MAC address on the RTK device change to the Bluetooth icon indicating its connected. If it detects NMEA, it will report a successful connection.
101+
102+
![Receiver Submenu](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Rover%20Receiver.jpg)
103+
104+
*Receiver Submenu*
105+
106+
You are welcome to enter the ARP (antenna reference point) and surveying stick length for your particular setup.
107+
108+
**NTRIP Client**
109+
110+
Note: If you are using the RTK Facet L-Band you do not need to setup NTRIP; the device generates its own correction data. But if L-Band corrections are not available, the device can still achieve RTK fixes using corrections over an NTRIP Client connection.
111+
112+
![RTK Submenu](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20NTRIP%20Client.jpg)
113+
114+
*RTK Submenu*
115+
116+
If you selected 'DGPS' as the Model type, the RTK submenu will be shown. This is where you give the details about your NTRIP Caster such as your mount point, user name/pw, etc. For more information about creating your own NTRIP mount point please see [Creating a Permanent Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/permanent_base/)
117+
118+
Once everything is conncted up, click the Green check in the top right corner.
119+
120+
![Storing Points](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Survey.jpg)
121+
122+
*Storing Points*
123+
124+
Now that we have a connection, you can use the device as usual, storing points and calculating distances.
125+
126+
![SurvPC Skyplot](img/SurvPC/SparkFun%20RTK%20Software%20-%20SurvPC%20Skyplot.jpg)
127+
128+
*SurvPC Skyplot*
129+
130+
Opening the Skyplot will allow you to see your GNSS details in real time.
131+
132+
If you are a big fan of SurvPC please contact your sales rep and ask them to include SparkFun products in their Manufacturer drop down list.
129 KB
Loading
113 KB
Loading
50.6 KB
Loading
181 KB
Loading
132 KB
Loading
527 KB
Loading
446 KB
Loading
341 KB
Loading

0 commit comments

Comments
 (0)