node-poweredup/docs/PoweredUP.html
Nathan Kellenicki 60a42dfc47
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
New build with PRs
2024-04-25 17:10:39 -07:00

4371 lines
48 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: PoweredUP</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: PoweredUP</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>PoweredUP<span class="signature">()</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="PoweredUP"><span class="type-signature"></span>new PoweredUP<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>EventEmitter</li>
</ul>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getHubByPrimaryMACAddress"><span class="type-signature"></span>getHubByPrimaryMACAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by primary MAC address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
</dd>
</dl>
<h4 class="name" id="getHubByPrimaryMACAddress"><span class="type-signature"></span>getHubByPrimaryMACAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by primary MAC address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
</dd>
</dl>
<h4 class="name" id="getHubByUUID"><span class="type-signature"></span>getHubByUUID<span class="signature">(uuid)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>|null}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by UUID.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="getHubByUUID"><span class="type-signature"></span>getHubByUUID<span class="signature">(uuid)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>|null}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by UUID.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line110">line 110</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="getHubs"><span class="type-signature"></span>getHubs<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hubs.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubs"><span class="type-signature"></span>getHubs<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hubs.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line102">line 102</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByName"><span class="type-signature"></span>getHubsByName<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by name.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line110">line 110</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByName"><span class="type-signature"></span>getHubsByName<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by name.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line128">line 128</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByType"><span class="type-signature"></span>getHubsByType<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by type.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByType"><span class="type-signature"></span>getHubsByType<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by type.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line137">line 137</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="scan"><span class="type-signature"></span>scan<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Begin scanning for Powered UP Hub devices.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="scan"><span class="type-signature"></span>scan<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Begin scanning for Powered UP Hub devices.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Stop scanning for Powered UP Hub devices.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Events</h3>
<h4 class="name" id="event:discover">discover</h4>
<div class="description">
<p>Emits when a Powered UP Hub device is found.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hub</code></td>
<td class="type">
<span class="param-type"><a href="WeDo2SmartHub.html">WeDo2SmartHub</a></span>
|
<span class="param-type"><a href="MoveHub.html">MoveHub</a></span>
|
<span class="param-type"><a href="TechnicMediumHub.html">TechnicMediumHub</a></span>
|
<span class="param-type"><a href="RemoteControl.html">RemoteControl</a></span>
|
<span class="param-type"><a href="DuploTrainBase.html">DuploTrainBase</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line232">line 232</a>
</li></ul></dd>
</dl>
<h4 class="name" id="event:discover">discover</h4>
<div class="description">
<p>Emits when a Powered UP Hub device is found.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hub</code></td>
<td class="type">
<span class="param-type"><a href="WeDo2SmartHub.html">WeDo2SmartHub</a></span>
|
<span class="param-type"><a href="MoveHub.html">MoveHub</a></span>
|
<span class="param-type"><a href="TechnicMediumHub.html">TechnicMediumHub</a></span>
|
<span class="param-type"><a href="RemoteControl.html">RemoteControl</a></span>
|
<span class="param-type"><a href="DuploTrainBase.html">DuploTrainBase</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
</article>
</section>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>PoweredUP<span class="signature">()</span><span class="type-signature"></span></h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="PoweredUP"><span class="type-signature"></span>new PoweredUP<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>EventEmitter</li>
</ul>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getHubByPrimaryMACAddress"><span class="type-signature"></span>getHubByPrimaryMACAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by primary MAC address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
</dd>
</dl>
<h4 class="name" id="getHubByPrimaryMACAddress"><span class="type-signature"></span>getHubByPrimaryMACAddress<span class="signature">(address)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by primary MAC address.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
</dd>
</dl>
<h4 class="name" id="getHubByUUID"><span class="type-signature"></span>getHubByUUID<span class="signature">(uuid)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>|null}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by UUID.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="getHubByUUID"><span class="type-signature"></span>getHubByUUID<span class="signature">(uuid)</span><span class="type-signature"> &rarr; {<a href="BaseHub.html">BaseHub</a>|null}</span></h4>
<div class="description">
<p>Retrieve a Powered UP Hub by UUID.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line110">line 110</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="BaseHub.html">BaseHub</a></span>
|
<span class="param-type">null</span>
</dd>
</dl>
<h4 class="name" id="getHubs"><span class="type-signature"></span>getHubs<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hubs.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubs"><span class="type-signature"></span>getHubs<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hubs.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line102">line 102</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByName"><span class="type-signature"></span>getHubsByName<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by name.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line110">line 110</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByName"><span class="type-signature"></span>getHubsByName<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by name.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line128">line 128</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByType"><span class="type-signature"></span>getHubsByType<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by type.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line119">line 119</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="getHubsByType"><span class="type-signature"></span>getHubsByType<span class="signature">(name)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="BaseHub.html">BaseHub</a>>}</span></h4>
<div class="description">
<p>Retrieve a list of Powered UP Hub by type.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line137">line 137</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="BaseHub.html">BaseHub</a>></span>
</dd>
</dl>
<h4 class="name" id="scan"><span class="type-signature"></span>scan<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Begin scanning for Powered UP Hub devices.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="scan"><span class="type-signature"></span>scan<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Begin scanning for Powered UP Hub devices.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<h4 class="name" id="stop"><span class="type-signature"></span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Stop scanning for Powered UP Hub devices.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Events</h3>
<h4 class="name" id="event:discover">discover</h4>
<div class="description">
<p>Emits when a Powered UP Hub device is found.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hub</code></td>
<td class="type">
<span class="param-type"><a href="WeDo2SmartHub.html">WeDo2SmartHub</a></span>
|
<span class="param-type"><a href="MoveHub.html">MoveHub</a></span>
|
<span class="param-type"><a href="TechnicMediumHub.html">TechnicMediumHub</a></span>
|
<span class="param-type"><a href="RemoteControl.html">RemoteControl</a></span>
|
<span class="param-type"><a href="DuploTrainBase.html">DuploTrainBase</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-browser.js.html">poweredup-browser.js</a>, <a href="poweredup-browser.js.html#line232">line 232</a>
</li></ul></dd>
</dl>
<h4 class="name" id="event:discover">discover</h4>
<div class="description">
<p>Emits when a Powered UP Hub device is found.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hub</code></td>
<td class="type">
<span class="param-type"><a href="WeDo2SmartHub.html">WeDo2SmartHub</a></span>
|
<span class="param-type"><a href="MoveHub.html">MoveHub</a></span>
|
<span class="param-type"><a href="TechnicMediumHub.html">TechnicMediumHub</a></span>
|
<span class="param-type"><a href="RemoteControl.html">RemoteControl</a></span>
|
<span class="param-type"><a href="DuploTrainBase.html">DuploTrainBase</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="poweredup-node.js.html">poweredup-node.js</a>, <a href="poweredup-node.js.html#line190">line 190</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbsoluteMotor.html">AbsoluteMotor</a></li><li><a href="BaseHub.html">BaseHub</a></li><li><a href="BasicMotor.html">BasicMotor</a></li><li><a href="ColorDistanceSensor.html">ColorDistanceSensor</a></li><li><a href="CurrentSensor.html">CurrentSensor</a></li><li><a href="Device.html">Device</a></li><li><a href="DuploTrainBase.html">DuploTrainBase</a></li><li><a href="DuploTrainBaseColorSensor.html">DuploTrainBaseColorSensor</a></li><li><a href="DuploTrainBaseMotor.html">DuploTrainBaseMotor</a></li><li><a href="DuploTrainBaseSpeaker.html">DuploTrainBaseSpeaker</a></li><li><a href="DuploTraniBaseSpeedometer.html">DuploTraniBaseSpeedometer</a></li><li><a href="Hub.html">Hub</a></li><li><a href="HubLED.html">HubLED</a></li><li><a href="LPF2Hub.html">LPF2Hub</a></li><li><a href="Light.html">Light</a></li><li><a href="Mario.html">Mario</a></li><li><a href="MarioAccelerometer.html">MarioAccelerometer</a></li><li><a href="MarioBarcodeSensor.html">MarioBarcodeSensor</a></li><li><a href="MarioPantsSensor.html">MarioPantsSensor</a></li><li><a href="MediumLinearMotor.html">MediumLinearMotor</a></li><li><a href="MotionSensor.html">MotionSensor</a></li><li><a href="MoveHub.html">MoveHub</a></li><li><a href="MoveHubMediumLinearMotor.html">MoveHubMediumLinearMotor</a></li><li><a href="MoveHubTiltSensor.html">MoveHubTiltSensor</a></li><li><a href="PiezoBuzzer.html">PiezoBuzzer</a></li><li><a href="PoweredUP.html">PoweredUP</a></li><li><a href="RemoteControl.html">RemoteControl</a></li><li><a href="RemoteControlButton.html">RemoteControlButton</a></li><li><a href="SimpleMediumLinearMotor.html">SimpleMediumLinearMotor</a></li><li><a href="TachoMotor.html">TachoMotor</a></li><li><a href="Technic3x3ColorLightMatrix.html">Technic3x3ColorLightMatrix</a></li><li><a href="TechnicColorSensor.html">TechnicColorSensor</a></li><li><a href="TechnicDistanceSensor.html">TechnicDistanceSensor</a></li><li><a href="TechnicForceSensor.html">TechnicForceSensor</a></li><li><a href="TechnicLargeAngularMotor.html">TechnicLargeAngularMotor</a></li><li><a href="TechnicLargeLinearMotor.html">TechnicLargeLinearMotor</a></li><li><a href="TechnicMediumAngularMotor.html">TechnicMediumAngularMotor</a></li><li><a href="TechnicMediumHub.html">TechnicMediumHub</a></li><li><a href="TechnicMediumHubAccelerometerSensor.html">TechnicMediumHubAccelerometerSensor</a></li><li><a href="TechnicMediumHubGyroSensor.html">TechnicMediumHubGyroSensor</a></li><li><a href="TechnicMediumHubTiltSensor.html">TechnicMediumHubTiltSensor</a></li><li><a href="TechnicSmallAngularMotor.html">TechnicSmallAngularMotor</a></li><li><a href="TechnicXLargeLinearMotor.html">TechnicXLargeLinearMotor</a></li><li><a href="TiltSensor.html">TiltSensor</a></li><li><a href="TrainMotor.html">TrainMotor</a></li><li><a href="VoltageSensor.html">VoltageSensor</a></li><li><a href="WeDo2SmartHub.html">WeDo2SmartHub</a></li></ul><h3>Events</h3><ul><li><a href="AbsoluteMotor.html#event:absolute">absolute</a></li><li><a href="AbsoluteMotor.html#event:rotate">rotate</a></li><li><a href="ColorDistanceSensor.html#event:ambient">ambient</a></li><li><a href="ColorDistanceSensor.html#event:color">color</a></li><li><a href="ColorDistanceSensor.html#event:colorAndDistance">colorAndDistance</a></li><li><a href="ColorDistanceSensor.html#event:distance">distance</a></li><li><a href="ColorDistanceSensor.html#event:distanceCount">distanceCount</a></li><li><a href="ColorDistanceSensor.html#event:reflect">reflect</a></li><li><a href="ColorDistanceSensor.html#event:rgbIntensity">rgbIntensity</a></li><li><a href="CurrentSensor.html#event:current">current</a></li><li><a href="DuploTrainBase.html#event:button">button</a></li><li><a href="DuploTrainBaseColorSensor.html#event:color">color</a></li><li><a href="DuploTrainBaseColorSensor.html#event:intensity">intensity</a></li><li><a href="DuploTrainBaseColorSensor.html#event:reflect">reflect</a></li><li><a href="DuploTrainBaseColorSensor.html#event:rgb">rgb</a></li><li><a href="DuploTrainBaseSpeedometer.html#event:speed">speed</a></li><li><a href="Hub.html#event:attach">attach</a></li><li><a href="Hub.html#event:button">button</a></li><li><a href="Hub.html#event:detach">detach</a></li><li><a href="Hub.html#event:disconnect">disconnect</a></li><li><a href="LPF2Hub.html#event:button">button</a></li><li><a href="Mario.html#event:button">button</a></li><li><a href="MarioAccelerometer.html#event:accel">accel</a></li><li><a href="MarioAccelerometer.html#event:gest">gest</a></li><li><a href="MarioBarcodeSensor.html#event:barcode">barcode</a></li><li><a href="MarioBarcodeSensor.html#event:rgb">rgb</a></li><li><a href="MarioPantsSensor.html#event:pants">pants</a></li><li><a href="MediumLinearMotor.html#event:rotate">rotate</a></li><li><a href="MotionSensor.html#event:distance">distance</a></li><li><a href="MoveHub.html#event:button">button</a></li><li><a href="MoveHubMediumLinearMotor.html#event:rotate">rotate</a></li><li><a href="MoveHubTiltSensor.html#event:tilt">tilt</a></li><li><a href="PoweredUP.html#event:discover">discover</a></li><li><a href="RemoteControl.html#event:button">button</a></li><li><a href="RemoteControlButton.html#event:remoteButton">remoteButton</a></li><li><a href="TachoMotor.html#event:rotate">rotate</a></li><li><a href="TechnicColorSensor.html#event:ambient">ambient</a></li><li><a href="TechnicColorSensor.html#event:color">color</a></li><li><a href="TechnicColorSensor.html#event:reflect">reflect</a></li><li><a href="TechnicDistanceSensor.html#event:distance">distance</a></li><li><a href="TechnicDistanceSensor.html#event:fastDistance">fastDistance</a></li><li><a href="TechnicForceSensor.html#event:force">force</a></li><li><a href="TechnicForceSensor.html#event:tapped">tapped</a></li><li><a href="TechnicForceSensor.html#event:touch">touch</a></li><li><a href="TechnicLargeAngularMotor.html#event:absolute">absolute</a></li><li><a href="TechnicLargeAngularMotor.html#event:rotate">rotate</a></li><li><a href="TechnicLargeLinearMotor.html#event:absolute">absolute</a></li><li><a href="TechnicLargeLinearMotor.html#event:rotate">rotate</a></li><li><a href="TechnicMediumAngularMotor.html#event:absolute">absolute</a></li><li><a href="TechnicMediumAngularMotor.html#event:rotate">rotate</a></li><li><a href="TechnicMediumHub.html#event:button">button</a></li><li><a href="TechnicMediumHubAccelerometerSensor.html#event:accel">accel</a></li><li><a href="TechnicMediumHubGyroSensor.html#event:gyro">gyro</a></li><li><a href="TechnicMediumHubTiltSensor.html#event:impactCount">impactCount</a></li><li><a href="TechnicMediumHubTiltSensor.html#event:tilt">tilt</a></li><li><a href="TechnicSmallAngularMotor.html#event:absolute">absolute</a></li><li><a href="TechnicSmallAngularMotor.html#event:rotate">rotate</a></li><li><a href="TechnicXLargeLinearMotor.html#event:absolute">absolute</a></li><li><a href="TechnicXLargeLinearMotor.html#event:rotate">rotate</a></li><li><a href="TiltSensor.html#event:tilt">tilt</a></li><li><a href="VoltageSensor.html#event:voltage">voltage</a></li><li><a href="WeDo2SmartHub.html#event:button">button</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Apr 25 2024 17:10:11 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>