479 lines
16 KiB
Markdown
479 lines
16 KiB
Markdown
## Classes
|
|
|
|
<dl>
|
|
<dt><a href="#LPF2">LPF2</a> ⇐ <code>EventEmitter</code></dt>
|
|
<dd></dd>
|
|
<dt><a href="#WeDo2Hub">WeDo2Hub</a> ⇐ <code>Hub</code></dt>
|
|
<dd></dd>
|
|
<dt><a href="#BoostMoveHub">BoostMoveHub</a> ⇐ <code>LPF2Hub</code></dt>
|
|
<dd></dd>
|
|
<dt><a href="#PUPHub">PUPHub</a> ⇐ <code>LPF2Hub</code></dt>
|
|
<dd></dd>
|
|
<dt><a href="#PUPRemote">PUPRemote</a> ⇐ <code>LPF2Hub</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
<a name="LPF2"></a>
|
|
|
|
## LPF2 ⇐ <code>EventEmitter</code>
|
|
**Kind**: global class
|
|
**Extends**: <code>EventEmitter</code>
|
|
|
|
* [LPF2](#LPF2) ⇐ <code>EventEmitter</code>
|
|
* [.scan()](#LPF2+scan)
|
|
* [.stop()](#LPF2+stop)
|
|
* [.getConnectedHubByUUID(uuid)](#LPF2+getConnectedHubByUUID) ⇒ <code>Hub</code> \| <code>null</code>
|
|
* [.getConnectedHubs()](#LPF2+getConnectedHubs) ⇒ <code>Array.<Hub></code>
|
|
* ["discover" (hub)](#LPF2+event_discover)
|
|
|
|
<a name="LPF2+scan"></a>
|
|
|
|
### lpF2.scan()
|
|
Begin scanning for LPF2 Hub devices.
|
|
|
|
**Kind**: instance method of [<code>LPF2</code>](#LPF2)
|
|
<a name="LPF2+stop"></a>
|
|
|
|
### lpF2.stop()
|
|
Stop scanning for LPF2 Hub devices.
|
|
|
|
**Kind**: instance method of [<code>LPF2</code>](#LPF2)
|
|
<a name="LPF2+getConnectedHubByUUID"></a>
|
|
|
|
### lpF2.getConnectedHubByUUID(uuid) ⇒ <code>Hub</code> \| <code>null</code>
|
|
Retrieve a LPF2 Hub by UUID.
|
|
|
|
**Kind**: instance method of [<code>LPF2</code>](#LPF2)
|
|
|
|
| Param | Type |
|
|
| --- | --- |
|
|
| uuid | <code>string</code> |
|
|
|
|
<a name="LPF2+getConnectedHubs"></a>
|
|
|
|
### lpF2.getConnectedHubs() ⇒ <code>Array.<Hub></code>
|
|
Retrieve a list of LPF2 Hubs.
|
|
|
|
**Kind**: instance method of [<code>LPF2</code>](#LPF2)
|
|
<a name="LPF2+event_discover"></a>
|
|
|
|
### "discover" (hub)
|
|
Emits when a LPF2 Hub device is found.
|
|
|
|
**Kind**: event emitted by [<code>LPF2</code>](#LPF2)
|
|
|
|
| Param | Type |
|
|
| --- | --- |
|
|
| hub | [<code>WeDo2Hub</code>](#WeDo2Hub) \| <code>LPF2Hub</code> |
|
|
|
|
<a name="WeDo2Hub"></a>
|
|
|
|
## WeDo2Hub ⇐ <code>Hub</code>
|
|
**Kind**: global class
|
|
**Extends**: <code>Hub</code>
|
|
|
|
* [WeDo2Hub](#WeDo2Hub) ⇐ <code>Hub</code>
|
|
* [new WeDo2Hub()](#new_WeDo2Hub_new)
|
|
* [.name](#Hub+name)
|
|
* [.uuid](#Hub+uuid)
|
|
* [.rssi](#Hub+rssi)
|
|
* [.batteryLevel](#Hub+batteryLevel)
|
|
* [.setLEDColor(color)](#WeDo2Hub+setLEDColor) ⇒ <code>Promise</code>
|
|
* [.setLEDRGB(red, green, blue)](#WeDo2Hub+setLEDRGB) ⇒ <code>Promise</code>
|
|
* [.setMotorSpeed(port, speed, [time])](#WeDo2Hub+setMotorSpeed) ⇒ <code>Promise</code>
|
|
* [.playSound(frequency, time)](#WeDo2Hub+playSound) ⇒ <code>Promise</code>
|
|
* [.connect()](#Hub+connect) ⇒ <code>Promise</code>
|
|
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
|
|
* [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code>
|
|
* [.unsubscribe(port)](#Hub+unsubscribe) ⇒ <code>Promise</code>
|
|
* [.sleep(delay)](#Hub+sleep) ⇒ <code>Promise</code>
|
|
* [.wait(commands)](#Hub+wait) ⇒ <code>Promise</code>
|
|
* ["button" (button, state)](#WeDo2Hub+event_button)
|
|
* ["distance" (port, distance)](#WeDo2Hub+event_distance)
|
|
* ["color" (port, color)](#WeDo2Hub+event_color)
|
|
* ["tilt" (port, x, y)](#WeDo2Hub+event_tilt)
|
|
* ["rotate" (port, rotation)](#WeDo2Hub+event_rotate)
|
|
* ["attach" (port, type)](#Hub+event_attach)
|
|
* ["detach" (port)](#Hub+event_detach)
|
|
|
|
<a name="new_WeDo2Hub_new"></a>
|
|
|
|
### new WeDo2Hub()
|
|
The WeDo2Hub is emitted if the discovered device is a WeDo 2.0 Smart Hub.
|
|
|
|
<a name="Hub+name"></a>
|
|
|
|
### weDo2Hub.name
|
|
**Kind**: instance property of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Read only**: true
|
|
**Properties**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| name | <code>string</code> | Name of the hub |
|
|
|
|
<a name="Hub+uuid"></a>
|
|
|
|
### weDo2Hub.uuid
|
|
**Kind**: instance property of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Read only**: true
|
|
**Properties**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| uuid | <code>string</code> | UUID of the hub |
|
|
|
|
<a name="Hub+rssi"></a>
|
|
|
|
### weDo2Hub.rssi
|
|
**Kind**: instance property of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Read only**: true
|
|
**Properties**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| rssi | <code>number</code> | Signal strength of the hub |
|
|
|
|
<a name="Hub+batteryLevel"></a>
|
|
|
|
### weDo2Hub.batteryLevel
|
|
**Kind**: instance property of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Read only**: true
|
|
**Properties**
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| batteryLevel | <code>number</code> | Battery level of the hub (Percentage between 0-100) |
|
|
|
|
<a name="WeDo2Hub+setLEDColor"></a>
|
|
|
|
### weDo2Hub.setLEDColor(color) ⇒ <code>Promise</code>
|
|
Set the color of the LED on the Hub via a color value.
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| color | <code>number</code> | A number representing one of the LED color consts. |
|
|
|
|
<a name="WeDo2Hub+setLEDRGB"></a>
|
|
|
|
### weDo2Hub.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
|
|
Set the color of the LED on the Hub via RGB values.
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
|
|
|
|
| Param | Type |
|
|
| --- | --- |
|
|
| red | <code>number</code> |
|
|
| green | <code>number</code> |
|
|
| blue | <code>number</code> |
|
|
|
|
<a name="WeDo2Hub+setMotorSpeed"></a>
|
|
|
|
### weDo2Hub.setMotorSpeed(port, speed, [time]) ⇒ <code>Promise</code>
|
|
Set the motor speed on a given port.
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful completion of command. If time is specified, this is once the motor is finished.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | <code>string</code> | |
|
|
| speed | <code>number</code> | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
|
|
| [time] | <code>number</code> | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. |
|
|
|
|
<a name="WeDo2Hub+playSound"></a>
|
|
|
|
### weDo2Hub.playSound(frequency, time) ⇒ <code>Promise</code>
|
|
Play a sound on the Hub's in-built buzzer
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful completion of command (ie. once the sound has finished playing).
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| frequency | <code>number</code> | |
|
|
| time | <code>number</code> | How long the sound should play for (in milliseconds). |
|
|
|
|
<a name="Hub+connect"></a>
|
|
|
|
### weDo2Hub.connect() ⇒ <code>Promise</code>
|
|
Connect to the Hub.
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Overrides**: [<code>connect</code>](#Hub+connect)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful connect.
|
|
<a name="Hub+disconnect"></a>
|
|
|
|
### weDo2Hub.disconnect() ⇒ <code>Promise</code>
|
|
Disconnect the Hub.
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful disconnect.
|
|
<a name="Hub+subscribe"></a>
|
|
|
|
### weDo2Hub.subscribe(port, [mode]) ⇒ <code>Promise</code>
|
|
Subscribe to sensor notifications on a given port.
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | <code>string</code> | |
|
|
| [mode] | <code>number</code> | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. |
|
|
|
|
<a name="Hub+unsubscribe"></a>
|
|
|
|
### weDo2Hub.unsubscribe(port) ⇒ <code>Promise</code>
|
|
Unsubscribe to sensor notifications on a given port.
|
|
|
|
**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
|
|
|
|
| Param | Type |
|
|
| --- | --- |
|
|
| port | <code>string</code> |
|
|
|
|
<a name="Hub+sleep"></a>
|
|
|
|
### weDo2Hub.sleep(delay) ⇒ <code>Promise</code>
|
|
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>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved after the delay is finished.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| delay | <code>number</code> | How long to sleep (in milliseconds). |
|
|
|
|
<a name="Hub+wait"></a>
|
|
|
|
### weDo2Hub.wait(commands) ⇒ <code>Promise</code>
|
|
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>WeDo2Hub</code>](#WeDo2Hub)
|
|
**Returns**: <code>Promise</code> - Resolved after the commands are finished.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| commands | <code>Array.<Promise.<any>></code> | Array of executing commands. |
|
|
|
|
<a name="WeDo2Hub+event_button"></a>
|
|
|
|
### "button" (button, state)
|
|
Emits when a button is pressed.
|
|
|
|
**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| button | <code>string</code> | |
|
|
| state | <code>number</code> | A number representing one of the button state consts. |
|
|
|
|
<a name="WeDo2Hub+event_distance"></a>
|
|
|
|
### "distance" (port, distance)
|
|
Emits when a distance sensor is activated.
|
|
|
|
**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | <code>string</code> | |
|
|
| distance | <code>number</code> | Distance, in millimeters. |
|
|
|
|
<a name="WeDo2Hub+event_color"></a>
|
|
|
|
### "color" (port, color)
|
|
Emits when a color sensor is activated.
|
|
|
|
**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | <code>string</code> | |
|
|
| color | <code>number</code> | A number representing one of the LED color consts. |
|
|
|
|
<a name="WeDo2Hub+event_tilt"></a>
|
|
|
|
### "tilt" (port, x, y)
|
|
Emits when a tilt sensor is activated.
|
|
|
|
**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
|
|
| Param | Type |
|
|
| --- | --- |
|
|
| port | <code>string</code> |
|
|
| x | <code>number</code> |
|
|
| y | <code>number</code> |
|
|
|
|
<a name="WeDo2Hub+event_rotate"></a>
|
|
|
|
### "rotate" (port, rotation)
|
|
Emits when a rotation sensor is activated.
|
|
|
|
**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
|
|
| Param | Type |
|
|
| --- | --- |
|
|
| port | <code>string</code> |
|
|
| rotation | <code>number</code> |
|
|
|
|
<a name="Hub+event_attach"></a>
|
|
|
|
### "attach" (port, type)
|
|
Emits when a motor or sensor is attached to the Hub.
|
|
|
|
**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | <code>string</code> | |
|
|
| type | <code>number</code> | A number representing one of the peripheral consts. |
|
|
|
|
<a name="Hub+event_detach"></a>
|
|
|
|
### "detach" (port)
|
|
Emits when an attached motor or sensor is detached from the Hub.
|
|
|
|
**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)
|
|
|
|
| Param | Type |
|
|
| --- | --- |
|
|
| port | <code>string</code> |
|
|
|
|
<a name="BoostMoveHub"></a>
|
|
|
|
## BoostMoveHub ⇐ <code>LPF2Hub</code>
|
|
**Kind**: global class
|
|
**Extends**: <code>LPF2Hub</code>
|
|
|
|
* [BoostMoveHub](#BoostMoveHub) ⇐ <code>LPF2Hub</code>
|
|
* [new BoostMoveHub()](#new_BoostMoveHub_new)
|
|
* [.setLEDColor(color)](#BoostMoveHub+setLEDColor) ⇒ <code>Promise</code>
|
|
* [.setMotorSpeed(port, speed, [time])](#BoostMoveHub+setMotorSpeed) ⇒ <code>Promise</code>
|
|
* [.setMotorAngle(port, angle, [speed])](#BoostMoveHub+setMotorAngle) ⇒ <code>Promise</code>
|
|
|
|
<a name="new_BoostMoveHub_new"></a>
|
|
|
|
### new BoostMoveHub()
|
|
The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
|
|
|
|
<a name="BoostMoveHub+setLEDColor"></a>
|
|
|
|
### boostMoveHub.setLEDColor(color) ⇒ <code>Promise</code>
|
|
Set the color of the LED on the Hub via a color value.
|
|
|
|
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| color | <code>number</code> | A number representing one of the LED color consts. |
|
|
|
|
<a name="BoostMoveHub+setMotorSpeed"></a>
|
|
|
|
### boostMoveHub.setMotorSpeed(port, speed, [time]) ⇒ <code>Promise</code>
|
|
Set the motor speed on a given port.
|
|
|
|
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful completion of command. If time is specified, this is once the motor is finished.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | <code>string</code> | |
|
|
| speed | <code>number</code> | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
|
|
| [time] | <code>number</code> | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. |
|
|
|
|
<a name="BoostMoveHub+setMotorAngle"></a>
|
|
|
|
### boostMoveHub.setMotorAngle(port, angle, [speed]) ⇒ <code>Promise</code>
|
|
Rotate a motor by a given angle.
|
|
|
|
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful completion of command (ie. once the motor is finished).
|
|
|
|
| Param | Type | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| port | <code>string</code> | | |
|
|
| angle | <code>number</code> | | How much the motor should be rotated (in degrees). |
|
|
| [speed] | <code>number</code> | <code>100</code> | How fast the motor should be rotated. |
|
|
|
|
<a name="PUPHub"></a>
|
|
|
|
## PUPHub ⇐ <code>LPF2Hub</code>
|
|
**Kind**: global class
|
|
**Extends**: <code>LPF2Hub</code>
|
|
|
|
* [PUPHub](#PUPHub) ⇐ <code>LPF2Hub</code>
|
|
* [new PUPHub()](#new_PUPHub_new)
|
|
* [.setLEDColor(color)](#PUPHub+setLEDColor) ⇒ <code>Promise</code>
|
|
* [.setMotorSpeed(port, speed, [time])](#PUPHub+setMotorSpeed) ⇒ <code>Promise</code>
|
|
|
|
<a name="new_PUPHub_new"></a>
|
|
|
|
### new PUPHub()
|
|
The PUPHub is emitted if the discovered device is a Powered Up Hub.
|
|
|
|
<a name="PUPHub+setLEDColor"></a>
|
|
|
|
### pupHub.setLEDColor(color) ⇒ <code>Promise</code>
|
|
Set the color of the LED on the Hub via a color value.
|
|
|
|
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| color | <code>number</code> | A number representing one of the LED color consts. |
|
|
|
|
<a name="PUPHub+setMotorSpeed"></a>
|
|
|
|
### pupHub.setMotorSpeed(port, speed, [time]) ⇒ <code>Promise</code>
|
|
Set the motor speed on a given port.
|
|
|
|
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful completion of command. If time is specified, this is once the motor is finished.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| port | <code>string</code> | |
|
|
| speed | <code>number</code> | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
|
|
| [time] | <code>number</code> | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. |
|
|
|
|
<a name="PUPRemote"></a>
|
|
|
|
## PUPRemote ⇐ <code>LPF2Hub</code>
|
|
**Kind**: global class
|
|
**Extends**: <code>LPF2Hub</code>
|
|
|
|
* [PUPRemote](#PUPRemote) ⇐ <code>LPF2Hub</code>
|
|
* [new PUPRemote()](#new_PUPRemote_new)
|
|
* [.setLEDColor(color)](#PUPRemote+setLEDColor) ⇒ <code>Promise</code>
|
|
|
|
<a name="new_PUPRemote_new"></a>
|
|
|
|
### new PUPRemote()
|
|
The PUPRemote is emitted if the discovered device is a Powered Up Remote.
|
|
|
|
<a name="PUPRemote+setLEDColor"></a>
|
|
|
|
### pupRemote.setLEDColor(color) ⇒ <code>Promise</code>
|
|
Set the color of the LED on the Remote via a color value.
|
|
|
|
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
|
|
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| color | <code>number</code> | A number representing one of the LED color consts. |
|
|
|