iot-sol
Version:
Intel(r) IoT Services Orchestration Layer - HTML5 IDE + Node.js middleware to create and host distributed IoT Apps in minutes
190 lines (186 loc) • 9.5 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>
<style type="text/css">
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
</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="#网络服务">网络服务</a><ul>
<li><a href="#http请求">http请求</a><ul>
<li><a href="#描述">描述</a></li>
<li><a href="#配置">配置</a></li>
<li><a href="#输入">输入</a></li>
<li><a href="#输出">输出</a></li>
<li><a href="#例子">例子</a></li>
<li><a href="#output-format">Output Format</a></li>
</ul></li>
<li><a href="#tcp请求">tcp请求</a><ul>
<li><a href="#描述-1">描述</a></li>
<li><a href="#配置-1">配置</a></li>
<li><a href="#输入-1">输入</a></li>
<li><a href="#输出-1">输出</a></li>
<li><a href="#例子-1">例子</a></li>
</ul></li>
<li><a href="#tcp服务器">tcp服务器</a><ul>
<li><a href="#描述-2">描述</a></li>
<li><a href="#配置-2">配置</a></li>
<li><a href="#输入-2">输入</a></li>
<li><a href="#例子-2">例子</a></li>
</ul></li>
<li><a href="#udp请求">udp请求</a><ul>
<li><a href="#描述-3">描述</a></li>
<li><a href="#配置-3">配置</a></li>
<li><a href="#输入-3">输入</a></li>
<li><a href="#输出-2">输出</a></li>
<li><a href="#例子-3"> 例子</a></li>
</ul></li>
<li><a href="#udp服务器">udp服务器</a><ul>
<li><a href="#描述-4"> 描述</a></li>
<li><a href="#配置-4"> 配置</a></li>
<li><a href="#输入-4">输入</a></li>
<li><a href="#输入-5"> 输入</a></li>
<li><a href="#例子-4">例子</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<h1 id="网络服务">网络服务</h1>
<h2 id="http请求">http请求</h2>
<h3 id="描述">描述</h3>
<p>提供发送http请求的服务。 被<a href="https://www.npmjs.com/package/request">REQUEST</a>实现。</p>
<h3 id="配置">配置</h3>
<p>‘url’：字符串，http请求的url，如果这个url没有以‘http://’开头，则会被添加上‘http://’。</p>
<p>‘method’：字符串，请求方法，现在只支持‘get’,'post','put','delete','patch'这５个方法。</p>
<p>‘headers’：对象，请求头部，默认是‘{}’。</p>
<p>‘body’：对象，请求主体，默认是‘{}’。</p>
<p>‘proxy’：字符串，可选参数，可以手动配置代理。</p>
<p>‘timeout’：数值，请求时限，默认是‘500000’(50s)。</p>
<h3 id="输入">输入</h3>
<p>‘switch’：布尔型，判断是否发送http请求，如果值为true，就会发送http请求，并格式化响应数据。</p>
<h3 id="输出">输出</h3>
<p>‘out’：字符串，http请求结果，包括‘状态码’，‘头部’，‘主体’。</p>
<h3 id="例子">例子</h3>
<div class="figure">
<img src="./pic/http_request.png" />
</div>
<p>在这个例子中，向 http://www.baidu.com发送了一个请求，并将结果写进了文件中。</p>
<p></br></p>
<h3 id="output-format">Output Format</h3>
<div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="op">{</span>
<span class="st">"statusCode"</span><span class="op">:</span> <span class="dv">200</span><span class="op">,</span>
<span class="st">"headers"</span><span class="op">:</span> <span class="st">"response.headers"</span><span class="op">,</span>
<span class="st">"body"</span><span class="op">:</span> <span class="st">"response.body"</span>
<span class="op">}</span></code></pre></div>
<h2 id="tcp请求">tcp请求</h2>
<h3 id="描述-1">描述</h3>
<p>提供发送tcp请求的服务</p>
<h3 id="配置-1">配置</h3>
<p>‘ip’：字符串，服务器ip地址。</p>
<p>‘port’：数值，服务器端口。</p>
<h3 id="输入-1">输入</h3>
<p>‘switch’：布尔型，判断是否发送tcp请求，如果值为true,就会发送请求，并格式化响应数据。</p>
<p>‘data’：字符串，发送给服务器的数据。</p>
<h3 id="输出-1">输出</h3>
<p>‘out’：字符串，从服务返回的响应信息。</p>
<h3 id="例子-1">例子</h3>
<div class="figure">
<img src="./pic/tcp_request.png" />
</div>
<p>在这个例子中，每隔３秒钟就会向127.0.0.1:9999发送一个请求，并用‘Text’ widget显示响应信息。</p>
<p></br></p>
<h2 id="tcp服务器">tcp服务器</h2>
<h3 id="描述-2">描述</h3>
<p>通过这个服务可以创建一个简单的tcp服务器。</p>
<h3 id="配置-2">配置</h3>
<p>‘ip’：字符串，监听ip地址，默认是‘0.0.0.0’。</p>
<p>‘port’：数值，监听端口。</p>
<p>‘f(data)’：函数，处理来自客户端的数据。</p>
<h3 id="输入-2">输入</h3>
<p>‘switch’：布尔型，判断是否开启tcp服务器，如果值为true，则会开启tcp服务器，否则关闭tcp服务器。</p>
<h3 id="例子-2">例子</h3>
<div class="figure">
<img src="./pic/tcp_server.png" />
</div>
<p>在这个例子中，创建了一个tcp服务器监听0.0.0.0:9999，当客户端发送数据时，就会在这个数据后面添加‘hello’。</p>
<p>function code</p>
<div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="cf">return</span> <span class="va">data</span>.<span class="at">toString</span>() <span class="op">+</span> <span class="st">"hello"</span><span class="op">;</span></code></pre></div>
<p></br></p>
<h2 id="udp请求">udp请求</h2>
<h3 id="描述-3">描述</h3>
<p>提供发送udp请求的服务。</p>
<h3 id="配置-3">配置</h3>
<p>'ip'：字符串，服务器ip地址。</p>
<p>‘port’：数值，服务器端口。</p>
<h3 id="输入-3">输入</h3>
<p>‘switch’：布尔型，判断是否发送udp请求，如果值为true，就会发送请求，并格式化响应信息。</p>
<p>‘data’：字符串，发送给服务器的信息。</p>
<h3 id="输出-2">输出</h3>
<p>‘out’：字符串，服务器的响应信息。</p>
<h3 id="例子-3"> 例子</h3>
<p>参照tcp请求的例子。</p>
<p></br></p>
<h2 id="udp服务器">udp服务器</h2>
<h3 id="描述-4"> 描述</h3>
<p>提供创建一个简单的udp服务器的功能。</p>
<h3 id="配置-4"> 配置</h3>
<p>‘ip’：字符串，监听ip，默认是'0.0.0.0'。</p>
<p>‘port’：数值，监听端口。</p>
<p>‘f(data)’：函数，处理来自与客户端的数据。</p>
<h3 id="输入-4">输入</h3>
<p>‘ip’：字符串，监听ip，默认是'0.0.0.0'。</p>
<p>‘port’：数值，监听端口。</p>
<p>‘f(data)’：函数，处理来自于客户端的数据。</p>
<h3 id="输入-5"> 输入</h3>
<p>‘switch’：布尔型，判断是否开启udp服务器，如果值为true，服务器就会开启，否则关闭。</p>
<h3 id="例子-4">例子</h3>
<p>参照tcp服务器的例子。</p>
</body>
</html>