Merge pull request #577 from sparkfun/PC_add_mosaic_docs

Tweaks

Author: PaulZC

docs/configure_with_ethernet_over_usb.md

@@ -44,15 +44,15 @@ The mosaic-X5's internal web page is (probably) the easiest way to view and chan
 The following is a summary of the mosaic-X5's interfaces and how they can be accessed on the RTK Facet mosaic:
 
 - **Ethernet-over-USB:**
-    - If you have followed the instructions above, the X5's internal web page can be viewed at **192.168.3.1**. This address is fixed and cannot be changed. If any of your computer's other interfaces (WiFi, Ethernet) also the 192.168.3.nnn subnet, you will run into conflicts. You will need to change the configuration of the other device to use a different subnet.
+    - If you have followed the instructions above, the X5's internal web page can be viewed at **192.168.3.1**. This address is fixed and cannot be changed. If any of your computer's other interfaces (WiFi, Ethernet) also use the 192.168.3.nnn subnet, you will run into conflicts. You will need to change the configuration of the other device to use a different subnet.
 - **USB COM (Serial) Ports:**
     - When connected via USB, two additional COM ports will appear. Internally to the X5, these are named _USB1_ and _USB2_. RxTools can connect directly to these ports. Or, if you wish, you can open a serial console / terminal emulator and enter commands directly. We recommend using _USB2_ since _USB1_ may have been [configured for GNSS Output](./menu_ports.md#output-gnss-data-over-usb).
 - **RADIO Port**:
     - The RTK Facet mosaic RADIO port is connected directly to the mosaic-X5 **COM2** serial / UART port. Normally this port carries NMEA and/or RTCM data to/from an external radio module. But, if you wish, you can enter commands direct to this port too. The baud rate can be changed through the menu; the default baud rate is **57600** (8 data bits, no parity, 1 stop bit).
 - **DATA Port:**
     - The RTK Facet mosaic DATA port is connected to the mosaic-X5 **COM3** serial / UART port via a hardware multiplexer. Please see [Ports Menu](./menu_ports.md) for more details, and the section on the [Mux Channel](./menu_ports.md#mux-channel) in particular. Set the multiplexer to **GNSS TX Out/RX In** to connect X5 COM3 to the **DATA** port. The baud rate can be changed through the menu; the default baud rate is **230400** (8 data bits, no parity, 1 stop bit). Commands can be entered over this port too.
 - **ESP32 and RTK Everywhere Firmware:**
-    - The ESP32 processor is connected to the mosaic-X5 **COM1** and **COM4** serial / UART ports. Configuration is performed over COM4. COM1 is used to: provide RTCM correction data _to_ the X5 in Rover mode; carry NMEA and / or RTCM data _from_ the X5 in Base mode. If you have a mobile phone connected to the RTK Facet mosaic over Bluetooth, corrections received over Bluetooth are pushed to the X5 on COM1. If the ESP32 is connected directly to WiFi, TCP (NTRIP) corrections received over WiFi are also pushed over COM1. COM1 also carries the raw L-Band correction stream from the X5, when the X5 is configured to use the u-blox PointPerfect corrections (only available in the contiguous USA).
+    - The ESP32 processor is connected to the mosaic-X5 **COM1** and **COM4** serial / UART ports. Configuration is performed over COM4. COM1 is used to: provide RTCM correction data _to_ the X5 in Rover mode; carry NMEA and / or RTCM data _from_ the X5 in Base mode. If you have a mobile phone connected to the RTK Facet mosaic over Bluetooth, corrections received over Bluetooth are pushed to the X5 on COM1. If the ESP32 is connected directly to WiFi, TCP (NTRIP) corrections received over WiFi are also pushed over COM1. COM1 also carries the raw L-Band correction stream from the X5, when the X5 is configured to use u-blox L-Band PointPerfect corrections (only available in the contiguous USA).
 
 ### mosaic-X5 microSD
 
@@ -158,8 +158,8 @@ However, it is straightforward to define your own SBF Stream and point it at DSK
 
 The abbreviated steps are:
 
-- Select the Logging tab
-- In the General window, select "New SBF stream"
+- Select the _Logging_ tab
+- In the _General_ window, select "New SBF stream"
 - Select the interval (e.g. 1 sec)
 - Click the "Detailed selection" button to reveal the vast list of SBF blocks
 - Select (e.g.) PVTCart / PVTCartesian
@@ -178,7 +178,7 @@ The mosaic-X5 configurations web page - Custom Configuration
 To save this new configuration:
 
 - Select the _Admin / Configurations_ tab
-- In the "Copy Configuration File" window:
+- In the _Copy Configuration File_ window:
     - Select _Current_ as the Source
     - Select _User1_ as the Target
 - Click OK to apply the changes
@@ -215,26 +215,26 @@ As described [above](#mosaic-x5-microsd), the RTK Facet mosaic SD card is connec
 - Connect via USB
 - Facet mosaic is in Rover mode and logging NMEA to DSK1 by default
 - Open a web browser, navigate to 192.168.3.1
-- Select the Logging tab
+- Select the _Logging_ tab
 - Note NMEA is being logged at about 140MB/day
-- Click Unmount and confirm with Unmount
+- Click _Unmount_ and confirm with _Unmount_
 - Note that the Internal Disk is not mounted and logging has stopped
 - On the OLED, the logging icon disappears. The pulse circle is displayed instead
-- The SD card pops up as mass-storage. You can now transfer and delete files
-- Click Mount
+- The SD card pops up as mass-storage on USB. You can now transfer and delete files
+- Click _Mount_
 - Wait a few seconds
 - Logging resumes and the logging icon reappears on the OLED
 
 The X5 is so clever, you don't even need to pause the DSK1 logging. It just figures it out itself, and resumes logging again when DSK1 is remounted.
 
 You can also do it with commands:
 
-- Open Admin \ Expert Control
-- In the Expert Console, enter ```emd,DSK1,Unmount```
-- Go back to the Overview tab, note that the Internal Disk is not mounted
+- Open _Admin / Expert Control_
+- In the _Expert Console_, enter ```emd,DSK1,Unmount```
+- Go back to the _Overview_ tab, note that the Internal Disk is not mounted
 - On the OLED, the logging icon disappears. The pulse circle is displayed
-- The SD card pops up as mass-storage. You can now transfer and delete files
-- Return to the Expert Console, enter ```emd,DSK1,Mount```
+- The SD card pops up as mass-storage on USB. You can now transfer and delete files
+- Return to the _Expert Console_, enter ```emd,DSK1,Mount```
 - Wait a few seconds
 - Logging resumes and the logging icon reappears on the OLED
 

docs/configure_with_rxtools.md

@@ -29,9 +29,15 @@ Download and install RxTools before continuing. This will also install the USB d
 There are multiple ways to connect to the mosaic-X5 using RxTools:
 
 - While the RTF Facet mosaic is connected to your computer via USB, two additional serial COM ports will appear in Device Manager: Septentrio Virtual USB COM Port 1 and 2. RxTools can be configured to use either serial port. The X5 firmware names these ports _USB1_ and _USB2_.
-- The mosaic-X5 also supports Ethernet-Over-USB and can be configured via TCP/IP. In RXControl \ Change Connection, select **TCP/IP Connection** and enter **192.168.3.1** as the Receiver Address.
-- The RTK Facet mosaic **DATA** JST connector is connected the mosaic-X5 _COM3_ UART port via a multiplexer. Please see [Ports Menu](./menu_ports.md) for more details, and the section on the [Mux Channel](./menu_ports.md#mux-channel) in particular. Set the multiplexer to **NMEA** to connect X5 _COM3_ to the **DATA** port. The baud rate can be changed through the menu; the default baud rate is **230400** (8 data bits, no parity, 1 stop bit). To connect the **DATA** port to your computer, you will need a [Serial Basic Breakout](https://www.sparkfun.com/sparkfun-serial-basic-breakout-ch340c-and-usb-c.html) or similar.
+- The mosaic-X5 also supports Ethernet-Over-USB and can be configured via TCP/IP. In RxControl / Change Connection, select **TCP/IP Connection** and enter **192.168.3.1** as the Receiver Address.
+- The RTK Facet mosaic **DATA** JST connector is connected the mosaic-X5 _COM3_ UART port via a multiplexer. Please see [Ports Menu](./menu_ports.md) for more details, and the section on the [Mux Channel](./menu_ports.md#mux-channel) in particular. Set the multiplexer to **GNSS TX Out/RX In** to connect X5 _COM3_ to the **DATA** port. The baud rate can be changed through the menu; the default baud rate is **230400** (8 data bits, no parity, 1 stop bit). To connect the **DATA** port to your computer, you will need a [Serial Basic Breakout](https://www.sparkfun.com/sparkfun-serial-basic-breakout-ch340c-and-usb-c.html) or similar.
+
+<figure markdown>
+![Wires connected to a SparkFun USB C to Serial adapter](./img/SparkFun_RTK_Facet_-_Data_Port_to_USB.jpg)
+<figcaption markdown>
+</figcaption>
+</figure>
 
 If you want to save the X5 configuration after you have changed it, we recommend using either of the _User1_ or _User2_ Receiver Configurations. The RTK Everywhere firmware will modify the _Current_ and _Boot_ Receiver Configurations, but it leaves _User1_ and _User2_ for your use. Copy the _Current_ configuration into (e.g.) _User1_ to save the modified configuration. You can restore it later by copying _User1_ into _Current_. See [Custom Configuration](./configure_with_ethernet_over_usb.md#custom-configuration) for more details.
 
-RxTools is very powerful software. It can read, analyze and visualise log files containing both NMEA and SBF binary data. It can also convert data to other formats. The mosaic-X5 supports data [logging in RINEX format directly](./menu_data_logging.md#rtk-facet-mosaic). But it is also possible to log data in SBF binary format and later convert it to RINEX using RxTools.
+RxTools is very powerful software. It can read, analyze and visualise log files containing both NMEA and SBF binary data. It can also convert data to other formats. The mosaic-X5 supports [data logging in RINEX format directly](./menu_data_logging.md#rtk-facet-mosaic). But it is also possible to log data in SBF binary format and later convert it to RINEX using RxTools.

docs/menu_messages.md

@@ -153,7 +153,7 @@ The GNSS Messages menu on the RTK Facet mosaic is different, due to the way mess
 
 ### RTK Facet mosaic NMEA Messages
 
-Opening the _Configure GNSS Messages \ Set NMEA Messages_ menu produces:
+Opening the _Configure GNSS Messages / Set NMEA Messages_ menu produces:
 
 <figure markdown>
 ![RTK Facet mosaic NMEA configuration](./img/Terminal/SparkFun_RTK_Everywhere_Facet_NMEA_Menu.png)
@@ -197,15 +197,15 @@ The available NMEA messages are:
 - NMEA-ZDA (Time and Date)
 </div>
 
-To output and log a message, set its Stream to _Stream1_ or _Stream2_. To disable a message, set its Stream to _Off_.
+To output and log a message, set its stream to _Stream1_ or _Stream2_. To disable a message, set its stream to _Off_.
 
-E.g. for the ALM message, select "1" to change the Stream from _Off_ to _Stream1_. Select "1" again to select _Stream2_. Select "1" again to return to _Off_.
+E.g. for the ALM message, select "1" to change the stream from _Off_ to _Stream1_. Select "1" again to select _Stream2_. Select "1" again to return to _Off_.
 
 Menu options 31 and 32 can be used to set the interval of _Stream1_ and _Stream2_. The interval can be adjusted between 10 milliseconds and 60 seconds. Be careful when setting the interval to less than 200 milliseconds, the load on the X5 CPU and the SD card will increase significantly.
 
 ### RTK Facet mosaic RTCM Messages
 
-Opening the _Configure GNSS Messages \ Set Rover RTCM Messages_ menu produces:
+Opening the _Configure GNSS Messages / Set Rover RTCM Messages_ menu produces:
 
 <figure markdown>
 ![RTK Facet mosaic Rover RTCM configuration](./img/Terminal/SparkFun_RTK_Everywhere_Facet_RTCM_Menu.png)
@@ -214,7 +214,7 @@ The Rover RTCM messages configuration menu on RTK Facet mosaic
 </figcaption>
 </figure>
 
-RTCM messages are configured differently compared to NMEA. It is necessary to first set the message interval for the message group, then enable / disable the individual message. Streams do not apply to RTCM messages.
+RTCM messages are configured differently compared to NMEA. It is necessary to first set the message interval for the message group, then enable / disable the individual message. Streams do not apply to RTCM messages, and RTCM messages can not be logged to SD card (DSK1).
 
 E.g. to set the RTCM1230 message to an interval of 10 seconds: