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

Better consts

Browse Source
This commit is contained in:
Nathan Kunicki 2018-06-20 14:32:01 +01:00
parent 12fde4c513
commit eaea510a35
2 changed files with 48 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
README.md
View File

@ -3,12 +3,12 @@
<dl>
<dt><a href="#LPF2">LPF2</a> ⇐ <code>EventEmitter</code></dt>
<dd></dd>
<dt><a href="#Hub">Hub</a> ⇐ <code>EventEmitter</code></dt>
<dd></dd>
<dt><a href="#BoostHub">BoostHub</a> ⇐ <code><a href="#Hub">Hub</a></code></dt>
<dd></dd>
<dt><a href="#WeDo2Hub">WeDo2Hub</a> ⇐ <code><a href="#Hub">Hub</a></code></dt>
<dd></dd>
<dt><a href="#Hub">Hub</a> ⇐ <code>EventEmitter</code></dt>
<dd></dd>
</dl>
<a name="LPF2"></a>
@ -38,51 +38,6 @@ Emits when a LPF2 Hub device is found.
| --- | --- |
| hub | [<code>Hub</code>](#Hub) |
<a name="Hub"></a>
## Hub ⇐ <code>EventEmitter</code>
**Kind**: global class
**Extends**: <code>EventEmitter</code>
* [Hub](#Hub) ⇐ <code>EventEmitter</code>
* [.connect([callback])](#Hub+connect)
* [.subscribe(port, [mode])](#Hub+subscribe)
* [.unsubscribe(port)](#Hub+unsubscribe)
<a name="Hub+connect"></a>
### hub.connect([callback])
Connect to the Hub.
**Kind**: instance method of [<code>Hub</code>](#Hub)
| Param | Type |
| --- | --- |
| [callback] | <code>function</code> |
<a name="Hub+subscribe"></a>
### hub.subscribe(port, [mode])
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>Hub</code>](#Hub)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| port | <code>string</code> | | |
| [mode] | <code>number</code> \| <code>boolean</code> | <code>false</code> | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. |
<a name="Hub+unsubscribe"></a>
### hub.unsubscribe(port)
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>Hub</code>](#Hub)
| Param | Type |
| --- | --- |
| port | <code>string</code> |
<a name="BoostHub"></a>
## BoostHub ⇐ [<code>Hub</code>](#Hub)
@ -384,3 +339,48 @@ Emits when a rotation sensor is activated.
| port | <code>string</code> |
| rotation | <code>number</code> |
<a name="Hub"></a>
## Hub ⇐ <code>EventEmitter</code>
**Kind**: global class
**Extends**: <code>EventEmitter</code>
* [Hub](#Hub) ⇐ <code>EventEmitter</code>
* [.connect([callback])](#Hub+connect)
* [.subscribe(port, [mode])](#Hub+subscribe)
* [.unsubscribe(port)](#Hub+unsubscribe)
<a name="Hub+connect"></a>
### hub.connect([callback])
Connect to the Hub.
**Kind**: instance method of [<code>Hub</code>](#Hub)
| Param | Type |
| --- | --- |
| [callback] | <code>function</code> |
<a name="Hub+subscribe"></a>
### hub.subscribe(port, [mode])
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>Hub</code>](#Hub)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| port | <code>string</code> | | |
| [mode] | <code>number</code> \| <code>boolean</code> | <code>false</code> | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. |
<a name="Hub+unsubscribe"></a>
### hub.unsubscribe(port)
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>Hub</code>](#Hub)
| Param | Type |
| --- | --- |
| port | <code>string</code> |

2
package.json
View File

@ -6,7 +6,7 @@
"types": "dist/lpf2.d.ts",
"scripts": {
"build": "tslint -c tslint.json \"*.ts\" && tsc",
"docs": "jsdoc2md dist/lpf2.js dist/hub.js dist/boosthub.js dist/wedo2hub.js > README.md"
"docs": "jsdoc2md dist/lpf2.js dist/boosthub.js dist/wedo2hub.js dist/hub.js > README.md"
},
"author": "Nathan Kunicki <me@nathankunicki.com>",
"license": "MIT",