229 lines
11 KiB
HTML
229 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: puphub.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: puphub.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>"use strict";
|
|
var __importStar = (this && this.__importStar) || function (mod) {
|
|
if (mod && mod.__esModule) return mod;
|
|
var result = {};
|
|
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
|
|
result["default"] = mod;
|
|
return result;
|
|
};
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
const lpf2hub_1 = require("./lpf2hub");
|
|
const port_1 = require("./port");
|
|
const Consts = __importStar(require("./consts"));
|
|
const Debug = require("debug");
|
|
const debug = Debug("puphub");
|
|
/**
|
|
* The PUPHub is emitted if the discovered device is a Powered UP Hub.
|
|
* @class PUPHub
|
|
* @extends LPF2Hub
|
|
* @extends Hub
|
|
*/
|
|
class PUPHub extends lpf2hub_1.LPF2Hub {
|
|
// We set JSDoc to ignore these events as a Powered UP Remote will never emit them.
|
|
/**
|
|
* @event PUPHub#rotate
|
|
* @ignore
|
|
*/
|
|
/**
|
|
* @event PUPHub#speed
|
|
* @ignore
|
|
*/
|
|
static IsPUPHub(peripheral) {
|
|
return (peripheral.advertisement.serviceUuids.indexOf(Consts.BLEService.LPF2_HUB.replace(/-/g, "")) >= 0 && peripheral.advertisement.manufacturerData[3] === Consts.BLEManufacturerData.POWERED_UP_HUB_ID);
|
|
}
|
|
constructor(peripheral, autoSubscribe = true) {
|
|
super(peripheral, autoSubscribe);
|
|
this.type = Consts.HubType.POWERED_UP_HUB;
|
|
this._ports = {
|
|
"A": new port_1.Port("A", 0),
|
|
"B": new port_1.Port("B", 1),
|
|
"AB": new port_1.Port("AB", 57)
|
|
};
|
|
debug("Discovered Powered UP Hub");
|
|
}
|
|
connect() {
|
|
return new Promise(async (resolve, reject) => {
|
|
debug("Connecting to Powered UP Hub");
|
|
await super.connect();
|
|
debug("Connect completed");
|
|
return resolve();
|
|
});
|
|
}
|
|
/**
|
|
* Set the motor speed on a given port.
|
|
* @method PUPHub#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.
|
|
*/
|
|
setMotorSpeed(port, speed, time) {
|
|
const portObj = this._portLookup(port);
|
|
if (portObj.id !== "AB" && speed instanceof Array) {
|
|
throw new Error(`Port ${portObj.id} can only accept a single speed`);
|
|
}
|
|
if (portObj.id === "AB") {
|
|
const portObjA = this._portLookup("A");
|
|
const portObjB = this._portLookup("B");
|
|
if (portObjA.type !== portObjB.type) {
|
|
throw new Error(`Port ${portObj.id} requires both motors be of the same type`);
|
|
}
|
|
}
|
|
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") {
|
|
let data = null;
|
|
if (portObj.id === "AB") {
|
|
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]);
|
|
}
|
|
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
const timeout = global.setTimeout(() => {
|
|
let data = null;
|
|
if (portObj.id === "AB") {
|
|
data = Buffer.from([0x81, portObj.value, 0x11, 0x02, 0x00, 0x00]);
|
|
}
|
|
else {
|
|
data = Buffer.from([0x81, portObj.value, 0x11, 0x60, 0x00, 0x00, 0x00, 0x00]);
|
|
}
|
|
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
return resolve();
|
|
}, time);
|
|
portObj.setEventTimer(timeout);
|
|
}
|
|
else {
|
|
let data = null;
|
|
if (portObj.id === "AB") {
|
|
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]);
|
|
}
|
|
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
return resolve();
|
|
}
|
|
});
|
|
}
|
|
/**
|
|
* Ramp the motor speed on a given port.
|
|
* @method PUPHub#rampMotorSpeed
|
|
* @param {string} port
|
|
* @param {number} fromSpeed For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
|
|
* @param {number} toSpeed For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
|
|
* @param {number} time How long the ramp should last (in milliseconds).
|
|
* @returns {Promise} Resolved upon successful completion of command.
|
|
*/
|
|
rampMotorSpeed(port, fromSpeed, toSpeed, time) {
|
|
const portObj = this._portLookup(port);
|
|
portObj.cancelEventTimer();
|
|
return new Promise((resolve, reject) => {
|
|
this._calculateRamp(fromSpeed, toSpeed, time, portObj)
|
|
.on("changeSpeed", (speed) => {
|
|
this.setMotorSpeed(port, speed, true);
|
|
})
|
|
.on("finished", resolve);
|
|
});
|
|
}
|
|
/**
|
|
* Fully (hard) stop the motor on a given port.
|
|
* @method PUPHub#hardStopMotor
|
|
* @param {string} port
|
|
* @returns {Promise} Resolved upon successful completion of command.
|
|
*/
|
|
hardStopMotor(port) {
|
|
return this.setMotorSpeed(port, 127);
|
|
}
|
|
/**
|
|
* Set the light brightness on a given port.
|
|
* @method PUPHub#setLightBrightness
|
|
* @param {string} port
|
|
* @param {number} brightness Brightness value between 0-100 (0 is off)
|
|
* @param {number} [time] How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely.
|
|
* @returns {Promise} Resolved upon successful completion of command. If time is specified, this is once the light is turned off.
|
|
*/
|
|
setLightBrightness(port, brightness, time) {
|
|
const portObj = this._portLookup(port);
|
|
portObj.cancelEventTimer();
|
|
return new Promise((resolve, reject) => {
|
|
const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, brightness]);
|
|
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
if (time) {
|
|
const timeout = global.setTimeout(() => {
|
|
const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, 0x00]);
|
|
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
return resolve();
|
|
}, time);
|
|
portObj.setEventTimer(timeout);
|
|
}
|
|
else {
|
|
return resolve();
|
|
}
|
|
});
|
|
}
|
|
}
|
|
exports.PUPHub = PUPHub;
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BoostMoveHub.html">BoostMoveHub</a></li><li><a href="DuploTrainBase.html">DuploTrainBase</a></li><li><a href="Hub.html">Hub</a></li><li><a href="LPF2Hub.html">LPF2Hub</a></li><li><a href="PoweredUP.html">PoweredUP</a></li><li><a href="PUPHub.html">PUPHub</a></li><li><a href="PUPRemote.html">PUPRemote</a></li><li><a href="WeDo2SmartHub.html">WeDo2SmartHub</a></li></ul><h3>Events</h3><ul><li><a href="BoostMoveHub.html#event:attach">attach</a></li><li><a href="BoostMoveHub.html#event:button">button</a></li><li><a href="BoostMoveHub.html#event:color">color</a></li><li><a href="BoostMoveHub.html#event:colorAndDistance">colorAndDistance</a></li><li><a href="BoostMoveHub.html#event:detach">detach</a></li><li><a href="BoostMoveHub.html#event:distance">distance</a></li><li><a href="BoostMoveHub.html#event:rotate">rotate</a></li><li><a href="BoostMoveHub.html#event:tilt">tilt</a></li><li><a href="DuploTrainBase.html#event:color">color</a></li><li><a href="DuploTrainBase.html#event:speed">speed</a></li><li><a href="Hub.html#event:attach">attach</a></li><li><a href="Hub.html#event:detach">detach</a></li><li><a href="LPF2Hub.html#event:attach">attach</a></li><li><a href="LPF2Hub.html#event:button">button</a></li><li><a href="LPF2Hub.html#event:color">color</a></li><li><a href="LPF2Hub.html#event:colorAndDistance">colorAndDistance</a></li><li><a href="LPF2Hub.html#event:detach">detach</a></li><li><a href="LPF2Hub.html#event:distance">distance</a></li><li><a href="LPF2Hub.html#event:rotate">rotate</a></li><li><a href="LPF2Hub.html#event:speed">speed</a></li><li><a href="LPF2Hub.html#event:tilt">tilt</a></li><li><a href="PoweredUP.html#event:discover">discover</a></li><li><a href="PUPHub.html#event:attach">attach</a></li><li><a href="PUPHub.html#event:button">button</a></li><li><a href="PUPHub.html#event:color">color</a></li><li><a href="PUPHub.html#event:colorAndDistance">colorAndDistance</a></li><li><a href="PUPHub.html#event:detach">detach</a></li><li><a href="PUPHub.html#event:distance">distance</a></li><li><a href="PUPHub.html#event:tilt">tilt</a></li><li><a href="PUPRemote.html#event:button">button</a></li><li><a href="PUPRemote.html#event:colorAndDistance">colorAndDistance</a></li><li><a href="WeDo2SmartHub.html#event:attach">attach</a></li><li><a href="WeDo2SmartHub.html#event:button">button</a></li><li><a href="WeDo2SmartHub.html#event:color">color</a></li><li><a href="WeDo2SmartHub.html#event:detach">detach</a></li><li><a href="WeDo2SmartHub.html#event:distance">distance</a></li><li><a href="WeDo2SmartHub.html#event:rotate">rotate</a></li><li><a href="WeDo2SmartHub.html#event:tilt">tilt</a></li></ul><h3><a href="global.html">Global</a></h3>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 18 2019 16:16:36 GMT-0800 (Pacific Standard Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|