UNPKG

iot-sol

Version:

Intel(r) IoT Services Orchestration Layer - HTML5 IDE + Node.js middleware to create and host distributed IoT Apps in minutes

162 lines (159 loc) 12.4 kB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <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="#sina-weibo">sina weibo</a><ul> <li><a href="#postweibo">postweibo</a><ul> <li><a href="#description">Description</a></li> <li><a href="#config">Config</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="#receiveweibo">receiveweibo</a><ul> <li><a href="#config-1">Config</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> <li><a href="#output-format">Output Format</a></li> </ul></li> </ul></li> </ul> </div> <h1 id="sina-weibo">sina weibo</h1> <h2 id="postweibo">postweibo</h2> <h3 id="description">Description</h3> <p>This service provides ability for post message to sina weibo.</p> <p>It is implemented by <a href="https://www.npmjs.com/package/node-weibo-twitter">node-weibo-twitter</a></p> <p>At this stage, only supports plain-text message, and don't support the network proxy.</p> <h3 id="config">Config</h3> <p><code>token</code>: String. The access token of weibo account.</p> <h3 id="inport">Inport</h3> <p><code>text</code>: String. The message content of weibo.</p> <h3 id="outport">Outport</h3> <p><code>status</code>: Boolean. Output true if success to sending, otherwise false.</p> <h3 id="example">Example</h3> <div class="figure"> <img src="./pic/weibo.jpg" /> </div> <p>In this example, we post a weibo message with &quot;hello&quot;.</p> <h2 id="receiveweibo">receiveweibo</h2> <h4 id="description-1">Description</h4> <p>This service provides ability for receive message to sina weibo.</p> <p>It is implemented by <a href="https://www.npmjs.com/package/request">Request</a></p> <p>There are two mode of receving message.One is <code>all</code> mode which means that everytime you will get the all message.The other is <code>new</code> mode which means that everytime you will only get the new message based on last received message.</p> <h3 id="config-1">Config</h3> <p><code>token</code>: String. The access token of weibo account.</p> <p><code>type</code>: String. The receive mode. It must be <code>all</code> or <code>new</code>.</p> <p><code>proxy</code>: String. Optinal. You can set the proxy manually.</p> <h3 id="inport-1">Inport</h3> <p><code>switch</code>: Boolean. The switching signal of receive weibo. If it's true, this service will send request and format response data.</p> <h3 id="outport-1">Outport</h3> <p><code>data</code>: Object. The message of weibo. Attention:The format of data is Object which means that you can't simply show it using <code>Text</code> widget. You may need <code>f</code>(user-defined) to show it.</p> <h3 id="example-1">Example</h3> <div class="figure"> <img src="./pic/receiveweibo.png" /> </div> <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">&quot;created_at&quot;</span><span class="op">:</span> <span class="st">&quot;Tue May 31 17:46:55 +0800 2011&quot;</span><span class="op">,</span> <span class="st">&quot;id&quot;</span><span class="op">:</span> <span class="dv">11488058246</span><span class="op">,</span> <span class="st">&quot;text&quot;</span><span class="op">:</span> <span class="st">&quot;求关注。&quot;</span><span class="st">&quot;source&quot;</span><span class="op">:</span> <span class="st">&quot;&lt;a href=&quot;</span><span class="dt">http</span><span class="op">:</span><span class="co">//weibo.com&quot; rel=&quot;nofollow&quot;&gt;新浪微博&lt;/a&gt;&quot;,</span> <span class="st">&quot;favorited&quot;</span><span class="op">:</span> <span class="kw">false</span><span class="op">,</span> <span class="st">&quot;truncated&quot;</span><span class="op">:</span> <span class="kw">false</span><span class="op">,</span> <span class="st">&quot;in_reply_to_status_id&quot;</span><span class="op">:</span> <span class="st">&quot;&quot;</span><span class="op">,</span> <span class="st">&quot;in_reply_to_user_id&quot;</span><span class="op">:</span> <span class="st">&quot;&quot;</span><span class="op">,</span> <span class="st">&quot;in_reply_to_screen_name&quot;</span><span class="op">:</span> <span class="st">&quot;&quot;</span><span class="op">,</span> <span class="st">&quot;geo&quot;</span><span class="op">:</span> <span class="kw">null</span><span class="op">,</span> <span class="st">&quot;mid&quot;</span><span class="op">:</span> <span class="st">&quot;5612814510546515491&quot;</span><span class="op">,</span> <span class="st">&quot;reposts_count&quot;</span><span class="op">:</span> <span class="dv">8</span><span class="op">,</span> <span class="st">&quot;comments_count&quot;</span><span class="op">:</span> <span class="dv">9</span><span class="op">,</span> <span class="st">&quot;annotations&quot;</span><span class="op">:</span> []<span class="op">,</span> <span class="st">&quot;user&quot;</span><span class="op">:</span> <span class="op">{</span> <span class="st">&quot;id&quot;</span><span class="op">:</span> <span class="dv">1404376560</span><span class="op">,</span> <span class="st">&quot;screen_name&quot;</span><span class="op">:</span> <span class="st">&quot;zaku&quot;</span><span class="op">,</span> <span class="st">&quot;name&quot;</span><span class="op">:</span> <span class="st">&quot;zaku&quot;</span><span class="op">,</span> <span class="st">&quot;province&quot;</span><span class="op">:</span> <span class="st">&quot;11&quot;</span><span class="op">,</span> <span class="st">&quot;city&quot;</span><span class="op">:</span> <span class="st">&quot;5&quot;</span><span class="op">,</span> <span class="st">&quot;location&quot;</span><span class="op">:</span> <span class="st">&quot;北京 朝阳区&quot;</span><span class="op">,</span> <span class="st">&quot;description&quot;</span><span class="op">:</span> <span class="st">&quot;人生五十年,乃如梦如幻;有生斯有死,壮士复何憾。&quot;</span><span class="op">,</span> <span class="st">&quot;url&quot;</span><span class="op">:</span> <span class="st">&quot;http://blog.sina.com.cn/zaku&quot;</span><span class="op">,</span> <span class="st">&quot;profile_image_url&quot;</span><span class="op">:</span> <span class="st">&quot;http://tp1.sinaimg.cn/1404376560/50/0/1&quot;</span><span class="op">,</span> <span class="st">&quot;domain&quot;</span><span class="op">:</span> <span class="st">&quot;zaku&quot;</span><span class="op">,</span> <span class="st">&quot;gender&quot;</span><span class="op">:</span> <span class="st">&quot;m&quot;</span><span class="op">,</span> <span class="st">&quot;followers_count&quot;</span><span class="op">:</span> <span class="dv">1204</span><span class="op">,</span> <span class="st">&quot;friends_count&quot;</span><span class="op">:</span> <span class="dv">447</span><span class="op">,</span> <span class="st">&quot;statuses_count&quot;</span><span class="op">:</span> <span class="dv">2908</span><span class="op">,</span> <span class="st">&quot;favourites_count&quot;</span><span class="op">:</span> <span class="dv">0</span><span class="op">,</span> <span class="st">&quot;created_at&quot;</span><span class="op">:</span> <span class="st">&quot;Fri Aug 28 00:00:00 +0800 2009&quot;</span><span class="op">,</span> <span class="st">&quot;following&quot;</span><span class="op">:</span> <span class="kw">false</span><span class="op">,</span> <span class="st">&quot;allow_all_act_msg&quot;</span><span class="op">:</span> <span class="kw">false</span><span class="op">,</span> <span class="st">&quot;remark&quot;</span><span class="op">:</span> <span class="st">&quot;&quot;</span><span class="op">,</span> <span class="st">&quot;geo_enabled&quot;</span><span class="op">:</span> <span class="kw">true</span><span class="op">,</span> <span class="st">&quot;verified&quot;</span><span class="op">:</span> <span class="kw">false</span><span class="op">,</span> <span class="st">&quot;allow_all_comment&quot;</span><span class="op">:</span> <span class="kw">true</span><span class="op">,</span> <span class="st">&quot;avatar_large&quot;</span><span class="op">:</span> <span class="st">&quot;http://tp1.sinaimg.cn/1404376560/180/0/1&quot;</span><span class="op">,</span> <span class="st">&quot;verified_reason&quot;</span><span class="op">:</span> <span class="st">&quot;&quot;</span><span class="op">,</span> <span class="st">&quot;follow_me&quot;</span><span class="op">:</span> <span class="kw">false</span><span class="op">,</span> <span class="st">&quot;online_status&quot;</span><span class="op">:</span> <span class="dv">0</span><span class="op">,</span> <span class="st">&quot;bi_followers_count&quot;</span><span class="op">:</span> <span class="dv">215</span> <span class="op">}</span> <span class="op">},</span> ... ]</code></pre></div> <p>For more information about the data format, you can visit <a href="http://open.weibo.com/wiki/2/statuses/friends_timeline">weibo api document</a>.</p> </body> </html>