Skip to content

Commit a2e73e7

Browse files
committed
Docs: Add QField for iOS
1 parent da0ce72 commit a2e73e7

23 files changed

+225
-109
lines changed
21.2 KB
Loading

docs/gis_software.md renamed to docs/gis_software_android.md

Lines changed: 3 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# GIS Software
1+
# Anrdoid
22

33
Torch: ![Feature Supported](img/Icons/GreenDot.png)
44

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.
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 into the software of your choice.
66

77
## SW Maps
88

@@ -358,7 +358,7 @@ Alternatively, a direct serial connection to the RTK device can be obtained. Use
358358

359359
![Opening page of QField](img/QField/SparkFun%20RTK%20QField%20-%20Open%20Project.png)
360360

361-
[QField](https://docs.qfield.org/get-started/) is a free GIS the Android app that runs QGIS.
361+
[QField](https://docs.qfield.org/get-started/) is a free GIS Android app that runs QGIS.
362362

363363
![NMEA message configuration](img/WiFi Config/RTK_Surveyor_-_WiFi_Config_-_GNSS_Config_Messages.jpg)
364364

@@ -404,100 +404,6 @@ Select the Positioning Menu. Then, with your RTK device on and in normal mode (n
404404

405405
Once connected exit out of the menus and see position information within your project.
406406

407-
## Apple iOS
408-
409-
The software options for Apple iOS are much more limited because Apple products do not support Bluetooth SPP. That's ok! The SparkFun RTK devices support Bluetooth Low Energy (BLE) which *does* work with iOS.
410-
411-
We recommend SWMaps for iOS. SWMaps is available for iOS [here](https://apps.apple.com/us/app/sw-maps/id6444248083).
412-
413-
More information is available on the [System Menu](menu_system.md) for switching between Bluetooth SPP and BLE.
414-
415-
To begin:
416-
417-
Make sure your RTK device is switched on, in Rover mode and operating in Bluetooth BLE mode.
418-
419-
Make sure Bluetooth is enabled on your iOS device Settings.
420-
421-
The RTK device will not appear in the _OTHER DEVICES_ list. That is OK.
422-
423-
![iOS Settings Bluetooth](img/iOS/Screenshot1.PNG)
424-
425-
*iOS Settings Bluetooth*
426-
427-
Open SWMaps.
428-
429-
Open or continue a Project if desired.
430-
431-
SWMaps will show your approximate location based on your iOS device's location.
432-
433-
![iOS SWMaps Initial Location](img/iOS/Screenshot2.PNG)
434-
435-
*iOS SWMaps Initial Location*
436-
437-
Press the 'SWMaps' icon at the top left of the screen to open the menu.
438-
439-
![iOS SWMaps Menu](img/iOS/Screenshot3.PNG)
440-
441-
*iOS SWMaps Menu*
442-
443-
Select Bluetooth GNSS.
444-
445-
![iOS SWMaps Bluetooth Connection](img/iOS/Screenshot4.PNG)
446-
447-
*iOS SWMaps Bluetooth Connection*
448-
449-
Set the **Instrument Model** to **Generic NMEA (Bluetooth LE)**.
450-
451-
![iOS SWMaps Instrument Model](img/iOS/Screenshot5.PNG)
452-
453-
*iOS SWMaps Instrument Model*
454-
455-
Press 'Scan' and your RTK device should appear.
456-
457-
![iOS SWMaps Bluetooth Scan](img/iOS/Screenshot6.PNG)
458-
459-
*iOS SWMaps Bluetooth Scan*
460-
461-
Select (tick) the RTK device and press 'Connect'.
462-
463-
![iOS SWMaps Bluetooth Connected](img/iOS/Screenshot7.PNG)
464-
465-
*iOS SWMaps Bluetooth Connected*
466-
467-
Close the menu and your RTK location will be displayed on the map.
468-
469-
You can now use the other features of SWMaps, including the built-in NTRIP Client.
470-
471-
Re-open the menu and select 'NTRIP Client'.
472-
473-
Enter the details for your NTRIP Caster - as shown in the [SWMaps section above](#sw-maps).
474-
475-
![iOS SWMaps NTRIP Client](img/iOS/Screenshot8.PNG)
476-
477-
*iOS SWMaps NTRIP Client*
478-
479-
Click 'Connect'
480-
481-
At this point, you should see a Bluetooth Pairing Request. Select 'Pair' to pair your RTK with your iOS device.
482-
483-
![iOS Bluetooth Pairing](img/iOS/Screenshot9.PNG)
484-
485-
*iOS Bluetooth Pairing*
486-
487-
SWMaps will now receive NTRIP correction data from the caster and push it to your RTK over Bluetooth BLE.
488-
489-
From the SWMaps menu, open 'GNSS Status' to see your position, fix type and accuracy.
490-
491-
![iOS SWMaps GNSS Status](img/iOS/Screenshot10.PNG)
492-
493-
*iOS SWMaps GNSS Status*
494-
495-
If you return to the iOS Bluetooth Settings, you will see that your iOS and RTK devices are now paired.
496-
497-
![iOS Settings Bluetooth Paired](img/iOS/Screenshot11.PNG)
498-
499-
*iOS Settings Bluetooth - Paired*
500-
501407
## Other GIS Packages
502408

503409
Hopefully, these examples give you an idea of how to connect the RTK product line to most any GIS software. If there is other GIS software that you'd like to see configuration information about, please open an issue on the [RTK Firmware repo](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/issues) and we'll add it.

docs/gis_software_ios.md

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
# iOS
2+
3+
Torch: ![Feature Supported](img/Icons/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 into the software of your choice.
6+
7+
The software options for Apple iOS are much more limited because Apple products do not support Bluetooth SPP. That's ok! The SparkFun RTK products support additional connection options including TCP and Bluetooth Low Energy (BLE).
8+
9+
## SW Maps
10+
11+
SWMaps is available for iOS [here](https://apps.apple.com/us/app/sw-maps/id6444248083).
12+
13+
Make sure your RTK device is switched on and operating in Rover mode.
14+
15+
Make sure Bluetooth is enabled on your iOS device Settings.
16+
17+
The RTK device will not appear in the _OTHER DEVICES_ list. That is OK.
18+
19+
![iOS Settings Bluetooth](img/iOS/Screenshot1.PNG)
20+
21+
*iOS Settings Bluetooth*
22+
23+
Open SWMaps.
24+
25+
Open or continue a Project if desired.
26+
27+
SWMaps will show your approximate location based on your iOS device's location.
28+
29+
![iOS SWMaps Initial Location](img/iOS/Screenshot2.PNG)
30+
31+
*iOS SWMaps Initial Location*
32+
33+
Press the 'SWMaps' icon at the top left of the screen to open the menu.
34+
35+
![iOS SWMaps Menu](img/iOS/Screenshot3.PNG)
36+
37+
*iOS SWMaps Menu*
38+
39+
Select Bluetooth GNSS.
40+
41+
![iOS SWMaps Bluetooth Connection](img/iOS/Screenshot4.PNG)
42+
43+
*iOS SWMaps Bluetooth Connection*
44+
45+
Set the **Instrument Model** to **Generic NMEA (Bluetooth LE)**.
46+
47+
![iOS SWMaps Instrument Model](img/iOS/Screenshot5.PNG)
48+
49+
*iOS SWMaps Instrument Model*
50+
51+
Press 'Scan' and your RTK device should appear.
52+
53+
![iOS SWMaps Bluetooth Scan](img/iOS/Screenshot6.PNG)
54+
55+
*iOS SWMaps Bluetooth Scan*
56+
57+
Select (tick) the RTK device and press 'Connect'.
58+
59+
![iOS SWMaps Bluetooth Connected](img/iOS/Screenshot7.PNG)
60+
61+
*iOS SWMaps Bluetooth Connected*
62+
63+
Close the menu and your RTK location will be displayed on the map.
64+
65+
You can now use the other features of SWMaps, including the built-in NTRIP Client.
66+
67+
Re-open the menu and select 'NTRIP Client'.
68+
69+
Enter the details for your NTRIP Caster - as shown in the [SWMaps section above](#sw-maps).
70+
71+
![iOS SWMaps NTRIP Client](img/iOS/Screenshot8.PNG)
72+
73+
*iOS SWMaps NTRIP Client*
74+
75+
Click 'Connect'
76+
77+
At this point, you should see a Bluetooth Pairing Request. Select 'Pair' to pair your RTK with your iOS device.
78+
79+
![iOS Bluetooth Pairing](img/iOS/Screenshot9.PNG)
80+
81+
*iOS Bluetooth Pairing*
82+
83+
SWMaps will now receive NTRIP correction data from the caster and push it to your RTK over Bluetooth BLE.
84+
85+
From the SWMaps menu, open 'GNSS Status' to see your position, fix type and accuracy.
86+
87+
![iOS SWMaps GNSS Status](img/iOS/Screenshot10.PNG)
88+
89+
*iOS SWMaps GNSS Status*
90+
91+
If you return to the iOS Bluetooth Settings, you will see that your iOS and RTK devices are now paired.
92+
93+
![iOS Settings Bluetooth Paired](img/iOS/Screenshot11.PNG)
94+
95+
*iOS Settings Bluetooth - Paired*
96+
97+
## QField
98+
99+
![Opening page of QField](<img/QField/SparkFun RTK QField - Opening Page.png>)
100+
101+
[QField](https://docs.qfield.org/get-started/) is a free iOS app that runs QGIS.
102+
103+
![Modified NMEA messages on RTK Torch](<img/QField/SparkFun RTK QField - NMEA Messages.png>)
104+
105+
*Modified NMEA messages on RTK Torch*
106+
107+
First, configure the RTK device to output *only* the following NMEA messages:
108+
109+
* GPGGA
110+
* GPGSA
111+
* GPGST
112+
* GPGSV
113+
114+
QField currently does not correctly parse other messages such as **GPRMC**, or **RTCM**. These messages will prevent communication if they are enabled.
115+
116+
These NMEA message settings can be found under the [Messages menu](menu_messages.md), using the [web config page](configure_with_wifi.md) or the [serial config interface](configure_with_serial.md).
117+
118+
![Adding WiFi network to settings](<SparkFun RTK WiFi Config - WiFi Menu.png>)
119+
120+
*Adding WiFi network to settings*
121+
122+
Next, the RTK device must use WiFi to connect to the data collector. Using a cellular hotspot or cellphone is recommended. In the above image, the device will attempt to connect to *Roving* (a cell phone hotspot) when WiFi is needed.
123+
124+
![TCP Server Enabled on port 9000](<img/QField/SparkFun RTK QField - TCP Server.png>)
125+
126+
*TCP Server Enabled on port 9000*
127+
128+
Next, the RTK device must be configured as a *TCP Server*. QField uses a default port of 9000 so that is what we recommend using. See [TCP/UDP Menu](menu_tcp_udp.md) for more information.
129+
130+
![RTK device showing IP address](<img/QField/SparkFun RTK QField - TCP Connection.png>)
131+
132+
*RTK device showing IP address*
133+
134+
Once the RTK device connects to the WiFi hotspot, it will display its IP address. This is the number that needs to be entered into QField. You can now proceed to the QField app to set up the software connection.
135+
136+
![QField Opening Screen](<img/QField/SparkFun RTK QField - Opening Page.png>)
137+
138+
*QField Opening Screen*
139+
140+
Click on *QFieldCloud projects* to open your project that was previously created on the [QField Cloud](https://app.qfield.cloud/) or skip this step by using one of the default projects (*Bee Farming*, *Wastewater*, etc).
141+
142+
![QField Main Map](<img/QField/SparkFun RTK QField - Main Map.png>)
143+
144+
*QField Main Map*
145+
146+
From the main map, click on the 'hamburger' icon in the upper left corner.
147+
148+
![QField Settings Gear](<img/QField/SparkFun RTK QField - Settings Gear.png>)
149+
150+
*QField Settings Gear*
151+
152+
Click on the gear to open settings.
153+
154+
![QField Settings Menu](<img/QField/SparkFun RTK QField - Settings Menu.png>)
155+
156+
Click on the *Settings* menu.
157+
158+
![QField Positioning Menu](<img/QField/SparkFun RTK QField - Settings Positioning Menu.png>)
159+
160+
*QField Positioning Menu*
161+
162+
From the *Positioning* menu, click Add.
163+
164+
![QField Entering TCP Information](<img/QField/SparkFun RTK QField - TCP Connection Type.png>)
165+
166+
*QField Entering TCP Information*
167+
168+
Select TCP as the connection type. Enter the IP address of the RTK device and the port number. Finally, hit the small check box in the upper left corner (shown in pink above) to close the window.
169+
170+
Once this information is entered, QField will automatically attempt to connect to that IP and port.
171+
172+
![QField TCP Connected](<img/QField/SparkFun RTK QField - TCP Connected.png>)
173+
174+
*QField TCP Connected*
175+
176+
Above, we see the port is successfully connected. Exit out of all menus.
177+
178+
![QField Connected via TCP with RTK Fix](<img/QField/SparkFun RTK QField - Connected with RTK Fix.png>)
179+
180+
*QField Connected via TCP with RTK Fix*
181+
182+
Returning to the map view, we see an RTK Fix with 11mm positional accuracy.
183+
184+
185+
186+
187+
188+
## Other GIS Packages
189+
190+
Hopefully, these examples give you an idea of how to connect the RTK product line to most any GIS software. If there is other GIS software that you'd like to see configuration information about, please open an issue on the [RTK Firmware repo](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/issues) and we'll add it.
191+
192+
## What's an NTRIP Caster?
193+
194+
In a nutshell, 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.
195+
196+
## Where do I get RTK Corrections?
197+
198+
Be sure to see [Correction Sources](correction_sources.md).
199+
200+
Don't have access to an NTRIP Caster or other RTCM correction source? There are a few options.
201+
202+
The [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) gets corrections via an encrypted signal from geosynchronous satellites. This device gets RTK Fix without the need for a WiFi or cellular connection.
203+
204+
Also, you can use a 2nd RTK product operating in Base mode to provide the correction data. Check out [Creating a Permanent Base](permanent_base.md).
205+
206+
If you're the DIY sort, you can create your own low-cost base station using an ESP32 and a ZED-F9P breakout board. Check out [How to Build a DIY GNSS Reference Station](https://learn.sparkfun.com/tutorials/how-to-build-a-diy-gnss-reference-station).
207+
208+
There are services available as well. [Syklark](https://www.swiftnav.com/skylark) provides RTCM coverage for $49 a month (as of writing) and is extremely easy to set up and use. [Point One](https://app.pointonenav.com/trial?utm_source=sparkfun) also offers RTK NTRIP service with a free 14 day trial and easy to use front end.
45.5 KB
Loading
Binary file not shown.
173 KB
Loading
2.11 KB
Loading
Binary file not shown.
Binary file not shown.
118 KB
Loading

0 commit comments

Comments
 (0)