Prism/Lente Nicegui revamp Documentation Updates

.gitignore

@@ -7,6 +7,8 @@ core/__pycache__/
 public/postgdata/
 
 public/result/
+public/traveller/
+.env
 
 public/users.sqlite
 

docs/build/html/_deployment.html

@@ -43,7 +43,7 @@ <h3>Navigation</h3>
   <section id="deployment">
 <h1>Deployment<a class="headerlink" href="#deployment" title="Link to this heading">¶</a></h1>
 <p>Prism/Lente allows for various deployment strategies, and some diagrams
-are shown <a class="reference external" href="_system.html#_system_arch">here</a>.</p>
+are shown <a class="reference internal" href="_system.html#system-arch"><span class="std std-ref">here</span></a>.</p>
 <p>Lente deployment depends on your dashboarding and Prism station management strategy.
 A Lente station can manage Prism stations directly below it, in the connection
 hierarchy.</p>

docs/build/html/_mes_integration.html

@@ -41,7 +41,7 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <section id="manufacturing-execution-system-mes-integration">
-<h1>Manufacturing Execution System (MES) Integration<a class="headerlink" href="#manufacturing-execution-system-mes-integration" title="Link to this heading">¶</a></h1>
+<span id="mes-integration"></span><h1>Manufacturing Execution System (MES) Integration<a class="headerlink" href="#manufacturing-execution-system-mes-integration" title="Link to this heading">¶</a></h1>
 <p>Manufacturing Execution Systems (MES) offer many benefits including enhanced visibility into
 production, improved efficiency, cost reduction, and better inventory monitoring.</p>
 <p>The Prism-Lente framework supports integration using industry standard protocol OPC-UA.

docs/build/html/_prodplan.html

@@ -232,7 +232,7 @@ <h2><a class="toc-backref" href="#id5" role="doc-backlink">Naming Proposal</a><a
   <span class="s2">&quot;config&quot;</span><span class="p">:</span> <span class="p">{</span>
     <span class="s2">&quot;result&quot;</span><span class="p">:</span> <span class="s2">&quot;public.prism.result.ResultBaseKeysV1&quot;</span><span class="p">,</span>
     <span class="s2">&quot;fail_fast&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
-    <span class="s2">&quot;drivers&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;public.prism.drivers.fake.fake&quot;</span><span class="p">]</span>
+    <span class="s2">&quot;drivers&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;public.prism.drivers.fake.hwdrv_fake&quot;</span><span class="p">]</span>
   <span class="p">},</span>
   <span class="s2">&quot;tests&quot;</span><span class="p">:</span> <span class="p">[</span>
     <span class="p">{</span>

docs/build/html/_security.html

@@ -58,7 +58,7 @@ <h1>Security<a class="headerlink" href="#security" title="Link to this heading">
 </nav>
 <section id="settings-json">
 <h2><a class="toc-backref" href="#id1" role="doc-backlink">Settings.json</a><a class="headerlink" href="#settings-json" title="Link to this heading">¶</a></h2>
-<p>Most of the security of the system is set by <a class="reference external" href="_deployment.html#_SettingsFile">settings.json</a>.</p>
+<p>Most of the security of the system is set by <a class="reference internal" href="_deployment.html#deploy-settings-file"><span class="std std-ref">settings.json</span></a>.</p>
 <p><cite>settings.json</cite> file is unique to each Prism/Lente in the deployment.  It is common for
 multiple Prism computers sitting below Lente to have the same <cite>settings.json</cite>, assuming the settings are the same.</p>
 <p><cite>settings.json</cite> is edited/created when Prism/Lente computer is configured.</p>
@@ -68,7 +68,7 @@ <h2><a class="toc-backref" href="#id1" role="doc-backlink">Settings.json</a><a c
 </section>
 <section id="manifest-checking">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">Manifest Checking</a><a class="headerlink" href="#manifest-checking" title="Link to this heading">¶</a></h2>
-<p>Enable Manifest checking in the <a class="reference external" href="_deployment.html#_SettingsFile">settings.json</a>. file.</p>
+<p>Enable Manifest checking in the <a class="reference internal" href="_deployment.html#deploy-settings-file"><span class="std std-ref">settings.json</span></a>. file.</p>
 <p>The Manifest (file) is created by Lente to ensure the integrity of the all the scripts and supporting files.
 The manifest is a list of files and corresponding hashes, which Prism will use to validate there are no
 changes to the files it will use to test.  The Manifest file itself is encrypted and cannot be viewed.</p>
@@ -124,7 +124,7 @@ <h2><a class="toc-backref" href="#id6" role="doc-backlink">Postgres DB</a><a cla
 <ul class="simple">
 <li><p>Change the default password!</p>
 <ul>
-<li><p>Also remember to use the same password in <a class="reference external" href="_deployment.html#_SettingsFile">settings.json</a>.</p></li>
+<li><p>Also remember to use the same password in <a class="reference internal" href="_deployment.html#deploy-settings-file"><span class="std std-ref">settings.json</span></a>.</p></li>
 </ul>
 </li>
 </ul>
@@ -137,7 +137,7 @@ <h2><a class="toc-backref" href="#id6" role="doc-backlink">Postgres DB</a><a cla
 These keys will still be using the same TLS protocol over the connection and are therefore just as secure.</p>
 <p>However, since the (Chrome) browser is not able to authenticate the self signed keys/certificate it
 will indicate that the connection is “untrusted” and will prompt the user to validate the connection.</p>
-<p>With HTTPS the connection between Prism/Lente is now encrypted.  <a class="reference external" href="_deployment.html#_SettingsFile">settings.json</a>
+<p>With HTTPS the connection between Prism/Lente is now encrypted.  <a class="reference internal" href="_deployment.html#deploy-settings-file"><span class="std std-ref">settings.json</span></a>
 has <cite>prism_lente_pw</cite> which should also be set to something unique.  This setting needs to be the same
 across all the Prism/Lente computers.</p>
 <p>On deployed Prism/Lente computers the user account is presumed to be secure.  The Ubuntu filesystem should
@@ -167,7 +167,7 @@ <h2><a class="toc-backref" href="#id6" role="doc-backlink">Postgres DB</a><a cla
 </div>
 <ul class="simple">
 <li><p>Generate the cert/key file on each Prism/Lente computer.</p></li>
-<li><p>See the <a class="reference external" href="_deployment.html#_SettingsFile">settings.json</a> to enable HTTPS and set the Prism/Lente password.</p></li>
+<li><p>See the <a class="reference internal" href="_deployment.html#deploy-settings-file"><span class="std std-ref">settings.json</span></a> to enable HTTPS and set the Prism/Lente password.</p></li>
 <li><p>In the browser, connect over HTTPs,</p>
 <ul>
 <li><p>for Prism use <cite>https://127.0.0.1:6590</cite></p></li>

docs/build/html/_sources/_deployment.rst.txt

@@ -2,7 +2,7 @@ Deployment
 ##########
 
 Prism/Lente allows for various deployment strategies, and some diagrams
-are shown `here <_system.html#_system_arch>`__.
+are shown :ref:`here <system_arch>`.
 
 Lente deployment depends on your dashboarding and Prism station management strategy.
 A Lente station can manage Prism stations directly below it, in the connection

docs/build/html/_sources/_mes_integration.rst.txt

@@ -1,3 +1,5 @@
+.. _mes-integration:
+
 Manufacturing Execution System (MES) Integration
 ################################################
 

docs/build/html/_sources/_prodplan.rst.txt

@@ -181,7 +181,7 @@ Example script P00100_T0100_SmokeTests.scr,
       "config": {
         "result": "public.prism.result.ResultBaseKeysV1",
         "fail_fast": false,
-        "drivers": ["public.prism.drivers.fake.fake"]
+        "drivers": ["public.prism.drivers.fake.hwdrv_fake"]
       },
       "tests": [
         {

docs/build/html/_sources/_security.rst.txt

@@ -13,7 +13,7 @@ until the system is operating correctly and only then able encryption and other
 Settings.json
 =============
 
-Most of the security of the system is set by `settings.json <_deployment.html#_Settings File>`__.
+Most of the security of the system is set by :ref:`settings.json <deploy-settings-file>`.
 
 `settings.json` file is unique to each Prism/Lente in the deployment.  It is common for
 multiple Prism computers sitting below Lente to have the same `settings.json`, assuming the settings are the same.
@@ -29,7 +29,7 @@ Prism computers should remove the Lente section of the `settings.json` file.
 Manifest Checking
 =================
 
-Enable Manifest checking in the `settings.json <_deployment.html#_Settings File>`__. file.
+Enable Manifest checking in the :ref:`settings.json <deploy-settings-file>`. file.
 
 The Manifest (file) is created by Lente to ensure the integrity of the all the scripts and supporting files.
 The manifest is a list of files and corresponding hashes, which Prism will use to validate there are no
@@ -99,7 +99,7 @@ Postgres DB
 
 * Change the default password!
 
-  * Also remember to use the same password in `settings.json <_deployment.html#_Settings File>`__.
+  * Also remember to use the same password in :ref:`settings.json <deploy-settings-file>`.
 
 
 .. _https:
@@ -116,7 +116,7 @@ These keys will still be using the same TLS protocol over the connection and are
 However, since the (Chrome) browser is not able to authenticate the self signed keys/certificate it
 will indicate that the connection is "untrusted" and will prompt the user to validate the connection.
 
-With HTTPS the connection between Prism/Lente is now encrypted.  `settings.json <_deployment.html#_Settings File>`__
+With HTTPS the connection between Prism/Lente is now encrypted.  :ref:`settings.json <deploy-settings-file>`
 has `prism_lente_pw` which should also be set to something unique.  This setting needs to be the same
 across all the Prism/Lente computers.
 
@@ -151,7 +151,7 @@ organization information, if desired.
 
 
 * Generate the cert/key file on each Prism/Lente computer.
-* See the `settings.json <_deployment.html#_Settings File>`__ to enable HTTPS and set the Prism/Lente password.
+* See the :ref:`settings.json <deploy-settings-file>` to enable HTTPS and set the Prism/Lente password.
 * In the browser, connect over HTTPs,
 
   * for Prism use `https://127.0.0.1:6590`

docs/build/html/_sources/_version_history.rst.txt

@@ -36,7 +36,7 @@ Prism
 ~~~~~~
 
 * [BUGFIX] Fix/improve getting self IP address (implemented in 0.7.52)
-* Support for UPCUA, see `OPCUA <_mes_integration.html#_Manufacturing>`__
+* Support for UPCUA, see :ref:`OPCUA <mes-integration>`
 * Test portal layout supports up to 8 test channels (jigs per Prism PC) (implemented in 0.7.43)
 * Index page shows time and date (implemented in 0.7.56)
 * Auto config test on startup, see :ref:`settings.json <deploy-settings-file>` (implemented in 0.7.64)
@@ -52,7 +52,7 @@ Lente
 ~~~~~~
 
 * [BUGFIX] Fix/improve getting self IP address
-* Support for UPCUA, see `OPCUA <_mes_integration.html#_Manufacturing>`__
+* Support for UPCUA, see :ref:`OPCUA <mes-integration>`
 * Station Management portal can remotely,
 
   * request Prism Log (implemented in 0.7.48)

docs/build/html/_sources/lente_accounts.rst.txt

@@ -14,11 +14,11 @@ Users
 
 Users should be added to the system, rather than using the Admin account.
 
-Users need to have unique username.
+Users need to have a unique username.
 
 Users are added by another user (Admin) who has Account role privileges.
 
-A new User account must have the role `Enabled` in order to login.
+A new User account must be set `Active` in order to login.
 
 
 Roles
@@ -30,24 +30,23 @@ The following roles are defined,
 
     "roles": {
         # Framework Roles
-        "ENABLED": "Enabled",
-        "ACCOUNT": "Account",
+        "ACCOUNT": "Account Admin, Add/Edit Roles & Users",
         "ADMIN":   "Administrator",  # rights to do anything
 
         # App specific Roles
         "OPERATOR":   "Operator",
-        "CONFIGMAN":  "Config Management",
+        "CONFIGMAN":  "Configuration Management",
         "DEVELOPER":  "Developer",
         "SERVERSYNC": "ServerSync",  # causes user to be pushed to all stations
     },
 
 
-Enabled
-=======
+Active
+======
+
+`Active` is not a Role.  It is a separate setting on the Account Management page.
 
-Without this role, the User cannot log into the system.  When a User is created,
-this role is NOT set.  After a User is created, you must access the Roles menu
-and add `Enabled` to the User for them to be able to login.
+Without `Active` set, the User cannot log into the system.
 
 This allows you to disable a User without deleting their account.
 
@@ -56,7 +55,7 @@ Admin
 
 The Admin(istrator) role has access to all system functions and menus.
 
-In general its good practice to have two Users with Admin role.
+In general it's good practice to have two Users with Admin role.
 
 Account
 =======
@@ -71,27 +70,27 @@ PRISM ONLY
 Basic role for operating Prism.
 
 Operator allows the User to scan a traveller and run tests.
-The User **cannot** use `Test Config` menu.
+The User **cannot** use `Test Configuration` page.
 
 ConfigMan
 =========
 
 PRISM ONLY
 
-Allows the User to use the `Test Config` menu, which allows the user to pick which
+Allows the User to use the `Test Configuration` page, which allows the user to pick which
 script to run, and fill in any parameters for the script, and also to be able to create
 a Traveller.
 
 Developer
 =========
 
-Currently this has no purpose.
+Same as Administrator, except without access to the account management pages.
 
 ServerSync
 ==========
 
 A User with this setting means their profile is controlled from Lente.  You
-may edit the user here on Prism, but if Users are sync'd from Lente, your changes
+may edit the user on a Prism station, but if Users are sync'd from Lente, your changes
 will be overridden by the profile on Lente.
 
 All changes to this User should be made on Lente.

docs/build/html/_sources/lente_cloud.rst.txt

@@ -85,7 +85,7 @@ Run these commands to install `scripts`,
     git clone https://github.com/sistemicorp/scripts.git
 
 
-Follow `these <lente_demo.html#Postgres>`__ instructions to start postgres server.
+Follow :ref:`these <lente-demo-postgres>` instructions to start postgres server.
 
 
 Run the Lente start script

docs/build/html/_sources/lente_demo.rst.txt

@@ -30,6 +30,8 @@ Requirements
   * install Docker CE (https://docs.docker.com/install/linux/docker-ce/ubuntu/)
 
 
+.. _lente-demo-postgres:
+
 Postgres
 ********
 

docs/build/html/_sources/lente_main.rst.txt

@@ -3,7 +3,7 @@ Lente
 
 Lente is a backend server that has two main functions.
 
-* dB (PostGres) interface
+* dB (Postgres) interface
 
   * receives results from connected Prism computers
   * stores test results into the dB

docs/build/html/_sources/lente_screenshots.rst.txt

@@ -3,49 +3,64 @@ Screenshots
 
 Lente screenshots.
 
-Dashboard
-*********
-Lente provides two dashboards.  The first shown here shows a historical summary of units tested, pass/fail and yield, over
-the previous week.  The table below shows the currently active test stations, and their status.
+Result Analytics
+****************
 
-.. image:: static/Screenshot_lente_dashboard_02.png
+The Result Analytics dashboard is for detailed results analysis.  Results shown graphically and in
+the table are filtered by the current state of the "Select/Date" filters.
 
-The second dashboard is for detailed results analysis.  The important thing about this dashboard is that the results shown
-graphically or in the table are filtered by the current state of the "Select/Date" filters across the top of the dashboard.
+The dashboard has three views, selected by the tabs across the top,
 
-The graph is a view of the previous week's history of Pass/Fail/Yield numbers.
+* `Throughput & Yield` - history of Pass/Fail/Yield numbers
+* `Failure Pareto` - which tests are failing, ranked by how often
+* `Test Runtime` - where the test time is being spent
 
-The right table is each result.  By selecting a result in this table, a new tab is opened with the result details.
+The `Results Summary` panel on the right totals the Pass/Fail/Yield for the current filter selection.
 
-The table on the bottom left counts the various types of Fail tests.
+The table below the filters is each result.  By selecting a result in this table, a new tab is opened with the
+result details.
 
-.. image:: static/Screenshot_lente_dashboard_01.png
+The `Throughput & Yield` tab charts the units tested over time; Pass and Fail as stacked bars against the left
+axis, and Yield as a line against the right axis.  The period selector sets the size of each bar, for
+example `Daily`.  Use this to track production output and yield trend.
 
+.. image:: static/Screenshot_lente_throughput.png
 
-Station Management
-******************
+The `Failure Pareto` tab ranks the failing tests by quantity, and shows each as a percentage of the failed runs
+and of all runs.  Use this to find which tests are costing you the most yield.
 
-Prism and Lente Station management console.
+.. image:: static/Screenshot_lente_pareto.png
 
-* View station stats
-* Take actions (Ping, Sync)
+The `Test Runtime` tab breaks down where the test time is being spent.  Select the `Script` and the `Script Result`
+to report on.  The table gives the average time of each test item and its percentage of the total, and the pie
+chart shows the same proportions.  Use this to find which test items to optimize to reduce cycle time.
 
-.. image:: static/Screenshot_lente_dashboard_03.png
+.. image:: static/Screenshot_lente_runtime.png
 
 
-Account Management
-******************
+Station Manager
+***************
 
-User Summary
+Prism and Lente Station management console.
 
-.. image:: static/Screenshot_lente_dashboard_06.png
+* View station stats - version, scripts, backups, disk usage, the script running, active users, and last ping
+* Select stations and take actions - `Ping`, `Get Log`, `Restart`, `Sync Users`, `Sync Script`
+* `Station Logs` below lists station events, filtered by the Type/Computer/Version/Cause and date selections
 
+.. image:: static/Screenshot_lente_station_mgr.png
+
+
+Account Management
+******************
 
-Create Users
+A single page manages all of the Account Management features.
 
-.. image:: static/Screenshot_lente_dashboard_04.png
+The table at the top summarizes the Users; their email, whether they are Active, their Language, and their Roles.
 
+* `New Account` creates a User
+* Selecting a User in the table loads them into the editor below
 
-Edit User Roles
+The editor sets the User's Language, whether the account is `Active`, and which Roles they hold.  `Set Password`
+sets the User's password.  `Update` saves the changes, `Reset` discards them, and `Delete` removes the User.
 
-.. image:: static/Screenshot_lente_dashboard_05.png
+.. image:: static/Screenshot_lente_acct_mgt.png