http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html index aff002b..559c040 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:50 KST 2016 --> -<title>IotDevice (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>IotDevice (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,13 +12,13 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="IotDevice (Edgent v1.0.0)"; + parent.document.title="IotDevice (Edgent v1.1.0)"; } } catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6}; +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/edgent/connectors/iot/HeartBeat.html" title="class in org.apache.edgent.connectors.iot"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/edgent/connectors/iot/QoS.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/edgent/connectors/iot/IotDevice.html" target="_top">Frames</a></li> @@ -104,14 +104,36 @@ var activeTableTab = "activeTableTab"; <dd><a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></dd> </dl> <dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">IotGateway</a></dd> +</dl> +<dl> <dt>All Known Implementing Classes:</dt> -<dd><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html" title="class in org.apache.edgent.connectors.iotp">IotpDevice</a>, <a href="../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">MqttDevice</a></dd> +<dd><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html" title="class in org.apache.edgent.connectors.iotp">IotpDevice</a>, <a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp">IotpGateway</a>, <a href="../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">MqttDevice</a></dd> </dl> <hr> <br> <pre>public interface <span class="typeNameLabel">IotDevice</span> extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></pre> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector. + <p> + IotDevice characteristics: + <ul> + <li><code>IotDevice.getDeviceTypeId()</code> returns an opaque value whose form + is the domain of an IoT connector implementation.</li> + <li><code>IotDevice.getDeviceId()</code> returns an opaque value whose form + is the domain of an IoT connector implementation. + The value is unique for a particular a logical device. + <li><code>IotDevice.equals()</code> returns true if two IotDevice instances are + for the same logical device, false otherwise.</li> + <li><code>IotDevice.hashCode()</code> returns the same value for all IotDevice instances + for the same logical device.</li> + </ul></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/edgent/connectors/iot/package-summary.html">Edgent generic IoT device model</a>, +<a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot"><code>IotGateway</code></a></dd> +</dl> </li> </ul> </div> @@ -132,29 +154,35 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_DEVICE">CMD_DEVICE</a></span></code> +<div class="block">Device identifier key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_FORMAT">CMD_FORMAT</a></span></code> <div class="block">Command format key.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_ID">CMD_ID</a></span></code> <div class="block">Command identifier key.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD">CMD_PAYLOAD</a></span></code> <div class="block">Command payload key.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_TS">CMD_TS</a></span></code> <div class="block">Command timestamp (in milliseconds) key.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#RESERVED_ID_PREFIX">RESERVED_ID_PREFIX</a></span></code> <div class="block">Device event and command identifiers starting with "edgent" are reserved for use by Edgent.</div> @@ -198,6 +226,18 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" <div class="block">Publish a stream's tuples as device events.</div> </td> </tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--">getDeviceId</a></span>()</code> +<div class="block">Get the device's unique opaque device identifier.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceType--">getDeviceType</a></span>()</code> +<div class="block">Get the device's opaque device type identifier.</div> +</td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.TopologyElement"> @@ -285,7 +325,7 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" <a name="CMD_PAYLOAD"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>CMD_PAYLOAD</h4> <pre>static final java.lang.String CMD_PAYLOAD</pre> @@ -301,6 +341,23 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" </dl> </li> </ul> +<a name="CMD_DEVICE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CMD_DEVICE</h4> +<pre>static final java.lang.String CMD_DEVICE</pre> +<div class="block">Device identifier key. + Key is "device". + The value is the result of <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--"><code>getDeviceId()</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#commands-java.lang.String...-"><code>commands(String...)</code></a>, +<a href="../../../../../constant-values.html#org.apache.edgent.connectors.iot.IotDevice.CMD_DEVICE">Constant Field Values</a></dd> +</dl> +</li> +</ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> @@ -309,6 +366,34 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" <!-- --> </a> <h3>Method Detail</h3> +<a name="getDeviceType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeviceType</h4> +<pre>java.lang.String getDeviceType()</pre> +<div class="block">Get the device's opaque device type identifier.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the device's type</dd> +</dl> +</li> +</ul> +<a name="getDeviceId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeviceId</h4> +<pre>java.lang.String getDeviceId()</pre> +<div class="block">Get the device's unique opaque device identifier.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the device's id</dd> +</dl> +</li> +</ul> <a name="events-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-"> <!-- --> </a> @@ -369,6 +454,7 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" Each command sent to the device matching <code>commands</code> will result in a tuple on the stream. The JSON object has these keys: <UL> + <LI><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_DEVICE"><code>device</code></a> - Command's opaque target device's id String. <LI><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_ID"><code>command</code></a> - Command identifier as a String</LI> <LI><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_TS"><code>tsms</code></a> - Timestamp of the command in milliseconds since the 1970/1/1 epoch.</LI> <LI><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_FORMAT"><code>format</code></a> - Format of the command as a String</LI> @@ -382,7 +468,7 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>commands</code> - Command identifiers to include. If no command identifiers are provided then the - stream will contain all device commands.</dd> + stream will contain all of this IotDevice's device commands.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>Stream containing device commands.</dd> </dl> @@ -418,7 +504,7 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/edgent/connectors/iot/HeartBeat.html" title="class in org.apache.edgent.connectors.iot"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/edgent/connectors/iot/QoS.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/edgent/connectors/iot/IotDevice.html" target="_top">Frames</a></li> @@ -458,6 +544,6 @@ extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html index 1430e22..682978f 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:50 KST 2016 --> -<title>QoS (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>QoS (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="QoS (Edgent v1.0.0)"; + parent.document.title="QoS (Edgent v1.1.0)"; } } catch(err) { @@ -43,7 +43,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> @@ -242,7 +242,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> @@ -283,6 +283,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html index b49e989..83c97cf 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Interface org.apache.edgent.connectors.iot.Commands (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Interface org.apache.edgent.connectors.iot.Commands (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.Commands (Edgent v1.0.0)"; + parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.Commands (Edgent v1.1.0)"; } } catch(err) { @@ -121,6 +121,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html index 8bd182b..948a515 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Interface org.apache.edgent.connectors.iot.Events (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Interface org.apache.edgent.connectors.iot.Events (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.Events (Edgent v1.0.0)"; + parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.Events (Edgent v1.1.0)"; } } catch(err) { @@ -121,6 +121,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html index f203fae..94d8ffe 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Class org.apache.edgent.connectors.iot.HeartBeat (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Class org.apache.edgent.connectors.iot.HeartBeat (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.apache.edgent.connectors.iot.HeartBeat (Edgent v1.0.0)"; + parent.document.title="Uses of Class org.apache.edgent.connectors.iot.HeartBeat (Edgent v1.1.0)"; } } catch(err) { @@ -121,6 +121,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html index 960a841..09cde5a 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Interface org.apache.edgent.connectors.iot.IotDevice (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Interface org.apache.edgent.connectors.iot.IotDevice (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.IotDevice (Edgent v1.0.0)"; + parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.IotDevice (Edgent v1.1.0)"; } } catch(err) { @@ -91,7 +91,7 @@ <tr class="rowColor"> <td class="colFirst"><a href="#org.apache.edgent.connectors.iot">org.apache.edgent.connectors.iot</a></td> <td class="colLast"> -<div class="block">Edgent device connector API to a message hub.</div> +<div class="block">Edgent IoT device and IoT Gateway device connector API to an IoT message hub.</div> </td> </tr> <tr class="altColor"> @@ -168,6 +168,42 @@ <!-- --> </a> <h3>Uses of <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a> in <a href="../../../../../../org/apache/edgent/connectors/iot/package-summary.html">org.apache.edgent.connectors.iot</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a> in <a href="../../../../../../org/apache/edgent/connectors/iot/package-summary.html">org.apache.edgent.connectors.iot</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">IotGateway</a></span></code> +<div class="block">A generic IoT gateway device IoT hub connector.</div> +</td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/edgent/connectors/iot/package-summary.html">org.apache.edgent.connectors.iot</a> that return <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></td> +<td class="colLast"><span class="typeNameLabel">IotGateway.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html#getIotDevice-java.util.Map-">getIotDevice</a></span>(java.util.Map<java.lang.String,java.lang.String> deviceIdAttrs)</code> +<div class="block">Get an <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><code>IotDevice</code></a> for a connected device.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></td> +<td class="colLast"><span class="typeNameLabel">IotGateway.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html#getIotDevice-java.lang.String-">getIotDevice</a></span>(java.lang.String deviceId)</code> +<div class="block">Get an <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><code>IotDevice</code></a> for a connected device.</div> +</td> +</tr> +</tbody> +</table> <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> <caption><span>Methods in <a href="../../../../../../org/apache/edgent/connectors/iot/package-summary.html">org.apache.edgent.connectors.iot</a> with parameters of type <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></span><span class="tabEnd"> </span></caption> <tr> @@ -201,9 +237,34 @@ <tr class="altColor"> <td class="colFirst"><code>class </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html" title="class in org.apache.edgent.connectors.iotp">IotpDevice</a></span></code> -<div class="block">Connector for IBM Watson IoT Platform.</div> +<div class="block">A Device Connector to IBM Watson IoT Platform (WIoTP).</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp">IotpGateway</a></span></code> +<div class="block">An IoT Gateway Device Connector to IBM Watson IoT Platform (WIoTP).</div> +</td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/edgent/connectors/iotp/package-summary.html">org.apache.edgent.connectors.iotp</a> that return <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></td> +<td class="colLast"><span class="typeNameLabel">IotpGateway.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html#getIotDevice-java.util.Map-">getIotDevice</a></span>(java.util.Map<java.lang.String,java.lang.String> deviceIdAttrs)</code> +<div class="block">Get an <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><code>IotDevice</code></a> for a connected device.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></td> +<td class="colLast"><span class="typeNameLabel">IotpGateway.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html#getIotDevice-java.lang.String-">getIotDevice</a></span>(java.lang.String fqDeviceId)</code> </td> +</tr> </tbody> </table> </li> @@ -260,6 +321,15 @@ <div class="block">Register an application that uses an <code>IotDevice</code>.</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="typeNameLabel">IotProvider.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/providers/iot/IotProvider.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-boolean-com.google.gson.JsonObject-">registerTopology</a></span>(java.lang.String applicationName, + <a href="../../../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>,com.google.gson.JsonObject> builder, + boolean autoSubmit, + com.google.gson.JsonObject config)</code> +<div class="block">Register an application that uses an <code>IotDevice</code>.</div> +</td> +</tr> </tbody> </table> <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> @@ -408,6 +478,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html index 09337ef..d68cb81 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Interface org.apache.edgent.connectors.iot.QoS (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Interface org.apache.edgent.connectors.iot.QoS (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.QoS (Edgent v1.0.0)"; + parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.QoS (Edgent v1.1.0)"; } } catch(err) { @@ -121,6 +121,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html index 2e51d6c..fb86354 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:51 KST 2016 --> -<title>org.apache.edgent.connectors.iot (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.iot (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -16,6 +16,7 @@ <li><a href="Commands.html" title="interface in org.apache.edgent.connectors.iot" target="classFrame"><span class="interfaceName">Commands</span></a></li> <li><a href="Events.html" title="interface in org.apache.edgent.connectors.iot" target="classFrame"><span class="interfaceName">Events</span></a></li> <li><a href="IotDevice.html" title="interface in org.apache.edgent.connectors.iot" target="classFrame"><span class="interfaceName">IotDevice</span></a></li> +<li><a href="IotGateway.html" title="interface in org.apache.edgent.connectors.iot" target="classFrame"><span class="interfaceName">IotGateway</span></a></li> <li><a href="QoS.html" title="interface in org.apache.edgent.connectors.iot" target="classFrame"><span class="interfaceName">QoS</span></a></li> </ul> <h2 title="Classes">Classes</h2> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html index cbfc39e..f4ebcb6 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:51 KST 2016 --> -<title>org.apache.edgent.connectors.iot (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.iot (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.edgent.connectors.iot (Edgent v1.0.0)"; + parent.document.title="org.apache.edgent.connectors.iot (Edgent v1.1.0)"; } } catch(err) { @@ -72,7 +72,7 @@ <div class="header"> <h1 title="Package" class="title">Package org.apache.edgent.connectors.iot</h1> <div class="docSummary"> -<div class="block">Edgent device connector API to a message hub.</div> +<div class="block">Edgent IoT device and IoT Gateway device connector API to an IoT message hub.</div> </div> <p>See: <a href="#package.description">Description</a></p> </div> @@ -89,7 +89,7 @@ <tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/iot/Commands.html" title="interface in org.apache.edgent.connectors.iot">Commands</a></td> <td class="colLast"> -<div class="block">Devic command identifiers used by Edgent.</div> +<div class="block">Device command identifiers used by Edgent.</div> </td> </tr> <tr class="rowColor"> @@ -101,10 +101,16 @@ <tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></td> <td class="colLast"> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">IotGateway</a></td> +<td class="colLast"> +<div class="block">A generic IoT gateway device IoT hub connector.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/iot/QoS.html" title="interface in org.apache.edgent.connectors.iot">QoS</a></td> <td class="colLast"> <div class="block">Device event quality of service levels.</div> @@ -123,7 +129,9 @@ <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/iot/HeartBeat.html" title="class in org.apache.edgent.connectors.iot">HeartBeat</a></td> -<td class="colLast"> </td> +<td class="colLast"> +<div class="block">An IoT device heartbeat event generator.</div> +</td> </tr> </tbody> </table> @@ -133,9 +141,27 @@ <!-- --> </a> <h2 title="Package org.apache.edgent.connectors.iot Description">Package org.apache.edgent.connectors.iot Description</h2> -<div class="block">Edgent device connector API to a message hub. +<div class="block">Edgent IoT device and IoT Gateway device connector API to an IoT message hub. + <P> + An IoT environment consists of an enterprise IoT message hub and devices and other clients + connected to it. + Each IoT device has an identity in the hub. The form of a device's identity is the domain + of an IoT hub implementation. + How a device becomes registered to an IoT hub and generally what device management capabilities + exist and how a device is managed is beyond the scope of the + "analytic pipelines" focused Edgent APIs. + </P> + <P> + An IoT device can publish device events to and receive device commands from an IoT hub. + An IoT gateway device is an IoT device that is also conduit for a collection of IoT devices + that lack direct connection to the enterprise IoT hub. + A gateway can publish events on behalf of its connected devices and + receive commands from the hub targeted to them. + An Edgent IoT hub connector bridges the gap between this generic model and and + particular IoT hub implementation's underlying protocols. + </P> <P> - Generic device model that supports a device model consisting of: + More specifically, the generic IoT device model consists of: <UL> <LI> <B>Device events</B> - A device <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-"><code>publishes</code></a> <em>events</em> as messages to a message hub to allow @@ -219,6 +245,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html index 986f0fc..c6d3056 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:51 KST 2016 --> -<title>org.apache.edgent.connectors.iot Class Hierarchy (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.iot Class Hierarchy (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.edgent.connectors.iot Class Hierarchy (Edgent v1.0.0)"; + parent.document.title="org.apache.edgent.connectors.iot Class Hierarchy (Edgent v1.1.0)"; } } catch(err) { @@ -92,7 +92,11 @@ <li type="circle">org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/QoS.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">QoS</span></a></li> <li type="circle">org.apache.edgent.topology.<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology"><span class="typeNameLink">TopologyElement</span></a> <ul> -<li type="circle">org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">IotDevice</span></a></li> +<li type="circle">org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">IotDevice</span></a> +<ul> +<li type="circle">org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot"><span class="typeNameLink">IotGateway</span></a></li> +</ul> +</li> </ul> </li> </ul> @@ -145,6 +149,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html index 9e63250..2689ddc 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Package org.apache.edgent.connectors.iot (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:13 EST 2017 --> +<title>Uses of Package org.apache.edgent.connectors.iot (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.apache.edgent.connectors.iot (Edgent v1.0.0)"; + parent.document.title="Uses of Package org.apache.edgent.connectors.iot (Edgent v1.1.0)"; } } catch(err) { @@ -91,7 +91,7 @@ <tr class="rowColor"> <td class="colFirst"><a href="#org.apache.edgent.connectors.iot">org.apache.edgent.connectors.iot</a></td> <td class="colLast"> -<div class="block">Edgent device connector API to a message hub.</div> +<div class="block">Edgent IoT device and IoT Gateway device connector API to an IoT message hub.</div> </td> </tr> <tr class="altColor"> @@ -137,7 +137,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.apps.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -154,7 +154,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.connectors.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -171,7 +171,12 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.connectors.iotp">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotGateway.html#org.apache.edgent.connectors.iotp">IotGateway</a> +<div class="block">A generic IoT gateway device IoT hub connector.</div> </td> </tr> </tbody> @@ -188,7 +193,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.connectors.mqtt.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -205,7 +210,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.providers.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -222,7 +227,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.samples.connectors.iotp">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -239,7 +244,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.test.svt.apps.iotp">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -295,6 +300,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html b/site/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html index 078309c..b9493a9 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:49 KST 2016 --> -<title>IotpDevice (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:09 EST 2017 --> +<title>IotpDevice (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,13 +12,13 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="IotpDevice (Edgent v1.0.0)"; + parent.document.title="IotpDevice (Edgent v1.1.0)"; } } catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li>Prev Class</li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/edgent/connectors/iotp/IotpDevice.html" target="_top">Frames</a></li> @@ -116,7 +116,7 @@ var activeTableTab = "activeTableTab"; <pre>public class <span class="typeNameLabel">IotpDevice</span> extends java.lang.Object implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></pre> -<div class="block">Connector for IBM Watson IoT Platform. +<div class="block">A Device Connector to IBM Watson IoT Platform (WIoTP). <BR> IBM Watson IoT Platform is a cloud based internet of things scale message hub that provides a device model on top of MQTT. @@ -125,11 +125,36 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot"><code>IotProvider</code></a>. <BR> <em>Note IBM Watson IoT Platform was previously known as - IBM Internet of Things Foundation.</em></div> + IBM Internet of Things Foundation.</em> + <p> + This connector is a thin wrapper over the WIoTP <code>DeviceClient</code> Java API. + The constructor <code>Properties</code> and <code>optionsFile</code> contents are those + demanded by <code>DeviceClient</code>. + <p> + For more complex use cases this connector can be constructed to use + a supplied <code>DeviceClient</code>. This gives an application complete + control over the construction and configuration of the underlying + connection to WIoTP. + <p> + An application that wants to be a WIoTP <i>managed device</i> + and an Edgent application must construct a WIoTP <code>ManagedDevice</code> instance + and construct this device connector using it. + <P> + If the following link's page doesn't render in javadoc, paste it into a browser window. + <BR> + See the IBM Watson IoT Platform documentation for Developing devices at + <a href="https://internetofthings.ibmcloud.com/";>https://internetofthings.ibmcloud.com/</a> + <p> + See <a href="https://github.com/ibm-watson-iot/iot-java/releases";>WIoTP Java Client Library Releases</a> + for general information. + <p> + See <a href="https://github.com/ibm-watson-iot/iot-java/tree/master#migration-from-release-015-to-021";>WIoTP Migration from release 0.1.5 to 0.2.1</a> + for details of changes that occurred to device event payloads + and how to revert the behavior if needed. + <p></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><code>Edgent generic device model</code>, -<a href="http://www.ibm.com/internet-of-things/iot-platform.html";>IBM Watson IoT Platform</a>, +<dd><a href="../../../../../org/apache/edgent/connectors/iot/package-summary.html">Edgent generic device model</a>, <a href="../../../../../org/apache/edgent/samples/connectors/iotp/IotpSensors.html" title="class in org.apache.edgent.samples.connectors.iotp"><code>Sample application</code></a></dd> </dl> </li> @@ -162,7 +187,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <!-- --> </a> <h3>Fields inherited from interface org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></h3> -<code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_FORMAT">CMD_FORMAT</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_ID">CMD_ID</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD">CMD_PAYLOAD</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_TS">CMD_TS</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#RESERVED_ID_PREFIX">RESERVED_ID_PREFIX</a></code></li> +<code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_DEVICE">CMD_DEVICE</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_FORMAT">CMD_FORMAT</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_ID">CMD_ID</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD">CMD_PAYLOAD</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_TS">CMD_TS</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#RESERVED_ID_PREFIX">RESERVED_ID_PREFIX</a></code></li> </ul> </li> </ul> @@ -178,16 +203,21 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#IotpDevice-org.apache.edgent.topology.Topology-com.ibm.iotf.client.device.DeviceClient-">IotpDevice</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, + com.ibm.iotf.client.device.DeviceClient deviceClient)</code> +<div class="block">Create a connector using the supplied WIoTP <code>DeviceClient</code>.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#IotpDevice-org.apache.edgent.topology.Topology-java.io.File-">IotpDevice</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.io.File optionsFile)</code> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service.</div> +<div class="block">Create a connector for the IoT device specified by <code>optionsFile</code>.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#IotpDevice-org.apache.edgent.topology.Topology-java.util.Properties-">IotpDevice</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.util.Properties options)</code> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service with the device - specified by <code>options</code>.</div> +<div class="block">Create a connector for the IoT device specified by <code>options</code>.</div> </td> </tr> </table> @@ -229,25 +259,56 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </td> </tr> <tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#getDeviceId--">getDeviceId</a></span>()</code> +<div class="block">Get the device's unique opaque device identifier.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#getDeviceType--">getDeviceType</a></span>()</code> +<div class="block">Get the device's opaque device type identifier.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#httpEvents-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-">httpEvents</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.String> eventId, + <a href="../../../../../org/apache/edgent/function/UnaryOperator.html" title="interface in org.apache.edgent.function">UnaryOperator</a><com.google.gson.JsonObject> payload)</code> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#httpEvents-org.apache.edgent.topology.TStream-java.lang.String-">httpEvents</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + java.lang.String eventId)</code> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html" title="class in org.apache.edgent.connectors.iotp">IotpDevice</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#quickstart-org.apache.edgent.topology.Topology-java.lang.String-">quickstart</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.lang.String deviceId)</code> <div class="block">Create an <code>IotpDevice</code> connector to the Quickstart service.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#topology--">topology</a></span>()</code> <div class="block">Topology this element is contained in.</div> </td> </tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#toString--">toString</a></span>()</code> </td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> @@ -294,8 +355,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <h4>IotpDevice</h4> <pre>public IotpDevice(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.util.Properties options)</pre> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service with the device - specified by <code>options</code>. +<div class="block">Create a connector for the IoT device specified by <code>options</code>. <BR> These properties must be set in <code>options</code>. @@ -319,10 +379,12 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht IotDevice iotDevice = new IotpDevice(options); </code> </pre> - <p> Connecting to the server occurs when the topology is submitted for execution. + </p> + <p> + See the IBM Watson IoT Platform documentation for additional properties. </p></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -334,14 +396,12 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <a name="IotpDevice-org.apache.edgent.topology.Topology-java.io.File-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>IotpDevice</h4> <pre>public IotpDevice(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.io.File optionsFile)</pre> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service. - Device identifier and authorization are specified - by a configuration file. +<div class="block">Create a connector for the IoT device specified by <code>optionsFile</code>. <BR> The format of the file is: <pre> @@ -368,6 +428,9 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <p> Connecting to the server occurs when the topology is submitted for execution. + </p> + <p> + See the IBM Watson IoT Platform documentation for additional properties. </p></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -376,6 +439,22 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </dl> </li> </ul> +<a name="IotpDevice-org.apache.edgent.topology.Topology-com.ibm.iotf.client.device.DeviceClient-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IotpDevice</h4> +<pre>public IotpDevice(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, + com.ibm.iotf.client.device.DeviceClient deviceClient)</pre> +<div class="block">Create a connector using the supplied WIoTP <code>DeviceClient</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topology</code> - the connector's associated <code>Topology</code>.</dd> +<dd><code>deviceClient</code> - a WIoTP device client API object.</dd> +</dl> +</li> +</ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> @@ -466,6 +545,52 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </dl> </li> </ul> +<a name="httpEvents-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>httpEvents</h4> +<pre>public <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> httpEvents(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.String> eventId, + <a href="../../../../../org/apache/edgent/function/UnaryOperator.html" title="interface in org.apache.edgent.function">UnaryOperator</a><com.google.gson.JsonObject> payload)</pre> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol. + <p> + Each tuple is published as a device event with the supplied functions + providing the event identifier and payload from the tuple. + The event identifier and payload can be generated based upon the tuple. + The event is published with the equivalent of <a href="../../../../../org/apache/edgent/connectors/iot/QoS.html#AT_MOST_ONCE"><code>QoS.AT_MOST_ONCE</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream to be published.</dd> +<dd><code>eventId</code> - function to supply the event identifier.</dd> +<dd><code>payload</code> - function to supply the event's payload.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>TSink sink element representing termination of this stream.</dd> +</dl> +</li> +</ul> +<a name="httpEvents-org.apache.edgent.topology.TStream-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>httpEvents</h4> +<pre>public <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> httpEvents(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + java.lang.String eventId)</pre> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol. + <p> + Each tuple is published as a device event with the fixed event identifier. + The event is published with the equivalent of <a href="../../../../../org/apache/edgent/connectors/iot/QoS.html#AT_MOST_ONCE"><code>QoS.AT_MOST_ONCE</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream to be published.</dd> +<dd><code>eventId</code> - Event identifier.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>TSink sink element representing termination of this stream.</dd> +</dl> +</li> +</ul> <a name="commands-java.lang.String...-"> <!-- --> </a> @@ -502,7 +627,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <a name="topology--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>topology</h4> <pre>public <a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology()</pre> @@ -516,6 +641,53 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </dl> </li> </ul> +<a name="getDeviceType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeviceType</h4> +<pre>public java.lang.String getDeviceType()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceType--">IotDevice</a></code></span></div> +<div class="block">Get the device's opaque device type identifier.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceType--">getDeviceType</a></code> in interface <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the device's type</dd> +</dl> +</li> +</ul> +<a name="getDeviceId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeviceId</h4> +<pre>public java.lang.String getDeviceId()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--">IotDevice</a></code></span></div> +<div class="block">Get the device's unique opaque device identifier.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--">getDeviceId</a></code> in interface <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the device's id</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> </li> </ul> </li> @@ -546,7 +718,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <div class="subNav"> <ul class="navList"> <li>Prev Class</li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/edgent/connectors/iotp/IotpDevice.html" target="_top">Frames</a></li> @@ -586,6 +758,6 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iotp/class-use/IotpDevice.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iotp/class-use/IotpDevice.html b/site/javadoc/latest/org/apache/edgent/connectors/iotp/class-use/IotpDevice.html index aaab78e..de8396a 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iotp/class-use/IotpDevice.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iotp/class-use/IotpDevice.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Class org.apache.edgent.connectors.iotp.IotpDevice (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 --> +<title>Uses of Class org.apache.edgent.connectors.iotp.IotpDevice (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Class org.apache.edgent.connectors.iotp.IotpDevice (Edgent v1.0.0)"; + parent.document.title="Uses of Class org.apache.edgent.connectors.iotp.IotpDevice (Edgent v1.1.0)"; } } catch(err) { @@ -166,6 +166,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-frame.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-frame.html b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-frame.html index 8bac1ae..a2e733d 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-frame.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-frame.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:51 KST 2016 --> -<title>org.apache.edgent.connectors.iotp (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.iotp (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -14,6 +14,7 @@ <h2 title="Classes">Classes</h2> <ul title="Classes"> <li><a href="IotpDevice.html" title="class in org.apache.edgent.connectors.iotp" target="classFrame">IotpDevice</a></li> +<li><a href="IotpGateway.html" title="class in org.apache.edgent.connectors.iotp" target="classFrame">IotpGateway</a></li> </ul> </div> </body> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-summary.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-summary.html b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-summary.html index ad94e65..899b296 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-summary.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-summary.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:51 KST 2016 --> -<title>org.apache.edgent.connectors.iotp (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.iotp (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.edgent.connectors.iotp (Edgent v1.0.0)"; + parent.document.title="org.apache.edgent.connectors.iotp (Edgent v1.1.0)"; } } catch(err) { @@ -89,7 +89,13 @@ <tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html" title="class in org.apache.edgent.connectors.iotp">IotpDevice</a></td> <td class="colLast"> -<div class="block">Connector for IBM Watson IoT Platform.</div> +<div class="block">A Device Connector to IBM Watson IoT Platform (WIoTP).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp">IotpGateway</a></td> +<td class="colLast"> +<div class="block">An IoT Gateway Device Connector to IBM Watson IoT Platform (WIoTP).</div> </td> </tr> </tbody> @@ -152,6 +158,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-tree.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-tree.html b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-tree.html index 8211ede..8b54dfc 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-tree.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-tree.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:51 KST 2016 --> -<title>org.apache.edgent.connectors.iotp Class Hierarchy (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>org.apache.edgent.connectors.iotp Class Hierarchy (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="org.apache.edgent.connectors.iotp Class Hierarchy (Edgent v1.0.0)"; + parent.document.title="org.apache.edgent.connectors.iotp Class Hierarchy (Edgent v1.1.0)"; } } catch(err) { @@ -82,6 +82,7 @@ <li type="circle">java.lang.Object <ul> <li type="circle">org.apache.edgent.connectors.iotp.<a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html" title="class in org.apache.edgent.connectors.iotp"><span class="typeNameLink">IotpDevice</span></a> (implements org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>)</li> +<li type="circle">org.apache.edgent.connectors.iotp.<a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp"><span class="typeNameLink">IotpGateway</span></a> (implements org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">IotGateway</a>)</li> </ul> </li> </ul> @@ -134,6 +135,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-use.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-use.html b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-use.html index 418f2a6..6b8ea11 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-use.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/iotp/package-use.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Package org.apache.edgent.connectors.iotp (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:13 EST 2017 --> +<title>Uses of Package org.apache.edgent.connectors.iotp (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.apache.edgent.connectors.iotp (Edgent v1.0.0)"; + parent.document.title="Uses of Package org.apache.edgent.connectors.iotp (Edgent v1.1.0)"; } } catch(err) { @@ -102,7 +102,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iotp/class-use/IotpDevice.html#org.apache.edgent.connectors.iotp">IotpDevice</a> -<div class="block">Connector for IBM Watson IoT Platform.</div> +<div class="block">A Device Connector to IBM Watson IoT Platform (WIoTP).</div> </td> </tr> </tbody> @@ -158,6 +158,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/4db39ee8/site/javadoc/latest/org/apache/edgent/connectors/jdbc/CheckedFunction.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/connectors/jdbc/CheckedFunction.html b/site/javadoc/latest/org/apache/edgent/connectors/jdbc/CheckedFunction.html index 4acb889..b2a82df 100644 --- a/site/javadoc/latest/org/apache/edgent/connectors/jdbc/CheckedFunction.html +++ b/site/javadoc/latest/org/apache/edgent/connectors/jdbc/CheckedFunction.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:51 KST 2016 --> -<title>CheckedFunction (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:11 EST 2017 --> +<title>CheckedFunction (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CheckedFunction (Edgent v1.0.0)"; + parent.document.title="CheckedFunction (Edgent v1.1.0)"; } } catch(err) { @@ -243,6 +243,6 @@ public interface <span class="typeNameLabel">CheckedFunction<T,R></span></ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html>
