Skip to content

Commit a0c6814

Browse files
authored
Merge pull request #478 from sparkfun/docs_updates
Docs updates: add iOS docs and screenshots; fix broken links
2 parents 1a65d10 + a54248c commit a0c6814

16 files changed

+96
-10
lines changed

docs/configure_with_bluetooth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
88

99
Starting with firmware v3.0, Bluetooth-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/).
1010

11-
The RTK device will be a discoverable Bluetooth device (both BT SPP and BLE are supported). For information about Bluetooth pairing, please see [Connecting Bluetooth](/docs/connecting_bluetooth.md).
11+
The RTK device will be a discoverable Bluetooth device (both BT SPP and BLE are supported). For information about Bluetooth pairing, please see [Connecting Bluetooth](connecting_bluetooth.md).
1212

1313
## Entering Bluetooth Echo Mode
1414

@@ -24,7 +24,7 @@ Once connected, the RTK device will report a large amount of NMEA data over the
2424

2525
Once in Bluetooth Echo Mode, any character sent from the RTK unit will be shown in the Bluetooth app, and any character sent from the connected device (cell phone, laptop, etc) will be received by the RTK device. This allows the opening of the config menu as well as the viewing of all regular system output.
2626

27-
For more information about the Serial Config menu please see [Configure with Serial](/docs/configure_with_serial.md).
27+
For more information about the Serial Config menu please see [Configure with Serial](configure_with_serial.md).
2828

2929
![System output over Bluetooth](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20System%20Output.png)
3030

docs/configure_with_serial.md

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

33
Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported](img/GreenDot.png) / Express Plus: ![Feature Supported](img/GreenDot.png) / Facet: ![Feature Supported](img/GreenDot.png) / Facet L-Band: ![Feature Supported](img/GreenDot.png)
44

5-
**Note:** Starting with v3.0 of the firmware any serial menu that is shown can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](docs\configure_with_bluetooth.md) for more information.
5+
**Note:** Starting with v3.0 of the firmware any serial menu that is shown can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
66

77
To configure an RTK device using serial attach a [USB C cable](https://www.sparkfun.com/products/15425) to the device. The device can be on or off.
88

@@ -56,5 +56,5 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
5656

5757
*Configuration menu via Bluetooth*
5858

59-
**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](docs\configure_with_bluetooth.md) for more information.
59+
**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
6060

docs/gis_software.md

Lines changed: 89 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ To verify the NMEA sentences are being delivered correctly, Survey Master has a
294294

295295
[Vespucci](https://play.google.com/store/apps/details?id=de.blau.android&hl=en_US&gl=US) is an Open Street Map editor for Android.
296296

297-
This software requires the RTK device to connect over TCP. Be sure you have a local WiFi network entered into the [WiFi Config menu](docs\menu_wifi.md), have a TCP Client or Server enabled, and have noted the TCP port (it's 2947 by default).
297+
This software requires the RTK device to connect over TCP. Be sure you have a local WiFi network entered into the [WiFi Config menu](menu_wifi.md), have a TCP Client or Server enabled, and have noted the TCP port (it's 2947 by default).
298298

299299
![Vespucci Gear Button](img/Vespucci/SparkFun%20RTK%20Vespucci%20-%20Main%20Gear.png)
300300

@@ -314,7 +314,7 @@ Select **GPS/GNSS source**. Select **NMEA from TCP client**. TCP server is also
314314

315315
![Vespucci NMEA network source menu](img/Vespucci/SparkFun%20RTK%20Vespucci%20-%20NMEA%20Network%20Source.png)
316316

317-
Select **NMEA network source**. Enter the IP address and TCP port of the RTK device. The IP address can be found by opening a serial terminal while connected to WiFi (it is reported every few seconds). The TCP port is entered into the [WiFi Config menu](docs\menu_wifi.md).
317+
Select **NMEA network source**. Enter the IP address and TCP port of the RTK device. The IP address can be found by opening a serial terminal while connected to WiFi (it is reported every few seconds). The TCP port is entered into the [WiFi Config menu](menu_wifi.md).
318318

319319
![Vespucci showing location on map](img/Vespucci/SparkFun%20RTK%20Vespucci%20-%20Point%20on%20Map.png)
320320

@@ -334,7 +334,7 @@ Open the View Menu, then look for the 'Panels' submenu.
334334

335335
From the Panels submenu, enable 'GPS Information'. This will show a new panel on the left side.
336336

337-
At this point, you will need to enable *TCP Server* mode on your RTK device from the [WiFi Config menu](docs\menu_wifi.md). Once the RTK device is connected to local WiFi QGIS will be able to connect to the given IP address and TCP port.
337+
At this point, you will need to enable *TCP Server* mode on your RTK device from the [WiFi Config menu](menu_wifi.md). Once the RTK device is connected to local WiFi QGIS will be able to connect to the given IP address and TCP port.
338338

339339
![Select GPSD](img/QGIS/SparkFun%20RTK%20QGIS%20-%20GPS%20Panel.png)
340340

@@ -431,3 +431,89 @@ The software options for Apple iOS are much more limited because Apple products
431431
We recommend SWMaps for iOS. SWMaps is available for iOS [here](https://apps.apple.com/us/app/sw-maps/id6444248083).
432432

433433
More information is available on the [System Menu](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system/) for switching between Bluetooth SPP and BLE.
434+
435+
To begin:
436+
437+
Make sure your RTK device is switched on, in Rover mode and operating in Bluetooth BLE mode.
438+
439+
Make sure Bluetooth is enabled on your iOS device Settings.
440+
441+
The RTK device will not appear in the _OTHER DEVICES_ list. That is OK.
442+
443+
![iOS Settings Bluetooth](img/iOS/Screenshot1.PNG)
444+
445+
*iOS Settings Bluetooth*
446+
447+
Open SWMaps.
448+
449+
Open or continue a Project if desired.
450+
451+
SWMaps will show your approximate location based on your iOS device's location.
452+
453+
![iOS SWMaps Initial Location](img/iOS/Screenshot2.PNG)
454+
455+
*iOS SWMaps Initial Location*
456+
457+
Press the 'SWMaps' icon at the top left of the screen to open the menu.
458+
459+
![iOS SWMaps Menu](img/iOS/Screenshot3.PNG)
460+
461+
*iOS SWMaps Menu*
462+
463+
Select Bluetooth GNSS.
464+
465+
![iOS SWMaps Bluetooth Connection](img/iOS/Screenshot4.PNG)
466+
467+
*iOS SWMaps Bluetooth Connection*
468+
469+
Set the **Instrument Model** to **Generic NMEA (Bluetooth LE)**.
470+
471+
![iOS SWMaps Instrument Model](img/iOS/Screenshot5.PNG)
472+
473+
*iOS SWMaps Instrument Model*
474+
475+
Press 'Scan' and your RTK device should appear.
476+
477+
![iOS SWMaps Bluetooth Scan](img/iOS/Screenshot6.PNG)
478+
479+
*iOS SWMaps Bluetooth Scan*
480+
481+
Select (tick) the RTK device and press 'Connect'.
482+
483+
![iOS SWMaps Bluetooth Connected](img/iOS/Screenshot7.PNG)
484+
485+
*iOS SWMaps Bluetooth Connected*
486+
487+
Close the menu and your RTK location will be displayed on the map.
488+
489+
You can now use the other features of SWMaps, including the built-in NTRIP Client.
490+
491+
Re-open the menu and select 'NTRIP Client'.
492+
493+
Enter the details for your NTRIP Caster - as shown in the [SWMaps section above](#sw-maps).
494+
495+
![iOS SWMaps NTRIP Client](img/iOS/Screenshot8.PNG)
496+
497+
*iOS SWMaps NTRIP Client*
498+
499+
Click 'Connect'
500+
501+
At this point, you should see a Bluetooth Pairing Request. Select 'Pair' to pair your RTK with your iOS device.
502+
503+
![iOS Bluetooth Pairing](img/iOS/Screenshot9.PNG)
504+
505+
*iOS Bluetooth Pairing*
506+
507+
SWMaps will now receive NTRIP correction data from the caster and push it to your RTK over Bluetooth BLE.
508+
509+
From the SWMaps menu, open 'GNSS Status' to see your position, fix type and accuracy.
510+
511+
![iOS SWMaps GNSS Status](img/iOS/Screenshot10.PNG)
512+
513+
*iOS SWMaps GNSS Status*
514+
515+
If you return to the iOS Bluetooth Settings, you will see that your iOS and RTK devices are now paired.
516+
517+
![iOS Settings Bluetooth Paired](img/iOS/Screenshot11.PNG)
518+
519+
*iOS Settings Bluetooth - Paired*

docs/img/iOS/Screenshot1.PNG

97.5 KB
Loading

docs/img/iOS/Screenshot10.PNG

184 KB
Loading

docs/img/iOS/Screenshot11.PNG

120 KB
Loading

docs/img/iOS/Screenshot2.PNG

1.22 MB
Loading

docs/img/iOS/Screenshot3.PNG

523 KB
Loading

docs/img/iOS/Screenshot4.PNG

95.3 KB
Loading

docs/img/iOS/Screenshot5.PNG

97.9 KB
Loading

0 commit comments

Comments
 (0)