http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html index aff002b..559c040 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/IotDevice.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/IotGateway.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/IotGateway.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/IotGateway.html new file mode 100644 index 0000000..e86b742 --- /dev/null +++ b/content/javadoc/latest/org/apache/edgent/connectors/iot/IotGateway.html @@ -0,0 +1,552 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 --> +<title>IotGateway (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> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="IotGateway (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/IotGateway.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</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/QoS.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/IotGateway.html" target="_top">Frames</a></li> +<li><a href="IotGateway.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.edgent.connectors.iot</div> +<h2 title="Interface IotGateway" class="title">Interface IotGateway</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>, <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp">IotpGateway</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">IotGateway</span> +extends <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></pre> +<div class="block">A generic IoT gateway device IoT hub connector. + <p> + <b>This interface is incubating and is subject to change.</b> + <p> + An IoT gateway device is a conduit for a collection of IoT devices + that lack direct connection to the enterprise IoT hub. + <p> + An IoT gateway device is an IoT device. Events can be published + that are from the gateway's deviceId and commands can be received that are targeted for it + using the gateway's <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-"><code>events()</code></a> + and <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#commands-java.lang.String...-"><code>commands()</code></a>. + <p> + Use <a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html#getIotDevice-java.util.Map-"><code>getIotDevice(Map)</code></a> to get an <code>IotDevice</code> for a gateway connected device + or <a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html#getIotDeviceId-java.util.Map-"><code>getIotDeviceId(Map)</code></a> to get a deviceId for it. + The name/value pairs in the map are IotGateway implementation defined values. + Refer to the IotGateway implementation for details. + <p> + Events can be published that are from a connected device's deviceId and commands can be + received for that are targeted for it using + <a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html#eventsForDevice-java.lang.String-org.apache.edgent.topology.TStream-java.lang.String-int-"><code>eventsForDevice()</code></a> + and <a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html#commandsForDevice-java.util.Set-java.lang.String...-"><code>commandsForDevice()</code></a>.</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/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><code>IotDevice</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.edgent.connectors.iot.IotDevice"> +<!-- --> +</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_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> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html#commandsForDevice-java.util.Set-java.lang.String...-">commandsForDevice</a></span>(java.util.Set<java.lang.String> deviceIds, + java.lang.String... commands)</code> +<div class="block">Create a stream of device commands as JSON objects.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html#commandsForDevice-java.lang.String-java.lang.String...-">commandsForDevice</a></span>(java.lang.String deviceId, + java.lang.String... commands)</code> +<div class="block">Create a stream of device commands as JSON objects.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iot/IotGateway.html#commandsForType-java.lang.String-java.lang.String...-">commandsForType</a></span>(java.lang.String deviceTypeId, + java.lang.String... commands)</code> +<div class="block">Create a stream of device commands as JSON objects.</div> +</td> +</tr> +<tr id="i3" 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/iot/IotGateway.html#eventsForDevice-org.apache.edgent.function.Function-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-">eventsForDevice</a></span>(<a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.String> deviceId, + <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, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.Integer> qos)</code> +<div class="block">Publish a stream's tuples as device events.</div> +</td> +</tr> +<tr id="i4" 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/iot/IotGateway.html#eventsForDevice-java.lang.String-org.apache.edgent.topology.TStream-java.lang.String-int-">eventsForDevice</a></span>(java.lang.String deviceId, + <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, + int qos)</code> +<div class="block">Publish a stream's tuples as device events.</div> +</td> +</tr> +<tr id="i5" 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"><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 id="i6" 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"><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> +<tr id="i7" 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/IotGateway.html#getIotDeviceId-java.util.Map-">getIotDeviceId</a></span>(java.util.Map<java.lang.String,java.lang.String> deviceIdAttrs)</code> +<div class="block">Get a <code>deviceId</code> for a device.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.connectors.iot.IotDevice"> +<!-- --> +</a> +<h3>Methods 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#commands-java.lang.String...-">commands</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-">events</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-">events</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--">getDeviceId</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceType--">getDeviceType</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.TopologyElement"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.edgent.topology.<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></h3> +<code><a href="../../../../../org/apache/edgent/topology/TopologyElement.html#topology--">topology</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getIotDevice-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIotDevice</h4> +<pre><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a> getIotDevice(java.util.Map<java.lang.String,java.lang.String> deviceIdAttrs)</pre> +<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. + No external validation of the attribute values is performed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceIdAttrs</code> - IotGateway implementation specific attributes + that identify a device.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>IotDevice</dd> +</dl> +</li> +</ul> +<a name="getIotDeviceId-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIotDeviceId</h4> +<pre>java.lang.String getIotDeviceId(java.util.Map<java.lang.String,java.lang.String> deviceIdAttrs)</pre> +<div class="block">Get a <code>deviceId</code> for a device. + Logically equivalent to <code>getIotDevice(deviceIdAttrs).getDeviceId()</code>. + No external validation of the attribute values is performed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceIdAttrs</code> - IotGateway implementation specific attributes + that identify a device.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>deviceId</dd> +</dl> +</li> +</ul> +<a name="getIotDevice-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIotDevice</h4> +<pre><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a> getIotDevice(java.lang.String deviceId)</pre> +<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> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceId</code> - a value from <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--"><code>IotDevice.getDeviceId()</code></a>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>IotDevice</dd> +</dl> +</li> +</ul> +<a name="eventsForDevice-org.apache.edgent.function.Function-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>eventsForDevice</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> eventsForDevice(<a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.String> deviceId, + <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, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.Integer> qos)</pre> +<div class="block">Publish a stream's tuples as device events. + Each tuple is published as a device event with the supplied functions + providing the device identifier, event identifier, payload and QoS. + The values can be generated based upon the tuple. + <p> + Events for a particular device can also be published via its + <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-"><code>IotDevice.events()</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceId</code> - function to supply the device-id that the event is associated with.</dd> +<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> +<dd><code>qos</code> - function to supply the event's delivery Quality of Service.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>TSink sink element representing termination of this stream.</dd> +</dl> +</li> +</ul> +<a name="eventsForDevice-java.lang.String-org.apache.edgent.topology.TStream-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>eventsForDevice</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> eventsForDevice(java.lang.String deviceId, + <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, + int qos)</pre> +<div class="block">Publish a stream's tuples as device events. + Each tuple is published as a device event with the supplied + device identifier, event identifier and QoS. + <p> + Events for a particular device can also be published via its + <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-"><code>IotDevice.event()</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceId</code> - Device-id that the event is associated with.</dd> +<dd><code>stream</code> - Stream to be published.</dd> +<dd><code>eventId</code> - Event identifier.</dd> +<dd><code>qos</code> - Event's delivery Quality of Service.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>TSink sink element representing termination of this stream.</dd> +</dl> +</li> +</ul> +<a name="commandsForDevice-java.util.Set-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commandsForDevice</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> commandsForDevice(java.util.Set<java.lang.String> deviceIds, + java.lang.String... commands)</pre> +<div class="block">Create a stream of device commands as JSON objects. + Each command sent to one of the specified <code>deviceIds</code> 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> + <LI><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD"><code>payload</code></a> - Payload of the command + <UL> + <LI>If <code>format</code> is <code>json</code> then <code>payload</code> is JSON</LI> + <LI>Otherwise <code>payload</code> is String</LI> + </UL> + </LI> + </UL> + + Logically equivalent to a union of a collection of individual IotDevice specific + command streams but enables an IotGateway implementation to implement it more efficiently.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceIds</code> - Filter to include commands for the specified deviceIds + If the set is empty no filtering occurs. The commands for any device are included.</dd> +<dd><code>commands</code> - Command identifiers to include. If no command identifiers are provided then the + stream will contain all device commands for the specified devices.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream containing device commands.</dd> +</dl> +</li> +</ul> +<a name="commandsForDevice-java.lang.String-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commandsForDevice</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> commandsForDevice(java.lang.String deviceId, + java.lang.String... commands)</pre> +<div class="block">Create a stream of device commands as JSON objects. + Each command sent to the specified <code>deviceId</code> 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 target device's opaque 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> + <LI><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD"><code>payload</code></a> - Payload of the command + <UL> + <LI>If <code>format</code> is <code>json</code> then <code>payload</code> is JSON</LI> + <LI>Otherwise <code>payload</code> is String</LI> + </UL> + </LI> + </UL> + <P> + Equivalent to <code>commandsForDevice(Collections.singleton(deviceId)), ...</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceId</code> - Filter to include commands for the specified deviceId</dd> +<dd><code>commands</code> - Command identifiers to include. If no command identifiers are provided then the + stream will contain all device commands for the specified device.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream containing device commands.</dd> +</dl> +</li> +</ul> +<a name="commandsForType-java.lang.String-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>commandsForType</h4> +<pre><a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> commandsForType(java.lang.String deviceTypeId, + java.lang.String... commands)</pre> +<div class="block">Create a stream of device commands as JSON objects. + Each command sent to connected devices of type <code>deviceTypeId</code> 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 target device's opaque 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> + <LI><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD"><code>payload</code></a> - Payload of the command + <UL> + <LI>If <code>format</code> is <code>json</code> then <code>payload</code> is JSON</LI> + <LI>Otherwise <code>payload</code> is String</LI> + </UL> + </LI> + </UL> + <P> + An IoT connector implementation may throw + <code>UnsupportedOperationException</code> + if it does not support this capability. See the implementation's documentation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deviceTypeId</code> - Only return commands for connected devices with the specified + device type id value (a value from <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceType--"><code>IotDevice.getDeviceType()</code></a>).</dd> +<dd><code>commands</code> - Command identifiers to include. If no command identifiers are provided then the + stream will contain all device commands for devices with the specified device type id.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Stream containing device commands.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/IotGateway.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</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/QoS.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/IotGateway.html" target="_top">Frames</a></li> +<li><a href="IotGateway.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html index 1430e22..682978f 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/QoS.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html index b49e989..83c97cf 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Commands.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html index 8bd182b..948a515 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/Events.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html index f203fae..94d8ffe 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/HeartBeat.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html index 960a841..09cde5a 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotDevice.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotGateway.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotGateway.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotGateway.html new file mode 100644 index 0000000..f63bb43 --- /dev/null +++ b/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/IotGateway.html @@ -0,0 +1,170 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- 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.IotGateway (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> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Interface org.apache.edgent.connectors.iot.IotGateway (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/iot/class-use/IotGateway.html" target="_top">Frames</a></li> +<li><a href="IotGateway.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface org.apache.edgent.connectors.iot.IotGateway" class="title">Uses of Interface<br>org.apache.edgent.connectors.iot.IotGateway</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">IotGateway</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.edgent.connectors.iotp">org.apache.edgent.connectors.iotp</a></td> +<td class="colLast"> +<div class="block">IBM Watson IoT Platform stream connector.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.edgent.connectors.iotp"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">IotGateway</a> in <a href="../../../../../../org/apache/edgent/connectors/iotp/package-summary.html">org.apache.edgent.connectors.iotp</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../../org/apache/edgent/connectors/iotp/package-summary.html">org.apache.edgent.connectors.iotp</a> that implement <a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">IotGateway</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<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> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/edgent/connectors/iot/IotGateway.html" title="interface in org.apache.edgent.connectors.iot">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../overview-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/edgent/connectors/iot/class-use/IotGateway.html" target="_top">Frames</a></li> +<li><a href="IotGateway.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html index 09337ef..d68cb81 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/class-use/QoS.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html index 2e51d6c..fb86354 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-frame.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html index cbfc39e..f4ebcb6 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-summary.html +++ b/content/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/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html index 986f0fc..c6d3056 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-tree.html +++ b/content/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>
