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

Updated docs for PR#3

Browse Source
This commit is contained in:
Nathan Kellenicki 2018-11-15 11:27:04 -08:00
parent 6ef5d8b769
commit 2212e5d31a
2 changed files with 62 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
DOCS.md
View File

@ -450,6 +450,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.name
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>name</code>](#Hub+name)
**Read only**: true
**Properties**
@ -461,6 +462,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.uuid
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>uuid</code>](#Hub+uuid)
**Read only**: true
**Properties**
@ -472,6 +474,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.rssi
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>rssi</code>](#Hub+rssi)
**Read only**: true
**Properties**
@ -483,6 +486,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.batteryLevel
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>batteryLevel</code>](#Hub+batteryLevel)
**Read only**: true
**Properties**
@ -599,6 +603,7 @@ Connect to the Hub.
Disconnect the Hub.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>disconnect</code>](#Hub+disconnect)
**Returns**: <code>Promise</code> - Resolved upon successful disconnect.
<a name="Hub+subscribe"></a>
@ -606,6 +611,7 @@ Disconnect the Hub.
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>subscribe</code>](#Hub+subscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type | Description |
@ -619,6 +625,7 @@ Subscribe to sensor notifications on a given port.
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>unsubscribe</code>](#Hub+unsubscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
@ -633,6 +640,7 @@ Sleep a given amount of time.
This is a helper method to make it easier to add delays into a chain of commands.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>sleep</code>](#Hub+sleep)
**Returns**: <code>Promise</code> - Resolved after the delay is finished.
| Param | Type | Description |
@ -647,6 +655,7 @@ Wait until a given list of concurrently running commands are complete.
This is a helper method to make it easier to wait for concurrent commands to complete.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>wait</code>](#Hub+wait)
**Returns**: <code>Promise</code> - Resolved after the commands are finished.
| Param | Type | Description |
@ -720,6 +729,7 @@ Emits when a rotation sensor is activated.
Emits when a motor or sensor is attached to the Hub.
**Kind**: event emitted by [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>attach</code>](#Hub+event_attach)
| Param | Type | Description |
| --- | --- | --- |
@ -732,6 +742,7 @@ Emits when a motor or sensor is attached to the Hub.
Emits when an attached motor or sensor is detached from the Hub.
**Kind**: event emitted by [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>detach</code>](#Hub+event_detach)
| Param | Type |
| --- | --- |
@ -789,6 +800,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.name
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>name</code>](#Hub+name)
**Read only**: true
**Properties**
@ -800,6 +812,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.uuid
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>uuid</code>](#Hub+uuid)
**Read only**: true
**Properties**
@ -811,6 +824,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.rssi
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>rssi</code>](#Hub+rssi)
**Read only**: true
**Properties**
@ -822,6 +836,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.batteryLevel
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>batteryLevel</code>](#Hub+batteryLevel)
**Read only**: true
**Properties**
@ -924,6 +939,7 @@ Connect to the Hub.
Disconnect the Hub.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>disconnect</code>](#Hub+disconnect)
**Returns**: <code>Promise</code> - Resolved upon successful disconnect.
<a name="Hub+subscribe"></a>
@ -931,6 +947,7 @@ Disconnect the Hub.
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>subscribe</code>](#Hub+subscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type | Description |
@ -944,6 +961,7 @@ Subscribe to sensor notifications on a given port.
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>unsubscribe</code>](#Hub+unsubscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
@ -958,6 +976,7 @@ Sleep a given amount of time.
This is a helper method to make it easier to add delays into a chain of commands.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>sleep</code>](#Hub+sleep)
**Returns**: <code>Promise</code> - Resolved after the delay is finished.
| Param | Type | Description |
@ -972,6 +991,7 @@ Wait until a given list of concurrently running commands are complete.
This is a helper method to make it easier to wait for concurrent commands to complete.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>wait</code>](#Hub+wait)
**Returns**: <code>Promise</code> - Resolved after the commands are finished.
| Param | Type | Description |
@ -1033,6 +1053,7 @@ Emits when a tilt sensor is activated.
Emits when a motor or sensor is attached to the Hub.
**Kind**: event emitted by [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>attach</code>](#Hub+event_attach)
| Param | Type | Description |
| --- | --- | --- |
@ -1045,6 +1066,7 @@ Emits when a motor or sensor is attached to the Hub.
Emits when an attached motor or sensor is detached from the Hub.
**Kind**: event emitted by [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>detach</code>](#Hub+event_detach)
| Param | Type |
| --- | --- |
@ -1094,6 +1116,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.name
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>name</code>](#Hub+name)
**Read only**: true
**Properties**
@ -1105,6 +1128,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.uuid
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>uuid</code>](#Hub+uuid)
**Read only**: true
**Properties**
@ -1116,6 +1140,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.rssi
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>rssi</code>](#Hub+rssi)
**Read only**: true
**Properties**
@ -1127,6 +1152,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.batteryLevel
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>batteryLevel</code>](#Hub+batteryLevel)
**Read only**: true
**Properties**
@ -1188,6 +1214,7 @@ Connect to the Hub.
Disconnect the Hub.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>disconnect</code>](#Hub+disconnect)
**Returns**: <code>Promise</code> - Resolved upon successful disconnect.
<a name="Hub+subscribe"></a>
@ -1195,6 +1222,7 @@ Disconnect the Hub.
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>subscribe</code>](#Hub+subscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type | Description |
@ -1208,6 +1236,7 @@ Subscribe to sensor notifications on a given port.
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>unsubscribe</code>](#Hub+unsubscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
@ -1222,6 +1251,7 @@ Sleep a given amount of time.
This is a helper method to make it easier to add delays into a chain of commands.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>sleep</code>](#Hub+sleep)
**Returns**: <code>Promise</code> - Resolved after the delay is finished.
| Param | Type | Description |
@ -1236,6 +1266,7 @@ Wait until a given list of concurrently running commands are complete.
This is a helper method to make it easier to wait for concurrent commands to complete.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>wait</code>](#Hub+wait)
**Returns**: <code>Promise</code> - Resolved after the commands are finished.
| Param | Type | Description |

31
README.md
View File

@ -529,6 +529,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.name
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>name</code>](#Hub+name)
**Read only**: true
**Properties**
@ -540,6 +541,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.uuid
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>uuid</code>](#Hub+uuid)
**Read only**: true
**Properties**
@ -551,6 +553,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.rssi
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>rssi</code>](#Hub+rssi)
**Read only**: true
**Properties**
@ -562,6 +565,7 @@ The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
### boostMoveHub.batteryLevel
**Kind**: instance property of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>batteryLevel</code>](#Hub+batteryLevel)
**Read only**: true
**Properties**
@ -678,6 +682,7 @@ Connect to the Hub.
Disconnect the Hub.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>disconnect</code>](#Hub+disconnect)
**Returns**: <code>Promise</code> - Resolved upon successful disconnect.
<a name="Hub+subscribe"></a>
@ -685,6 +690,7 @@ Disconnect the Hub.
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>subscribe</code>](#Hub+subscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type | Description |
@ -698,6 +704,7 @@ Subscribe to sensor notifications on a given port.
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>unsubscribe</code>](#Hub+unsubscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
@ -712,6 +719,7 @@ Sleep a given amount of time.
This is a helper method to make it easier to add delays into a chain of commands.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>sleep</code>](#Hub+sleep)
**Returns**: <code>Promise</code> - Resolved after the delay is finished.
| Param | Type | Description |
@ -726,6 +734,7 @@ Wait until a given list of concurrently running commands are complete.
This is a helper method to make it easier to wait for concurrent commands to complete.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>wait</code>](#Hub+wait)
**Returns**: <code>Promise</code> - Resolved after the commands are finished.
| Param | Type | Description |
@ -799,6 +808,7 @@ Emits when a rotation sensor is activated.
Emits when a motor or sensor is attached to the Hub.
**Kind**: event emitted by [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>attach</code>](#Hub+event_attach)
| Param | Type | Description |
| --- | --- | --- |
@ -811,6 +821,7 @@ Emits when a motor or sensor is attached to the Hub.
Emits when an attached motor or sensor is detached from the Hub.
**Kind**: event emitted by [<code>BoostMoveHub</code>](#BoostMoveHub)
**Overrides**: [<code>detach</code>](#Hub+event_detach)
| Param | Type |
| --- | --- |
@ -868,6 +879,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.name
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>name</code>](#Hub+name)
**Read only**: true
**Properties**
@ -879,6 +891,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.uuid
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>uuid</code>](#Hub+uuid)
**Read only**: true
**Properties**
@ -890,6 +903,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.rssi
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>rssi</code>](#Hub+rssi)
**Read only**: true
**Properties**
@ -901,6 +915,7 @@ The PUPHub is emitted if the discovered device is a Powered UP Hub.
### pupHub.batteryLevel
**Kind**: instance property of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>batteryLevel</code>](#Hub+batteryLevel)
**Read only**: true
**Properties**
@ -1003,6 +1018,7 @@ Connect to the Hub.
Disconnect the Hub.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>disconnect</code>](#Hub+disconnect)
**Returns**: <code>Promise</code> - Resolved upon successful disconnect.
<a name="Hub+subscribe"></a>
@ -1010,6 +1026,7 @@ Disconnect the Hub.
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>subscribe</code>](#Hub+subscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type | Description |
@ -1023,6 +1040,7 @@ Subscribe to sensor notifications on a given port.
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>unsubscribe</code>](#Hub+unsubscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
@ -1037,6 +1055,7 @@ Sleep a given amount of time.
This is a helper method to make it easier to add delays into a chain of commands.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>sleep</code>](#Hub+sleep)
**Returns**: <code>Promise</code> - Resolved after the delay is finished.
| Param | Type | Description |
@ -1051,6 +1070,7 @@ Wait until a given list of concurrently running commands are complete.
This is a helper method to make it easier to wait for concurrent commands to complete.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>wait</code>](#Hub+wait)
**Returns**: <code>Promise</code> - Resolved after the commands are finished.
| Param | Type | Description |
@ -1112,6 +1132,7 @@ Emits when a tilt sensor is activated.
Emits when a motor or sensor is attached to the Hub.
**Kind**: event emitted by [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>attach</code>](#Hub+event_attach)
| Param | Type | Description |
| --- | --- | --- |
@ -1124,6 +1145,7 @@ Emits when a motor or sensor is attached to the Hub.
Emits when an attached motor or sensor is detached from the Hub.
**Kind**: event emitted by [<code>PUPHub</code>](#PUPHub)
**Overrides**: [<code>detach</code>](#Hub+event_detach)
| Param | Type |
| --- | --- |
@ -1173,6 +1195,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.name
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>name</code>](#Hub+name)
**Read only**: true
**Properties**
@ -1184,6 +1207,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.uuid
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>uuid</code>](#Hub+uuid)
**Read only**: true
**Properties**
@ -1195,6 +1219,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.rssi
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>rssi</code>](#Hub+rssi)
**Read only**: true
**Properties**
@ -1206,6 +1231,7 @@ The PUPRemote is emitted if the discovered device is a Powered UP Remote.
### pupRemote.batteryLevel
**Kind**: instance property of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>batteryLevel</code>](#Hub+batteryLevel)
**Read only**: true
**Properties**
@ -1267,6 +1293,7 @@ Connect to the Hub.
Disconnect the Hub.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>disconnect</code>](#Hub+disconnect)
**Returns**: <code>Promise</code> - Resolved upon successful disconnect.
<a name="Hub+subscribe"></a>
@ -1274,6 +1301,7 @@ Disconnect the Hub.
Subscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>subscribe</code>](#Hub+subscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type | Description |
@ -1287,6 +1315,7 @@ Subscribe to sensor notifications on a given port.
Unsubscribe to sensor notifications on a given port.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>unsubscribe</code>](#Hub+unsubscribe)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
@ -1301,6 +1330,7 @@ Sleep a given amount of time.
This is a helper method to make it easier to add delays into a chain of commands.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>sleep</code>](#Hub+sleep)
**Returns**: <code>Promise</code> - Resolved after the delay is finished.
| Param | Type | Description |
@ -1315,6 +1345,7 @@ Wait until a given list of concurrently running commands are complete.
This is a helper method to make it easier to wait for concurrent commands to complete.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>wait</code>](#Hub+wait)
**Returns**: <code>Promise</code> - Resolved after the commands are finished.
| Param | Type | Description |