# **node-lpf2** - A Node.js module to interface with LEGO Power Functions 2.0 components.

### Installation

Node.js v8.0+ required.

```javascript
npm install node-lpf2 --save
```

node-lpf2 uses the Noble BLE library by Sandeep Mistry. On macOS everything should function out of the box. On Linux and Windows there are [certain dependencies which may need installed first](https://github.com/noble/noble#prerequisites).

Note: node-lpf2 has been tested on macOS 10.13 and Debian/Raspbian on the Raspberry Pi 3 Model B.

### Compatibility

While most LPF2 components and Hubs are compatible with each other, there are exceptions. There is limited backwards compatibility between newer components and the WeDo 2.0 Smart Hub. However WeDo 2.0 components are fully forwards compatible with newer Hubs.

|                                 |  Type  | WeDo 2.0 Smart Hub | Boost Move Hub | Powered Up Hub |
| ------------------------------- | ------ | ------------------ | -------------- | -------------- |
| WeDo 2.0 Tilt Sensor            | Sensor |         Yes        |       Yes      |       Yes      |
| WeDo 2.0 Distance Sensor        | Sensor |         Yes        |       Yes      |       Yes      |
| WeDo 2.0 Medium Motor           | Motor  |         Yes        |       Yes      |       Yes      |
| Boost Color and Distance Sensor | Sensor |      *Some (<a href="#compatibility-note-1">1</a>)*    |       Yes      |       Yes      |
| Boost Interactive Medium Motor  | Motor  |      *Some (<a href="#compatibility-note-2">2</a>)*    |       Yes      |       Yes      |
| Powered Up Train Motor          | Motor  |         Yes        |       Yes      |       Yes      |

<a name="compatibility-note-1"></a><sub>(1) Only color mode is supported on the WeDo 2.0 Smart Hub at this point.</sub>

<a name="compatibility-note-2"></a><sub>(2) Only basic motor functionality is supported on the WeDo 2.0 Smart Hub at this point. No interactive functionality. In short, it functions like the WeDo 2.0 Medium Motor.</sub>

### Usage

```javascript
const LPF2 = require("node-lpf2").LPF2;
const lpf2 = new LPF2();
```

Examples are available in the "examples" directory.

## Classes

<dl>
<dt><a href="#LPF2">LPF2</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>

## LPF2 ⇐ <code>EventEmitter</code>
**Kind**: global class  
**Extends**: <code>EventEmitter</code>  

* [LPF2](#LPF2) ⇐ <code>EventEmitter</code>
    * [.scan()](#LPF2+scan)
    * ["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+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>Hub</code>](#Hub) | 

<a name="BoostHub"></a>

## BoostHub ⇐ [<code>Hub</code>](#Hub)
**Kind**: global class  
**Extends**: [<code>Hub</code>](#Hub)  

* [BoostHub](#BoostHub) ⇐ [<code>Hub</code>](#Hub)
    * [.setLEDColor(color)](#BoostHub+setLEDColor)
    * [.setMotorSpeed(port, speed, [time])](#BoostHub+setMotorSpeed)
    * [.setMotorAngle(port, angle, [speed])](#BoostHub+setMotorAngle)
    * [.connect([callback])](#Hub+connect)
    * [.subscribe(port, [mode])](#Hub+subscribe)
    * [.unsubscribe(port)](#Hub+unsubscribe)
    * ["button" (state)](#BoostHub+event_button)
    * ["distance" (port, distance)](#BoostHub+event_distance)
    * ["color" (port, color)](#BoostHub+event_color)
    * ["tilt" (port, x, y)](#BoostHub+event_tilt)
    * ["rotate" (port, rotation)](#BoostHub+event_rotate)

<a name="BoostHub+setLEDColor"></a>

### boostHub.setLEDColor(color)
Set the color of the LED on the Hub via a color value.

**Kind**: instance method of [<code>BoostHub</code>](#BoostHub)  

| Param | Type | Description |
| --- | --- | --- |
| color | <code>number</code> | A number representing one of the LED color consts. |

<a name="BoostHub+setMotorSpeed"></a>

### boostHub.setMotorSpeed(port, speed, [time])
Set the motor speed on a given port.

**Kind**: instance method of [<code>BoostHub</code>](#BoostHub)  

| 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="BoostHub+setMotorAngle"></a>

### boostHub.setMotorAngle(port, angle, [speed])
Rotate a motor by a given angle.

**Kind**: instance method of [<code>BoostHub</code>](#BoostHub)  

| 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="Hub+connect"></a>

### boostHub.connect([callback])
Connect to the Hub.

**Kind**: instance method of [<code>BoostHub</code>](#BoostHub)  
**Overrides**: [<code>connect</code>](#Hub+connect)  

| Param | Type |
| --- | --- |
| [callback] | <code>function</code> | 

<a name="Hub+subscribe"></a>

### boostHub.subscribe(port, [mode])
Subscribe to sensor notifications on a given port.

**Kind**: instance method of [<code>BoostHub</code>](#BoostHub)  

| 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>

### boostHub.unsubscribe(port)
Unsubscribe to sensor notifications on a given port.

**Kind**: instance method of [<code>BoostHub</code>](#BoostHub)  

| Param | Type |
| --- | --- |
| port | <code>string</code> | 

<a name="BoostHub+event_button"></a>

### "button" (state)
Emits when a button is pressed.

**Kind**: event emitted by [<code>BoostHub</code>](#BoostHub)  

| Param | Type | Description |
| --- | --- | --- |
| state | <code>number</code> | A number representing one of the button state consts. |

<a name="BoostHub+event_distance"></a>

### "distance" (port, distance)
Emits when a distance sensor is activated.

**Kind**: event emitted by [<code>BoostHub</code>](#BoostHub)  

| Param | Type | Description |
| --- | --- | --- |
| port | <code>string</code> |  |
| distance | <code>number</code> | Distance, in millimeters. |

<a name="BoostHub+event_color"></a>

### "color" (port, color)
Emits when a color sensor is activated.

**Kind**: event emitted by [<code>BoostHub</code>](#BoostHub)  

| Param | Type | Description |
| --- | --- | --- |
| port | <code>string</code> |  |
| color | <code>number</code> | A number representing one of the LED color consts. |

<a name="BoostHub+event_tilt"></a>

### "tilt" (port, x, y)
Emits when a tilt sensor is activated.

**Kind**: event emitted by [<code>BoostHub</code>](#BoostHub)  

| Param | Type |
| --- | --- |
| port | <code>string</code> | 
| x | <code>number</code> | 
| y | <code>number</code> | 

<a name="BoostHub+event_rotate"></a>

### "rotate" (port, rotation)
Emits when a rotation sensor is activated.

**Kind**: event emitted by [<code>BoostHub</code>](#BoostHub)  

| Param | Type |
| --- | --- |
| port | <code>string</code> | 
| rotation | <code>number</code> | 

<a name="WeDo2Hub"></a>

## WeDo2Hub ⇐ [<code>Hub</code>](#Hub)
**Kind**: global class  
**Extends**: [<code>Hub</code>](#Hub)  

* [WeDo2Hub](#WeDo2Hub) ⇐ [<code>Hub</code>](#Hub)
    * [.setLEDColor(color)](#WeDo2Hub+setLEDColor)
    * [.setLEDRGB(red, green, blue)](#WeDo2Hub+setLEDRGB)
    * [.setMotorSpeed(port, speed)](#WeDo2Hub+setMotorSpeed)
    * [.connect([callback])](#Hub+connect)
    * [.subscribe(port, [mode])](#Hub+subscribe)
    * [.unsubscribe(port)](#Hub+unsubscribe)
    * ["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)

<a name="WeDo2Hub+setLEDColor"></a>

### weDo2Hub.setLEDColor(color)
Set the color of the LED on the Hub via a color value.

**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)  

| 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)
Set the color of the LED on the Hub via RGB values.

**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)  

| Param | Type |
| --- | --- |
| red | <code>number</code> | 
| green | <code>number</code> | 
| blue | <code>number</code> | 

<a name="WeDo2Hub+setMotorSpeed"></a>

### weDo2Hub.setMotorSpeed(port, speed)
Set the motor speed on a given port.

**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)  

| 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. |

<a name="Hub+connect"></a>

### weDo2Hub.connect([callback])
Connect to the Hub.

**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)  
**Overrides**: [<code>connect</code>](#Hub+connect)  

| Param | Type |
| --- | --- |
| [callback] | <code>function</code> | 

<a name="Hub+subscribe"></a>

### weDo2Hub.subscribe(port, [mode])
Subscribe to sensor notifications on a given port.

**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)  

| 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>

### weDo2Hub.unsubscribe(port)
Unsubscribe to sensor notifications on a given port.

**Kind**: instance method of [<code>WeDo2Hub</code>](#WeDo2Hub)  

| Param | Type |
| --- | --- |
| port | <code>string</code> | 

<a name="WeDo2Hub+event_button"></a>

### "button" (state)
Emits when a button is pressed.

**Kind**: event emitted by [<code>WeDo2Hub</code>](#WeDo2Hub)  

| Param | Type | Description |
| --- | --- | --- |
| 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"></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> |