Skip to content

Commit

Permalink
Deployed e67b179 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
stephan1827 committed May 22, 2024
1 parent 8d641e0 commit 539b601
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 8 deletions.
74 changes: 67 additions & 7 deletions appendix.html
Original file line number Diff line number Diff line change
Expand Up @@ -372,8 +372,29 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#common" class="md-nav__link">
Common
<a href="#common-constants" class="md-nav__link">
Common constants
</a>

</li>

<li class="md-nav__item">
<a href="#export-constants" class="md-nav__link">
Export constants
</a>

</li>

<li class="md-nav__item">
<a href="#ui-constants" class="md-nav__link">
UI constants
</a>

</li>

<li class="md-nav__item">
<a href="#logger-constants" class="md-nav__link">
Logger constants
</a>

</li>
Expand Down Expand Up @@ -468,7 +489,7 @@ <h3 id="how-the-data-is-stored">How the data is stored</h3>
<p>Short term data like piece counters are stored in the remanent variable of type <code>exAssetIntLinkType</code>. This structure is used for cross function block communication. The short term data will survive a power off but not a cold reboot. </p>
<p>All long term data is stored in a ring buffer consisting of individual files on the user partition. The data is spread over multiple directories to speed up the reading process during boot-up. Data on this user partition will survive restarts and even program updates and be backed up if necessary. Each file contains one event. An event can be job or shift change or a downtime event. The total number of stored events can be adjusted with the constant <code>CORE_EVENT_NUM_MAX</code>. Keep in mind that all events must be loaded on boot-up which can take some time. As a ball park figure, it takes about 4 seconds to load 100 events.</p>
<h3 id="constants">Constants</h3>
<h4 id="common">Common</h4>
<h4 id="common-constants">Common constants</h4>
<table>
<thead>
<tr>
Expand All @@ -491,12 +512,19 @@ <h4 id="common">Common</h4>
<td>10</td>
<td>Maximum number of events in one directory</td>
</tr>
</tbody>
</table>
<h4 id="export-constants">Export constants</h4>
<table>
<thead>
<tr>
<td>EVENT_ADDITONAL_DATA_LEN</td>
<td>UINT</td>
<td>100</td>
<td>Length of the event comment</td>
<th>Name</th>
<th>Type</th>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>EXPORT_BUFFER</td>
<td>UINT</td>
Expand Down Expand Up @@ -539,18 +567,50 @@ <h4 id="common">Common</h4>
<td>'Start Time;Shift ID;Production State;...'</td>
<td>Export file column headers</td>
</tr>
</tbody>
</table>
<h4 id="ui-constants">UI constants</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>UI_SHIFT_LIST_IDX</td>
<td>UINT</td>
<td>8</td>
<td>Max index for list box entries for shift data</td>
</tr>
<tr>
<td>UI_SHIFT_SHOW_JOBS</td>
<td>BOOL</td>
<td>TRUE</td>
<td>Show job changes in shift list</td>
</tr>
<tr>
<td>UI_JOB_LIST_IDX</td>
<td>UINT</td>
<td>8</td>
<td>Max index for list box entries for job data</td>
</tr>
</tbody>
</table>
<h4 id="logger-constants">Logger constants</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>LOG_LEN</td>
<td>UINT</td>
Expand Down
1 change: 1 addition & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,7 @@ <h3 id="what-is-different">What is different</h3>
<h3 id="what-is-new">What is new</h3>
<ul>
<li>Most function blocks have an additional Logger input. This is used to log messages to the console. This is useful for debugging purposes.</li>
<li>Job events also show up in the shift UI list by default. This can be changed with the UI_SHIFT_SHOW_JOBS constant.</li>
</ul>
<h2 id="future-development">Future development</h2>
<p>The goal for version 1.x is to have a complete set of functions that match the official mappAssetInt package. Version 2.x will focus on adding new features and improvements and will be optimized to work with mappView.</p>
Expand Down
Loading

0 comments on commit 539b601

Please sign in to comment.