node-poweredup/src/lpf2hub.ts
Nathan Kellenicki 2797081091
Merge pull request #33 from nutki/pr-1
allow RGB led control for the duplo train hub
2019-11-10 12:19:48 -08:00

595 lines
22 KiB
TypeScript

import { Peripheral } from "@abandonware/noble";
import { Hub } from "./hub";
import { Port } from "./port";
import * as Consts from "./consts";
import Debug = require("debug");
const debug = Debug("lpf2hub");
const modeInfoDebug = Debug("lpf2hubmodeinfo");
/**
* @class LPF2Hub
* @extends Hub
*/
export class LPF2Hub extends Hub {
private static decodeVersion(v: number) {
const t = v.toString(16).padStart(8, "0");
return [t[0], t[1], t.substring(2, 4), t.substring(4)].join(".");
}
protected _ledPort: number = 0x32;
private _lastTiltX: number = 0;
private _lastTiltY: number = 0;
private _lastTiltZ: number = 0;
private _messageBuffer: Buffer = Buffer.alloc(0);
public connect () {
return new Promise(async (resolve, reject) => {
await super.connect();
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.LPF2_HUB);
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.LPF2_ALL, this._parseMessage.bind(this));
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x02, 0x02])); // Activate button reports
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x03, 0x05])); // Request firmware version
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x06, 0x02])); // Activate battery level reports
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x3c, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01])); // Activate voltage reports
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x3b, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01])); // Activate current reports
if (this.type === Consts.HubType.DUPLO_TRAIN_HUB) {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x01, 0x01, 0x01, 0x00, 0x00, 0x00, 0x01]));
}
this.emit("connect");
resolve();
setTimeout(() => {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x03, 0x05])); // Request firmware version again
}, 200);
});
}
/**
* Shutdown the Hub.
* @method LPF2Hub#shutdown
* @returns {Promise} Resolved upon successful disconnect.
*/
public shutdown () {
return new Promise((resolve, reject) => {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x02, 0x01]), () => {
return resolve();
});
});
}
/**
* Set the name of the Hub.
* @method LPF2Hub#setName
* @param {string} name New name of the hub (14 characters or less, ASCII only).
* @returns {Promise} Resolved upon successful issuance of command.
*/
public setName (name: string) {
if (name.length > 14) {
throw new Error("Name must be 14 characters or less");
}
return new Promise((resolve, reject) => {
let data = Buffer.from([0x01, 0x01, 0x01]);
data = Buffer.concat([data, Buffer.from(name, "ascii")]);
// Send this twice, as sometimes the first time doesn't take
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
this._name = name;
return resolve();
});
}
/**
* Set the color of the LED on the Hub via a color value.
* @method LPF2Hub#setLEDColor
* @param {Color} color
* @returns {Promise} Resolved upon successful issuance of command.
*/
public setLEDColor (color: number | boolean) {
return new Promise((resolve, reject) => {
let data = Buffer.from([0x41, this._ledPort, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00]);
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
if (typeof color === "boolean") {
color = 0;
}
data = Buffer.from([0x81, this._ledPort, 0x11, 0x51, 0x00, color]);
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
return resolve();
});
}
/**
* Set the color of the LED on the Hub via RGB values.
* @method LPF2Hub#setLEDRGB
* @param {number} red
* @param {number} green
* @param {number} blue
* @returns {Promise} Resolved upon successful issuance of command.
*/
public setLEDRGB (red: number, green: number, blue: number) {
return new Promise((resolve, reject) => {
let data = Buffer.from([0x41, this._ledPort, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00]);
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
data = Buffer.from([0x81, this._ledPort, 0x11, 0x51, 0x01, red, green, blue]);
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
return resolve();
});
}
public sendRaw (message: Buffer) {
return new Promise((resolve, reject) => {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, message, () => {
return resolve();
});
});
}
protected _activatePortDevice (port: number, type: number, mode: number, format: number, callback?: () => void) {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, port, mode, 0x01, 0x00, 0x00, 0x00, 0x01]), callback);
}
protected _deactivatePortDevice (port: number, type: number, mode: number, format: number, callback?: () => void) {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, port, mode, 0x01, 0x00, 0x00, 0x00, 0x00]), callback);
}
protected _writeMessage (uuid: string, message: Buffer, callback?: () => void) {
message = Buffer.concat([Buffer.alloc(2), message]);
message[0] = message.length;
debug("Sent Message (LPF2_ALL)", message);
this._bleDevice.writeToCharacteristic(uuid, message, callback);
}
protected _combinePorts (port: string, type: number) {
if (!this._ports[port]) {
return;
}
const portObj = this._portLookup(port);
if (portObj) {
Object.keys(this._ports).forEach((id) => {
if (this._ports[id].type === type && this._ports[id].value !== portObj.value && !this._virtualPorts[`${portObj.value < this._ports[id].value ? portObj.id : this._ports[id].id}${portObj.value > this._ports[id].value ? portObj.id : this._ports[id].id}`]) {
debug("Combining ports", portObj.value < this._ports[id].value ? portObj.id : id, portObj.value > this._ports[id].value ? portObj.id : id);
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x61, 0x01, portObj.value < this._ports[id].value ? portObj.value : this._ports[id].value, portObj.value > this._ports[id].value ? portObj.value : this._ports[id].value]));
}
});
}
}
protected _checkFirmware (version: string) {
return;
}
private _parseMessage (data?: Buffer) {
if (data) {
this._messageBuffer = Buffer.concat([this._messageBuffer, data]);
}
if (this._messageBuffer.length <= 0) {
return;
}
const len = this._messageBuffer[0];
if (len >= this._messageBuffer.length) {
const message = this._messageBuffer.slice(0, len);
this._messageBuffer = this._messageBuffer.slice(len);
debug("Received Message (LPF2_ALL)", message);
switch (message[2]) {
case 0x01: {
this._parseDeviceInfo(message);
break;
}
case 0x04: {
this._parsePortMessage(message);
break;
}
case 0x43: {
this._parsePortInformationResponse(message);
break;
}
case 0x44: {
this._parseModeInformationResponse(message);
break;
}
case 0x45: {
this._parseSensorMessage(message);
break;
}
case 0x82: {
this._parsePortAction(message);
break;
}
}
if (this._messageBuffer.length > 0) {
this._parseMessage();
}
}
}
private _parseDeviceInfo (data: Buffer) {
// Button press reports
if (data[3] === 0x02) {
if (data[5] === 1) {
/**
* Emits when a button is pressed.
* @event LPF2Hub#button
* @param {string} button
* @param {ButtonState} state
*/
this.emit("button", "GREEN", Consts.ButtonState.PRESSED);
return;
} else if (data[5] === 0) {
this.emit("button", "GREEN", Consts.ButtonState.RELEASED);
return;
}
// Firmware version
} else if (data[3] === 0x03) {
this._firmwareVersion = LPF2Hub.decodeVersion(data.readInt32LE(5));
this._checkFirmware(this._firmwareVersion);
// Battery level reports
} else if (data[3] === 0x06) {
this._batteryLevel = data[5];
}
}
private _parsePortMessage (data: Buffer) {
let port = this._getPortForPortNumber(data[3]);
if (data[4] === 0x01) {
this._sendPortInformationRequest(data[3]);
}
if (!port) {
if (data[4] === 0x02) {
const portA = this._getPortForPortNumber(data[7]);
const portB = this._getPortForPortNumber(data[8]);
if (portA && portB) {
this._virtualPorts[`${portA.id}${portB.id}`] = new Port(`${portA.id}${portB.id}`, data[3]);
port = this._getPortForPortNumber(data[3]);
if (port) {
port.connected = true;
this._registerDeviceAttachment(port, data[5]);
} else {
return;
}
} else {
return;
}
} else {
return;
}
} else {
port.connected = (data[4] === 0x01 || data[4] === 0x02) ? true : false;
this._registerDeviceAttachment(port, data[5]);
}
}
private _sendPortInformationRequest (port: number) {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x21, port, 0x01]));
}
private _parsePortInformationResponse (data: Buffer) {
const port = data[3];
const count = data[6];
const input = data.readUInt16LE(7);
const output = data.readUInt16LE(9);
modeInfoDebug(`Port ${port}, total modes ${count}, input modes ${input.toString(2)}, output modes ${output.toString(2)}`);
for (let i = 0; i < count; i++) {
this._sendModeInformationRequest(port, i, 0x00); // Mode Name
this._sendModeInformationRequest(port, i, 0x01); // RAW Range
this._sendModeInformationRequest(port, i, 0x02); // PCT Range
this._sendModeInformationRequest(port, i, 0x03); // SI Range
this._sendModeInformationRequest(port, i, 0x04); // SI Symbol
}
}
private _sendModeInformationRequest (port: number, mode: number, type: number) {
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x22, port, mode, type]));
}
private _parseModeInformationResponse (data: Buffer) {
const port = data[3];
const mode = data[4];
const type = data[5];
switch (type) {
case 0x00: // Mode Name
modeInfoDebug(`Port ${port}, mode ${mode}, name ${data.slice(6, data.length).toString()}`);
break;
case 0x01: // RAW Range
modeInfoDebug(`Port ${port}, mode ${mode}, RAW min ${data.readFloatLE(6)}, max ${data.readFloatLE(10)}`);
break;
case 0x02: // PCT Range
modeInfoDebug(`Port ${port}, mode ${mode}, PCT min ${data.readFloatLE(6)}, max ${data.readFloatLE(10)}`);
break;
case 0x03: // SI Range
modeInfoDebug(`Port ${port}, mode ${mode}, SI min ${data.readFloatLE(6)}, max ${data.readFloatLE(10)}`);
break;
case 0x04: // SI Symbol
modeInfoDebug(`Port ${port}, mode ${mode}, SI symbol ${data.slice(6, data.length).toString()}`);
break;
}
}
private _parsePortAction (data: Buffer) {
const port = this._getPortForPortNumber(data[3]);
if (!port) {
return;
}
if (data[4] === 0x0a) {
port.busy = false;
if (port.finished) {
port.finished();
port.finished = null;
}
}
}
private _padMessage (data: Buffer, len: number) {
if (data.length < len) {
data = Buffer.concat([data, Buffer.alloc(len - data.length)]);
}
return data;
}
private _parseSensorMessage (data: Buffer) {
if ((data[3] === 0x3b && this.type === Consts.HubType.POWERED_UP_REMOTE)) { // Voltage (PUP Remote)
data = this._padMessage(data, 6);
const voltage = data.readUInt16LE(4);
this._voltage = 6400.0 * voltage / 3200.0 / 1000.0;
return;
} else if ((data[3] === 0x3c && this.type === Consts.HubType.POWERED_UP_HUB)) { // Voltage (PUP Hub)
data = this._padMessage(data, 6);
const voltage = data.readUInt16LE(4);
this._voltage = 9620.0 * voltage / 3893.0 / 1000.0;
return;
} else if ((data[3] === 0x3c && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Voltage (Control+ Hub)
data = this._padMessage(data, 6);
const voltage = data.readUInt16LE(4);
this._voltage = 9615.0 * voltage / 4095.0 / 1000.0;
return;
} else if (data[3] === 0x3c) { // Voltage (Others)
data = this._padMessage(data, 6);
const voltage = data.readUInt16LE(4);
this._voltage = 9600.0 * voltage / 3893.0 / 1000.0;
return;
} else if (data[3] === 0x3c && this.type === Consts.HubType.POWERED_UP_REMOTE) { // RSSI (PUP Remote)
return;
} else if (data[3] === 0x3b) { // Current (Others)
data = this._padMessage(data, 6);
const current = data.readUInt16LE(4);
this._current = 2444 * current / 4095.0;
return;
}
if ((data[3] === 0x62 && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Control+ Accelerometer
const accelX = Math.round((data.readInt16LE(4) / 28571) * 2000);
const accelY = Math.round((data.readInt16LE(6) / 28571) * 2000);
const accelZ = Math.round((data.readInt16LE(8) / 28571) * 2000);
/**
* Emits when accelerometer detects movement. Measured in DPS - degrees per second.
* @event LPF2Hub#accel
* @param {string} port
* @param {number} x
* @param {number} y
* @param {number} z
*/
this.emit("accel", "ACCEL", accelX, accelY, accelZ);
return;
}
if ((data[3] === 0x63 && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Control+ Accelerometer
const tiltZ = data.readInt16LE(4);
const tiltY = data.readInt16LE(6);
const tiltX = data.readInt16LE(8);
this._lastTiltX = tiltX;
this._lastTiltY = tiltY;
this._lastTiltZ = tiltZ;
this.emit("tilt", "TILT", this._lastTiltX, this._lastTiltY, this._lastTiltZ);
return;
}
if ((data[3] === 0x3d && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Control+ CPU Temperature
/**
* Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.
* @event LPF2Hub#temp
* @param {string} port For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.
* @param {number} temp
*/
this.emit("temp", "CPU", ((data.readInt16LE(4) / 900) * 90).toFixed(2));
return;
}
const port = this._getPortForPortNumber(data[3]);
if (!port) {
return;
}
if (port && port.connected) {
switch (port.type) {
case Consts.DeviceType.WEDO2_DISTANCE: {
let distance = data[4];
if (data[5] === 1) {
distance = data[4] + 255;
}
/**
* Emits when a distance sensor is activated.
* @event LPF2Hub#distance
* @param {string} port
* @param {number} distance Distance, in millimeters.
*/
this.emit("distance", port.id, distance * 10);
break;
}
case Consts.DeviceType.BOOST_DISTANCE: {
/**
* Emits when a color sensor is activated.
* @event LPF2Hub#color
* @param {string} port
* @param {Color} color
*/
if (data[4] <= 10) {
this.emit("color", port.id, data[4]);
}
let distance = data[5];
const partial = data[7];
if (partial > 0) {
distance += 1.0 / partial;
}
distance = Math.floor(distance * 25.4) - 20;
this.emit("distance", port.id, distance);
/**
* A combined color and distance event, emits when the sensor is activated.
* @event LPF2Hub#colorAndDistance
* @param {string} port
* @param {Color} color
* @param {number} distance Distance, in millimeters.
*/
if (data[4] <= 10) {
this.emit("colorAndDistance", port.id, data[4], distance);
}
break;
}
case Consts.DeviceType.WEDO2_TILT: {
const tiltX = data[4] > 160 ? data[4] - 255 : data[4] - (data[4] * 2);
const tiltY = data[5] > 160 ? 255 - data[5] : data[5] - (data[5] * 2);
this._lastTiltX = tiltX;
this._lastTiltY = tiltY;
/**
* Emits when a tilt sensor is activated.
* @event LPF2Hub#tilt
* @param {string} port If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.
* @param {number} x
* @param {number} y
* @param {number} z (Only available when using a Control+ Hub)
*/
this.emit("tilt", port.id, this._lastTiltX, this._lastTiltY, this._lastTiltZ);
break;
}
case Consts.DeviceType.BOOST_TACHO_MOTOR: {
const rotation = data.readInt32LE(4);
/**
* Emits when a rotation sensor is activated.
* @event LPF2Hub#rotate
* @param {string} port
* @param {number} rotation
*/
this.emit("rotate", port.id, rotation);
break;
}
case Consts.DeviceType.BOOST_MOVE_HUB_MOTOR: {
const rotation = data.readInt32LE(4);
this.emit("rotate", port.id, rotation);
break;
}
case Consts.DeviceType.CONTROL_PLUS_LARGE_MOTOR: {
const rotation = data.readInt32LE(4);
this.emit("rotate", port.id, rotation);
break;
}
case Consts.DeviceType.CONTROL_PLUS_XLARGE_MOTOR: {
const rotation = data.readInt32LE(4);
this.emit("rotate", port.id, rotation);
break;
}
case Consts.DeviceType.BOOST_TILT: {
const tiltX = data[4] > 160 ? data[4] - 255 : data[4];
const tiltY = data[5] > 160 ? 255 - data[5] : data[5] - (data[5] * 2);
this._lastTiltX = tiltX;
this._lastTiltY = tiltY;
this.emit("tilt", port.id, this._lastTiltX, this._lastTiltY, this._lastTiltZ);
break;
}
case Consts.DeviceType.POWERED_UP_REMOTE_BUTTON: {
switch (data[4]) {
case 0x01: {
this.emit("button", port.id, Consts.ButtonState.UP);
break;
}
case 0xff: {
this.emit("button", port.id, Consts.ButtonState.DOWN);
break;
}
case 0x7f: {
this.emit("button", port.id, Consts.ButtonState.STOP);
break;
}
case 0x00: {
this.emit("button", port.id, Consts.ButtonState.RELEASED);
break;
}
}
break;
}
case Consts.DeviceType.DUPLO_TRAIN_BASE_COLOR: {
if (data[4] <= 10) {
this.emit("color", port.id, data[4]);
}
break;
}
case Consts.DeviceType.DUPLO_TRAIN_BASE_SPEEDOMETER: {
/**
* Emits on a speed change.
* @event LPF2Hub#speed
* @param {string} port
* @param {number} speed
*/
const speed = data.readInt16LE(4);
this.emit("speed", port.id, speed);
break;
}
}
}
}
}