Skip to content

Commit 490bf64

Browse files
nseidlenseidle
committed
Fix v30 docs
1 parent 7dc0ed2 commit 490bf64

File tree

4 files changed

+87
-2
lines changed

4 files changed

+87
-2
lines changed

‎docs/firmware_update.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,22 @@ The GUI method is generally recommended. For more information see [here](https:/
2424

2525
Remember, all SparkFun RTK devices are open source hardware meaning you have total access to the [firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) and [hardware](https://github.com/sparkfun/SparkFun_RTK_Facet). Be sure to check out each repo for the latest firmware and hardware information.
2626

27+
## Updating Firmware Over-The-Air
28+
29+
![Updating Firmware from WiFi config page](img/SparkFun%20RTK%20OTA%20Firmware%20Update.gif)
30+
31+
*Updating the firmware via WiFi config page*
32+
33+
![Alt text](img/SparkFun%20RTK%20Firmware%20Update%20Menu.png)
34+
35+
*Updating the firmware via Firmware serial menu*
36+
37+
Introduced with version 3.0, firmware can be updated by pressing a button in the System Configuration section of the WiFi Config page, or over the Firmware menu of the serial interface. This makes checking and upgrading a unit very easy.
38+
39+
Additionally, users may opt into checking for Beta firmware. This is the latest firmware that may have new features and is meant for testing. Beta firmware is not recommended for units deployed into the field as it may not be stable.
40+
41+
If you have a device with firmware lower than v3.0, you will need to use the [GUI](https://docs.sparkfun.com/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-using-the-uploader-gui) or a method listed below to get to v3.x.
42+
2743
## Updating Firmware Using The Uploader GUI
2844

2945
![RTK Firmware GUI](./img/RTK_Uploader_Windows.png)

‎docs/menu_sensor.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Sensor Menu
2+
3+
Surveyor: ![Feature Not Supported](img/RedDot.png) / Express: ![Feature Not Supported](img/RedDot.png) / Express Plus: ![Feature Supported](img/GreenDot.png) / Facet: ![Feature Not Supported](img/RedDot.png) / Facet L-Band: ![Feature Not Supported](img/RedDot.png)
4+
5+
![Sensor menu is shown in WiFi config](img/SparkFun%20RTK%20Sensor%20Menu%20WiFi%20Config.png)
6+
7+
![Sensor menu from serial prompt](img/SparkFun%20RTK%20-%20Sensor%20Menu.png)
8+
9+
*Setting the Sensor options over WiFi config and serial connections*
10+
11+
The [RTK Express Plus](https://www.sparkfun.com/products/18589) utilizes the ZED-F9R GNSS receiver with built-in IMU. This allows the RTK device to continue to output high-precision location information even if GNSS reception goes down or becomes unavailable. This was designed for and is especially helpful in automotive environments, such as tunnels or parking garages, where GNSS reception because sparse.
12+
13+
Enable 'Sensor Fusion' to begin using the onboard IMU when GNSS is avaialble. Sensor Fusion will only aid position information when used with an automobile and may lead to degraded position fixes when used in other situations (ie, surveying, pedestrian, etc).
14+
15+
'Automatic IMU-Mount Alignment' will allow the device to automatically determine how the product is mounted within the vehicle's frame of reference.
16+
17+
Additionally, wheel ticks should be provided to the unit to enhance the positional fixes. Please see [Mux Channel](https://docs.sparkfun.com/SparkFun_RTK_Firmware/configure_ports/#mux-channel) of the Ports Menu for more information.
18+
19+

‎docs/menu_wifi.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# WiFi Menu
2+
3+
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)
4+
5+
![WiFi Menu in AP Config page](img/SparkFun%20RTK%20AP%20WiFi%20Menu.png)
6+
7+
*WiFi Menu in the WiFi config page*
8+
9+
![WiFi Network Entry](img/SparkFun%20RTK%20WiFi%20Menu%20Terminal.png)
10+
11+
*WiFi Menu containing one network*
12+
13+
Beginning in firmware version 3.0, the WiFi menu allows a user to input credentials of up to four WiFi networks. WiFi is used for a variety of features on the RTK device. When WiFi is needed, the RTK device will attempt to connect to any network on the list of WiFi networks. For example, if you enter your home WiFi, work WiFi, and the WiFi for a mobile hotspot, the RTK device will automatically detect and connect to the network with the strongest signal.
14+
15+
WiFi is used for the following features:
16+
17+
* NTRIP Client or Server
18+
* TCP Client or Server
19+
* Firmware Updates
20+
* Device Configuration (WiFi mode only)
21+
* PointPerfect Key renewal (RTK Facet L-Band only)
22+
23+
## TCP Client and Server
24+
25+
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.
26+
27+
**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.
28+
29+
![TCP Port Entry](img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20TCP%20Port.png)
30+
31+
If either Client or Server is enabled, a port can be designated. By default, the port is 2947 (registered as [*GPS Daemon request/response*](https://en.wikipedia.org/wiki/Gpsd)) but any port 0 to 65535 is supported.
32+
33+
## Configure Mode: AP vs WiFi
34+
35+
![Configure Mode in WiFi menu](img/WiFi%20Config/SparkFun%20RTK%20Config%20-%20Configure%20Mode.png)
36+
37+
![WiFi Network Entry](img/SparkFun%20RTK%20WiFi%20Menu%20Terminal.png)
38+
39+
By default, the device will become an Access Point when the user selects 'Config' from the front panel controls. This is handy for in-field device configuration. Alternatively, changing this setting to 'WiFi' will cause the device to connect to local WiFi.
40+
41+
![Configuring RTK device over local WiFi](img/WiFi%20Config/SparkFun%20RTK%20AP%20Main%20Page%20over%20Local%20WiFi.png)
42+
43+
Configuring over WiFi allows the device to be configured from any desktop computer that has access to the same WiFi network. This method allows for greater control from a full size keyboard and mouse.
44+
45+
![RTK display showing local IP and SSID](img/WiFi%20Config/SparkFun%20RTK%20WiFi%20Config%20IP.png)
46+
47+
When the device enters WiFi config mode it will display the WiFi network it is connected to as well as its assigned IP address.
48+

‎mkdocs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,16 @@ nav:
8484
- configure_with_wifi.md
8585
- configure_with_bluetooth.md
8686
- configure_with_serial.md
87-
- configure_with_settings_file.md
88-
- configure_ucenter.md
8987
- configure_gnss.md
9088
- configure_messages.md
9189
- configure_base.md
90+
- menu_wifi.md
9291
- configure_ports.md
9392
- configure_data_logging.md
9493
- configure_profiles.md
9594
- configure_pointperfect.md
9695
- menu_radios.md
96+
- menu_sensor.md
9797
- menu_system_status.md
9898
- menu_debug.md
9999
- system_status_report.md
@@ -103,4 +103,6 @@ nav:
103103
- repair.md
104104
- accuracy_verification.md
105105
- embeddedsystem_connection.md
106+
- configure_with_settings_file.md
107+
- configure_ucenter.md
106108
- contribute.md

0 commit comments

Comments
 (0)