New build with PRs

Rename tiltCount to impactCount for consistency

.drone.yml

@@ -1,14 +1,15 @@
 pipeline:
 
   install:
-    image: node:10.15.1
+    image: node:20.12.2
     commands:
       - apt-get update
       - apt-get install -y bluetooth bluez libbluetooth-dev libudev-dev
+      - git submodule update --init --recursive
       - npm install
 
   build:
-    image: node:10.15.1
+    image: node:20.12.2
     commands:
       - npm run all
 

.jsdoc.json

@@ -1,9 +1,15 @@
 {
     "tags": {
-        "allowUnknownTags": true
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc"]
+    },
+    "source": {
+        "include": [ "README.md", "dist/node" ],
+        "includePattern": ".js$"
     },
     "plugins": ["plugins/markdown"],
     "templates": {
+        "referenceTitle": "node-poweredup Reference",
         "logoFile": "",
         "cleverLinks": false,
         "monospaceLinks": false,
@@ -24,5 +30,11 @@
     "markdown": {
         "parser": "gfm",
         "hardwrap": true
+    },
+    "opts": {
+        "destination": "./docs/",
+        "encoding": "utf8",
+        "private": true,
+        "recurse": true
     }
 }

README.md

@@ -1,29 +1,79 @@
 [![Drone](https://drone.kellenicki.com/api/badges/nkellenicki/node-poweredup/status.svg)](https://drone.kellenicki.com/nkellenicki/node-poweredup)
 [![NPM Version](https://img.shields.io/npm/v/node-poweredup.svg?style=flat)](https://www.npmjs.com/package/node-poweredup)
+[![Docs](https://img.shields.io/badge/docs-start%20here-yellowgreen.svg)](https://nathan.kellenicki.com/node-poweredup/)
 
 # **node-poweredup** - A Javascript module to interface with LEGO Powered Up components.
 
 ### Announcements
 
-*Important*: v6.0.0 is a complete re-architecting of this library. Improvements include proper device and mode support through an external Device object, correct handling of firmware features, and promise-based functionality for interfacing with device attachments. Although many new features were added, existing code will almost surely break upon upgrade.
+* v7.1.0 adds support for SPIKE Essential, including the Technic Small Hub, Technic Small Angular Motor, and Technic 3x3 Color Matrix.
 
 ### 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 Education WeDo 2.0 released in 2016, LEGO Boost released in 2017, LEGO Powered Up released in 2018, LEGO Technic CONTROL+ released in 2019, and LEGO Education SPIKE Prime released in 2020. It also includes the 2018 Duplo App-Controlled Train sets.
+LEGO Powered Up is the successor to Power Functions, the system for adding electronics to LEGO models. Powered Up is a collection of ranges, all of which are compatible with each other:
+
+* LEGO Education WeDo 2.0
+* LEGO Boost
+* LEGO Powered Up
+* LEGO Technic CONTROL+
+* LEGO Education SPIKE Prime
+* LEGO Education SPIKE Essential
+* LEGO Mindstorms Robot Inventor
+
+Other products that speak the Powered Up protocol include the Duplo App-Controlled trains and LEGO Super Mario, both of which are compatible with this library.
 
 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.
 
+### Sample Usage
+
+```javascript
+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
+    const motorA = await hub.waitForDeviceAtPort("A"); // Make sure a motor is plugged into port A
+    const motorB = await hub.waitForDeviceAtPort("B"); // Make sure a motor is plugged into port B
+    console.log("Connected");
+
+    while (true) { // Repeat indefinitely
+        console.log("Running motor B at speed 50");
+        motorB.setPower(50); // 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");
+        motorA.setPower(100); // Run a motor attached to port A for 2 seconds at maximum speed (100) then stop
+        await hub.sleep(2000);
+        motorA.brake();
+        await hub.sleep(1000); // Do nothing for 1 second
+        console.log("Running motor A at speed -30 for 1 second");
+        motorA.setPower(-30); // Run a motor attached to port A for 2 seconds at 1/2 speed in reverse (-50) then stop
+        await hub.sleep(2000);
+        motorA.brake();
+        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.
+
+### Documentation
+
+[Full documentation is available here.](https://nathankellenicki.github.io/node-poweredup/)
+
 ### Node.js Installation
 
-Node.js v8.0+ required.
+Node.js v12.0+ required.
 
 ```javascript
 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](https://github.com/noble/noble#prerequisites).
+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](https://github.com/abandonware/noble#prerequisites).
 
-Note: node-poweredup has been tested on macOS 10.15 and Debian/Raspbian on the Raspberry Pi 3 Model B.
+Note: node-poweredup has been tested on macOS 11.0 and Debian/Raspbian on the Raspberry Pi 3 Model B.
 
 ### Compatibility
 
@@ -40,11 +90,13 @@ While most Powered Up components and Hubs are compatible with each other, there
 | Powered Up LED Lights           | <a href="https://brickset.com/sets/88005-1/">88005</a>        | Light         |       Yes      |     Yes    |     Yes    | Yes | <a href="https://brickset.com/sets/88005-1/">88005</a> |
 | Control+ Large Motor            | 22169        | Motor/Sensor  |       *Partial*      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/42099-1/">42099</a><br /><a href="https://brickset.com/sets/42100-1/">42100</a> |
 | Control+ XLarge Motor            | 22172        | Motor/Sensor  |       *Partial*      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/42099-1/">42099</a><br /><a href="https://brickset.com/sets/42100-1/">42100</a> |
-| SPIKE Prime Medium Motor            | 45678        | Motor/Sensor  |       *Partial*      |     Yes    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
+| SPIKE Prime Medium Motor            | 45678        | Motor/Sensor  |       *Partial*      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
-| SPIKE Prime Large Motor            | 45678        | Motor/Sensor  |       *Partial*      |     Yes    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
+| SPIKE Prime Large Motor            | 45678        | Motor/Sensor  |       *Partial*      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
-| SPIKE Prime Color Sensor            | 45678        | Motor/Sensor  |       *Partial*      |     Yes    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
+| SPIKE Prime Color Sensor            | 45678        | Sensor  |       No      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
-| SPIKE Prime Distance Sensor            | 45678        | Motor/Sensor  |       *Partial*      |     Yes    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
+| SPIKE Prime Distance Sensor            | 45678        | Sensor  |       No      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
-| SPIKE Prime Force Sensor            | 45678        | Motor/Sensor  |       *Partial*      |     Yes    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
+| SPIKE Prime Force Sensor            | 45678        | Sensor  |       *Partial*      |     Yes    |     Yes    | Yes | <a href="https://brickset.com/sets/45678-1/">45678</a> |
+| SPIKE Essential Small Motor            | 45607        | Motor/Sensor  |       *Partial*      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/45345-1/">45345</a> |
+| SPIKE Essential 3x3 Color Matrix            | 45608        | Motor/Sensor  |       *Partial*      |     No    |     Yes    | Yes | <a href="https://brickset.com/sets/45345-1/">45345</a> |
 
 
 In addition, the Hubs themselves have certain built-in features which this library exposes.
@@ -57,55 +109,18 @@ In addition, the Hubs themselves have certain built-in features which this libra
 | Powered Up Remote  | <a href="https://brickset.com/sets/88010-1/">88010</a> | RGB LED<br />Left and Right Control Buttons<br />Button                 | <a href="https://brickset.com/sets/60197-1/">60197</a><br /><a href="https://brickset.com/sets/60198-1/">60198</a> |
 | Duplo Train Base   | 28743 | RGB LED/Headlights<br />Speaker<br />Speedometer<br />Motor<br />Color and Distance Sensor<br />Button | <a href="https://brickset.com/sets/10874-1/">10874</a><br /><a href="https://brickset.com/sets/10875-1/">10875</a> |
 | Control+ Hub     | 22127 | RGB LED<br />Button<br />Tilt Sensor<br />Accelerometer                                                     | <a href="https://brickset.com/sets/42099-1/">42099</a><br /><a href="https://brickset.com/sets/42100-1/">42100</a> |
+| Super Mario     | 71360 | Pants Sensor<br />Barcode and Color Sensor | <a href="https://brickset.com/sets/71360-1/">71360</a> |
+| SPIKE Essential Hub     | 45609 | RGB LED<br />Button<br />Tilt Sensor<br />Accelerometer                                                     | <a href="https://brickset.com/sets/45345-1/">45345</a> |
 
 ### Known Issues and Limitations
 
-* The Boost Color and Distance sensor only works in color mode with the WeDo 2.0 Smart Hub.
+* The WeDo 2.0 Smart Hub uses an older firmware which is no longer being updated. As a result, only certain motors and sensors work with it. See the table above.
 
-* When used with the WeDo 2.0 Smart Hub, the Boost Tacho Motor and Control+ Motors do not support rotating the motor by angle.
+* When used with the Boost Move Hub, the Control+ Motors and SPIKE Prime Motors/Sensors do not currently accept commands (This is a known bug which requires a firmware update from Lego to fix)
 
-* When used with the Boost Move Hub, the Control+ Motors do not currently accept commands.
+* The SPIKE Prime Hub does not use Bluetooth Low Energy, so is not supported via this library. It is recommended you use MicroPython to develop for this Hub using the officially provided tools and software. The SPIKE Essential Hub however is supported, as it uses Bluetooth Low Energy.
 
-* The SPIKE Prime Hub does not use Bluetooth Low Energy, so is not supported via this library. It is recommended you use MicroPython and Bluetooth Classic to develop for this Hub.
+* On most Unix systems, you need root permissions to access Bluetooth devices. You may want to [grant the node executable access to the Bluetooth adapter](https://github.com/abandonware/noble#running-without-rootsudo-linux-specific)
-
-### Documentation
-
-[Full documentation is available here.](https://nathankellenicki.github.io/node-poweredup/)
-
-### Node.js Sample Usage
-
-```javascript
-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
-    const motorA = hub.waitForDeviceAtPort("A"); // Make sure a motor is plugged into port A
-    const motorB = hub.waitForDeviceAtPort("B"); // Make sure a motor is plugged into port B
-    console.log("Connected");
-
-    while (true) { // Repeat indefinitely
-        console.log("Running motor B at speed 75");
-        motorB.setPower("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");
-        motorA.setPower("A", 100); // Run a motor attached to port A for 2 seconds at maximum speed (100) then stop
-        await hub.sleep(2000);
-        motorA.setPower("A", 0);
-        await hub.sleep(1000); // Do nothing for 1 second
-        console.log("Running motor A at speed -50 for 1 second");
-        motorA.setPower("A", -50); // Run a motor attached to port A for 1 second at 1/2 speed in reverse (-50) then stop
-        hub.sleep(1000);
-        motorA.setPower("A", 0);
-        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