| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| |
| <title>PPMP Specification | Unide</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> |
| |
| <link rel="icon" href="/unide/images/icon.ico"> |
| |
| |
| <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" integrity="sha384-XdYbMnZ/QjLh6iI4ogqCTaIjrFk87ip+ekIjefZch0Y+PvJ8CDYtEs1ipDmPorQ+" crossorigin="anonymous"> |
| |
| <link rel="stylesheet" href="/unide/css/styles.css"> |
| </head> |
| <body> |
| <nav class="navbar navbar-inverse"> |
| <div class="container"> |
| |
| <div class="navbar-brand navbar-right"> |
| <a href="/unide/"><img src='/unide/images/logo.png'></img></a> |
| </div> |
| |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#main-menu-navbar" aria-expanded="false"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| </div> |
| |
| <div class="collapse navbar-collapse" id="main-menu-navbar"> |
| <ul class="nav navbar-nav"> |
| |
| <li><a class="" |
| href="/unide/index.html">Home</a></li> |
| |
| <li><a class="" |
| href="/unide/proposal">Proposal</a></li> |
| |
| <li><a class="active" |
| href="/unide/specification">Specification</a></li> |
| |
| <li><a class="" |
| href="/unide/archives">Blog Archives</a></li> |
| |
| <li><a class="" |
| href="/unide/faq">FAQ</a></li> |
| |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <div class="container"> |
| <div class="row"> |
| <div class="col-sm-12 content-main specification_index"> |
| <h1> |
| PPMP Specification |
| </h1> |
| <h1 id="Rationale"> |
| <a href="#Rationale" class="headerlink" title="Rationale"></a> |
| Rationale |
| </h1> |
| <p> |
| Noticeably in recent years, there is a continuous increase in demand, price pressure and complexity in manufacturing. Things need to move faster, be more flexible, and fulfill higher quality standards forcing manufacturers to optimize their processes. |
| </p> |
| <p> |
| Production facilities and their performance have a huge impact on the overall performance of manufacturing processes. However, to identify bottlenecks and possibilities for improvements detailed data from machines are required. |
| </p> |
| <p> |
| Such data is surely provided by machines either via modern protocols such as OPC UA or via proprietary access methods but it is not provided in a common and easily accessible format, which can be used to do performance analysis and optimization. This renders holistic process improvement efforts infeasible for many, especially smaller organizations. |
| </p> |
| <p> |
| The Production Performance Management Protocol (PPMP) specifies a format that allows to capture data that is required to do performance analysis of production facilities. It allows monitoring backends to collect and evaluate key metrics of machines in the context of a production process. It is doing that by allowing to relate the machine status with currently produced parts. |
| </p> |
| <p> |
| The specification is structured into three payload formats: Measurement payload, message payload and process payload. The Measurement payload contains measurements from machines such as the temperature of a machine at a specific point in time together with the currently produced part. The message payload contains arbitrary messages sent by a machine, e.g. alerts or the like. A process message consists of information about a discrete e.g. tightening or welding processes with all their characterising data which are need to describe and analyze it. |
| </p> |
| <p> |
| The payload is meant to be transported via http as a json object. This allows for an easy integration into various backend systems. |
| </p> |
| <h1 id="Communicating-Parties"> |
| <a href="#Communicating-Parties" class="headerlink" title="Communicating Parties"></a> |
| Communicating Parties |
| </h1> |
| <p> |
| Two parties are involved in a PPMP message exchange: the sender and the receiver. The sender pushes a message to the receiver. Usually the sender is a machine or a sensor of a machine. |
| </p> |
| <p> |
| The receiver waits for messages. It offers a API that allows for sending either measurement payloads or message payloads. |
| </p> |
| <p> |
| The communication is unidirectional. Only the sender can contact the receiver and send messages. No feedback from receiver to sender is provided. |
| </p> |
| <img src="images/collaborators_v2.png" alt="Overview PPMP" title="Overview PPMP" class="center-block img-responsive"> |
| |
| <h1> |
| <a name="#Measurement-Payload" title="Measurement Payload"></a> |
| Measurement Payload |
| </h1> |
| <p>The measurement message is the format to exchange simple (non-structured, non-complex ) measurement data. It also allows to transport multiple measurement data (eg. values over time), called 'series'.</p> |
| <img src="images/measurementPayload.png" alt="Class diagram of the measurement payload" title="Class diagram of the measurement payload" class="center-block img-responsive"> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapsePayloadMeasurement" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Structure of payload |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapsePayloadMeasurement" class="panel-collapse collapse"> |
| <ul class="toc"> |
| <li><a href="#content_spec">content-spec</a></li> |
| <li><a href="#device">device</a> |
| <ul> |
| <li><a href="#deviceID">deviceID</a></li> |
| <li><a href="#operationalStatus">operationalStatus</a></li> |
| <li><a href="#metaData">metaData</a></li> |
| </ul> |
| </li> |
| <li><a href="#part">part</a> |
| <ul> |
| <li><a href="#partTypeID">partTypeID</a></li> |
| <li><a href="#partID">partID</a></li> |
| <li><a href="#result">result</a></li> |
| <li><a href="#code">code</a></li> |
| <li><a href="#metaData">metaData</a></li> |
| </ul> |
| </li> |
| <li><a href="#measurements">measurements</a> |
| <ul> |
| <li><a href="#ts">ts</a></li> |
| <li><a href="#result">result</a></li> |
| <li><a href="#code">code</a></li> |
| <li><a href="#series">series</a> |
| <ul> |
| <li><a href="#__time">$_time</a></li> |
| </ul> |
| </li> |
| <li><a href="#limits">limits</a> |
| <ul> |
| <li><a href="#upperError">upperError</a></li> |
| <li><a href="#lowerError">lowerError</a></li> |
| <li><a href="#upperWarn">upperWarn</a></li> |
| <li><a href="#lowerWarn">lowerWarn</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapseMeasurementExample" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Measurement example |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapseMeasurementExample" class="panel-collapse collapse"> |
| <figure class="highlight json"><table><tr><td class="code"><pre><div class="line">{</div><div class="line"> <span class="attr">"content-spec"</span>: <span class="string">"urn:spec://eclipse.org/unide/measurement-message#v2"</span>,</div><div class="line"> <span class="attr">"device"</span>: {</div><div class="line"> <span class="attr">"deviceID"</span>: <span class="string">"a4927dad-58d4-4580-b460-79cefd56775b"</span></div><div class="line"> },</div><div class="line"></div><div class="line"> <span class="attr">"measurements"</span>: [{</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span>,</div><div class="line"> <span class="attr">"series"</span>: {</div><div class="line"> <span class="attr">"$_time"</span>: [ <span class="number">0</span>, <span class="number">23</span>, <span class="number">24</span> ], </div><div class="line"> <span class="attr">"temperature"</span>: [ <span class="number">45.4231</span>, <span class="number">46.4222</span>, <span class="number">44.2432</span>]</div><div class="line"> }</div><div class="line"> }, {</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span>,</div><div class="line"> <span class="attr">"series"</span>: {</div><div class="line"> <span class="attr">"$_time"</span>: [ <span class="number">0</span>, <span class="number">13</span>, <span class="number">26</span> ],</div><div class="line"> <span class="attr">"pressure"</span>: [ <span class="number">52.4</span>, <span class="number">46.32</span>, <span class="number">44.2432</span> ]</div><div class="line"> }</div><div class="line"> }]</div><div class="line">}</div></pre></td></tr></table></figure> |
| </div> |
| </div> |
| </div> |
| |
| <h1> |
| <a name="#Message-Payload" title="Machine Message Payload"></a> |
| Machine Message Payload |
| </h1> |
| <p>The main purpose of the machine message format is to allow devices and integrators to send messages containing an interpretation of measurement data or status.</p> |
| |
| <img src="images/messagePayload.png" alt="Class diagram of the message payload" title="Class diagram of the message payload" class="center-block img-responsive"> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapsePayloadMessage" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Structure of payload |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapsePayloadMessage" class="panel-collapse collapse"> |
| <ul class="toc"> |
| <li><a href="#content_spec">content-spec</a></li> |
| <li><a href="#device">device</a> |
| <ul> |
| <li><a href="#deviceID">deviceID</a></li> |
| <li><a href="#operationalStatus">operationalStatus</a></li> |
| <li><a href="#metaData">metaData</a></li> |
| </ul> |
| </li> |
| <li><a href="#messages">messages</a> |
| <ul> |
| <li><a href="#ts">ts</a></li> |
| <li><a href="#origin">origin</a></li> |
| <li><a href="#type">type</a></li> |
| <li><a href="#severity">severity</a></li> |
| <li><a href="#code_msg">code</a></li> |
| <li><a href="#title">title</a></li> |
| <li><a href="#description">description</a></li> |
| <li><a href="#hint">hint</a></li> |
| <li><a href="#metaData">metaData</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapseMinMessage" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Minimal message example |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapseMinMessage" class="panel-collapse collapse"> |
| <figure class="highlight json"><table><tr><td class="code"><pre><div class="line">{</div><div class="line"> <span class="attr">"content-spec"</span>:<span class="string">"urn:spec://eclipse.org/unide/machine-message#v2"</span>,</div><div class="line"> <span class="attr">"device"</span>: {</div><div class="line"> <span class="attr">"deviceID"</span>: <span class="string">"2ca5158b-8350-4592-bff9-755194497d4e"</span></div><div class="line"> },</div><div class="line"> <span class="attr">"messages"</span>: [{</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span>, </div><div class="line"> <span class="attr">"code"</span>: <span class="string">"190ABT"</span></div><div class="line"> }]</div><div class="line">}</div></pre></td></tr></table></figure> |
| </div> |
| </div> |
| </div> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapseMultiMessage" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Multiple message example |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapseMultiMessage" class="panel-collapse collapse"> |
| <figure class="highlight json"><table><tr><td class="code"><pre><div class="line">{</div><div class="line"> <span class="attr">"content-spec"</span>:<span class="string">"urn:spec://eclipse.org/unide/machine-message#v2"</span>,</div><div class="line"> <span class="attr">"device"</span>: {</div><div class="line"> <span class="attr">"deviceID"</span>: <span class="string">"2ca5158b-8350-4592-bff9-755194497d4e"</span>,</div><div class="line"> <span class="attr">"operationalStatus"</span>: <span class="string">"normal"</span>,</div><div class="line"> <span class="attr">"metaData"</span>:{</div><div class="line"> <span class="attr">"swVersion"</span>: <span class="string">"2.0.3.13"</span>,</div><div class="line"> <span class="attr">"swBuildID"</span>: <span class="string">"41535"</span></div><div class="line"> }</div><div class="line"> },</div><div class="line"> <span class="attr">"messages"</span>: [{</div><div class="line"> <span class="attr">"origin"</span>: <span class="string">"sensor-id-992.2393.22"</span>,</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span>,</div><div class="line"> <span class="attr">"type"</span>: <span class="string">"DEVICE"</span>,</div><div class="line"> <span class="attr">"severity"</span>: <span class="string">"HIGH"</span>,</div><div class="line"> <span class="attr">"code"</span>: <span class="string">"190ABT"</span>,</div><div class="line"> <span class="attr">"title"</span>: <span class="string">"control board damaged"</span>,</div><div class="line"> <span class="attr">"description"</span>: <span class="string">"Electronic control board or its electrical connections are damaged"</span>, </div><div class="line"> <span class="attr">"hint"</span>: <span class="string">"Check the control board"</span>,</div><div class="line"> <span class="attr">"metaData"</span>: {</div><div class="line"> <span class="attr">"firmware"</span>: <span class="string">"20130304_22.020"</span></div><div class="line"> }</div><div class="line"> }, {</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.125+02:00"</span>,</div><div class="line"> <span class="attr">"type"</span>: <span class="string">"TECHNICAL_INFO"</span>,</div><div class="line"> <span class="attr">"severity"</span>: <span class="string">"HIGH"</span>,</div><div class="line"> <span class="attr">"code"</span>: <span class="string">"33-02"</span>,</div><div class="line"> <span class="attr">"title"</span>: <span class="string">"Disk size limit reached"</span>,</div><div class="line"> <span class="attr">"description"</span>: <span class="string">"Disk size has reached limit. Unable to write log files."</span></div><div class="line"> }]</div><div class="line">}</div></pre></td></tr></table></figure> |
| </div> |
| </div> |
| </div> |
| |
| <h1> |
| <a name="#Process-Payload" title="Process Payload"></a> |
| Process Payload |
| </h1> |
| <p>The process message is the format to exchange data out of discrete processes. It also allows to transport process information, part information and measurement data for each phase of the process.</p> |
| <img src="images/processDataPayload.png" alt="Class diagram of the process data payload" title="Class diagram of the process data payload" class="center-block img-responsive"> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapsePayloadProcess" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Structure of payload |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapsePayloadProcess" class="panel-collapse collapse"> |
| <ul class="toc"> |
| <li><a href="#content_spec">content-spec</a></li> |
| <li><a href="#device">device</a> |
| <ul> |
| <li><a href="#deviceID">deviceID</a></li> |
| <li><a href="#operationalStatus">operationalStatus</a></li> |
| <li><a href="#metaData">metaData</a></li> |
| </ul> |
| </li> |
| <li><a href="#part">part</a> |
| <ul> |
| <li><a href="#partID">partID</a></li> |
| <li><a href="#partTypeID">partTypeID</a></li> |
| <li><a href="#type">type</a></li> |
| <li><a href="#result">result</a></li> |
| <li><a href="#code">code</a></li> |
| <li><a href="#metaData">metaData</a></li> |
| </ul> |
| </li> |
| <li><a href="#process">process</a> |
| <ul> |
| <li><a href="#externalProcessId">externalProcessId</a></li> |
| <li><a href="#ts">ts</a></li> |
| <li><a href="#result">result</a></li> |
| <li><a href="#shutoffPhase">shutoffPhase</a></li> |
| <li><a href="#program">program</a> |
| <ul> |
| <li><a href="#id_prg">id</a></li> |
| <li><a href="#name">name</a></li> |
| <li><a href="#lastChangedDate">lastChangedDate</a></li> |
| </ul> |
| </li> |
| <li><a href="#shutoffValues">shutoffValues</a> |
| <ul> |
| <li><a href="#value">value</a></li> |
| <ul> |
| <li><a href="#ts">ts</a></li> |
| <li><a href="#value">value</a></li> |
| <li><a href="#upperError">upperError</a></li> |
| <li><a href="#lowerError">lowerError</a></li> |
| <li><a href="#upperError">upperWarn</a></li> |
| <li><a href="#lowerError">lowerWarn</a></li> |
| </ul> |
| </ul> |
| </li> |
| <li><a href="#metaData">metaData</a></li> |
| </ul> |
| </li> |
| <li><a href="#measurements_process">measurements</a> |
| <ul> |
| <li><a href="#ts">ts</a></li> |
| <li><a href="#phase">phase</a></li> |
| <li><a href="#name_phase">name</a></li> |
| <li><a href="#result">result</a></li> |
| <li><a href="#code">code</a></li> |
| <li><a href="#specialValues">specialValues</a> |
| <ul> |
| <li><a href="#time">time</a></li> |
| <li><a href="#value">value</a></li> |
| </ul> |
| </li> |
| <li><a href="#series">series</a></li> |
| <li><a href="#limits_process">limits</a> |
| <ul> |
| <li><a href="#target">target</a></li> |
| <li><a href="#upperError">upperError</a></li> |
| <li><a href="#lowerError">lowerError</a></li> |
| <li><a href="#upperWarn">upperWarn</a></li> |
| <li><a href="#lowerWarn">lowerWarn</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapseMinProcessMessage" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Minimal process message example |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapseMinProcessMessage" class="panel-collapse collapse"> |
| <figure class="highlight json"><table><tr><td class="code"><pre><div class="line">{</div><div class="line"> <span class="attr">"content-spec"</span>: <span class="string">"urn:spec://eclipse.org/unide/process-message#v2"</span>,</div><div class="line"> <span class="attr">"device"</span>: {</div><div class="line"> <span class="attr">"deviceID"</span>: <span class="string">"a4927dad-58d4-4580-b460-79cefd56775b"</span></div><div class="line"> },</div><div class="line"> <span class="attr">"process"</span>: {</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span></div><div class="line"> },</div><div class="line"> <span class="attr">"measurements"</span>: [</div><div class="line"> {</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span>,</div><div class="line"> <span class="attr">"series"</span>: {</div><div class="line"> <span class="attr">"force"</span>: [<span class="number">26</span>, <span class="number">23</span>, <span class="number">24</span>],</div><div class="line"> <span class="attr">"pressure"</span>: [<span class="number">52.4</span>, <span class="number">46.32</span>, <span class="number">44.2432</span>] </div><div class="line"> }</div><div class="line"> }</div><div class="line"> ]</div><div class="line">}</div></pre></td></tr></table></figure> |
| </div> |
| </div> |
| </div> |
| |
| <div class="panel panel-default"> |
| <div class="panel-heading"> |
| <a href="#collapseProcessMessage" data-toggle="collapse" class="toggle-collapse collapsed"> |
| Process message example |
| </a> |
| </div> |
| <div class="panel-body"> |
| <div id="collapseProcessMessage" class="panel-collapse collapse"> |
| <figure class="highlight json"><table><tr><td class="code"><pre><div class="line">{</div><div class="line"> <span class="attr">"content-spec"</span>: <span class="string">"urn:spec://eclipse.org/unide/process-message#v2"</span>,</div><div class="line"> <span class="attr">"device"</span>: {</div><div class="line"> <span class="attr">"deviceID"</span>: <span class="string">"a4927dad-58d4-4580-b460-79cefd56775b"</span>,</div><div class="line"> <span class="attr">"operationalStatus"</span>: <span class="string">"normal"</span>,</div><div class="line"> <span class="attr">"metaData"</span>: {</div><div class="line"> <span class="attr">"swVersion"</span>: <span class="string">"2.0.3.13"</span>,</div><div class="line"> <span class="attr">"swBuildId"</span>: <span class="string">"41535"</span> </div><div class="line"> }</div><div class="line"> },</div><div class="line"> <span class="attr">"part"</span>: {</div><div class="line"> <span class="attr">"type"</span>: <span class="string">"SINGLE"</span>,</div><div class="line"> <span class="attr">"partTypeID"</span>: <span class="string">"F00VH07328"</span>, </div><div class="line"> <span class="attr">"partID"</span>: <span class="string">"420003844"</span>,</div><div class="line"> <span class="attr">"result"</span>: <span class="string">"NOK"</span>,</div><div class="line"> <span class="attr">"code"</span>: <span class="string">"HUH289"</span>,</div><div class="line"> <span class="attr">"metaData"</span>: {</div><div class="line"> <span class="attr">"toolId"</span>: <span class="string">"32324-432143"</span> </div><div class="line"> }</div><div class="line"> },</div><div class="line"> <span class="attr">"process"</span>: { </div><div class="line"> <span class="attr">"externalProcessId"</span>: <span class="string">"b4927dad-58d4-4580-b460-79cefd56775b"</span>,</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span>,</div><div class="line"> <span class="attr">"result"</span>: <span class="string">"NOK"</span>,</div><div class="line"> <span class="attr">"shutoffPhase"</span>: <span class="string">"phase 1"</span>,</div><div class="line"> <span class="attr">"program"</span>: {</div><div class="line"> <span class="attr">"id"</span>: <span class="string">"1"</span>,</div><div class="line"> <span class="attr">"name"</span>: <span class="string">"Programm 1"</span>,</div><div class="line"> <span class="attr">"lastChangedDate"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span></div><div class="line"> },</div><div class="line"> <span class="attr">"shutoffValues"</span>: {</div><div class="line"> <span class="attr">"force"</span>: {</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:11.123+02:00"</span>,</div><div class="line"> <span class="attr">"value"</span>: <span class="number">24</span>,</div><div class="line"> <span class="attr">"upperError"</span>: <span class="number">26</span>,</div><div class="line"> <span class="attr">"lowerError"</span>: <span class="number">22</span></div><div class="line"> },</div><div class="line"> <span class="attr">"pressure"</span>: { </div><div class="line"> <span class="attr">"value"</span>: <span class="number">50</span>,</div><div class="line"> <span class="attr">"upperError"</span>: <span class="number">52</span>,</div><div class="line"> <span class="attr">"lowerError"</span>: <span class="number">48</span></div><div class="line"> }</div><div class="line"> },</div><div class="line"> <span class="attr">"metaData"</span>: {</div><div class="line"> <span class="attr">"name"</span>: <span class="string">"Tightening"</span></div><div class="line"> }</div><div class="line"> },</div><div class="line"> <span class="attr">"measurements"</span>: [ </div><div class="line"> {</div><div class="line"> <span class="attr">"ts"</span>: <span class="string">"2002-05-30T09:30:10.123+02:00"</span>,</div><div class="line"> <span class="attr">"phase"</span>: <span class="string">"phasen name"</span>,</div><div class="line"> <span class="attr">"result"</span>: <span class="string">"OK"</span>, </div><div class="line"> <span class="attr">"code"</span>: <span class="string">"0000 EE01"</span>,</div><div class="line"> <span class="attr">"limits"</span>: {</div><div class="line"> <span class="attr">"pressure"</span>: {</div><div class="line"> <span class="attr">"upperError"</span>: <span class="number">4444</span>,</div><div class="line"> <span class="attr">"lowerError"</span>: <span class="number">44</span>,</div><div class="line"> <span class="attr">"upperWarn"</span>: <span class="number">2222</span>,</div><div class="line"> <span class="attr">"lowerWarn"</span>: <span class="number">46</span>,</div><div class="line"> <span class="attr">"target"</span>: <span class="number">35</span></div><div class="line"> },</div><div class="line"> <span class="attr">"force"</span>: {</div><div class="line"> <span class="attr">"upperError"</span>: [<span class="number">27</span>, <span class="number">24</span>, <span class="number">25</span>],</div><div class="line"> <span class="attr">"lowerError"</span>: [<span class="number">25</span>, <span class="number">22</span>, <span class="number">23</span>] </div><div class="line"> }</div><div class="line"> },</div><div class="line"> <span class="attr">"specialValues"</span>: {</div><div class="line"> <span class="attr">"pressure"</span>: {</div><div class="line"> <span class="attr">"value"</span>: <span class="number">24</span></div><div class="line"> },</div><div class="line"> <span class="attr">"force"</span>: {</div><div class="line"> <span class="attr">"time"</span>: <span class="number">24</span>,</div><div class="line"> <span class="attr">"value"</span>: <span class="number">50</span></div><div class="line"> }</div><div class="line"> },</div><div class="line"> <span class="attr">"series"</span>: {</div><div class="line"> <span class="attr">"time"</span>: [<span class="number">30</span>, <span class="number">36</span>, <span class="number">42</span>],</div><div class="line"> <span class="attr">"force"</span>: [<span class="number">26</span>, <span class="number">23</span>, <span class="number">24</span>],</div><div class="line"> <span class="attr">"pressure"</span>: [<span class="number">52.4</span>, <span class="number">46.32</span>, <span class="number">44.2432</span>],</div><div class="line"> <span class="attr">"temperature"</span>: [<span class="number">45.4243</span>, <span class="number">46.42342</span>, <span class="number">44.2432</span>] </div><div class="line"> }</div><div class="line"> }</div><div class="line"> ]</div><div class="line">}</div></pre></td></tr></table></figure> |
| </div> |
| </div> |
| </div> |
| |
| <h1> |
| <a name="#fields-definition" title="Fields definition"></a> |
| Fields definition |
| </h1> |
| |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="content_spec" title="content-spec"></a> |
| content-spec |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Defines the format version</td> |
| </tr> |
| |
| <tr> |
| <th>Possible values:</th> |
| <td> |
| <ul> |
| |
| <li>"urn:spec://eclipse.org/unide/machine-message#v2"</li> |
| |
| <li>"urn:spec://eclipse.org/unide/measurement-message#v2"</li> |
| |
| <li>"urn:spec://eclipse.org/unide/process-message#v2"</li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>enum indicating the type of this payload.</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"content-spec": "urn:spec://eclipse.org/unide/measurement-message#v2"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="device" title="device"></a> |
| device |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Contains information about the device</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#deviceID" title="go to deviceID">deviceID</a> |
| </li> |
| |
| <li> |
| <a href="#operationalStatus" title="go to operationalStatus">operationalStatus</a> |
| </li> |
| |
| <li> |
| <a href="#metaData" title="go to metaData">metaData</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"device": {</div><div class="line"> "deviceID": "0815"</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="deviceID" title="deviceID"></a> |
| deviceID |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The unique ID of the device. As this is used to identify a device independently from time or location. The ID itself must be stable and unique. The recommendation is to use a universally unique identifier (UUID).</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>true</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>reprentation could follow <a href="http://www.gs1.org/global-individual-asset-identifier-giai" title="GIAI" target="_blank" rel="external">GIAI</a>, <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier" title="UUID" target="_blank" rel="external">UUID</a> or others</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"deviceID": "6e7807d0-5491-11e6-9d32-02423234b390"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="operationalStatus" title="operationalStatus"></a> |
| operationalStatus |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The operationalStatus describes the status of a device. It is a string matching a definition in the Production Performance Manager.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"operationStatus": "MM" //Maintenance Mode</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="metaData" title="metaData"></a> |
| metaData |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Additional key-value pairs in a JSON structure format. Key and value must be strings.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>subfields can be any key/string value pair</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"metaData": {</div><div class="line"> "swVersion": "2.0.3.13", //software (firmware) version</div><div class="line"> "swBuildID": "41535" //software (firmware) build identifier/number</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="part" title="part"></a> |
| part |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Contains information regarding the part which this payload relates to</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#partTypeID" title="go to partTypeID">partTypeID</a> |
| </li> |
| |
| <li> |
| <a href="#partID" title="go to partID">partID</a> |
| </li> |
| |
| <li> |
| <a href="#result" title="go to result">result</a> |
| </li> |
| |
| <li> |
| <a href="#code" title="go to code">code</a> |
| </li> |
| |
| <li> |
| <a href="#metaData" title="go to metaData">metaData</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"part": {</div><div class="line"> "partTypeID": "F00VH07328",</div><div class="line"> "partID": "420003844",</div><div class="line"> "result": "OK",</div><div class="line"> "code": "HUH289",</div><div class="line"> "metaData": {</div><div class="line"> "lotID": "845849",</div><div class="line"> "toolID": "32324-432143"</div><div class="line"> }</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="partTypeID" title="partTypeID"></a> |
| partTypeID |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Identifies the type of the part</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"partTypeID": "F00VH07328"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="partID" title="partID"></a> |
| partID |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Identifies a part. This ID comes from a 3rd party system and thus we have no guarantees if this is unique or not.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>256</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"partID": "420003844"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="result" title="result"></a> |
| result |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Information if the quality of the produced part was ok or not</td> |
| </tr> |
| |
| <tr> |
| <th>Possible values:</th> |
| <td> |
| <ul> |
| |
| <li>"UNKNOWN"</li> |
| |
| <li>"OK"</li> |
| |
| <li>"NOK"</li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Default value is "UNKNOWN"</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"result": "OK"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="type" title="type"></a> |
| type |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Describes the type of the part. Type SINGLE means a single item is processed. Type BATCH means multiple items of the same type are processed. Default value is SINGLE</td> |
| </tr> |
| |
| <tr> |
| <th>Possible values:</th> |
| <td> |
| <ul> |
| |
| <li>"SINGLE"</li> |
| |
| <li>"BATCH"</li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"type": "SINGLE"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="code" title="code"></a> |
| code |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The code is an addendum to the result which allows to pass information in the case the result was NOK.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>36</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The value often stems from the integrated system e.g. a PLC code</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"code": "HUH289"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="measurements" title="measurements"></a> |
| measurements |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>A list of sensor readings</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>if sensor readings have the same timestamp/-offsets, they can be combined in one measurement block. Otherwise they are added to the measurements list as individual block.</td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#ts" title="go to ts">ts</a> |
| </li> |
| |
| <li> |
| <a href="#result" title="go to result">result</a> |
| </li> |
| |
| <li> |
| <a href="#code" title="go to code">code</a> |
| </li> |
| |
| <li> |
| <a href="#limits" title="go to limits">limits</a> |
| </li> |
| |
| <li> |
| <a href="#series" title="go to series">series</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"measurements": [{</div><div class="line"> "ts": "2002-05-30T09:30:10.123+02:00",</div><div class="line"> "series": {</div><div class="line"> "$_time": [ 0, 23, 24 ],</div><div class="line"> "temperature": [ 45.4231, 46.4222, 44.2432]</div><div class="line"> }</div><div class="line">}]</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="ts" title="ts"></a> |
| ts |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Start time of the the data measurment in <a href="http://www.w3.org/TR/NOTE-datetime" title="ISO 8601" target="_blank" rel="external">ISO 8601 format</a></td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>http://www.w3.org/TR/NOTE-datetime</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"ts": "2002-05-30T09:30:10.123+02:00"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="limits" title="limits"></a> |
| limits |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Provides information about limits for data provided in the series element. The limits is an JSON object where the key is the name of a Measurement Point (see also series element) and the value is a structure of different upper/lower limits.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>each subfield key corresponds to one measurement point and holds an object with the error/warning levels.</td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#upperError" title="go to upperError">upperError</a> |
| </li> |
| |
| <li> |
| <a href="#lowerError" title="go to lowerError">lowerError</a> |
| </li> |
| |
| <li> |
| <a href="#upperWarn" title="go to upperWarn">upperWarn</a> |
| </li> |
| |
| <li> |
| <a href="#lowerWarn" title="go to lowerWarn">lowerWarn</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"limits": {</div><div class="line"> "temperature": {</div><div class="line"> "upperError": 4444,</div><div class="line"> "lowerError": 44,</div><div class="line"> "upperWarn": 2222,</div><div class="line"> "lowerWarn": 46</div><div class="line"> }</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="upperError" title="upperError"></a> |
| upperError |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Indicates the upper error threshold, given by the device/integrator</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"upperError": 4444</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="lowerError" title="lowerError"></a> |
| lowerError |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Indicates the lower error threshold, given by the device/integrator</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"lowerError": 44</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="upperWarn" title="upperWarn"></a> |
| upperWarn |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Indicates the upper warning threshold, given by the device/integrator</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"upperWarn": 2222</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="lowerWarn" title="lowerWarn"></a> |
| lowerWarn |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Indicates the lower warning threshold, given by the device/integrator</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"lowerWarn": 46</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="series" title="series"></a> |
| series |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The series data collected for the measurements. Every subfield key matches a measurement point of the device type. Every subfield value is an array. All arrays are of equal length and an entry at a given index corresponds to another arrays value at this index</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>In the case of a time series, one column contains the time offset (positive values in ascending order starting with 0). In this case the key is <i>$_time`</i>.</td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#__time" title="go to $_time">$_time</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"ts": "2015-07-23T16:04:10.223+02:00",</div><div class="line">"series": {</div><div class="line"> "$_time": [0, 22, 24, 27],</div><div class="line"> "temperature": [33, 34, 33, 32],</div><div class="line"> "pressure": [1, 1.001. 2.52. 3.2]</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="__time" title="$_time"></a> |
| $_time |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>An array of time offsets in miliseconds from the <href="#ts">ts field of this series</href="#ts"></td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>the offsets are of unsigned long integer values</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"$_time": [0, 22, 24, 27]</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="messages" title="messages"></a> |
| messages |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>A list of machine messages</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#ts" title="go to ts">ts</a> |
| </li> |
| |
| <li> |
| <a href="#origin" title="go to origin">origin</a> |
| </li> |
| |
| <li> |
| <a href="#type" title="go to type">type</a> |
| </li> |
| |
| <li> |
| <a href="#severity" title="go to severity">severity</a> |
| </li> |
| |
| <li> |
| <a href="#code" title="go to code">code</a> |
| </li> |
| |
| <li> |
| <a href="#title" title="go to title">title</a> |
| </li> |
| |
| <li> |
| <a href="#description" title="go to description">description</a> |
| </li> |
| |
| <li> |
| <a href="#hint" title="go to hint">hint</a> |
| </li> |
| |
| <li> |
| <a href="#metaData" title="go to metaData">metaData</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"messages": [{</div><div class="line"> "ts": "2002-05-30T09:30:10.123+02:00", </div><div class="line"> "code": "190ABT"</div><div class="line">}]</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="origin" title="origin"></a> |
| origin |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The origin of the message if not the device identified by deviceID in the header element.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>Could be used to identify a subsystem or a particular sensor/part of the device where the <br> message actually relates to.</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"origin": "sensor-id-992.2393.22"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="type" title="type"></a> |
| type |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The type of message. Default is DEVICE but can be set to TECHNICAL_INFO indicating a problem with the integration of the actual device.</td> |
| </tr> |
| |
| <tr> |
| <th>Possible values:</th> |
| <td> |
| <ul> |
| |
| <li>"DEVICE"</li> |
| |
| <li>"TECHNICAL_INFO"</li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"type": "DEVICE"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="severity" title="severity"></a> |
| severity |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Severity of the message.</td> |
| </tr> |
| |
| <tr> |
| <th>Possible values:</th> |
| <td> |
| <ul> |
| |
| <li>"HIGH"</li> |
| |
| <li>"MEDIUM"</li> |
| |
| <li>"LOW"</li> |
| |
| <li>"UNKNOWN"</li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Default is "UNKNOWN"</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"severity": "HIGH"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="code_msg" title="code"></a> |
| code |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Code identifying the problem described in the message.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>36</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The value often stems from the machine e.g. a PLC code. Is similar to <a href="#code" title="go to measurement code">code</a> in measurement interface.</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"code": "190ABT"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="title" title="title"></a> |
| title |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The title of the message</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>1000</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"title": "control board damaged"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="description" title="description"></a> |
| description |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The description is used to describe the purpose of the message, e.g. the problem</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>2000</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"description": "Electronic control board or its electrical connections are damaged"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="hint" title="hint"></a> |
| hint |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>In case a problem is reported, the hint can be used to point out a possible solution.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>2000</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"hint": "Check the control board"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="type" title="type"></a> |
| type |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Describes the type of the part. </td> |
| </tr> |
| |
| <tr> |
| <th>Possible values:</th> |
| <td> |
| <ul> |
| |
| <li>"SINGLE"</li> |
| |
| <li>"BATCH"</li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Type SINGLE means a single item is processed. Type BATCH means multiple items of the same type are processed. Default value is SINGLE</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"type": "SINGLE"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="process" title="process"></a> |
| process |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Contains information about the process</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#externalProcessId" title="go to externalProcessId">externalProcessId</a> |
| </li> |
| |
| <li> |
| <a href="#ts" title="go to ts">ts</a> |
| </li> |
| |
| <li> |
| <a href="#result" title="go to result">result</a> |
| </li> |
| |
| <li> |
| <a href="#shutoffPhase" title="go to shutoffPhase">shutoffPhase</a> |
| </li> |
| |
| <li> |
| <a href="#program" title="go to program">program</a> |
| </li> |
| |
| <li> |
| <a href="#shutoffValues" title="go to shutoffValues">shutoffValues</a> |
| </li> |
| |
| <li> |
| <a href="#metaData" title="go to metaData">metaData</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"process": {</div><div class="line"> "externalProcessId": "b4927dad-58d4-4580-b460-79cefd56775b",</div><div class="line"> "ts": "2002-05-30T09:30:10.123+02:00",</div><div class="line"> "result": "NOK",</div><div class="line"> "shutoffPhase": "phase 1",</div><div class="line"> "program": {</div><div class="line"> "id": "1",</div><div class="line"> "name": "Program 1",</div><div class="line"> "lastChangedDate": "2002-05-30T09:30:10.123+02:00"</div><div class="line"> },</div><div class="line"> "shutoffValues": {</div><div class="line"> "force": {</div><div class="line"> "ts": "2002-05-30T09:30:11.123+02:00",</div><div class="line"> "value": 24,</div><div class="line"> "upperError": 26,</div><div class="line"> "lowerError": 22</div><div class="line"> },</div><div class="line"> "pressure": {</div><div class="line"> "value": 50,</div><div class="line"> "upperError": 52,</div><div class="line"> "lowerError": 48</div><div class="line"> }</div><div class="line"> },</div><div class="line"> "metaData": {</div><div class="line"> "name": "Tightening"</div><div class="line"> }</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="externalProcessId" title="externalProcessId"></a> |
| externalProcessId |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The process Id identifies the process as part of long living process |
| Format: |
| alphanumeric string |
| dash as special character</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>2000</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The process Id can be used to connect multiple processes in a manufacturing chain. The Id has to be set and tracked by the different devices in the chain.</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"externalProcessId": "b4927dad-58d4-4580-b460-79cefd56775b"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="ts_process" title="ts"></a> |
| ts |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Start time of the process</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Format: ISO 8601 format</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"ts": "2002-05-30T09:30:11.123+02:00"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="result_process" title="result"></a> |
| result |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Result of the whole process</td> |
| </tr> |
| |
| <tr> |
| <th>Possible values:</th> |
| <td> |
| <ul> |
| |
| <li>"UNKNOWN"</li> |
| |
| <li>"OK"</li> |
| |
| <li>"NOK"</li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Default value is "UNKNOWN"</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"result": "OK"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="shutoffPhase" title="shutoffPhase"></a> |
| shutoffPhase |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The ID of the phase that led to stop the process. The shutOffPhase is the phase of the process in which either pre-defined parameters are met to successfully finish the process or an error that stopped the process. That is not necessarily the last phase.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The phase which should be sent with last process phase in measurements.</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"shutoffPhase": "phase 1"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="program" title="program"></a> |
| program |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Contains information about the program that was used in the process</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#id_prg" title="go to id#prg">id</a> |
| </li> |
| |
| <li> |
| <a href="#name" title="go to name">name</a> |
| </li> |
| |
| <li> |
| <a href="#lastChangedDate" title="go to lastChangedDate">lastChangedDate</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"program": {</div><div class="line"> "id": "1",</div><div class="line"> "name": "Program 1",</div><div class="line"> "lastChangedDate": "2002-05-30T09:30:10.123+02:00"</div><div class="line"> }</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="id_prg" title="id"></a> |
| id |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The ID of the program Format: alphanumeric string (dash allowed e.g. UUID)</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>36</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The ID of the program for unique identification</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"id": "b4927dad-58d4-4580-b460-79cefd56775b"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="name" title="name"></a> |
| name |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The name of the program |
| Format: |
| alphanumeric string (dash allowed e.g. UUID)</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>256</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The name of the program if existing</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"name": "welding_1"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="lastChangedDate" title="lastChangedDate"></a> |
| lastChangedDate |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The process Id identifies the process as part of long living process |
| Format: |
| alphanumeric string |
| dash as special character</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>2000</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The process Id can be used to connect multiple processes in a manufacturing chain. The Id has to be set and tracked by the different devices in the chain.</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"externalProcessId": "b4927dad-58d4-4580-b460-79cefd56775b"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="shutoffValues" title="shutoffValues"></a> |
| shutoffValues |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The shutoff values contain the values of the process that stopped the process.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The shutoffValues is a JSON object where the key is the name of a Measurement Point (see also series element) and the value is a structure of different upper/lower limits and the actual value as described.</td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#ts_process" title="go to ts#process">ts</a> |
| </li> |
| |
| <li> |
| <a href="#value_sov" title="go to value#sov">value</a> |
| </li> |
| |
| <li> |
| <a href="#upperError" title="go to upperError">upperError</a> |
| </li> |
| |
| <li> |
| <a href="#lowerError" title="go to lowerError">lowerError</a> |
| </li> |
| |
| <li> |
| <a href="#upperWarn" title="go to upperWarn">upperWarn</a> |
| </li> |
| |
| <li> |
| <a href="#lowerWarn" title="go to lowerWarn">lowerWarn</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"shutoffValues": {</div><div class="line"> "force": {</div><div class="line"> "ts": "2002-05-30T09:30:11.123+02:00",</div><div class="line"> "value": 24,</div><div class="line"> "upperError": 26,</div><div class="line"> "lowerError": 22</div><div class="line"> },</div><div class="line"> "pressure": { </div><div class="line"> "value": 50,</div><div class="line"> "upperError": 52,</div><div class="line"> "lowerError": 48</div><div class="line"> }</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="value_sov" title="value"></a> |
| value |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The final value of the process</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"value": 24</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="measurements_process" title="measurements"></a> |
| measurements |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Contains the measurements of the different phases</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Each phase represents an execution step in the process and contains information about that specific execution step. All phases should be sorted by the timestamp of the phase.</td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#ts" title="go to ts">ts</a> |
| </li> |
| |
| <li> |
| <a href="#phase" title="go to phase">phase</a> |
| </li> |
| |
| <li> |
| <a href="#name_phase" title="go to name#phase">name</a> |
| </li> |
| |
| <li> |
| <a href="#result" title="go to result">result</a> |
| </li> |
| |
| <li> |
| <a href="#code" title="go to code">code</a> |
| </li> |
| |
| <li> |
| <a href="#limits_process" title="go to limits#process">limits</a> |
| </li> |
| |
| <li> |
| <a href="#specialValues" title="go to specialValues">specialValues</a> |
| </li> |
| |
| <li> |
| <a href="#series_process" title="go to series#process">series</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"measurements": [{</div><div class="line"> "ts": "2002-05-30T09:30:10.123+02:00",</div><div class="line"> "phase": "phase name 2",</div><div class="line"> "name": "Turn left 500 degrees",</div><div class="line"> "result": "NOK",</div><div class="line"> "code": "0000 EE01",</div><div class="line"> "limits": {</div><div class="line"> "temperature": {</div><div class="line"> "upperError": 4444,</div><div class="line"> "lowerError": 44,</div><div class="line"> "upperWarn": 2222,</div><div class="line"> "lowerWarn": 46,</div><div class="line"> "target": 35</div><div class="line"> }</div><div class="line"> },</div><div class="line"> "specialValues": {</div><div class="line"> "pressure": {</div><div class="line"> "time": 24,</div><div class="line"> "value": 44.2432</div><div class="line"> },</div><div class="line"> "force": {</div><div class="line"> "time": 24,</div><div class="line"> "value": 24</div><div class="line"> }</div><div class="line"> },</div><div class="line"> "series": {</div><div class="line"> "time": [0, 23, 24],</div><div class="line"> "force": [26, 23, 24],</div><div class="line"> "pressure": [52.4, 46.32, 44.2432],</div><div class="line"> "temperature": [45.4243, 46.42342, 44.2432] </div><div class="line"> }</div><div class="line">}]</div><div class="line"></div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="phase" title="phase"></a> |
| phase |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The ID of the process phase.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>256</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Format: alphanumeric string (dash allowed e.g. UUID)</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"phase": "b4927dad-58d4-4580-b460-79cefd56775b"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="name_phase" title="name"></a> |
| name |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>The name of the process phase.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>256</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>Format: alphanumeric string</td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"phase": "phase name 1"</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="limits_process" title="limits"></a> |
| limits |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Provides information about limits for data provided in the series element. </td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>The limits is an JSON object where the key is the name of a Measurement Point (see also series element) and the value is a structure of different upper/lower limits described below. The limit is either a single value or an array of values. If the limit is array of values the array size has to be the same as the series.</td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#upperError" title="go to upperError">upperError</a> |
| </li> |
| |
| <li> |
| <a href="#lowerError" title="go to lowerError">lowerError</a> |
| </li> |
| |
| <li> |
| <a href="#upperWarn" title="go to upperWarn">upperWarn</a> |
| </li> |
| |
| <li> |
| <a href="#lowerWarn" title="go to lowerWarn">lowerWarn</a> |
| </li> |
| |
| <li> |
| <a href="#target" title="go to target">target</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"limits": {</div><div class="line"> "temperature": {</div><div class="line"> "upperError": 4444,</div><div class="line"> "lowerError": 44,</div><div class="line"> "upperWarn": 2222,</div><div class="line"> "lowerWarn": 46,</div><div class="line"> "target": 35</div><div class="line"> },</div><div class="line"> "force": {</div><div class="line"> "upperError": [27, 24, 25],</div><div class="line"> "lowerError": [25, 22, 23] </div><div class="line"> }</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="target" title="target"></a> |
| target |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Information about the expected final value</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td></td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"target": 35</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| <h4> |
| </h4> |
| |
| <div class="panel panel-default field-definition table-responsive"> |
| <div class="panel-heading"> |
| <a name="specialValues" title="specialValues"></a> |
| specialValues |
| <a href="#" title="go up"> |
| <span class="glyphicon glyphicon-chevron-up pull-right" aria-hidden="true"> </span> |
| </a> |
| </div> |
| <table class="table"> |
| <tr> |
| <th>Definition:</th> |
| <td>Provides information about special or interesting values during the process phase.</td> |
| </tr> |
| |
| <tr> |
| <th>Required:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Size restriction:</th> |
| <td>no</td> |
| </tr> |
| <tr> |
| <th>Note:</th> |
| <td>There is an option to set a time offset value related to the start time of the process phase. By setting this it is possible to using these value analog to one measurement value.</td> |
| </tr> |
| |
| <tr> |
| <th>Sub Fields:</th> |
| <td> |
| <ul> |
| |
| <li> |
| <a href="#time" title="go to time">time</a> |
| </li> |
| |
| <li> |
| <a href="#value_specialValue" title="go to value#specialValue">value</a> |
| </li> |
| |
| </ul> |
| </td> |
| </tr> |
| |
| <tr> |
| <th>Example:</th> |
| <td> |
| <figure class="highlight"><table><tr><td class="code"><pre><div class="line">...</div><div class="line">"specialValues": { </div><div class="line"> "pressure": {</div><div class="line"> "value": 24,</div><div class="line"> "time": 0</div><div class="line"> }</div><div class="line"> "force": {</div><div class="line"> "value": 50</div><div class="line"> }</div><div class="line">}</div><div class="line">...</div></pre></td></tr></table></figure></td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| </div> |
| <footer class="blog-footer"> |
| <div class="container"> |
| <div id="footer-info" class="inner"> |
| <ul> |
| <li> |
| <a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a> |
| </li> |
| <li> |
| <a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a> |
| </li> |
| <li> |
| <a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a> |
| </li> |
| <li> |
| <a href="http://www.eclipse.org/legal/">Legal</a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </footer> |
| |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js" integrity="sha384-8gBf6Y4YYq7Jx97PIqmTwLPin4hxIzQw5aDmUg/DDhul9fFpbbLcLh3nTIIDJKhx" crossorigin="anonymous"></script> |
| <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> |
| </body> |
| </html> |
