Increased speed of vernie

.gitignore

@@ -1,4 +1,6 @@
 node_modules/
 dist/
+coverage/
 .vscode/
 *.tgz
+.DS_Store

.npmignore

@@ -1,17 +1,5 @@
-boostmovehub.ts
+src/
-consts.ts
-duplotrainbase.ts
-hub.ts
-index.ts
-lpf2hub.ts
-port.ts
-poweredup.ts
-puphub.ts
-pupremote.ts
-package-lock.json
-tsconfig.json
-tslint.json
-utils.ts
-wedo2smarthub.ts
 .vscode/
 examples/
+coverage/
+.DS_Store

examples/vernie_remote.js

@@ -31,12 +31,12 @@ poweredUP.on("discover", async (hub) => { // Wait to discover Vernie and Remote
                 switch (state) {
                     case PoweredUP.Consts.ButtonState.UP: // If up is pressed, move the track forward
                     {
-                        vernie.setMotorSpeed(button === "LEFT" ? "A" : "B", 50);
+                        vernie.setMotorSpeed(button === "LEFT" ? "A" : "B", 65);
                         break;
                     }
                     case PoweredUP.Consts.ButtonState.DOWN: // If down is pressed, move the track backwards
                     {
-                        vernie.setMotorSpeed(button === "LEFT" ? "A" : "B", -50);
+                        vernie.setMotorSpeed(button === "LEFT" ? "A" : "B", -65);
                         break;
                     }
                     case PoweredUP.Consts.ButtonState.RELEASED: // Stop the track when the button is released

jest.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+    preset: "ts-jest",
+    testEnvironment: "node",
+    collectCoverage: true,
+    roots: [
+      "<rootDir>/src"
+    ],
+    transform: {
+        "^.+\\.tsx?$": "ts-jest"
+    },
+    testRegex: "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+    moduleFileExtensions: [
+        "ts",
+        "tsx",
+        "js",
+        "jsx",
+        "json",
+        "node"
+    ]
+};

package.json

@@ -6,11 +6,12 @@
     "main": "dist/node/index-node.js",
     "types": "dist/node/index-node.d.ts",
     "scripts": {
+        "test": "jest",
         "build:node": "tslint -c tslint.json \"./src/*.ts\" && tsc",
         "build:browser": "tslint -c tslint.json \"./src/*.ts\" && webpack --mode=production",
         "build:all": "tslint -c tslint.json \"./src/*.ts\" && tsc && webpack --mode=production",
         "docs": "jsdoc -d docs -c jsdoc.conf.json -t ./node_modules/ink-docstrap/template -R README.md dist/node/consts.js dist/node/poweredup-node.js dist/node/lpf2hub.js dist/node/wedo2smarthub.js dist/node/boostmovehub.js dist/node/puphub.js dist/node/pupremote.js dist/node/duplotrainbase.js dist/node/hub.js dist/node/consts.js",
-    "all": "npm run build:all && npm run docs",
+        "all": "npm run test && npm run build:all && npm run docs",
         "prepublishOnly": "npm run build:node"
     },
     "author": "Nathan Kellenicki <nathan@kellenicki.com>",
@@ -22,12 +23,15 @@
     },
     "devDependencies": {
         "@types/debug": "0.0.31",
+        "@types/jest": "^24.0.11",
         "@types/noble": "0.0.38",
         "@types/node": "^10.12.21",
         "@types/web-bluetooth": "0.0.4",
         "ink-docstrap": "^1.3.2",
+        "jest": "^24.7.1",
         "jsdoc": "^3.5.5",
         "jsdoc-to-markdown": "^4.0.1",
+        "ts-jest": "^24.0.1",
         "ts-loader": "^5.3.3",
         "tslint": "^5.12.1",
         "typescript": "^3.3.1",

src/__tests__/boostmovehub.test.ts

@@ -0,0 +1,64 @@
+import * as Consts from "../consts";
+import { BoostMoveHub } from "../boostmovehub";
+import { TestDevice } from "../testdevice";
+
+const device = new TestDevice()
+const hub = new BoostMoveHub(device);
+
+
+beforeAll((done) => {
+    device.on("discoverComplete", async () => {
+        await hub.connect();
+        device.clearOutbox(Consts.BLECharacteristic.LPF2_ALL);
+        done();
+    });
+});
+
+
+afterAll(async (done) => {
+    await hub.disconnect();
+    done();
+});
+
+
+test("Set motor speed", async (done) => {
+    hub.setMotorSpeed("A", 52);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x37, 0x11, 0x51, 0x00, 0x34]));
+    done();
+});
+
+
+test("Set motor speed for specific amount of time", async (done) => {
+    hub.setMotorSpeed("A", 52, 3000);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x37, 0x11, 0x51, 0x00, 0x34]));
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x37, 0x11, 0x51, 0x00, 0x00]));
+    done();
+});
+
+
+test("Brake a motor", async (done) => {
+    hub.brakeMotor("A");
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x37, 0x11, 0x51, 0x00, 0x7f]));
+    done();
+});
+
+
+test("Attempt to set two speeds on a port that only accepts one", async (done) => {
+    expect(() => hub.setMotorSpeed("A", [52, 32])).toThrow("Port A can only accept a single speed");
+    done();
+});
+
+
+test("Set light brightness", async (done) => {
+    hub.setLightBrightness("B", 74);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x38, 0x11, 0x51, 0x00, 0x4a]));
+    done();
+});
+
+
+test("Set light brightness for specific amount of time", async (done) => {
+    hub.setLightBrightness("B", 74, 2000);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x38, 0x11, 0x51, 0x00, 0x4a]));
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x38, 0x11, 0x51, 0x00, 0x00]));
+    done();
+});

src/__tests__/puphub.test.ts

@@ -0,0 +1,64 @@
+import * as Consts from "../consts";
+import { PUPHub } from "../puphub";
+import { TestDevice } from "../testdevice";
+
+const device = new TestDevice()
+const hub = new PUPHub(device);
+
+
+beforeAll((done) => {
+    device.on("discoverComplete", async () => {
+        await hub.connect();
+        device.clearOutbox(Consts.BLECharacteristic.LPF2_ALL);
+        done();
+    });
+});
+
+
+afterAll(async (done) => {
+    await hub.disconnect();
+    done();
+});
+
+
+test("Set motor speed", async (done) => {
+    hub.setMotorSpeed("A", 52);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x34, 0x00, 0x00]));
+    done();
+});
+
+
+test("Set motor speed for specific amount of time", async (done) => {
+    hub.setMotorSpeed("A", 52, 3000);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x34, 0x00, 0x00]));
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x00, 0x00, 0x00]));
+    done();
+});
+
+
+test("Brake a motor", async (done) => {
+    hub.brakeMotor("A");
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x00, 0x11, 0x60, 0x00, 0x7f, 0x00, 0x00]));
+    done();
+});
+
+
+test("Attempt to set two speeds on a port that only accepts one", async (done) => {
+    expect(() => hub.setMotorSpeed("A", [52, 32])).toThrow("Port A can only accept a single speed");
+    done();
+});
+
+
+test("Set light brightness", async (done) => {
+    hub.setLightBrightness("B", 74);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x01, 0x11, 0x51, 0x00, 0x4a]));
+    done();
+});
+
+
+test("Set light brightness for specific amount of time", async (done) => {
+    hub.setLightBrightness("B", 74, 2000);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x01, 0x11, 0x51, 0x00, 0x4a]));
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x01, 0x11, 0x51, 0x00, 0x00]));
+    done();
+});

src/__tests__/pupremote.test.ts

@@ -0,0 +1,66 @@
+import * as Consts from "../consts";
+import { PUPRemote } from "../pupremote";
+import { TestDevice } from "../testdevice";
+
+const device = new TestDevice()
+const remote = new PUPRemote(device);
+
+
+beforeAll((done) => {
+    device.on("discoverComplete", async () => {
+        await remote.connect();
+        device.postToInbox(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x06, 0x00, 0x01, 0x02, 0x06, 0x00]));
+        device.postToInbox(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x0f, 0x00, 0x04, 0x00, 0x01, 0x37, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x10]));
+        device.postToInbox(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x0f, 0x00, 0x04, 0x01, 0x01, 0x37, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x10]));
+        device.clearOutbox(Consts.BLECharacteristic.LPF2_ALL);
+        done();
+    });
+});
+
+
+afterAll(async (done) => {
+    await remote.disconnect();
+    done();
+});
+
+
+test("Set LED color via discrete value", async (done) => {
+    remote.setLEDColor(Consts.Color.BLUE);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x41, 0x34, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00]));
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x34, 0x11, 0x51, 0x00, 0x03]));
+    done();
+});
+
+
+test("Turn off LED", async (done) => {
+    remote.setLEDColor(false);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x41, 0x34, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00]));
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x08, 0x00, 0x81, 0x34, 0x11, 0x51, 0x00, 0x00]));
+    done();
+});
+
+
+test("Set LED color via RGB values", async (done) => {
+    remote.setLEDRGB(127, 32, 233);
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x41, 0x34, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00]));
+    expect(await device.readFromOutbox(Consts.BLECharacteristic.LPF2_ALL)).toEqual(Buffer.from([0x0a, 0x00, 0x81, 0x34, 0x11, 0x51, 0x01, 0x7f, 0x20, 0xe9]));
+    done();
+});
+
+
+test("Ensure buttons are correctly attached", async (done) => {
+    expect(remote.getPortDeviceType("LEFT")).toBe(Consts.DeviceType.POWERED_UP_REMOTE_BUTTON);
+    expect(remote.getPortDeviceType("RIGHT")).toBe(Consts.DeviceType.POWERED_UP_REMOTE_BUTTON);
+    done();
+});
+
+
+test("Ensure UP button press events are emitted", async (done) => {
+    remote.on("button", (button, state) => {
+        expect(button).toBe("LEFT");
+        expect(state).toBe(Consts.ButtonState.UP);
+        remote.removeAllListeners();
+        done();
+    });
+    device.postToInbox(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x05, 0x00, 0x45, 0x00, 0x01]));
+});

src/lpf2hub.ts

@@ -36,6 +36,9 @@ export class LPF2Hub extends Hub {
             if (this.type === Consts.HubType.DUPLO_TRAIN_HUB) {
                 this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x01, 0x01, 0x01, 0x00, 0x00, 0x00, 0x01]));
             }
+            setTimeout(() => {
+                this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x03, 0x05])); // Request firmware version again
+            }, 200);
         });
     }
 

src/puphub.ts

@@ -98,7 +98,7 @@ export class PUPHub extends LPF2Hub {
                     data = Buffer.from([0x81, portObj.value, 0x11, 0x02, this._mapSpeed(speed instanceof Array ? speed[0] : speed), this._mapSpeed(speed instanceof Array ? speed[1] : speed)]);
                 } else {
                     // @ts-ignore: The type of speed is properly checked at the start
-                    data = Buffer.from([0x81, portObj.value, 0x11, 0x60, 0x00, this._mapSpeed(speed), 0x00, 0x00]);
+                    data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, this._mapSpeed(speed)]);
                 }
                 this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
                 const timeout = global.setTimeout(() => {
@@ -118,7 +118,7 @@ export class PUPHub extends LPF2Hub {
                     data = Buffer.from([0x81, portObj.value, 0x11, 0x02, this._mapSpeed(speed instanceof Array ? speed[0] : speed), this._mapSpeed(speed instanceof Array ? speed[1] : speed)]);
                 } else {
                     // @ts-ignore: The type of speed is properly checked at the start
-                    data = Buffer.from([0x81, portObj.value, 0x11, 0x60, 0x00, this._mapSpeed(speed), 0x00, 0x00]);
+                    data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, this._mapSpeed(speed)]);
                 }
                 this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
                 return resolve();
@@ -149,6 +149,37 @@ export class PUPHub extends LPF2Hub {
     }
 
 
+
+    public setMotorAngle (port: string, angle: number, speed: number | [number, number] = 100) {
+        const portObj = this._portLookup(port);
+        if (!(portObj.type === Consts.DeviceType.BOOST_TACHO_MOTOR || portObj.type === Consts.DeviceType.BOOST_MOVE_HUB_MOTOR)) {
+            throw new Error("Angle rotation is only available when using a Boost Tacho Motor or Boost Move Hub Motor");
+        }
+        if (portObj.id !== "AB" && speed instanceof Array) {
+            throw new Error(`Port ${portObj.id} can only accept a single speed`);
+        }
+        portObj.cancelEventTimer();
+        return new Promise((resolve, reject) => {
+            portObj.busy = true;
+            let data = null;
+            if (portObj.id === "AB") {
+                data = Buffer.from([0x81, portObj.value, 0x11, 0x0c, 0x00, 0x00, 0x00, 0x00, this._mapSpeed(speed instanceof Array ? speed[0] : speed), this._mapSpeed(speed instanceof Array ? speed[1] : speed), 0x64, 0x7f, 0x03]);
+            } else {
+                // @ts-ignore: The type of speed is properly checked at the start
+                data = Buffer.from([0x81, portObj.value, 0x11, 0x0b, 0x00, 0x00, 0x00, 0x00, this._mapSpeed(speed), 0x64, 0x7f, 0x03]);
+            }
+            data.writeUInt32LE(angle, 4);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            portObj.finished = () => {
+                return resolve();
+            };
+        });
+    }
+
+
+
+
+
     /**
      * Fully (hard) stop the motor on a given port.
      * @method PUPHub#brakeMotor

src/testdevice.ts

@@ -0,0 +1,150 @@
+import Debug = require("debug");
+import { EventEmitter } from "events";
+import { IBLEDevice } from "./interfaces";
+const debug = Debug("testdevice");
+
+
+export class TestDevice extends EventEmitter implements IBLEDevice {
+
+    private _uuid: string;
+    private _name: string = "";
+
+    private _listeners: {[uuid: string]: any} = {};
+    private _characteristics: {[uuid: string]: any} = {};
+
+    private _queue: Promise<any> = Promise.resolve();
+    private _mailbox: Buffer[] = [];
+
+    private _outbox: {[uuid: string]: Buffer[]} = {};
+    private _outboxCallback: {[uuid: string]: () => void} = {};
+    private _inbox: {[uuid: string]: Buffer[]} = {};
+    private _inboxCallback: {[uuid: string]: (data: Buffer) => void} = {};
+
+    private _connected: boolean = false;
+    private _connecting: boolean = false;
+
+
+    constructor () {
+        super();
+        this._uuid = "test-device";
+        this._name = "Test Device";
+        setTimeout(() => {
+            this.emit("discoverComplete");
+        }, 2000);
+    }
+
+
+    public get uuid () {
+        return this._uuid;
+    }
+
+
+    public get name () {
+        return this._name;
+    }
+
+
+    public get connecting () {
+        return this._connecting;
+    }
+
+
+    public get connected () {
+        return this._connected;
+    }
+
+
+    public connect () {
+        return new Promise((resolve, reject) => {
+            this._connected = true;
+            return resolve();
+        });
+    }
+
+
+    public disconnect () {
+        return new Promise((resolve, reject) => {
+            return resolve();
+        });
+    }
+
+
+    public discoverCharacteristicsForService (uuid: string) {
+        return new Promise((resolve, reject) => {
+            return resolve();
+        });
+    }
+
+
+    public subscribeToCharacteristic (uuid: string, callback: (data: Buffer) => void) {
+        this._inbox[uuid] = this._inbox[uuid] || [];
+        if (this._inbox[uuid].length >= 1) {
+            // @ts-ignore
+            callback(this._inbox[uuid].shift());
+        }
+        this._inboxCallback[uuid] = (data) => {
+            callback(data);
+        };
+        return;
+    }
+
+
+    public addToCharacteristicMailbox (uuid: string, data: Buffer) {
+        this._mailbox.push(data);
+    }
+
+
+    public readFromCharacteristic (uuid: string, callback: (err: string | null, data: Buffer | null) => void) {
+        callback(null, Buffer.alloc(0));
+    }
+
+
+    public writeToCharacteristic (uuid: string, data: Buffer, callback?: () => void) {
+        this._outbox[uuid] = this._outbox[uuid] || [];
+        this._outbox[uuid].push(data);
+        if (this._outboxCallback[uuid]) {
+            this._outboxCallback[uuid]();
+            delete this._outboxCallback[uuid];
+        }
+        if (callback) {
+            callback();
+        }
+    }
+
+
+    public readFromOutbox (uuid: string) {
+        return new Promise((resolve, reject) => {
+            this._outbox[uuid] = this._outbox[uuid] || [];
+            if (this._outbox[uuid].length >= 1) {
+                return resolve(this._outbox[uuid].shift());
+            } else {
+                this._outboxCallback[uuid] = () => {
+                    return resolve(this._outbox[uuid].shift());
+                };
+            }
+        });
+    }
+
+
+    public postToInbox (uuid: string, data: Buffer) {
+        if (this._inboxCallback[uuid]) {
+            this._inboxCallback[uuid](data);
+        } else {
+            this._inbox[uuid] = this._inbox[uuid] || [];
+            this._inbox[uuid].push(data);
+        }
+    }
+
+
+    public clearOutbox (uuid: string) {
+        this._outbox[uuid] = [];
+        delete this._outboxCallback[uuid];
+    }
+
+
+    private _sanitizeUUID (uuid: string) {
+        return uuid.replace(/-/g, "");
+    }
+
+
+}