Merge pull request #478 from sparkfun/docs_updates

Docs updates: add iOS docs and screenshots; fix broken links
sparkfun · May 31, 2023 · a0c6814 · a0c6814
2 parents 1a65d10 + a54248c
commit a0c6814
Show file tree

Hide file tree

Showing 16 changed files with 96 additions and 10 deletions.
diff --git a/docs/configure_with_bluetooth.md b/docs/configure_with_bluetooth.md
@@ -8,7 +8,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
 
 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/).
 
-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).
+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).
 
 ## Entering Bluetooth Echo Mode
 
@@ -24,7 +24,7 @@ Once connected, the RTK device will report a large amount of NMEA data over the
 
 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.
 
-For more information about the Serial Config menu please see [Configure with Serial](/docs/configure_with_serial.md).
+For more information about the Serial Config menu please see [Configure with Serial](configure_with_serial.md).
 
 ![System output over Bluetooth](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20System%20Output.png)
 

diff --git a/docs/configure_with_serial.md b/docs/configure_with_serial.md
@@ -2,7 +2,7 @@
 
 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)
 
-**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.
+**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.
 
 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.
 
@@ -56,5 +56,5 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
 
 *Configuration menu via Bluetooth*
 
-**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](docs\configure_with_bluetooth.md) for more information.
+**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
 
diff --git a/docs/gis_software.md b/docs/gis_software.md
@@ -294,7 +294,7 @@ To verify the NMEA sentences are being delivered correctly, Survey Master has a
 
 [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.
 
-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).
+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).
 
 ![Vespucci Gear Button](img/Vespucci/SparkFun%20RTK%20Vespucci%20-%20Main%20Gear.png)
 
@@ -314,7 +314,7 @@ Select **GPS/GNSS source**. Select **NMEA from TCP client**. TCP server is also
 
 ![Vespucci NMEA network source menu](img/Vespucci/SparkFun%20RTK%20Vespucci%20-%20NMEA%20Network%20Source.png)
 
-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).
+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).
 
 ![Vespucci showing location on map](img/Vespucci/SparkFun%20RTK%20Vespucci%20-%20Point%20on%20Map.png)
 
@@ -334,7 +334,7 @@ Open the View Menu, then look for the 'Panels' submenu.
 
 From the Panels submenu, enable 'GPS Information'. This will show a new panel on the left side.
 
-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.
+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.
 
 ![Select GPSD](img/QGIS/SparkFun%20RTK%20QGIS%20-%20GPS%20Panel.png)
 
@@ -431,3 +431,89 @@ The software options for Apple iOS are much more limited because Apple products
 We recommend SWMaps for iOS. SWMaps is available for iOS [here](https://apps.apple.com/us/app/sw-maps/id6444248083).  
 
 More information is available on the [System Menu](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system/) for switching between Bluetooth SPP and BLE.
+
+To begin:
+
+Make sure your RTK device is switched on, in Rover mode and operating in Bluetooth BLE mode.
+
+Make sure Bluetooth is enabled on your iOS device Settings.
+
+The RTK device will not appear in the _OTHER DEVICES_ list. That is OK.
+
+![iOS Settings Bluetooth](img/iOS/Screenshot1.PNG)
+
+*iOS Settings Bluetooth*
+
+Open SWMaps.
+
+Open or continue a Project if desired.
+
+SWMaps will show your approximate location based on your iOS device's location.
+
+![iOS SWMaps Initial Location](img/iOS/Screenshot2.PNG)
+
+*iOS SWMaps Initial Location*
+
+Press the 'SWMaps' icon at the top left of the screen to open the menu.
+
+![iOS SWMaps Menu](img/iOS/Screenshot3.PNG)
+
+*iOS SWMaps Menu*
+
+Select Bluetooth GNSS.
+
+![iOS SWMaps Bluetooth Connection](img/iOS/Screenshot4.PNG)
+
+*iOS SWMaps Bluetooth Connection*
+
+Set the **Instrument Model** to **Generic NMEA (Bluetooth LE)**.
+
+![iOS SWMaps Instrument Model](img/iOS/Screenshot5.PNG)
+
+*iOS SWMaps Instrument Model*
+
+Press 'Scan' and your RTK device should appear.
+
+![iOS SWMaps Bluetooth Scan](img/iOS/Screenshot6.PNG)
+
+*iOS SWMaps Bluetooth Scan*
+
+Select (tick) the RTK device and press 'Connect'.
+
+![iOS SWMaps Bluetooth Connected](img/iOS/Screenshot7.PNG)
+
+*iOS SWMaps Bluetooth Connected*
+
+Close the menu and your RTK location will be displayed on the map.
+
+You can now use the other features of SWMaps, including the built-in NTRIP Client.
+
+Re-open the menu and select 'NTRIP Client'.
+
+Enter the details for your NTRIP Caster - as shown in the [SWMaps section above](#sw-maps).
+
+![iOS SWMaps NTRIP Client](img/iOS/Screenshot8.PNG)
+
+*iOS SWMaps NTRIP Client*
+
+Click 'Connect'
+
+At this point, you should see a Bluetooth Pairing Request. Select 'Pair' to pair your RTK with your iOS device.
+
+![iOS Bluetooth Pairing](img/iOS/Screenshot9.PNG)
+
+*iOS Bluetooth Pairing*
+
+SWMaps will now receive NTRIP correction data from the caster and push it to your RTK over Bluetooth BLE.
+
+From the SWMaps menu, open 'GNSS Status' to see your position, fix type and accuracy.
+
+![iOS SWMaps GNSS Status](img/iOS/Screenshot10.PNG)
+
+*iOS SWMaps GNSS Status*
+
+If you return to the iOS Bluetooth Settings, you will see that your iOS and RTK devices are now paired.
+
+![iOS Settings Bluetooth Paired](img/iOS/Screenshot11.PNG)
+
+*iOS Settings Bluetooth - Paired*
diff --git a/docs/img/iOS/Screenshot1.PNG b/docs/img/iOS/Screenshot1.PNG
diff --git a/docs/img/iOS/Screenshot10.PNG b/docs/img/iOS/Screenshot10.PNG
diff --git a/docs/img/iOS/Screenshot11.PNG b/docs/img/iOS/Screenshot11.PNG
diff --git a/docs/img/iOS/Screenshot2.PNG b/docs/img/iOS/Screenshot2.PNG
diff --git a/docs/img/iOS/Screenshot3.PNG b/docs/img/iOS/Screenshot3.PNG
diff --git a/docs/img/iOS/Screenshot4.PNG b/docs/img/iOS/Screenshot4.PNG
diff --git a/docs/img/iOS/Screenshot5.PNG b/docs/img/iOS/Screenshot5.PNG
diff --git a/docs/img/iOS/Screenshot6.PNG b/docs/img/iOS/Screenshot6.PNG
diff --git a/docs/img/iOS/Screenshot7.PNG b/docs/img/iOS/Screenshot7.PNG
diff --git a/docs/img/iOS/Screenshot8.PNG b/docs/img/iOS/Screenshot8.PNG
diff --git a/docs/img/iOS/Screenshot9.PNG b/docs/img/iOS/Screenshot9.PNG
diff --git a/docs/menu_wifi.md b/docs/menu_wifi.md
@@ -24,7 +24,7 @@ WiFi is used for the following features:
 
 ## TCP Client and Server
 
-The RTK device supports connection over TCP. Some Data Collector software (such as [Vespucci](docs\gis_software\#vespucci)) requires that the SparkFun RTK device connect as a TCP Client. Other software (such as [QGIS](docs\gis_software\#qgis)) requires that the SparkFun RTK device acts as a TCP Server. Both are supported.
+The RTK device supports connection over TCP. Some Data Collector software (such as [Vespucci](https://docs.sparkfun.com/SparkFun_RTK_Firmware/gis_software/#vespucci)) requires that the SparkFun RTK device connect as a TCP Client. Other software (such as [QGIS](https://docs.sparkfun.com/SparkFun_RTK_Firmware/gis_software/#qgis)) requires that the SparkFun RTK device acts as a TCP Server. Both are supported.
 
 **Note:** Currently TCP is only supported while connected to local WiFi, not AP mode. This means the device will need to be connected to a WiFi network, such as a mobile hotspot, before TCP connections can occur.
 

diff --git a/docs/permanent_base.md b/docs/permanent_base.md
@@ -265,7 +265,7 @@ Once WiFi connects the device will attempt to connect to the NTRIP mount point.
 
 Your RTK device can both serve RTCM correction data (aka Server) to an NTRIP Caster and get RTCM correction data (aka Client) from an NTRIP Caster. But how does one get an NTRIP Caster?
 
-There are a variety of Windows applications out there that claim to be an NTRIP caster. We found them to be generally terrible. The easiest solutions we've found are [RTK2GO](rtk2go.com) or [Emlid Caster](caster.emlid.com). Both are free and available to the public.
+There are a variety of Windows applications out there that claim to be an NTRIP caster. We found them to be generally terrible. The easiest solutions we've found are [RTK2GO](http://rtk2go.com) or [Emlid Caster](https://emlid.com/ntrip-caster/). Both are free and available to the public.
 
 ### RTK2Go
 
@@ -305,7 +305,7 @@ To verify that your RTK product is correctly broadcasting RTCM data, you can acc
 
 ### Emlid Caster
 
-[Emlid Caster](caster.emlid.com) is also very easy to set up and has a bit more user-friendly-looking website. Creating an account is very straightforward.
+[Emlid Caster](https://emlid.com/ntrip-caster/) is also very easy to set up and has a bit more user-friendly-looking website. Creating an account is very straightforward.
 
 ![Emlid Mount Points](img/SparkFun%20RTK%20Emlid%20Mount%20Points.png)