iot-sol
Version:
Intel(r) IoT Services Orchestration Layer - HTML5 IDE + Node.js middleware to create and host distributed IoT Apps in minutes
109 lines (103 loc) • 4.39 kB
HTML
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<meta name="author" content="Copyright 2015 Intel Corporation All Rights Reserved." />
<title>IoT Services Orchestration Layer</title>
<style type="text/css">code{white-space: pre;}</style>
<link rel="stylesheet" href="styles/style.css" type="text/css" />
</head>
<body>
<div id="header">
<h1 class="title">IoT Services Orchestration Layer</h1>
<h2 class="author">Copyright 2015 Intel Corporation All Rights Reserved.</h2>
</div>
<div id="TOC">
<ul>
<li><a href="#flow">flow</a><ul>
<li><a href="#gate">gate</a><ul>
<li><a href="#description">Description</a></li>
<li><a href="#inport">Inport</a></li>
<li><a href="#outport">Outport</a></li>
<li><a href="#example">Example</a></li>
</ul></li>
<li><a href="#if">if</a><ul>
<li><a href="#description-1">Description</a></li>
<li><a href="#inport-1">Inport</a></li>
<li><a href="#outport-1">Outport</a></li>
<li><a href="#example-1">Example</a></li>
</ul></li>
<li><a href="#sender">sender</a><ul>
<li><a href="#description-2">Description</a></li>
<li><a href="#inport-2">Inport</a></li>
<li><a href="#outport-2">Outport</a></li>
<li><a href="#example-2">Example</a></li>
</ul></li>
<li><a href="#merge">merge</a><ul>
<li><a href="#description-3">Description</a></li>
<li><a href="#inport-3">Inport</a></li>
<li><a href="#outport-3">Outport</a></li>
<li><a href="#example-3">Example</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<h1 id="flow">flow</h1>
<h2 id="gate">gate</h2>
<h3 id="description">Description</h3>
<p>This service is a controllable gate for dataflow.</p>
<h3 id="inport">Inport</h3>
<p><code>gate</code>: Boolean. <em>Non-trigger</em> inport, the state of gate.</p>
<p><code>in</code>: Any.</p>
<h3 id="outport">Outport</h3>
<p><code>out</code>: Any. Output the value of <code>in</code> if <code>gate</code> is true.</p>
<h3 id="example">Example</h3>
<div class="figure">
<img src="./pic/add_gate.jpg" />
</div>
<p>For this example, the value of <code>gate</code> was fixed to false, no data output forever.</p>
<h2 id="if">if</h2>
<h3 id="description-1">Description</h3>
<p>This service is a splitter for dataflow, <code>then</code> outputs true when <code>in</code> is true, otherwise <code>else</code> outputs true.</p>
<p><strong>Note that</strong>: Only one outport outputs true each time.</p>
<h3 id="inport-1">Inport</h3>
<p><code>in</code>: Boolean.</p>
<h3 id="outport-1">Outport</h3>
<p><code>then</code>: Boolean. Output true only when <code>in</code> is true</p>
<p><code>else</code>: Boolean. Output true only when <code>in</code> is false</p>
<h3 id="example-1">Example</h3>
<div class="figure">
<img src="./pic/if_sender.jpg" />
</div>
<p>For this example, if <code>in</code> is true, the upper branch will be satisfied and eventually output "path_up", otherwise the lower branch will be selected and eventually output "path_down".</p>
<h2 id="sender">sender</h2>
<h3 id="description-2">Description</h3>
<p>Output the value of <code>content</code> to <code>out</code> only when <code>trigger</code> received message.</p>
<h3 id="inport-2">Inport</h3>
<p><code>content</code>: Any. <em>Non-trigger</em> inport</p>
<p><code>trigger</code>: Any. The value will be discard.</p>
<h3 id="outport-2">Outport</h3>
<p><code>out</code>: Any.</p>
<h3 id="example-2">Example</h3>
<div class="figure">
<img src="./pic/if_sender.jpg" />
</div>
<h2 id="merge">merge</h2>
<h3 id="description-3">Description</h3>
<p>This service combines all inport to a JSON object and output it.</p>
<h3 id="inport-3">Inport</h3>
<p>You can add/delete inport, and the name of inport is changable.</p>
<div class="figure">
<img src="./pic/merge_port.jpg" />
</div>
<h3 id="outport-3">Outport</h3>
<p><code>out</code>: JSON Object. keys from the name of inports and value from each inport.</p>
<h3 id="example-3">Example</h3>
<div class="figure">
<img src="./pic/merge.jpg" />
</div>
<p>For this example, the value of <code>out</code> is {"name":"abc", "phone":12345, "addr":"intel corp"}</p>
</body>
</html>