Skip to content

Commit

Permalink
deploy: b402b8d
Browse files Browse the repository at this point in the history
  • Loading branch information
@LoydIrrving
LoydIrrving committed Jul 5, 2024
1 parent 5fc864e commit 9fcc196
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 103 deletions.
116 changes: 15 additions & 101 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Dashboard_Documentation.knit</title>
<meta name="description" content="" />
<meta name="generator" content="bookdown 0.39 and GitBook 2.6.7" />
<meta name="generator" content="bookdown 0.40 and GitBook 2.6.7" />

<meta property="og:title" content="Dashboard_Documentation.knit" />
<meta property="og:type" content="book" />
Expand Down Expand Up @@ -52,70 +52,6 @@
<script src="libs/anchor-sections-1.1.0/anchor-sections.js"></script>


<style type="text/css">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { color: #008000; } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { color: #008000; font-weight: bold; } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</style>

<style type="text/css">

Expand Down Expand Up @@ -154,7 +90,6 @@
<li class="chapter" data-level="4.2.1" data-path=""><a href="#system-sub-part"><i class="fa fa-check"></i><b>4.2.1</b> System sub part</a></li>
<li class="chapter" data-level="4.2.2" data-path=""><a href="#sensor-sub-part"><i class="fa fa-check"></i><b>4.2.2</b> Sensor sub part</a></li>
<li class="chapter" data-level="4.2.3" data-path=""><a href="#rule-sub-part"><i class="fa fa-check"></i><b>4.2.3</b> Rule sub part</a></li>
<li class="chapter" data-level="4.2.4" data-path=""><a href="#auto-importing-rule-configurations"><i class="fa fa-check"></i><b>4.2.4</b> Auto importing rule configurations</a></li>
</ul></li>
<li class="chapter" data-level="4.3" data-path=""><a href="#replay-tab"><i class="fa fa-check"></i><b>4.3</b> Replay Tab</a></li>
<li class="chapter" data-level="4.4" data-path=""><a href="#stability-tab"><i class="fa fa-check"></i><b>4.4</b> Stability Tab</a>
Expand Down Expand Up @@ -341,41 +276,20 @@ <h3><span class="header-section-number">4.2.2</span> Sensor sub part<a href="#se
<div id="rule-sub-part" class="section level3 hasAnchor" number="4.2.3">
<h3><span class="header-section-number">4.2.3</span> Rule sub part<a href="#rule-sub-part" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p><img src="assets/Database_rule.png" alt="system" /></p>
<p>This sub part has a list of all defined rules on the left side. The rule “0” is always there, can not be deleted and is using the momentary parameters of the dashboard instead of predefined parameters. The “Parameters” box shows a list of all the parameters of the chosen rule. With the button “Delete Rule” the highlighted rule will be deleted. When pressing the “Rule -&gt;” button the parameter of the chosen rule will be loaded into the configuration fields on the right side. In the fields on the right side you can chose a “Rule ID” and give it a name. In the fields below you can set the parameters for the “Stability” tab. A description of these parameters can be found in this manual in the chapter “Stability tab”. Additionally you can chose a “Base Rule ID” here. If you choose a rule different from “0” then all parameters which are given <strong>NEGATIVE</strong> will load parameters of the chosen “Base Rule”. (The rule mode and the stability_Channel also have a “From Base Rule” option to chose if wanted) This can be used if you want to use the same parameter from a predefined set and only have to change this rule to change more rules automatically. In the “description” field the rule can be given a description. With the “Add/Update Rule” button the configuration can be written into the list. If a rule with the chosen “Rule ID” already exists, it will be overwritten with the new values.</p>
</div>
<div id="auto-importing-rule-configurations" class="section level3 hasAnchor" number="4.2.4">
<h3><span class="header-section-number">4.2.4</span> Auto importing rule configurations<a href="#auto-importing-rule-configurations" class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>It is possible to import rules automatically via the network into the system. To do this you have to copy a .json file with the right inputs to the following path:
“<a href="http://192.168.1.115/files/c/autoload" class="uri">http://192.168.1.115/files/c/autoload</a>”
<strong>Attention: everything has to be written in lower cases!!!</strong>
If a file in the right format is moved to this path it will automatically be added to the rules.
Below you can find the necessary .json file format:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a> <span class="dt">&quot;mode&quot;</span><span class="fu">:</span><span class="st">&quot;watch&quot;</span><span class="fu">,</span></span>
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a> <span class="dt">&quot;description&quot;</span><span class="fu">:</span><span class="st">&quot;&quot;</span><span class="fu">,</span></span>
<span id="cb1-4"><a href="#cb1-4" tabindex="-1"></a> <span class="dt">&quot;#attributes&quot;</span><span class="fu">:{</span></span>
<span id="cb1-5"><a href="#cb1-5" tabindex="-1"></a> <span class="dt">&quot;id&quot;</span><span class="fu">:</span><span class="dv">-1</span><span class="fu">,</span></span>
<span id="cb1-6"><a href="#cb1-6" tabindex="-1"></a> <span class="dt">&quot;name&quot;</span><span class="fu">:</span><span class="st">&quot;&quot;</span></span>
<span id="cb1-7"><a href="#cb1-7" tabindex="-1"></a> <span class="fu">},</span></span>
<span id="cb1-8"><a href="#cb1-8" tabindex="-1"></a> <span class="dt">&quot;stabilityParam&quot;</span><span class="fu">:{</span></span>
<span id="cb1-9"><a href="#cb1-9" tabindex="-1"></a> <span class="dt">&quot;windowLength&quot;</span><span class="fu">:</span><span class="dv">126</span><span class="fu">,</span></span>
<span id="cb1-10"><a href="#cb1-10" tabindex="-1"></a> <span class="dt">&quot;upperThreshold&quot;</span><span class="fu">:</span><span class="dv">0</span><span class="er">.00000</span><span class="fu">,</span></span>
<span id="cb1-11"><a href="#cb1-11" tabindex="-1"></a> <span class="dt">&quot;lowerThreshold&quot;</span><span class="fu">:</span><span class="dv">0</span><span class="er">.00000</span><span class="fu">,</span></span>
<span id="cb1-12"><a href="#cb1-12" tabindex="-1"></a> <span class="dt">&quot;ramp&quot;</span><span class="fu">:</span><span class="dv">0</span><span class="er">.00000</span><span class="fu">,</span></span>
<span id="cb1-13"><a href="#cb1-13" tabindex="-1"></a> <span class="dt">&quot;feedOverride&quot;</span><span class="fu">:</span><span class="dv">-1</span><span class="fu">,</span></span>
<span id="cb1-14"><a href="#cb1-14" tabindex="-1"></a> <span class="dt">&quot;spindleOverride&quot;</span><span class="fu">:</span><span class="dv">-1</span><span class="fu">,</span></span>
<span id="cb1-15"><a href="#cb1-15" tabindex="-1"></a> <span class="dt">&quot;feedReductionFactor&quot;</span><span class="fu">:</span><span class="dv">0</span><span class="er">.00000</span><span class="fu">,</span></span>
<span id="cb1-16"><a href="#cb1-16" tabindex="-1"></a> <span class="dt">&quot;spindleReductionFactor&quot;</span><span class="fu">:</span><span class="dv">0</span><span class="er">.00000</span><span class="fu">,</span></span>
<span id="cb1-17"><a href="#cb1-17" tabindex="-1"></a> <span class="dt">&quot;deadtime&quot;</span><span class="fu">:</span><span class="dv">0</span><span class="fu">,</span></span>
<span id="cb1-18"><a href="#cb1-18" tabindex="-1"></a> <span class="dt">&quot;stability_Channel&quot;</span><span class="fu">:</span><span class="st">&quot;Channel 1&quot;</span></span>
<span id="cb1-19"><a href="#cb1-19" tabindex="-1"></a> <span class="fu">},</span></span>
<span id="cb1-20"><a href="#cb1-20" tabindex="-1"></a> <span class="dt">&quot;Base Rule ID&quot;</span><span class="fu">:</span><span class="dv">0</span></span>
<span id="cb1-21"><a href="#cb1-21" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>The input parameters “mode” &amp; “stability_Channel” have to be the exact same string as used in the dashboard.
The input parameters “description” &amp; “name” can be freely chosen strings.
All the other parameters have to be numbers as in the dashboard configuration. As in the dashboard configuration negative numbers dedicate that this value should be taken from the chosen “Base Rule ID”.
The input parameter “id” defines the Rule ID. This means the “id” defines the identification number of the rule. If this value is given a negativ number the rule will be put in the next free spot of the rule configuration.
When the file was successfully added to the rules it will be automatically moved to the folder “done”.</p>
<p>This sub part has a list of all defined rules on the left side. The rule “0” is always there, can not be deleted and is using the momentary parameters of the dashboard instead of predefined parameters. The “Parameters” box shows a list of all the parameters of the chosen rule. With the button “Delete Rule” the highlighted rule will be deleted. When pressing the “Rule -&gt;” button the parameter of the chosen rule will be loaded into the configuration fields on the right side. In the fields on the right side you can chose a “Rule ID” and give it a name. In the fields below you can set the parameters for the “Stability” tab. A description of these parameters can be found in this manual in the chapter “Stability tab”. Additionally you can chose a “Base Rule ID” here. If you choose a rule different from “0” then all parameters which are given as follows will load parameters of the chosen “Base Rule”:</p>
<ul>
<li>mode: “from Baserule” option</li>
<li>window length: 0</li>
<li>upper/lower Threshold: &lt;0</li>
<li>ramp: 0</li>
<li>stability Channel: “from Baserule” option</li>
<li>minimum IFT level: &lt;0</li>
<li>deadtime: 0</li>
<li>feed/spindle Override: &gt;125</li>
<li>feed/spindle Reduction Factor: &gt;125</li>
<li>low/high-pass filter: &lt;0</li>
</ul>
<p>This can be used if you want to use the same parameter from a predefined set and only have to change this rule to change more rules automatically. In the “description” field the rule can be given a description. With the “Add/Update Rule” button the configuration can be written into the list. If a rule with the chosen “Rule ID” already exists, it will be overwritten with the new values.</p>
</div>
</div>
<div id="replay-tab" class="section level2 hasAnchor" number="4.3">
Expand Down
1 change: 0 additions & 1 deletion reference-keys.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ database
system-sub-part
sensor-sub-part
rule-sub-part
auto-importing-rule-configurations
replay-tab
stability-tab
ift-value
Expand Down
2 changes: 1 addition & 1 deletion search_index.json
View file

Large diffs are not rendered by default.

0 comments on commit 9fcc196

Please sign in to comment.