Merge branch 'main' of https://github.com/sparkfun/SparkFun_RTK_Firmware

Author: nseidle

docs/configure_ports.md

@@ -20,17 +20,10 @@ The **Data** port on the RTK Facet, Express, and Express Plus is very flexible.
 
 * **NMEA** - The TX pin outputs any enabled messages (NMEA, UBX, and RTCM) at a default of 460,800bps (configurable 9600 to 921600bps). The RX pin can receive RTCM for RTK and can also receive UBX configuration commands if desired.
 * **PPS/Trigger** - The TX pin outputs the pulse-per-second signal that is accurate to 30ns RMS. This pin can be configured as an extremely accurate time base. The pulse length and time between pulses are configurable down to 1us. The RX pin is connected to the EXTINT pin on the ZED-F9P allowing for events to be measured with incredibly accurate nano-second resolution. Useful for things like audio triangulation. See the [External Event Logging](#surveyor-data-port) section below and the Timemark section of the [ZED-F9P Integration Manual](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/ZED-F9P_IntegrationManual__UBX-18010802_.pdf) for more information.
-* **I2C** - The TX pin operates as SCL, RX pin as SDA on the I2C bus. This allows additional sensors to be connected to the I2C bus.
+* **I2C** - (On Express, Facet, and Facet L-Band) The TX pin operates as SCL, RX pin as SDA on the I2C bus. This allows additional sensors to be connected to the I2C bus.
+* **Wheel/Dir Encoder** - (On Express Plus) Connect the DATA port to the wheel tick inputs on the ZED-F9R. This aids the Sensor Fusion engine for IMU based location fixes when installed in an automobile. Signals must be limited to 3.3V.
 * **GPIO** - The TX pin operates as a DAC-capable GPIO on the ESP32. The RX pin operates as an ADC-capable input on the ESP32. This is useful for custom applications.
 
-![Configuring the External Pulse and External Events](img/SparkFun%20RTK%20Ports%20PPS%20Config.png)
-
-*Configuring the External Pulse and External Events over WiFi*
-
-[![RTK Facet Mux Menu](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Ports_Menu_Mux.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Ports_Menu_Mux.jpg)
-
-*Port menu showing mux data port connections*
-
 ## Data Port
 
 By default, the **Data** port is set to 460800bps and can be configured from 4800bps to 921600bps. The 460800bps baud rate was chosen to support applications where a large number of messages are enabled and a large amount of data is sent. If you need to decrease the baud rate to 115200bps or other, be sure to monitor the MON-COMM message within u-center for buffer overruns. A baud rate of 115200bps and the NMEA+RXM default configuration at 4Hz *will* cause buffer overruns.
@@ -43,13 +36,38 @@ If you must run the data port at lower than 460800bps, and you need to enable a
 
 Most applications do not need to plug anything into the **Data** port. Most users will get their NMEA position data over Bluetooth. However, this port can be useful for sending position data to an embedded microcontroller or single-board computer. The pinout is 3.3V / TX / RX / GND. **3.3V** is provided by this connector to power a remote device if needed. While the port is capable of sourcing up to 600mA, we do not recommend more than 300mA. This port should not be connected to a power source.
 
-## Surveyor Data Port
+### Wheel Ticks
 
-By default, the Data port is set to 460800bps and can be configured from 4800bps to 921600bps. 
+![Wheel/Direction Encoder drop down](img/SparkFun%20RTK%20Ports%20Menu%20Mux%20Config.png)
 
-Note: The Data port does not output NMEA by default. The unit must be opened and the *Serial NMEA Connection* switch must be moved to 'Ext Connector'. See [Hardware Overview - Advanced Features](https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_surveyor/#advanced-features) for the location of the switch.
+*On the RTK Express Plus only.* This dropdown is made available if users wish to connect wheel ticks and a direction encoder as inputs to the ZED-F9R. This aids the Sensor Fusion engine for IMU based location fixes when installed in an automobile. Signals must be limited to 3.3V.
+
+### Pulse Per Second
+
+![Configuring the External Pulse and External Events](img/SparkFun%20RTK%20Ports%20PPS%20Config.png)
+
+*Configuring the External Pulse and External Events over WiFi*
+
+[![RTK Facet Mux Menu](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Ports_Menu_Mux.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/8/5/7/SparkFun_RTK_Express_-_Ports_Menu_Mux.jpg)
+
+*Port menu showing mux data port connections*
+
+When PPS/Event Trigger is selected, the Pulse-Per-Second output from the ZED-F9x is sent out of the TX pin of the DATA port. Once the RTK device has GNSS reception, this can be used as a *very* accurate time base. 
+
+The time between pulses can be configured down to 100ns (10MHz) with an accuracy of 30ns RMS and 60ns 99%. The pulse width and polarity are also configurable.
+
+[![Wires connected to a SparkFun USB C to Serial adapter](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Data_Port_to_USB.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/2/1/8/8/SparkFun_RTK_Facet_-_Data_Port_to_USB.jpg)
 
-## External Event Logging
+For PPS, only the Black and Green wires are needed. If you need to provide 3.3V to your system, the red wire can supply up to 600mA but we do not recommend sourcing more than 300mA.
+
+* **Red** - 3.3V
+* **Green** - TX (output from the RTK device)
+* **Orange** - RX (input into the RTK device)
+* **Black** - GND
+
+Similarly, the RX pin of the DATA port can be used for event logging. See [External Event Logging](https://docs.sparkfun.com/SparkFun_RTK_Firmware/configure_ports/#external-event-logging) for more information.
+
+### External Event Logging
 
 ![Three RTK Express with External Triggers](img/RTK%20Express%20with%20External%20Microphones.png)
 
@@ -94,4 +112,11 @@ Where
 * 31: accEst - Accuracy estimate (ns)
 * 74: NMEA CRC
 
-The event timestamps can be analyzed to precisely coordinate or triangulate a past event. In the case of the three RTK Expresses with microphones, the three units' locations were known with RTK 14mm accuracy. The air temperature was taken to obtain the speed of sound. From these data points, we can solve for the location of a sound such as a popped balloon.
+The event timestamps can be analyzed to precisely coordinate or triangulate a past event. In the case of the three RTK Expresses with microphones, the three units' locations were known with RTK 14mm accuracy. The air temperature was taken to obtain the speed of sound. From these data points, we can solve for the location of a sound such as a popped balloon.
+
+## Surveyor Data Port
+
+By default, the Data port is set to 460800bps and can be configured from 4800bps to 921600bps. 
+
+Note: The Data port does not output NMEA by default. The unit must be opened and the *Serial NMEA Connection* switch must be moved to 'Ext Connector'. See [Hardware Overview - Advanced Features](https://sparkfun.github.io/SparkFun_RTK_Firmware/hardware_rtk_surveyor/#advanced-features) for the location of the switch.
+

docs/configure_sensor.md

@@ -0,0 +1,19 @@
+# Sensor Menu
+
+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)
+
+![Sensor menu is shown in WiFi config](img/SparkFun%20RTK%20Sensor%20Menu%20WiFi%20Config.png)
+
+![Sensor menu from serial prompt](img/SparkFun%20RTK%20-%20Sensor%20Menu.png)
+
+*Setting the Sensor options over WiFi config and serial connections*
+
+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.
+
+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).
+
+'Automatic IMU-Mount Alignment' will allow the device to automatically determine how the product is mounted within the vehicle's frame of reference.
+
+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.
+
+

docs/configure_with_bluetooth.md

@@ -6,7 +6,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
 
 *Configuration menu via Bluetooth*
 
-Starting with firmware v2.7, 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/).
+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).
 

docs/configure_with_serial.md

@@ -2,6 +2,8 @@
 
 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.
+
 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.
 
 ## RTK Surveyor / Express / Express+
@@ -46,15 +48,13 @@ Note that some Windows terminal programs (e.g. Tera Term) may reboot the Facet w
 
 Pressing any button will display the Main menu. The Main menu will display the current firmware version and the Bluetooth broadcast name. Note: When powered on, the RTK device will broadcast itself as either *[Platform] Rover-XXXX* or *[Platform] Base-XXXX* depending on which state it is in. The Platform is 'Facet', 'Express', 'Surveyor', etc.
 
-1. Configure GNSS Receiver
-2. Configure GNSS [Messages](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_messages/)
-3. Configure [Base](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_base/)
-4. Configure [Ports](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_ports/)
-5. Configure [Logging](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_data_logging/)
+Pressing '1' or 's' for example, will open those submenus.
+
+The menus will timeout after 10 minutes of inactivity, so if you do not press a key the device will exit the menu and return to reporting status messages.
+
+![Configuration menu open over Bluetooth](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Exit%20BEM.png)
+
+*Configuration menu via Bluetooth*
 
-   p. Configure [Profiles](https://sparkfun.github.io/SparkFun_RTK_Firmware/configure_profiles/)
-   s. [System Status](https://sparkfun.github.io/SparkFun_RTK_Firmware/menu_system_status/)
-   f. Firmware upgrade
-   x. Exit
+**Note:** Starting with firmware v3.0, Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](docs\configure_with_bluetooth.md) for more information.
 
-The menus will timeout after 15 seconds of inactivity, so if you do not press a key the device will exit the menu and return to reporting status messages after 15 seconds.

docs/configure_with_wifi.md

@@ -56,6 +56,14 @@ Clicking on the category 'carrot' will open or close that section. Clicking on a
 
 Please note that the firmware for the RTK device and the firmware for the ZED receiver is shown at the top of the page. This can be helpful when troubleshooting or requesting new features.
 
+## File Manager
+
+![Alt text](img/SparkFun%20RTK%20WiFi%20Config%20File%20Manager.png)
+
+Added in v3.0 firmware, a file manager is shown if an SD card is detected. This is a handy way to download files to a local device (cell phone or laptop) as well as delete any unneeded files. The SD size and free space are shown. And files may be uploaded to the SD card if needed.
+
+Additionally, clicking on the top checkbox will select all files for easy removal of a large number of files.
+
 ## Saving and Exit
 
 [![Save and Exit buttons](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_WiFi_Config_-_System_Save_Exit.jpg)](https://cdn.sparkfun.com/assets/learn_tutorials/1/4/6/3/RTK_Surveyor_-_WiFi_Config_-_System_Save_Exit.jpg)