nkellenicki/node-poweredup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Nathan Kellenicki 2019-01-18 16:17:21 -08:00
parent 86e84395e1
commit 55f26fab6f
20 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -63,7 +63,11 @@ In addition, the Hubs themselves have certain built-in features which this libra
* Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix). * Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix).
### Usage ### Documentation
[Full documentation is available here.](https://nathankellenicki.github.io/node-poweredup/)
### Sample Usage
```javascript ```javascript
const PoweredUP = require("node-poweredup"); const PoweredUP = require("node-poweredup");

2
docs/BoostMoveHub.html
View File

@ -5134,7 +5134,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/DuploTrainBase.html
View File

@ -3809,7 +3809,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/Hub.html
View File

@ -2169,7 +2169,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/LPF2Hub.html
View File

@ -4133,7 +4133,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/PUPHub.html
View File

@ -4721,7 +4721,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/PUPRemote.html
View File

@ -3058,7 +3058,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/PoweredUP.html
View File

@ -753,7 +753,7 @@
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/WeDo2SmartHub.html
View File

@ -4603,7 +4603,7 @@ This is a helper method to make it easier to wait for concurrent commands to com
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/boostmovehub.js.html
View File

@ -262,7 +262,7 @@ exports.BoostMoveHub = BoostMoveHub;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:37 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/consts.js.html
View File

@ -190,7 +190,7 @@ var BLECharacteristic;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/duplotrainbase.js.html
View File

@ -211,7 +211,7 @@ exports.DuploTrainBase = DuploTrainBase;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/global.html
View File

@ -3014,7 +3014,7 @@
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/hub.js.html
View File

@ -377,7 +377,7 @@ exports.Hub = Hub;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

5
docs/index.html
View File

@ -191,7 +191,8 @@
<li><p>Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix).</p> <li><p>Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix).</p>
</li> </li>
</ul> </ul>
<h3>Usage</h3><pre class="prettyprint source lang-javascript"><code>const PoweredUP = require(&quot;node-poweredup&quot;); <h3>Documentation</h3><p><a href="https://nathankellenicki.github.io/node-poweredup/">Full documentation is available here.</a></p>
<h3>Sample Usage</h3><pre class="prettyprint source lang-javascript"><code>const PoweredUP = require(&quot;node-poweredup&quot;);
const poweredUP = new PoweredUP.PoweredUP(); const poweredUP = new PoweredUP.PoweredUP();
poweredUP.on(&quot;discover&quot;, async (hub) => { // Wait to discover a Hub poweredUP.on(&quot;discover&quot;, async (hub) => { // Wait to discover a Hub
@ -225,7 +226,7 @@ poweredUP.scan(); // Start scanning for Hubs</code></pre><p>More examples are av
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/lpf2hub.js.html
View File

@ -422,7 +422,7 @@ exports.LPF2Hub = LPF2Hub;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/poweredup.js.html
View File

@ -186,7 +186,7 @@ exports.PoweredUP = PoweredUP;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/puphub.js.html
View File

@ -219,7 +219,7 @@ exports.PUPHub = PUPHub;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/pupremote.js.html
View File

@ -149,7 +149,7 @@ exports.PUPRemote = PUPRemote;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>

2
docs/wedo2smarthub.js.html
View File

@ -377,7 +377,7 @@ exports.WeDo2SmartHub = WeDo2SmartHub;
<br class="clear"> <br class="clear">
<footer> <footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:10:38 GMT-0800 (Pacific Standard Time) Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
</footer> </footer>
<script> prettyPrint(); </script> <script> prettyPrint(); </script>