Skip to content

Add OPC-UA Server documentation and settings #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add OPC-UA Server documentation and settings #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c6bf71
Add OPC-UA Server documentation and settings
andrewoaks-staric May 15, 2025
dfa9cd2
Add certificate details to documentation
andrewoaks-staric May 15, 2025
5f12764
Add link to HTTPS generation in _mes_integration
andrewoaks-staric May 15, 2025
3b6d40b
Add uaExpert Client Screenshot
andrewoaks-staric May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/build/doctrees/_database.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/_deployment.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/_development.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/_jigs.doctree
View file
Open in desktop
Binary file not shown.
Binary file added docs/build/doctrees/_mes_integration.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/_prodplan.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/_security.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/_system.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/lente_accounts.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/lente_cloud.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/lente_demo.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/lente_main.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/lente_screenshots.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_accounts.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_demo.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_drivers.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_main.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_programs.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_screenshots.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_scripts.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_sw_arch.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/prism_travellers.doctree
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/build/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: efc70a3cff7219ccfb3a987dfe6959f2
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a8046214103c2320d6436174ea5000b5
tags: 645f666f9bcd5a90fca523b33c5a78b7
84 changes: 43 additions & 41 deletions docs/build/html/_database.html
View file
Open in desktop

Large diffs are not rendered by default.

62 changes: 37 additions & 25 deletions docs/build/html/_deployment.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@

<!DOCTYPE html>

<html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Deployment &#8212; Sistemi Lente/Prism Test System 0.6.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=2bf1fcf8" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/documentation_options.js?v=8fa8b3e9"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Manufacturing Execution System (MES) Integration" href="_mes_integration.html" />
<link rel="prev" title="Security" href="_security.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="_mes_integration.html" title="Manufacturing Execution System (MES) Integration"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="_security.html" title="Security"
accesskey="P">previous</a> |</li>
Expand All @@ -39,15 +41,15 @@ <h3>Navigation</h3>
<div class="body" role="main">

<section id="deployment">
<h1>Deployment<a class="headerlink" href="#deployment" title="Permalink to this headline">¶</a></h1>
<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>
<p>Prism deployment is straight foward.</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>
<section id="ubuntu-file-system-and-users">
<span id="deployment-ubuntu-filesystem"></span><span id="index-0"></span><h2>Ubuntu File System and Users<a class="headerlink" href="#ubuntu-file-system-and-users" title="Permalink to this headline">¶</a></h2>
<span id="deployment-ubuntu-filesystem"></span><span id="index-0"></span><h2>Ubuntu File System and Users<a class="headerlink" href="#ubuntu-file-system-and-users" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Install Ubuntu onto the computers and enable file system encryption</p>
<ul>
Expand Down Expand Up @@ -80,7 +82,7 @@ <h1>Deployment<a class="headerlink" href="#deployment" title="Permalink to this
</ul>
</section>
<section id="installing-prism-lente-stations">
<h2>Installing Prism/Lente Stations<a class="headerlink" href="#installing-prism-lente-stations" title="Permalink to this headline">¶</a></h2>
<h2>Installing Prism/Lente Stations<a class="headerlink" href="#installing-prism-lente-stations" title="Link to this heading">¶</a></h2>
<p>For Prism/Lente stations, follow the Full “Demo” instructions, but note the following
changes,</p>
<ul class="simple">
Expand Down Expand Up @@ -113,7 +115,7 @@ <h2>Installing Prism/Lente Stations<a class="headerlink" href="#installing-prism
</ul>
</section>
<section id="settings-json-file">
<span id="deploy-settings-file"></span><h2>Settings.JSON File<a class="headerlink" href="#settings-json-file" title="Permalink to this headline">¶</a></h2>
<span id="deploy-settings-file"></span><h2>Settings.JSON File<a class="headerlink" href="#settings-json-file" title="Link to this heading">¶</a></h2>
<p>Each Lente/Prism station instillation will have a local settings file, as
shown below and documented inline,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>// This file is NOT propagated by Lente to Prism stations.
Expand Down Expand Up @@ -193,7 +195,7 @@ <h2>Installing Prism/Lente Stations<a class="headerlink" href="#installing-prism
to be configured for each computer (Lente or Prism) in the deployment.</p>
</section>
<section id="prism-lente-docker-images">
<h2>Prism/Lente Docker Images<a class="headerlink" href="#prism-lente-docker-images" title="Permalink to this headline">¶</a></h2>
<h2>Prism/Lente Docker Images<a class="headerlink" href="#prism-lente-docker-images" title="Link to this heading">¶</a></h2>
<p>On computers that are deployed, you will want the Docker images to run (and restart)
every time the computer boots up.</p>
<p>The helper scripts to start Prism/Lente (see <a class="reference internal" href="_system.html#system-helper-docker"><span class="std std-ref">Helpers</span></a>),
Expand All @@ -207,31 +209,41 @@ <h2>Prism/Lente Docker Images<a class="headerlink" href="#prism-lente-docker-ima
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="_security.html"
title="previous chapter">Security</a></p>
<div id="searchbox" style="display: none" role="search">
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="_security.html"
title="previous chapter">Security</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="_mes_integration.html"
title="next chapter">Manufacturing Execution System (MES) Integration</a></p>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="_mes_integration.html" title="Manufacturing Execution System (MES) Integration"
>next</a> |</li>
<li class="right" >
<a href="_security.html" title="Security"
>previous</a> |</li>
Expand All @@ -240,8 +252,8 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2019-2023, Sistemi Corp..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
&#169; Copyright 2019-2023, Sistemi Corp..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>
66 changes: 34 additions & 32 deletions docs/build/html/_development.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@

<!DOCTYPE html>

<html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Development &#8212; Sistemi Lente/Prism Test System 0.6.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=2bf1fcf8" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/documentation_options.js?v=8fa8b3e9"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Test Jigs" href="_jigs.html" />
<link rel="prev" title="Results Database" href="_database.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -43,9 +41,9 @@ <h3>Navigation</h3>
<div class="body" role="main">

<section id="development">
<h1>Development<a class="headerlink" href="#development" title="Permalink to this headline">¶</a></h1>
<h1>Development<a class="headerlink" href="#development" title="Link to this heading">¶</a></h1>
<p>This section describes how to get started with your own development.</p>
<div class="contents local topic" id="contents">
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#your-own-git-repo" id="id1">Your Own Git Repo</a></p></li>
<li><p><a class="reference internal" href="#repo-setup" id="id2">Repo Setup</a></p>
Expand All @@ -57,9 +55,9 @@ <h1>Development<a class="headerlink" href="#development" title="Permalink to thi
</li>
<li><p><a class="reference internal" href="#command-line-development" id="id6">Command Line Development</a></p></li>
</ul>
</div>
</nav>
<section id="your-own-git-repo">
<h2><a class="toc-backref" href="#id1">Your Own Git Repo</a><a class="headerlink" href="#your-own-git-repo" title="Permalink to this headline">¶</a></h2>
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Your Own Git Repo</a><a class="headerlink" href="#your-own-git-repo" title="Link to this heading">¶</a></h2>
<p>You will want to begin with setting up your own Git repo. If you are unfamiliar with Git,
then you should read up on it, and/or do some tutorials. It is beyond the scope
of this documentation to teach Git.</p>
Expand Down Expand Up @@ -146,10 +144,10 @@ <h2><a class="toc-backref" href="#id1">Your Own Git Repo</a><a class="headerlink
</ul>
</section>
<section id="repo-setup">
<h2><a class="toc-backref" href="#id2">Repo Setup</a><a class="headerlink" href="#repo-setup" title="Permalink to this headline">¶</a></h2>
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Repo Setup</a><a class="headerlink" href="#repo-setup" title="Link to this heading">¶</a></h2>
<p>Additional steps.</p>
<section id="install-git-hooks">
<h3><a class="toc-backref" href="#id3">Install Git Hooks</a><a class="headerlink" href="#install-git-hooks" title="Permalink to this headline">¶</a></h3>
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Install Git Hooks</a><a class="headerlink" href="#install-git-hooks" title="Link to this heading">¶</a></h3>
<p><em>Git Hooks are generally replaced by Git Actions and are beyond the scope of these instructions</em></p>
<p>In the <cite>scripts</cite> repo, there is a folder called <cite>hooks</cite>. The contents of this folder
needs to be copied to <cite>./.git/hooks</cite> folder of your repository.</p>
Expand All @@ -160,7 +158,7 @@ <h3><a class="toc-backref" href="#id3">Install Git Hooks</a><a class="headerlink
</div>
</section>
<section id="create-a-tag">
<h3><a class="toc-backref" href="#id4">Create a Tag</a><a class="headerlink" href="#create-a-tag" title="Permalink to this headline">¶</a></h3>
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Create a Tag</a><a class="headerlink" href="#create-a-tag" title="Link to this heading">¶</a></h3>
<p>The Sistemi system reports the version of things to help keep you organized, including the version of your scripts.</p>
<p>On whatever branch you decide to “release” your scripts, for example, the “master” branch, create a
tag on that branch. The tag <strong>MUST</strong> be of this format,</p>
Expand Down Expand Up @@ -194,12 +192,12 @@ <h3><a class="toc-backref" href="#id4">Create a Tag</a><a class="headerlink" hre
</div>
</section>
<section id="change-readme-md">
<h3><a class="toc-backref" href="#id5">Change README.md</a><a class="headerlink" href="#change-readme-md" title="Permalink to this headline">¶</a></h3>
<h3><a class="toc-backref" href="#id5" role="doc-backlink">Change README.md</a><a class="headerlink" href="#change-readme-md" title="Link to this heading">¶</a></h3>
<p>Change this file to suit your needs. For example, document your script/program naming strategy.</p>
</section>
</section>
<section id="command-line-development">
<h2><a class="toc-backref" href="#id6">Command Line Development</a><a class="headerlink" href="#command-line-development" title="Permalink to this headline">¶</a></h2>
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Command Line Development</a><a class="headerlink" href="#command-line-development" title="Link to this heading">¶</a></h2>
<p>Initial development will be done in “headless” mode, whereupon coding is done outside of the GUI used in production.</p>
<p>A command line version of the core engine of the system is at the top of the <cite>scripts</cite> folder, called <cite>prism_dev.py</cite>.
The command line help,</p>
Expand Down Expand Up @@ -243,29 +241,33 @@ <h2><a class="toc-backref" href="#id6">Command Line Development</a><a class="hea
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="_database.html"
title="previous chapter">Results Database</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="_jigs.html"
title="next chapter">Test Jigs</a></p>
<div id="searchbox" style="display: none" role="search">
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="_database.html"
title="previous chapter">Results Database</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="_jigs.html"
title="next chapter">Test Jigs</a></p>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -282,8 +284,8 @@ <h3>Navigation</h3>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2019-2023, Sistemi Corp..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
&#169; Copyright 2019-2023, Sistemi Corp..
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>
Binary file added docs/build/html/_images/Screenshot_mes_integration_uaexpert.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading