You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/software_overview.md
+35-8Lines changed: 35 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -323,6 +323,8 @@ When connected to the ESP32 CH340 COM port at 115200 baud, pressing any key in t
323
323
<figcaptionmarkdown>The ESP32 firmware main menu.</figcaption>
324
324
</figure>
325
325
326
+
### Configure Operation
327
+
326
328
Select option **c** ("c" followed by "Enter") to configure the firmware:
327
329
328
330
<figuremarkdown>
@@ -386,9 +388,7 @@ Select option **c** ("c" followed by "Enter") to configure the firmware:
386
388
***13) Pulse-Per-Second Pulse Width**
387
389
* This defines the width of the PPS signal. The units are milliseconds: 0.000001 to 1000.000000.
388
390
***14) TCP Server (IPS1)**
389
-
* When enabled, the ESP32 serial console is diverted from the CH340 (USB) interface to the mosaic-T COM3 and from there to the IPS1 TCP server.
390
-
* When enabled, the configuration menu and debug messages can be accessed over TCP / Telnet on the chosen port. The CH340 (USB) interface is no longer active.
391
-
* TCP is supported over both Ethernet and the Ethernet-over-USB (CONFIG MOSAIC) connection. Only one TCP2Way connection is supported.
391
+
* See [TCP Server (IPS1)](#tcp-server-ips1) below for more details
392
392
***15) TCP Server Port**
393
393
* The port for the TCP connection. Default is 28785.
394
394
@@ -398,16 +398,42 @@ The settings are saved to non-volatile memory (NVM, LittleFS) on exiting the men
398
398
399
399
The TCXO frequency control word is saved to NVM once per hour, to allow a quicker startup at the next power-on.
400
400
401
+
### TCP Server (IPS1)
402
+
403
+
When **TCP Server (IPS1)** is enabled, the ESP32 serial console is diverted from the CH340 (USB) interface to the mosaic-T COM3 UART interface.
404
+
The serial data is then daisy chained from COM3 to the IPS1 TCP server.
405
+
406
+
When **TCP Server (IPS1)** is enabled, the configuration menu and debug messages can be accessed over TCP / Telnet on the chosen port. The CH340 (USB) interface is then no longer active.
407
+
408
+
TCP / Telnet is supported over both Ethernet and the Ethernet-over-USB connection. Only one TCP2Way connection is supported.
409
+
410
+
If you are using Tera Term:
411
+
412
+
* Select **TCP/IP** and **Telnet**
413
+
* Enter the mosaic-T's IP address in **Host**
414
+
* If you are connected via the CONFIG MOSAIC Ethernet-over-USB interface, the IP address is 192.168.3.1
415
+
* Enter the TCP Server Port number in **TCP port#**
416
+
* The default port is 28785
417
+
418
+
<figuremarkdown>
419
+
[{ width="600" }](./assets/img/hookup_guide/Tera_Term_TCP_Server.png"Click to enlarge")
420
+
<figcaptionmarkdown>Tera Term configuration for TCP.</figcaption>
421
+
</figure>
422
+
423
+
### Debug Software
424
+
401
425
Select option **d** ("d" followed by "Enter") to configure the software debug options:
402
426
403
427
<figuremarkdown>
404
428
[{ width="600" }](./assets/img/hookup_guide/Menu-Debug.png"Click to enlarge")
The debug options are what we use at SparkFun to check that the firmware is running correctly. You should not need change any of the options, except perhaps option 8 ** Print conditions**. This option controls the periodic CSV messages seen in the console when the menu is closed. The format can be changed to human-readable text, or the messages can be disabled if desired.
432
+
The debug options are what we use at SparkFun to check that the firmware is running correctly. You should not need change any of the options, except perhaps option 8 **Print conditions**. This option controls the periodic CSV messages seen in the console when the menu is closed. The format can be changed to human-readable text, or the messages can be disabled if desired.
433
+
434
+
### Print Conditions (Periodic messages)
409
435
410
-
The format of the CSV data is:
436
+
The format of the **Print conditions**CSV data is:
@@ -420,11 +446,12 @@ The format of the CSV data is:
420
446
***TimeSys** is the named TimeSystem from the PVTGeodetic SBF message
421
447
***Error** is the Error byte from the PVTGeodetic SBF message. 0 indicates no error
422
448
***Fine** is the FINETIME bit from the SyncLevel byte from the ReceiverTime SBF message
423
-
***PPS** indicates if the Pulse-Per-Second output is enabled. PPS is enabled when the RxClkBias reaches the required accuracy
449
+
***PPS** indicates if the Pulse-Per-Second output is enabled
450
+
* PPS is enabled when the RxClkBias reaches the required accuracy, set by **RX Clock Bias Lock Limit**
424
451
***Bias** is the receiver clock bias in seconds
425
452
***Source** is the source of the receiver clock bias reported in **Bias**
426
-
* By default, this is the composite RxClkBias reported in the PVTGeodetic SBF message. "PVT" indicates the source is RxClkBias from PVTGeodetic
427
-
* If AtomiChron is enabled and if **Prefer non-composite GPS bias** or **Prefer non-composite Galileo bias** has been selected, this will change to "GPS" or "Galileo" indicating that the individual non-composite bias from the FugroTimeOffset SBF message is being used
453
+
* By default, this is **PVT** indicating the source is the composite RxClkBias from the PVTGeodetic SBF message
454
+
* If AtomiChron is enabled and if **Prefer non-composite GPS bias** or **Prefer non-composite Galileo bias** has been selected, this will change to **GPS** or **Galileo** indicating that the individual non-composite bias from the FugroTimeOffset SBF message is available and is being used
428
455
***TCXO** is the 26-bit signed frequency control word written to the SiT5358 TCXO
429
456
***Pk** is the PI control loop Proportional term - set in the configuration menu
430
457
***Ik** is the PI control loop Integral term - set in the configuration menu
0 commit comments