docs for main gui widget

software overview
CohenLabPrinceton · Aug 16, 2020 · 19fea69 · 19fea69
1 parent 766d937
commit 19fea69
Show file tree

Hide file tree

Showing 9 changed files with 498 additions and 361 deletions.
diff --git a/_docs/_src/sass/_theme_etc_local.sass b/_docs/_src/sass/_theme_etc_local.sass
@@ -45,7 +45,7 @@
 
   h2
     margin: 0
-    
+
     @media (max-width: $breakpoint-tablet)
       margin-top: 1rem
 

diff --git a/_docs/controller.rst b/_docs/controller.rst
@@ -1,4 +1,6 @@
-controller module
+.. _controller_overview:
+
+Controller
 =================
 
 .. automodule:: pvp.controller.control_module

diff --git a/_docs/coordinator.rst b/_docs/coordinator.rst
@@ -1,3 +1,5 @@
+.. _coordinator_overview:
+
 coordinator module
 ========================
 

diff --git a/_docs/gui.main.rst b/_docs/gui.main.rst
@@ -3,5 +3,4 @@ Main GUI Module
 
 .. automodule:: pvp.gui.main
     :members:
-    :undoc-members:
     :autosummary:
diff --git a/_docs/gui.rst b/_docs/gui.rst
@@ -1,3 +1,5 @@
+.. _gui_overview:
+
 GUI
 ======
 

diff --git a/_docs/pvp.common.prefs.rst b/_docs/pvp.common.prefs.rst
@@ -1,4 +1,6 @@
-prefs
+.. _prefs_overview:
+
+Prefs
 =========
 
 .. automodule:: pvp.common.prefs

diff --git a/_docs/pvp.common.values.rst b/_docs/pvp.common.values.rst
@@ -1,4 +1,6 @@
-values
+.. _values_overview:
+
+Values
 ========
 
 Parameterization of variables and values

diff --git a/_docs/software_overview.rst b/_docs/software_overview.rst
@@ -6,6 +6,22 @@ Software Overview
 .. raw:: html
     :file: assets/images/pvp_software_overview_clickable.svg
 
+PVP runs as three independent processes:
+
+* The :ref:`GUI <gui_overview>` and :ref:`Coordinator <coordinator_overview>` run in the first process, receive user input, display system status, and relay :class:`~.message.ControlSetting` s to the :ref:`Controller <controller_overview>` .
+* At launch, the :ref:`Coordinator <coordinator_overview>` spawns a :ref:`Controller <controller_overview>` that runs the logic of the ventilator based on control values from the GUI.
+* The :ref:`Controller <controller_overview>` communicates with a third `pigpiod <http://abyz.me.uk/rpi/pigpio/>`_ process which communicates with the ventilation hardware
+
+PVP is configured by
+
+* The :ref:`Values <values_overview>` module parameterizes the different sensor and control values displayed by the GUI and used by the controller
+* The :ref:`Prefs <prefs_overview>` module creates a ``prefs.json`` file in ``~/pvp`` that defines user-specific preferences.
+
+PVP is launched like::
+
+    python3 -m pvp.main
+
+And launch options can be displayed with the ``--help`` flag.
 
 PVP Modules
 ------------