Added NMEA-0183 listener documentation.

eriffon · Oct 10, 2023 · 8b25dbc · 8b25dbc
1 parent 6e90f40
commit 8b25dbc
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/docs/_static/ssm_nmea0183_input.png b/docs/_static/ssm_nmea0183_input.png
diff --git a/docs/_static/ssm_nmea0183_listeners.png b/docs/_static/ssm_nmea0183_listeners.png
diff --git a/docs/user_manual_setup.rst b/docs/user_manual_setup.rst
@@ -10,3 +10,4 @@ Setup
     user_manual_setup_settings
     user_manual_setup_sis_v4
     user_manual_setup_sis_v5
+    user_manual_setup_nmea0183
diff --git a/docs/user_manual_setup_nmea0183.rst b/docs/user_manual_setup_nmea0183.rst
@@ -0,0 +1,37 @@
+.. _nmea0183:
+
+Sound Speed Manager - NMEA-0183 interaction
+===========================================
+
+.. index:: NMEA-0183
+
+A rudimentary NMEA-0183 listener can be used to capture the current location via a UDP broadcast of NMEA-0183 $--GGA or $--GLL sentences. This feature can be used to associate the current position to the sound speed profile formats that cannot store location information.
+
+Open in editing mode the Sound Speed Manager’s Setup Tab, then set the NMEA-0183 listen port the Listeners sub-tab (see :numref:`ssm_nmea0183_listeners_fig`).
+
+.. _ssm_nmea0183_listeners_fig:
+
+.. figure:: ./_static/ssm_nmea0183_listeners.png
+    :width: 618px
+    :align: center
+    :height: 472px
+    :alt: figure with nmea0183 settings part 1
+    :figclass: align-center
+
+    *Sound Speed Manager Setup Listeners* dialog, with the *Listen Port* setting and incoming NMEA-0183 data highlighted in red.
+
+Then, switch to the Input sub-tab (see :numref:`ssm_nmea0183_input_fig`) and select the True value for the Listen NMEA-0183 field. The current position is displayed in the status bar.    
+
+.. _ssm_nmea0183_input_fig:
+
+.. figure:: ./_static/ssm_nmea0183_input.png
+    :width: 618px
+    :align: center
+    :height: 472px
+    :alt: figure with nmea0183 settings part 2
+    :figclass: align-center    
+
+    *Input tab* in the Sound Speed Manager’s Setup.
+
+.. note::
+    I don't know why the figure number is not being displayed.