Added docs

This commit is contained in:
Nathan Kellenicki 2019-01-24 17:05:52 -08:00
parent 40cd244086
commit 787195324a
21 changed files with 685 additions and 77 deletions

View File

@ -2075,7 +2075,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-63">line 63</a> <a href="lpf2hub.js.html#sunlight-1-line-75">line 75</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2294,7 +2294,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-81">line 81</a> <a href="lpf2hub.js.html#sunlight-1-line-93">line 93</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3201,7 +3201,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a> <a href="lpf2hub.js.html#sunlight-1-line-55">line 55</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3252,6 +3252,127 @@
</dd>
<hr>
<dt>
<h4 class="name" id="shutdown"><span class="type-signature"></span>shutdown()</h4>
</dt>
<dd>
<div class="description">
<p>Shutdown the Hub.</p>
</div>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="LPF2Hub.html#shutdown">LPF2Hub#shutdown</a>
</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Resolved upon successful disconnect.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</dd> </dd>
@ -4330,7 +4451,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4501,7 +4622,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4696,7 +4817,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5019,7 +5140,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-249">line 249</a> <a href="lpf2hub.js.html#sunlight-1-line-261">line 261</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5190,7 +5311,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a> <a href="lpf2hub.js.html#sunlight-1-line-316">line 316</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5385,7 +5506,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-292">line 292</a> <a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5464,7 +5585,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -2452,7 +2452,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-81">line 81</a> <a href="lpf2hub.js.html#sunlight-1-line-93">line 93</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2864,7 +2864,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a> <a href="lpf2hub.js.html#sunlight-1-line-55">line 55</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2915,6 +2915,127 @@
</dd>
<hr>
<dt>
<h4 class="name" id="shutdown"><span class="type-signature"></span>shutdown()</h4>
</dt>
<dd>
<div class="description">
<p>Shutdown the Hub.</p>
</div>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="LPF2Hub.html#shutdown">LPF2Hub#shutdown</a>
</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Resolved upon successful disconnect.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</dd> </dd>
@ -3817,7 +3938,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3988,7 +4109,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-352">line 352</a> <a href="lpf2hub.js.html#sunlight-1-line-364">line 364</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4067,7 +4188,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -2467,7 +2467,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -1619,7 +1619,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-63">line 63</a> <a href="lpf2hub.js.html#sunlight-1-line-75">line 75</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -1829,7 +1829,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-81">line 81</a> <a href="lpf2hub.js.html#sunlight-1-line-93">line 93</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -1991,7 +1991,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a> <a href="lpf2hub.js.html#sunlight-1-line-55">line 55</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2042,6 +2042,118 @@
</dd>
<hr>
<dt>
<h4 class="name" id="shutdown"><span class="type-signature"></span>shutdown()</h4>
</dt>
<dd>
<div class="description">
<p>Shutdown the Hub.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Resolved upon successful disconnect.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</dd> </dd>
@ -3086,7 +3198,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3248,7 +3360,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3434,7 +3546,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3743,7 +3855,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-249">line 249</a> <a href="lpf2hub.js.html#sunlight-1-line-261">line 261</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3905,7 +4017,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a> <a href="lpf2hub.js.html#sunlight-1-line-316">line 316</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4067,7 +4179,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-352">line 352</a> <a href="lpf2hub.js.html#sunlight-1-line-364">line 364</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4253,7 +4365,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-292">line 292</a> <a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4332,7 +4444,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -2075,7 +2075,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-63">line 63</a> <a href="lpf2hub.js.html#sunlight-1-line-75">line 75</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2294,7 +2294,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-81">line 81</a> <a href="lpf2hub.js.html#sunlight-1-line-93">line 93</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2944,7 +2944,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a> <a href="lpf2hub.js.html#sunlight-1-line-55">line 55</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2995,6 +2995,127 @@
</dd>
<hr>
<dt>
<h4 class="name" id="shutdown"><span class="type-signature"></span>shutdown()</h4>
</dt>
<dd>
<div class="description">
<p>Shutdown the Hub.</p>
</div>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="LPF2Hub.html#shutdown">LPF2Hub#shutdown</a>
</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Resolved upon successful disconnect.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</dd> </dd>
@ -4073,7 +4194,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4244,7 +4365,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4439,7 +4560,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4762,7 +4883,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-249">line 249</a> <a href="lpf2hub.js.html#sunlight-1-line-261">line 261</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4957,7 +5078,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-292">line 292</a> <a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5036,7 +5157,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -2061,7 +2061,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a> <a href="lpf2hub.js.html#sunlight-1-line-55">line 55</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2112,6 +2112,127 @@
</dd>
<hr>
<dt>
<h4 class="name" id="shutdown"><span class="type-signature"></span>shutdown()</h4>
</dt>
<dd>
<div class="description">
<p>Shutdown the Hub.</p>
</div>
<dl class="details">
<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="LPF2Hub.html#shutdown">LPF2Hub#shutdown</a>
</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-43">line 43</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Resolved upon successful disconnect.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</dd> </dd>
@ -3014,7 +3135,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3209,7 +3330,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3288,7 +3409,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -860,7 +860,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -5046,7 +5046,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -349,7 +349,7 @@ exports.BoostMoveHub = BoostMoveHub;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -506,7 +506,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -677,7 +677,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -872,7 +872,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -1195,7 +1195,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-249">line 249</a> <a href="lpf2hub.js.html#sunlight-1-line-261">line 261</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -1366,7 +1366,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a> <a href="lpf2hub.js.html#sunlight-1-line-316">line 316</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -1561,7 +1561,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-292">line 292</a> <a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -1732,7 +1732,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -1903,7 +1903,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-352">line 352</a> <a href="lpf2hub.js.html#sunlight-1-line-364">line 364</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2536,7 +2536,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2698,7 +2698,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -2884,7 +2884,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3193,7 +3193,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-249">line 249</a> <a href="lpf2hub.js.html#sunlight-1-line-261">line 261</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3355,7 +3355,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a> <a href="lpf2hub.js.html#sunlight-1-line-316">line 316</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3517,7 +3517,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-352">line 352</a> <a href="lpf2hub.js.html#sunlight-1-line-364">line 364</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -3703,7 +3703,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-292">line 292</a> <a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4200,7 +4200,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4371,7 +4371,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-259">line 259</a> <a href="lpf2hub.js.html#sunlight-1-line-271">line 271</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4566,7 +4566,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -4889,7 +4889,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-249">line 249</a> <a href="lpf2hub.js.html#sunlight-1-line-261">line 261</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5084,7 +5084,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-292">line 292</a> <a href="lpf2hub.js.html#sunlight-1-line-304">line 304</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5255,7 +5255,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-159">line 159</a> <a href="lpf2hub.js.html#sunlight-1-line-171">line 171</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -5450,7 +5450,7 @@
<ul class="dummy"> <ul class="dummy">
<li> <li>
<a href="lpf2hub.js.html">lpf2hub.js</a>, <a href="lpf2hub.js.html">lpf2hub.js</a>,
<a href="lpf2hub.js.html#sunlight-1-line-275">line 275</a> <a href="lpf2hub.js.html#sunlight-1-line-287">line 287</a>
</li> </li>
</ul> </ul>
</dd> </dd>
@ -6681,7 +6681,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -277,7 +277,7 @@ var BLECharacteristic;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -298,7 +298,7 @@ exports.DuploTrainBase = DuploTrainBase;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -3272,7 +3272,7 @@
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -480,7 +480,7 @@ exports.Hub = Hub;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -314,7 +314,7 @@ poweredUP.scan(); // Start scanning for Hubs</code></pre><p>More examples are av
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -126,6 +126,18 @@ class LPF2Hub extends hub_1.Hub {
return resolve(); return resolve();
}); });
} }
/**
* Shutdown the Hub.
* @method LPF2Hub#shutdown
* @returns {Promise} Resolved upon successful disconnect.
*/
shutdown() {
return new Promise((resolve, reject) => {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x02, 0x01]), () => {
return resolve();
});
});
}
/** /**
* Set the name of the Hub. * Set the name of the Hub.
* @method LPF2Hub#setName * @method LPF2Hub#setName
@ -495,7 +507,7 @@ exports.LPF2Hub = LPF2Hub;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -273,7 +273,7 @@ exports.PoweredUP = PoweredUP;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -306,7 +306,7 @@ exports.PUPHub = PUPHub;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

View File

@ -236,7 +236,7 @@ exports.PUPRemote = PUPRemote;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>

File diff suppressed because one or more lines are too long

View File

@ -484,7 +484,7 @@ exports.WeDo2SmartHub = WeDo2SmartHub;
<span class="jsdoc-message"> <span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
on Tue Jan 22nd 2019 on Thu Jan 24th 2019
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span> </span>