node-poweredup/src/boostmovehub.ts

216 lines
9.8 KiB
TypeScript

import { Peripheral } from "@abandonware/noble";
import compareVersion from "compare-versions";
import { IBLEAbstraction } from "./interfaces";
import { LPF2Hub } from "./lpf2hub";
import * as Consts from "./consts";
import Debug = require("debug");
const debug = Debug("boostmovehub");
/**
* The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
* @class BoostMoveHub
* @extends LPF2Hub
* @extends Hub
*/
export class BoostMoveHub extends LPF2Hub {
public static IsBoostMoveHub (peripheral: Peripheral) {
return (
peripheral.advertisement &&
peripheral.advertisement.serviceUuids &&
peripheral.advertisement.serviceUuids.indexOf(Consts.BLEService.LPF2_HUB.replace(/-/g, "")) >= 0 &&
peripheral.advertisement.manufacturerData &&
peripheral.advertisement.manufacturerData.length > 3 &&
peripheral.advertisement.manufacturerData[3] === Consts.BLEManufacturerData.BOOST_MOVE_HUB_ID
);
}
protected _currentPort = 0x3b;
protected _voltagePort = 0x3c;
constructor (device: IBLEAbstraction) {
super(device, Consts.HubType.BOOST_MOVE_HUB);
this._portNames = {
"A": 0,
"B": 1,
"C": 2,
"D": 3,
"TILT": 58
};
debug("Discovered Boost Move Hub");
}
public connect () {
return new Promise(async (resolve, reject) => {
debug("Connecting to Boost Move Hub");
await super.connect();
debug("Connect completed");
return resolve();
});
}
// /**
// * Set the motor speed on a given port.
// * @method BoostMoveHub#setMotorSpeed
// * @param {string} port
// * @param {number | Array.<number>} speed For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. If you are specifying port AB to control both motors, you can optionally supply a tuple of speeds.
// * @param {number} [time] How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely.
// * @returns {Promise} Resolved upon successful completion of command. If time is specified, this is once the motor is finished.
// */
// public setMotorSpeed (port: string, speed: number | [number, number], time?: number | boolean) {
// const portObj = this._portLookup(port);
// if (!this._virtualPorts[portObj.id] && speed instanceof Array) {
// throw new Error(`Port ${portObj.id} can only accept a single speed`);
// }
// let cancelEventTimer = true;
// if (typeof time === "boolean") {
// if (time === true) {
// cancelEventTimer = false;
// }
// time = undefined;
// }
// if (cancelEventTimer) {
// portObj.cancelEventTimer();
// }
// return new Promise((resolve, reject) => {
// if (time && typeof time === "number") {
// if (
// portObj.type === Consts.DeviceType.BOOST_TACHO_MOTOR ||
// portObj.type === Consts.DeviceType.BOOST_MOVE_HUB_MOTOR ||
// portObj.type === Consts.DeviceType.CONTROL_PLUS_LARGE_MOTOR ||
// portObj.type === Consts.DeviceType.CONTROL_PLUS_XLARGE_MOTOR
// ) {
// portObj.busy = true;
// let data = null;
// if (this._virtualPorts[portObj.id]) {
// data = Buffer.from([0x81, portObj.value, 0x11, 0x0a, 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, 0x09, 0x00, 0x00, this._mapSpeed(speed), 0x64, 0x7f, 0x03]);
// }
// data.writeUInt16LE(time > 65535 ? 65535 : time, 4);
// this.send(data, Consts.BLECharacteristic.LPF2_ALL);
// portObj.finished = () => {
// return resolve();
// };
// } else {
// // @ts-ignore: The type of speed is properly checked at the start
// const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, this._mapSpeed(speed)]);
// this.send(data, Consts.BLECharacteristic.LPF2_ALL);
// const timeout = global.setTimeout(() => {
// const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, 0x00]);
// this.send(data, Consts.BLECharacteristic.LPF2_ALL);
// return resolve();
// // @ts-ignore: The type of time is properly checked at the start
// }, time);
// portObj.setEventTimer(timeout);
// }
// } else {
// if (
// portObj.type === Consts.DeviceType.BOOST_TACHO_MOTOR ||
// portObj.type === Consts.DeviceType.BOOST_MOVE_HUB_MOTOR ||
// portObj.type === Consts.DeviceType.CONTROL_PLUS_LARGE_MOTOR ||
// portObj.type === Consts.DeviceType.CONTROL_PLUS_XLARGE_MOTOR
// ) {
// portObj.busy = true;
// let data = null;
// if (this._virtualPorts[portObj.id]) {
// data = Buffer.from([0x81, portObj.value, 0x11, 0x02, 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, 0x01, this._mapSpeed(speed), 0x64, 0x7f, 0x03]);
// }
// this.send(data, Consts.BLECharacteristic.LPF2_ALL);
// portObj.finished = () => {
// return resolve();
// };
// } else {
// // @ts-ignore: The type of speed is properly checked at the start
// const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, this._mapSpeed(speed)]);
// this.send(data, Consts.BLECharacteristic.LPF2_ALL);
// }
// }
// });
// }
// /**
// * Tell motor to goto an absolute position
// * @method BoostMoveHub#setAbsolutePosition
// * @param {string} port
// * @param {number} pos The position of the motor to go to
// * @param {number | Array.<number>} [speed=100] A value between 1 - 100 should be set (Direction does not apply when going to absolute position)
// * @returns {Promise} Resolved upon successful completion of command (ie. once the motor is finished).
// */
// public setAbsolutePosition (port: string, pos: number, speed: number = 100) {
// const portObj = this._portLookup(port);
// if (!(
// portObj.type === Consts.DeviceType.CONTROL_PLUS_LARGE_MOTOR ||
// portObj.type === Consts.DeviceType.CONTROL_PLUS_XLARGE_MOTOR
// )) {
// throw new Error("Absolute positioning is only available when using a Control+ Medium Motor, or Control+ Large Motor");
// }
// portObj.cancelEventTimer();
// return new Promise((resolve, reject) => {
// portObj.busy = true;
// let data = null;
// if (this._virtualPorts[portObj.id]) {
// data = Buffer.from([0x81, portObj.value, 0x11, 0x0e, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, this._mapSpeed(speed), 0x64, 0x7f, 0x03]);
// data.writeInt32LE(pos, 4);
// data.writeInt32LE(pos, 8);
// } else {
// // @ts-ignore: The type of speed is properly checked at the start
// data = Buffer.from([0x81, portObj.value, 0x11, 0x0d, 0x00, 0x00, 0x00, 0x00, this._mapSpeed(speed), 0x64, 0x7f, 0x03]);
// data.writeInt32LE(pos, 4);
// }
// this.send(data, Consts.BLECharacteristic.LPF2_ALL);
// portObj.finished = () => {
// return resolve();
// };
// });
// }
// /**
// * Reset the current motor position as absolute position zero
// * @method BoostMoveHub#resetAbsolutePosition
// * @param {string} port
// * @returns {Promise} Resolved upon successful completion of command (ie. once the motor is finished).
// */
// public resetAbsolutePosition (port: string) {
// const portObj = this._portLookup(port);
// if (!(
// portObj.type === Consts.DeviceType.CONTROL_PLUS_LARGE_MOTOR ||
// portObj.type === Consts.DeviceType.CONTROL_PLUS_XLARGE_MOTOR
// )) {
// throw new Error("Absolute positioning is only available when using a Control+ Medium Motor, or Control+ Large Motor");
// }
// return new Promise((resolve) => {
// const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x02, 0x00, 0x00, 0x00, 0x00]);
// this.send(data, Consts.BLECharacteristic.LPF2_ALL);
// return resolve();
// });
// }
protected _checkFirmware (version: string) {
if (compareVersion("2.0.00.0017", version) === 1) {
throw new Error(`Your Boost Move Hub's (${this.name}) firmware is out of date and unsupported by this library. Please update it via the official Powered Up app.`);
}
}
}