# **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/sandeepmistry/noble#prerequisites).

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

### Compatibility

While most Powered Up and Boost components are compatible, there is limited backwards compatibility with WeDo 2.0. WeDo 2.0 components are fully forwards compatible.

|                                 |  Type  | WeDo 2.0 Smart Hub | Boost Move Hub | Powered Up Hub | Notes                                                                                                |
| ------------------------------- | ------ | ------------------ | -------------- | -------------- | ---------------------------------------------------------------------------------------------------- |
| 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(1)**    |       Yes      |       Yes      | Only color mode is supported on the WeDo 2.0 Smart Hub.                                              |
| Boost Interactive Medium Motor  | Motor  |     **Some(2)**    |       Yes      |       Yes      | Only basic motor functionality is supported on the WeDo 2.0 Smart Hub. No interactive functionality. |
| Powered Up Train Motor          | Motor  |         Yes        |       Yes      |       Yes      |                                                                                                      |

### Usage

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

Examples are available in the "examples" directory.