444 lines
19 KiB
HTML
444 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width">
|
|
<title>DocStrap Source: boostmovehub.js</title>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<a class="navbar-brand" href="index.html">DocStrap</a>
|
|
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
</div>
|
|
<div class="navbar-collapse collapse" id="topNavigation">
|
|
<ul class="nav navbar-nav">
|
|
|
|
<li class="dropdown">
|
|
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
|
|
<ul class="dropdown-menu ">
|
|
<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>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
|
|
<ul class="dropdown-menu ">
|
|
<li><a href="BoostMoveHub.html#event:attach">BoostMoveHub#event:attach</a></li><li><a href="BoostMoveHub.html#event:button">BoostMoveHub#event:button</a></li><li><a href="BoostMoveHub.html#event:color">BoostMoveHub#event:color</a></li><li><a href="BoostMoveHub.html#event:colorAndDistance">BoostMoveHub#event:colorAndDistance</a></li><li><a href="BoostMoveHub.html#event:detach">BoostMoveHub#event:detach</a></li><li><a href="BoostMoveHub.html#event:distance">BoostMoveHub#event:distance</a></li><li><a href="BoostMoveHub.html#event:rotate">BoostMoveHub#event:rotate</a></li><li><a href="BoostMoveHub.html#event:tilt">BoostMoveHub#event:tilt</a></li><li><a href="DuploTrainBase.html#event:color">DuploTrainBase#event:color</a></li><li><a href="DuploTrainBase.html#event:speed">DuploTrainBase#event:speed</a></li><li><a href="Hub.html#event:attach">Hub#event:attach</a></li><li><a href="Hub.html#event:detach">Hub#event:detach</a></li><li><a href="LPF2Hub.html#event:attach">LPF2Hub#event:attach</a></li><li><a href="LPF2Hub.html#event:button">LPF2Hub#event:button</a></li><li><a href="LPF2Hub.html#event:color">LPF2Hub#event:color</a></li><li><a href="LPF2Hub.html#event:colorAndDistance">LPF2Hub#event:colorAndDistance</a></li><li><a href="LPF2Hub.html#event:detach">LPF2Hub#event:detach</a></li><li><a href="LPF2Hub.html#event:distance">LPF2Hub#event:distance</a></li><li><a href="LPF2Hub.html#event:rotate">LPF2Hub#event:rotate</a></li><li><a href="LPF2Hub.html#event:speed">LPF2Hub#event:speed</a></li><li><a href="LPF2Hub.html#event:tilt">LPF2Hub#event:tilt</a></li><li><a href="PoweredUP.html#event:discover">PoweredUP#event:discover</a></li><li><a href="PUPHub.html#event:attach">PUPHub#event:attach</a></li><li><a href="PUPHub.html#event:button">PUPHub#event:button</a></li><li><a href="PUPHub.html#event:color">PUPHub#event:color</a></li><li><a href="PUPHub.html#event:colorAndDistance">PUPHub#event:colorAndDistance</a></li><li><a href="PUPHub.html#event:detach">PUPHub#event:detach</a></li><li><a href="PUPHub.html#event:distance">PUPHub#event:distance</a></li><li><a href="PUPHub.html#event:tilt">PUPHub#event:tilt</a></li><li><a href="PUPRemote.html#event:button">PUPRemote#event:button</a></li><li><a href="PUPRemote.html#event:colorAndDistance">PUPRemote#event:colorAndDistance</a></li><li><a href="WeDo2SmartHub.html#event:attach">WeDo2SmartHub#event:attach</a></li><li><a href="WeDo2SmartHub.html#event:button">WeDo2SmartHub#event:button</a></li><li><a href="WeDo2SmartHub.html#event:color">WeDo2SmartHub#event:color</a></li><li><a href="WeDo2SmartHub.html#event:detach">WeDo2SmartHub#event:detach</a></li><li><a href="WeDo2SmartHub.html#event:distance">WeDo2SmartHub#event:distance</a></li><li><a href="WeDo2SmartHub.html#event:rotate">WeDo2SmartHub#event:rotate</a></li><li><a href="WeDo2SmartHub.html#event:tilt">WeDo2SmartHub#event:tilt</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown">
|
|
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
|
|
<ul class="dropdown-menu ">
|
|
<li><a href="global.html">Global</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<div class="col-sm-3 col-md-3">
|
|
<form class="navbar-form" role="search">
|
|
<div class="input-group">
|
|
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
|
<div class="input-group-btn">
|
|
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
|
</div>
|
|
</div>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="container" id="toc-content">
|
|
<div class="row">
|
|
|
|
|
|
<div class="col-md-12">
|
|
|
|
<div id="main">
|
|
|
|
|
|
<h1 class="page-title">Source: boostmovehub.js</h1>
|
|
|
|
<section>
|
|
<article>
|
|
<pre
|
|
class="sunlight-highlight-javascript linenums">"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("boostmovehub");
|
|
/**
|
|
* The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.
|
|
* @class BoostMoveHub
|
|
* @extends LPF2Hub
|
|
* @extends Hub
|
|
*/
|
|
class BoostMoveHub extends lpf2hub_1.LPF2Hub {
|
|
// We set JSDoc to ignore these events as a Boost Move Hub will never emit them.
|
|
/**
|
|
* @event BoostMoveHub#speed
|
|
* @ignore
|
|
*/
|
|
static IsBoostMoveHub(peripheral) {
|
|
return (peripheral.advertisement.serviceUuids.indexOf(Consts.BLEService.LPF2_HUB.replace(/-/g, "")) >= 0 && peripheral.advertisement.manufacturerData[3] === Consts.BLEManufacturerData.BOOST_MOVE_HUB_ID);
|
|
}
|
|
constructor(peripheral, autoSubscribe = true) {
|
|
super(peripheral, autoSubscribe);
|
|
this.type = Consts.HubType.BOOST_MOVE_HUB;
|
|
this._ports = {
|
|
"A": new port_1.Port("A", 55),
|
|
"B": new port_1.Port("B", 56),
|
|
"AB": new port_1.Port("AB", 57),
|
|
"TILT": new port_1.Port("TILT", 58),
|
|
"C": new port_1.Port("C", 1),
|
|
"D": new port_1.Port("D", 2)
|
|
};
|
|
debug("Discovered Boost Move Hub");
|
|
}
|
|
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.
|
|
*/
|
|
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`);
|
|
}
|
|
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.busy = true;
|
|
let data = null;
|
|
if (portObj.id === "AB") {
|
|
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._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
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._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
const timeout = global.setTimeout(() => {
|
|
const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, 0x00]);
|
|
this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
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.busy = true;
|
|
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), 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._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
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._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
/**
|
|
* Ramp the motor speed on a given port.
|
|
* @method BoostMoveHub#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);
|
|
});
|
|
}
|
|
/**
|
|
* Rotate a motor by a given angle.
|
|
* @method BoostMoveHub#setMotorAngle
|
|
* @param {string} port
|
|
* @param {number} angle How much the motor should be rotated (in degrees).
|
|
* @param {number | Array.<number>} [speed=100] 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.
|
|
* @returns {Promise} Resolved upon successful completion of command (ie. once the motor is finished).
|
|
*/
|
|
setMotorAngle(port, angle, speed = 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 BoostMoveHub#brakeMotor
|
|
* @param {string} port
|
|
* @returns {Promise} Resolved upon successful completion of command.
|
|
*/
|
|
brakeMotor(port) {
|
|
return this.setMotorSpeed(port, 127);
|
|
}
|
|
/**
|
|
* Set the light brightness on a given port.
|
|
* @method BoostMoveHub#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.BoostMoveHub = BoostMoveHub;
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="searchResults">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
|
<h4 class="modal-title">Search results</h4>
|
|
</div>
|
|
<div class="modal-body"></div>
|
|
<div class="modal-footer">
|
|
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
|
</div>
|
|
</div><!-- /.modal-content -->
|
|
</div><!-- /.modal-dialog -->
|
|
</div>
|
|
|
|
|
|
<footer>
|
|
|
|
|
|
<span class="copyright">
|
|
node-poweredup by Nathan Kellenicki licensed under the MIT license.
|
|
</span>
|
|
|
|
<span class="jsdoc-message">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
|
|
|
on Wed Feb 13th 2019
|
|
|
|
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
|
</span>
|
|
</footer>
|
|
|
|
<script src="scripts/docstrap.lib.js"></script>
|
|
<script src="scripts/toc.js"></script>
|
|
|
|
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
|
|
|
|
|
<script>
|
|
$( function () {
|
|
$( "[id*='$']" ).each( function () {
|
|
var $this = $( this );
|
|
|
|
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
|
} );
|
|
|
|
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
|
|
var $this = $( this );
|
|
|
|
var example = $this.find( "code" );
|
|
exampleText = example.html();
|
|
var lang = /{@lang (.*?)}/.exec( exampleText );
|
|
if ( lang && lang[1] ) {
|
|
exampleText = exampleText.replace( lang[0], "" );
|
|
example.html( exampleText );
|
|
lang = lang[1];
|
|
} else {
|
|
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
|
lang = langClassMatch ? langClassMatch[1] : "javascript";
|
|
}
|
|
|
|
if ( lang ) {
|
|
|
|
$this
|
|
.addClass( "sunlight-highlight-" + lang )
|
|
.addClass( "linenums" )
|
|
.html( example.html() );
|
|
|
|
}
|
|
} );
|
|
|
|
Sunlight.highlightAll( {
|
|
lineNumbers : true,
|
|
showMenu : true,
|
|
enableDoclinks : true
|
|
} );
|
|
|
|
$.catchAnchorLinks( {
|
|
navbarOffset: 10
|
|
} );
|
|
$( "#toc" ).toc( {
|
|
anchorName : function ( i, heading, prefix ) {
|
|
return $( heading ).attr( "id" ) || ( prefix + i );
|
|
},
|
|
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
|
showAndHide : false,
|
|
smoothScrolling: true
|
|
} );
|
|
|
|
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
|
$( '.dropdown-toggle' ).dropdown();
|
|
|
|
$( "table" ).each( function () {
|
|
var $this = $( this );
|
|
$this.addClass('table');
|
|
} );
|
|
|
|
} );
|
|
</script>
|
|
|
|
|
|
|
|
<!--Navigation and Symbol Display-->
|
|
|
|
|
|
<!--Google Analytics-->
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
$(document).ready(function() {
|
|
SearcherDisplay.init();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html>
|