Google Git
Sign in
apache / incubator-retired-edgent-website / 9f47ca2fac6c40ebcb370c7ed57de1dc33f80013 / . / site / javadoc / lastest / quarks / connectors / iot / class-use / IotDevice.html
blob: 1e54965b3706fd8fc629a7cbb1ddcd27be389004 [file] [log] [blame]
<!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_71) on Tue May 17 00:28:47 UTC 2016 -->
<title>Uses of Interface quarks.connectors.iot.IotDevice (Quarks v0.4.0)</title>
<meta name="date" content="2016-05-17">
<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 quarks.connectors.iot.IotDevice (Quarks v0.4.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="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?quarks/connectors/iot/class-use/IotDevice.html" target="_top">Frames</a></li>
<li><a href="IotDevice.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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 quarks.connectors.iot.IotDevice" class="title">Uses of Interface<br>quarks.connectors.iot.IotDevice</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="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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="#quarks.apps.iot">quarks.apps.iot</a></td>
<td class="colLast">
<div class="block">Applications for use in an Internet of Things environment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#quarks.connectors.iotf">quarks.connectors.iotf</a></td>
<td class="colLast">
<div class="block">IBM Watson IoT Platform stream connector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#quarks.connectors.mqtt.iot">quarks.connectors.mqtt.iot</a></td>
<td class="colLast">
<div class="block">An MQTT based IotDevice connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#quarks.providers.iot">quarks.providers.iot</a></td>
<td class="colLast">
<div class="block">Iot provider that allows multiple applications to
share an <code>IotDevice</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#quarks.samples.connectors.iotf">quarks.samples.connectors.iotf</a></td>
<td class="colLast">
<div class="block">Samples showing device events and commands with IBM Watson IoT Platform.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#quarks.test.svt.apps.iotf">quarks.test.svt.apps.iotf</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="quarks.apps.iot">
<!-- -->
</a>
<h3>Uses of <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a> in <a href="../../../../quarks/apps/iot/package-summary.html">quarks.apps.iot</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../quarks/apps/iot/package-summary.html">quarks.apps.iot</a> that return <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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>static <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></code></td>
<td class="colLast"><span class="typeNameLabel">IotDevicePubSub.</span><code><span class="memberNameLink"><a href="../../../../quarks/apps/iot/IotDevicePubSub.html#addIotDevice-quarks.topology.TopologyElement-">addIotDevice</a></span>(<a href="../../../../quarks/topology/TopologyElement.html" title="interface in quarks.topology">TopologyElement</a>&nbsp;te)</code>
<div class="block">Add a proxy <code>IotDevice</code> for the topology containing <code>te</code>.</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="../../../../quarks/apps/iot/package-summary.html">quarks.apps.iot</a> with parameters of type <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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>static void</code></td>
<td class="colLast"><span class="typeNameLabel">IotDevicePubSub.</span><code><span class="memberNameLink"><a href="../../../../quarks/apps/iot/IotDevicePubSub.html#createApplication-quarks.connectors.iot.IotDevice-">createApplication</a></span>(<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>&nbsp;device)</code>
<div class="block">Create an instance of this application using <code>device</code> as the device
connection to a message hub.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="quarks.connectors.iotf">
<!-- -->
</a>
<h3>Uses of <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a> in <a href="../../../../quarks/connectors/iotf/package-summary.html">quarks.connectors.iotf</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="../../../../quarks/connectors/iotf/package-summary.html">quarks.connectors.iotf</a> that implement <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/connectors/iotf/IotfDevice.html" title="class in quarks.connectors.iotf">IotfDevice</a></span></code>
<div class="block">Connector for IBM Watson IoT Platform.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="quarks.connectors.mqtt.iot">
<!-- -->
</a>
<h3>Uses of <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a> in <a href="../../../../quarks/connectors/mqtt/iot/package-summary.html">quarks.connectors.mqtt.iot</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="../../../../quarks/connectors/mqtt/iot/package-summary.html">quarks.connectors.mqtt.iot</a> that implement <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/connectors/mqtt/iot/MqttDevice.html" title="class in quarks.connectors.mqtt.iot">MqttDevice</a></span></code>
<div class="block">An MQTT based Quarks <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot"><code>IotDevice</code></a> connector.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="quarks.providers.iot">
<!-- -->
</a>
<h3>Uses of <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a> in <a href="../../../../quarks/providers/iot/package-summary.html">quarks.providers.iot</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../quarks/providers/iot/package-summary.html">quarks.providers.iot</a> that return <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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>protected <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></code></td>
<td class="colLast"><span class="typeNameLabel">IotProvider.</span><code><span class="memberNameLink"><a href="../../../../quarks/providers/iot/IotProvider.html#createMessageHubDevice-quarks.topology.Topology-">createMessageHubDevice</a></span>(<a href="../../../../quarks/topology/Topology.html" title="interface in quarks.topology">Topology</a>&nbsp;topology)</code>
<div class="block">Create the connection to the message hub.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Method parameters in <a href="../../../../quarks/providers/iot/package-summary.html">quarks.providers.iot</a> with type arguments of type <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><span class="typeNameLabel">IotProvider.</span><code><span class="memberNameLink"><a href="../../../../quarks/providers/iot/IotProvider.html#registerTopology-java.lang.String-quarks.function.BiConsumer-">registerTopology</a></span>(java.lang.String&nbsp;applicationName,
<a href="../../../../quarks/function/BiConsumer.html" title="interface in quarks.function">BiConsumer</a>&lt;<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>,com.google.gson.JsonObject&gt;&nbsp;builder)</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">
<caption><span>Constructor parameters in <a href="../../../../quarks/providers/iot/package-summary.html">quarks.providers.iot</a> with type arguments of type <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/providers/iot/IotProvider.html#IotProvider-quarks.providers.direct.DirectProvider-quarks.function.Function-">IotProvider</a></span>(<a href="../../../../quarks/providers/direct/DirectProvider.html" title="class in quarks.providers.direct">DirectProvider</a>&nbsp;provider,
<a href="../../../../quarks/function/Function.html" title="interface in quarks.function">Function</a>&lt;<a href="../../../../quarks/topology/Topology.html" title="interface in quarks.topology">Topology</a>,<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>&gt;&nbsp;iotDeviceCreator)</code>
<div class="block">Create an <code>IotProvider</code> that uses the passed in <code>DirectProvider</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/providers/iot/IotProvider.html#IotProvider-quarks.function.Function-">IotProvider</a></span>(<a href="../../../../quarks/function/Function.html" title="interface in quarks.function">Function</a>&lt;<a href="../../../../quarks/topology/Topology.html" title="interface in quarks.topology">Topology</a>,<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>&gt;&nbsp;iotDeviceCreator)</code>
<div class="block">Create an <code>IotProvider</code> that uses its own <code>DirectProvider</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../quarks/providers/iot/IotProvider.html#IotProvider-quarks.topology.TopologyProvider-quarks.execution.DirectSubmitter-quarks.function.Function-">IotProvider</a></span>(<a href="../../../../quarks/topology/TopologyProvider.html" title="interface in quarks.topology">TopologyProvider</a>&nbsp;provider,
<a href="../../../../quarks/execution/DirectSubmitter.html" title="interface in quarks.execution">DirectSubmitter</a>&lt;<a href="../../../../quarks/topology/Topology.html" title="interface in quarks.topology">Topology</a>,<a href="../../../../quarks/execution/Job.html" title="interface in quarks.execution">Job</a>&gt;&nbsp;submitter,
<a href="../../../../quarks/function/Function.html" title="interface in quarks.function">Function</a>&lt;<a href="../../../../quarks/topology/Topology.html" title="interface in quarks.topology">Topology</a>,<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>&gt;&nbsp;iotDeviceCreator)</code>
<div class="block">Create an <code>IotProvider</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="quarks.samples.connectors.iotf">
<!-- -->
</a>
<h3>Uses of <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a> in <a href="../../../../quarks/samples/connectors/iotf/package-summary.html">quarks.samples.connectors.iotf</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../quarks/samples/connectors/iotf/package-summary.html">quarks.samples.connectors.iotf</a> with parameters of type <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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>static <a href="../../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a>&lt;java.lang.String&gt;</code></td>
<td class="colLast"><span class="typeNameLabel">IotfSensors.</span><code><span class="memberNameLink"><a href="../../../../quarks/samples/connectors/iotf/IotfSensors.html#displayMessages-quarks.connectors.iot.IotDevice-boolean-">displayMessages</a></span>(<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>&nbsp;device,
boolean&nbsp;print)</code>
<div class="block">Subscribe to IoTF device commands with identifier <code>display</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">IotfSensors.</span><code><span class="memberNameLink"><a href="../../../../quarks/samples/connectors/iotf/IotfSensors.html#heartBeat-quarks.connectors.iot.IotDevice-boolean-">heartBeat</a></span>(<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>&nbsp;device,
boolean&nbsp;print)</code>
<div class="block">Create a heart beat device event with
identifier <code>heartbeat</code> to
ensure there is some immediate output and
the connection to IoTF happens as soon as possible.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><span class="typeNameLabel">IotfSensors.</span><code><span class="memberNameLink"><a href="../../../../quarks/samples/connectors/iotf/IotfSensors.html#simulatedSensors-quarks.connectors.iot.IotDevice-boolean-">simulatedSensors</a></span>(<a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a>&nbsp;device,
boolean&nbsp;print)</code>
<div class="block">Simulate two bursty sensors and send the readings as IoTF device events
with an identifier of <code>sensors</code>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="quarks.test.svt.apps.iotf">
<!-- -->
</a>
<h3>Uses of <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a> in <a href="../../../../quarks/test/svt/apps/iotf/package-summary.html">quarks.test.svt.apps.iotf</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../quarks/test/svt/apps/iotf/package-summary.html">quarks.test.svt.apps.iotf</a> that return <a href="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></span><span class="tabEnd">&nbsp;</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="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">IotDevice</a></code></td>
<td class="colLast"><span class="typeNameLabel">AbstractIotfApplication.</span><code><span class="memberNameLink"><a href="../../../../quarks/test/svt/apps/iotf/AbstractIotfApplication.html#iotDevice--">iotDevice</a></span>()</code>
<div class="block">Get the application's IotfDevice</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="../../../../quarks/connectors/iot/IotDevice.html" title="interface in quarks.connectors.iot">Class</a></li>
<li class="navBarCell1Rev">Use</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://quarks.incubator.apache.org">Apache Quarks (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?quarks/connectors/iot/class-use/IotDevice.html" target="_top">Frames</a></li>
<li><a href="IotDevice.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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 &copy; 2016 The Apache Software Foundation. All Rights Reserved - d6cdfc6-20160517-0028</small></p>
</body>
</html>