Skip to content
A Javascript module to interface with LEGO Powered UP components.
Branch: master
Clone or download
Latest commit 5308e78 Mar 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Drone now does npm publish Mar 20, 2019
examples Fixed types in package.json Mar 21, 2019
src
.drone.yml More Drone Mar 20, 2019
.gitignore Updated .gitignore & .npmignore and fixed export from index.ts Nov 14, 2018
.npmignore Updated .gitignore & .npmignore and fixed export from index.ts Nov 14, 2018
LICENSE.md
README.md Drone now does npm publish Mar 20, 2019
jsdoc.conf.json
noble-mac.d.ts macOS 10.14 Mojave support Oct 9, 2018
package-lock.json Bumped again Mar 21, 2019
package.json
tsconfig.json
tslint.json
webble_test.html
webpack.config.js

README.md

Drone NPM Version

node-poweredup - A Javascript module to interface with LEGO Powered UP components.

Introduction

LEGO Powered UP is the successor to Power Functions, the system for adding electronics to LEGO models. Powered UP is a collection of ranges - starting with LEGO WeDo 2.0 released in 2016, LEGO Boost released in 2017, and LEGO Powered UP released in 2018. It also includes the 2018 Duplo App-Controlled Train sets.

This library allows communication and control of Powered UP devices and peripherals via Javascript, both from Node.js and from the browser using Web Bluetooth.

Node.js Installation

Node.js v8.0 required.

npm install node-poweredup --save

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

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

Compatibility

While most Powered UP components and Hubs are compatible with each other, there are exceptions. For example, 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.

Device Name Product Code Type WeDo 2.0 Smart Hub Boost Move Hub Powered UP Hub Availability
WeDo 2.0 Tilt Sensor 45305 Sensor Yes Yes Yes 45300
WeDo 2.0 Motion Sensor 45304 Sensor Yes Yes Yes 45300
WeDo 2.0 Medium Motor 45303 Motor Yes Yes Yes 45300
76112
Boost Color and Distance Sensor 88007 Sensor Partial Yes Yes 17101
Boost Tacho Motor 88008 Motor/Sensor Partial Yes Partial 17101
Powered UP Train Motor 88011 Motor Yes Yes Yes 60197
60198
Powered UP LED Lights 88005 Light Yes Yes Yes 88005

In addition, the Hubs themselves have certain built-in features which this library exposes.

Hub Name Product Code Built-In Features Availability
WeDo 2.0 Smart hub 45301 RGB LED
Piezo Buzzer
Button
45300
Boost Move Hub 88006 RGB LED
Tilt Sensor
2x Tacho Motors
Button
17101
Powered UP Hub 88009 RGB LED
Button
60197
60198
76112
Powered UP Remote 88010 RGB LED
Left and Right Control Buttons
Button
60197
60198
Duplo Train Base 28743 RGB LED/Headlights
Speaker
Speedometer
Motor
Color and Distance Sensor
Button
10874
10875

Known Issues and Limitations

  • The Boost Color and Distance sensor only works in color mode with the WeDo 2.0 Smart Hub.

  • When used with the WeDo 2.0 Smart Hub, the Boost Tacho Motor does not support rotating the motor by angle.

  • When used with the Powered UP Hub, the Boost Tacho Motor does not support rotating the motor by angle. It also does not support rotation detection.

  • Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix).

Documentation

Full documentation is available here.

Node.js Sample Usage

const PoweredUP = require("node-poweredup");
const poweredUP = new PoweredUP.PoweredUP();

poweredUP.on("discover", async (hub) => { // Wait to discover a Hub
    console.log(`Discovered ${hub.name}!`);
    await hub.connect(); // Connect to the Hub
    console.log("Connected");
    await hub.sleep(3000); // Sleep for 3 seconds before starting

    while (true) { // Repeat indefinitely
        console.log("Running motor B at speed 75");
        hub.setMotorSpeed("B", 75); // Start a motor attached to port B to run a 3/4 speed (75) indefinitely
        console.log("Running motor A at speed 100 for 2 seconds");
        await hub.setMotorSpeed("A", 100,  2000); // Run a motor attached to port A for 2 seconds at maximum speed (100) then stop
        await hub.sleep(1000); // Do nothing for 1 second
        console.log("Running motor A at speed -50 for 1 seconds");
        await hub.setMotorSpeed("A", -50,  1000); // Run a motor attached to port A for 1 second at 1/2 speed in reverse (-50) then stop
        await hub.sleep(1000); // Do nothing for 1 second
    }
});

poweredUP.scan(); // Start scanning for Hubs
console.log("Scanning for Hubs...");

More examples are available in the "examples" directory.

Credits

Thanks go to Jorge Pereira (@JorgePe), Sebastian Raff (@hobbyquaker), Valentin Heun (@vheun), Johan Korten (@jakorten), and Andrey Pokhilko (@undera) for their various works, contributions, and assistance on figuring out the LEGO Boost, WeDo 2.0, and Powered UP protocols.

You can’t perform that action at this time.