node-poweredup/docs/hubs_lpf2hub.js.html
Nathan Kellenicki abecb5385b
Some checks failed
continuous-integration/drone/push Build is failing
Updated
2024-04-25 16:38:57 -07:00

392 lines
24 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: hubs/lpf2hub.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: hubs/lpf2hub.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
var __createBinding = (this &amp;&amp; this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this &amp;&amp; this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this &amp;&amp; this.__importStar) || function (mod) {
if (mod &amp;&amp; mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" &amp;&amp; Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.LPF2Hub = void 0;
const basehub_1 = require("./basehub");
const Consts = __importStar(require("../consts"));
const utils_1 = require("../utils");
const Debug = require("debug");
const debug = Debug("lpf2hub");
const modeInfoDebug = Debug("lpf2hubmodeinfo");
/**
* @class LPF2Hub
* @extends BaseHub
*/
class LPF2Hub extends basehub_1.BaseHub {
constructor() {
super(...arguments);
this._messageBuffer = Buffer.alloc(0);
this._propertyRequestCallbacks = {};
}
async connect() {
debug("LPF2Hub connecting");
await super.connect();
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.LPF2_HUB);
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.LPF2_ALL, this._parseMessage.bind(this));
await this._requestHubPropertyReports(Consts.HubPropertyPayload.BUTTON_STATE);
await this._requestHubPropertyValue(Consts.HubPropertyPayload.FW_VERSION);
await this._requestHubPropertyValue(Consts.HubPropertyPayload.HW_VERSION);
await this._requestHubPropertyReports(Consts.HubPropertyPayload.RSSI);
await this._requestHubPropertyReports(Consts.HubPropertyPayload.BATTERY_VOLTAGE);
await this._requestHubPropertyValue(Consts.HubPropertyPayload.PRIMARY_MAC_ADDRESS);
this.emit("connect");
debug("LPF2Hub connected");
}
/**
* Shutdown the Hub.
* @method LPF2Hub#shutdown
* @returns {Promise} Resolved upon successful disconnect.
*/
shutdown() {
return this.send(Buffer.from([0x02, 0x01]), Consts.BLECharacteristic.LPF2_ALL);
}
/**
* 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.
*/
async setName(name) {
if (name.length > 14) {
throw new Error("Name must be 14 characters or less");
}
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
await this.send(data, Consts.BLECharacteristic.LPF2_ALL);
await this.send(data, Consts.BLECharacteristic.LPF2_ALL);
this._name = name;
}
send(message, uuid) {
message = Buffer.concat([Buffer.alloc(2), message]);
message[0] = message.length;
debug("Sent Message (LPF2_ALL)", message);
return this._bleDevice.writeToCharacteristic(uuid, message);
}
subscribe(portId, deviceType, mode) {
return this.send(Buffer.from([0x41, portId, mode, 0x01, 0x00, 0x00, 0x00, 0x01]), Consts.BLECharacteristic.LPF2_ALL);
}
unsubscribe(portId, mode) {
return this.send(Buffer.from([0x41, portId, mode, 0x01, 0x00, 0x00, 0x00, 0x00]), Consts.BLECharacteristic.LPF2_ALL);
}
/**
* Combines two ports with into a single virtual port.
*
* Note: The devices attached to the ports must be of the same device type.
* @method LPF2Hub#createVirtualPort
* @param {string} firstPortName First port name
* @param {string} secondPortName Second port name
* @returns {Promise} Resolved upon successful issuance of command.
*/
createVirtualPort(firstPortName, secondPortName) {
const firstDevice = this.getDeviceAtPort(firstPortName);
if (!firstDevice) {
throw new Error(`Port ${firstPortName} does not have an attached device`);
}
const secondDevice = this.getDeviceAtPort(secondPortName);
if (!secondDevice) {
throw new Error(`Port ${secondPortName} does not have an attached device`);
}
if (firstDevice.type !== secondDevice.type) {
throw new Error(`Both devices must be of the same type to create a virtual port`);
}
return this.send(Buffer.from([0x61, 0x01, firstDevice.portId, secondDevice.portId]), Consts.BLECharacteristic.LPF2_ALL);
}
_checkFirmware(version) {
return;
}
_parseMessage(data) {
if (data) {
this._messageBuffer = Buffer.concat([this._messageBuffer, data]);
}
if (this._messageBuffer.length &lt;= 0) {
return;
}
const len = this._messageBuffer[0];
if (len &lt;= 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 Consts.MessageType.HUB_PROPERTIES: {
const property = message[3];
const callback = this._propertyRequestCallbacks[property];
if (callback) {
callback(message);
}
else {
this._parseHubPropertyResponse(message);
}
delete this._propertyRequestCallbacks[property];
break;
}
case Consts.MessageType.HUB_ATTACHED_IO: {
this._parsePortMessage(message);
break;
}
case Consts.MessageType.PORT_INFORMATION: {
this._parsePortInformationResponse(message);
break;
}
case Consts.MessageType.PORT_MODE_INFORMATION: {
this._parseModeInformationResponse(message);
break;
}
case Consts.MessageType.PORT_VALUE_SINGLE: {
this._parseSensorMessage(message);
break;
}
case Consts.MessageType.PORT_OUTPUT_COMMAND_FEEDBACK: {
this._parsePortAction(message);
break;
}
}
if (this._messageBuffer.length > 0) {
this._parseMessage();
}
}
}
_requestHubPropertyValue(property) {
return new Promise((resolve) => {
this._propertyRequestCallbacks[property] = (message) => {
this._parseHubPropertyResponse(message);
return resolve();
};
this.send(Buffer.from([0x01, property, 0x05]), Consts.BLECharacteristic.LPF2_ALL);
});
}
_requestHubPropertyReports(property) {
return this.send(Buffer.from([0x01, property, 0x02]), Consts.BLECharacteristic.LPF2_ALL);
}
_parseHubPropertyResponse(message) {
if (message[3] === Consts.HubPropertyPayload.BUTTON_STATE) {
if (message[5] === 1) {
/**
* Emits when a button is pressed.
* @event LPF2Hub#button
* @param {string} button
* @param {ButtonState} state
*/
this.emit("button", { event: Consts.ButtonState.PRESSED });
return;
}
else if (message[5] === 0) {
this.emit("button", { event: Consts.ButtonState.RELEASED });
return;
}
}
else if (message[3] === Consts.HubPropertyPayload.FW_VERSION) {
this._firmwareVersion = (0, utils_1.decodeVersion)(message.readInt32LE(5));
this._checkFirmware(this._firmwareVersion);
}
else if (message[3] === Consts.HubPropertyPayload.HW_VERSION) {
this._hardwareVersion = (0, utils_1.decodeVersion)(message.readInt32LE(5));
}
else if (message[3] === Consts.HubPropertyPayload.RSSI) {
const rssi = message.readInt8(5);
if (rssi !== 0) {
this._rssi = rssi;
this.emit("rssi", { rssi: this._rssi });
}
}
else if (message[3] === Consts.HubPropertyPayload.PRIMARY_MAC_ADDRESS) {
this._primaryMACAddress = (0, utils_1.decodeMACAddress)(message.slice(5));
}
else if (message[3] === Consts.HubPropertyPayload.BATTERY_VOLTAGE) {
const batteryLevel = message[5];
if (batteryLevel !== this._batteryLevel) {
this._batteryLevel = batteryLevel;
this.emit("batteryLevel", { batteryLevel });
}
}
}
async _parsePortMessage(message) {
const portId = message[3];
const event = message[4];
const deviceType = event ? message.readUInt16LE(5) : 0;
if (event === Consts.Event.ATTACHED_IO) {
if (modeInfoDebug.enabled) {
const deviceTypeName = Consts.DeviceTypeNames[message[5]] || "Unknown";
modeInfoDebug(`Port ${(0, utils_1.toHex)(portId)}, type ${(0, utils_1.toHex)(deviceType, 4)} (${deviceTypeName})`);
const hwVersion = (0, utils_1.decodeVersion)(message.readInt32LE(7));
const swVersion = (0, utils_1.decodeVersion)(message.readInt32LE(11));
modeInfoDebug(`Port ${(0, utils_1.toHex)(portId)}, hardware version ${hwVersion}, software version ${swVersion}`);
await this._sendPortInformationRequest(portId);
}
const device = this._createDevice(deviceType, portId);
this._attachDevice(device);
}
else if (event === Consts.Event.DETACHED_IO) {
const device = this._getDeviceByPortId(portId);
if (device) {
this._detachDevice(device);
if (this.isPortVirtual(portId)) {
const portName = this.getPortNameForPortId(portId);
if (portName) {
delete this._portMap[portName];
}
this._virtualPorts = this._virtualPorts.filter((virtualPortId) => virtualPortId !== portId);
}
}
}
else if (event === Consts.Event.ATTACHED_VIRTUAL_IO) {
const firstPortName = this.getPortNameForPortId(message[7]);
const secondPortName = this.getPortNameForPortId(message[8]);
// @ts-ignore NK These should never be undefined
const virtualPortName = firstPortName + secondPortName;
const virtualPortId = message[3];
this._portMap[virtualPortName] = virtualPortId;
this._virtualPorts.push(virtualPortId);
const device = this._createDevice(deviceType, virtualPortId);
this._attachDevice(device);
}
}
async _sendPortInformationRequest(port) {
await this.send(Buffer.from([0x21, port, 0x01]), Consts.BLECharacteristic.LPF2_ALL);
await this.send(Buffer.from([0x21, port, 0x02]), Consts.BLECharacteristic.LPF2_ALL); // Mode combinations
}
async _parsePortInformationResponse(message) {
const port = message[3];
if (message[4] === 2) {
const modeCombinationMasks = [];
for (let i = 5; i &lt; message.length; i += 2) {
modeCombinationMasks.push(message.readUInt16LE(i));
}
modeInfoDebug(`Port ${(0, utils_1.toHex)(port)}, mode combinations [${modeCombinationMasks.map((c) => (0, utils_1.toBin)(c, 0)).join(", ")}]`);
return;
}
const count = message[6];
const input = (0, utils_1.toBin)(message.readUInt16LE(7), count);
const output = (0, utils_1.toBin)(message.readUInt16LE(9), count);
modeInfoDebug(`Port ${(0, utils_1.toHex)(port)}, total modes ${count}, input modes ${input}, output modes ${output}`);
for (let i = 0; i &lt; count; i++) {
await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.NAME);
await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.RAW);
await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.PCT);
await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.SI);
await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.SYMBOL);
await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.VALUE_FORMAT);
}
}
_sendModeInformationRequest(port, mode, type) {
return this.send(Buffer.from([0x22, port, mode, type]), Consts.BLECharacteristic.LPF2_ALL);
}
_parseModeInformationResponse(message) {
const port = (0, utils_1.toHex)(message[3]);
const mode = message[4];
const type = message[5];
switch (type) {
case Consts.ModeInformationType.NAME:
modeInfoDebug(`Port ${port}, mode ${mode}, name ${message.slice(6, message.length).toString()}`);
break;
case Consts.ModeInformationType.RAW:
modeInfoDebug(`Port ${port}, mode ${mode}, RAW min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`);
break;
case Consts.ModeInformationType.PCT:
modeInfoDebug(`Port ${port}, mode ${mode}, PCT min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`);
break;
case Consts.ModeInformationType.SI:
modeInfoDebug(`Port ${port}, mode ${mode}, SI min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`);
break;
case Consts.ModeInformationType.SYMBOL:
modeInfoDebug(`Port ${port}, mode ${mode}, SI symbol ${message.slice(6, message.length).toString()}`);
break;
case Consts.ModeInformationType.VALUE_FORMAT:
const numValues = message[6];
const dataType = ["8bit", "16bit", "32bit", "float"][message[7]];
const totalFigures = message[8];
const decimals = message[9];
modeInfoDebug(`Port ${port}, mode ${mode}, Value ${numValues} x ${dataType}, Decimal format ${totalFigures}.${decimals}`);
}
}
_parsePortAction(message) {
for (let offset = 3; offset &lt; message.length; offset += 2) {
const device = this._getDeviceByPortId(message[offset]);
if (device) {
device.finish(message[offset + 1]);
}
}
}
_parseSensorMessage(message) {
const portId = message[3];
const device = this._getDeviceByPortId(portId);
if (device) {
device.receive(message);
}
}
}
exports.LPF2Hub = LPF2Hub;
//# sourceMappingURL=lpf2hub.js.map</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbsoluteMotor.html">AbsoluteMotor</a></li><li><a href="BaseHub.html">BaseHub</a></li><li><a href="BasicMotor.html">BasicMotor</a></li><li><a href="ColorDistanceSensor.html">ColorDistanceSensor</a></li><li><a href="CurrentSensor.html">CurrentSensor</a></li><li><a href="Device.html">Device</a></li><li><a href="DuploTrainBase.html">DuploTrainBase</a></li><li><a href="DuploTrainBaseColorSensor.html">DuploTrainBaseColorSensor</a></li><li><a href="DuploTrainBaseMotor.html">DuploTrainBaseMotor</a></li><li><a href="DuploTrainBaseSpeaker.html">DuploTrainBaseSpeaker</a></li><li><a href="DuploTraniBaseSpeedometer.html">DuploTraniBaseSpeedometer</a></li><li><a href="Hub.html">Hub</a></li><li><a href="HubLED.html">HubLED</a></li><li><a href="LPF2Hub.html">LPF2Hub</a></li><li><a href="Light.html">Light</a></li><li><a href="Mario.html">Mario</a></li><li><a href="MarioAccelerometer.html">MarioAccelerometer</a></li><li><a href="MarioBarcodeSensor.html">MarioBarcodeSensor</a></li><li><a href="MarioPantsSensor.html">MarioPantsSensor</a></li><li><a href="MediumLinearMotor.html">MediumLinearMotor</a></li><li><a href="MotionSensor.html">MotionSensor</a></li><li><a href="MoveHub.html">MoveHub</a></li><li><a href="MoveHubMediumLinearMotor.html">MoveHubMediumLinearMotor</a></li><li><a href="MoveHubTiltSensor.html">MoveHubTiltSensor</a></li><li><a href="PiezoBuzzer.html">PiezoBuzzer</a></li><li><a href="PoweredUP.html">PoweredUP</a></li><li><a href="RemoteControl.html">RemoteControl</a></li><li><a href="RemoteControlButton.html">RemoteControlButton</a></li><li><a href="SimpleMediumLinearMotor.html">SimpleMediumLinearMotor</a></li><li><a href="TachoMotor.html">TachoMotor</a></li><li><a href="Technic3x3ColorLightMatrix.html">Technic3x3ColorLightMatrix</a></li><li><a href="TechnicColorSensor.html">TechnicColorSensor</a></li><li><a href="TechnicDistanceSensor.html">TechnicDistanceSensor</a></li><li><a href="TechnicForceSensor.html">TechnicForceSensor</a></li><li><a href="TechnicLargeAngularMotor.html">TechnicLargeAngularMotor</a></li><li><a href="TechnicLargeLinearMotor.html">TechnicLargeLinearMotor</a></li><li><a href="TechnicMediumAngularMotor.html">TechnicMediumAngularMotor</a></li><li><a href="TechnicMediumHub.html">TechnicMediumHub</a></li><li><a href="TechnicMediumHubAccelerometerSensor.html">TechnicMediumHubAccelerometerSensor</a></li><li><a href="TechnicMediumHubGyroSensor.html">TechnicMediumHubGyroSensor</a></li><li><a href="TechnicMediumHubTiltSensor.html">TechnicMediumHubTiltSensor</a></li><li><a href="TechnicSmallAngularMotor.html">TechnicSmallAngularMotor</a></li><li><a href="TechnicXLargeLinearMotor.html">TechnicXLargeLinearMotor</a></li><li><a href="TiltSensor.html">TiltSensor</a></li><li><a href="TrainMotor.html">TrainMotor</a></li><li><a href="VoltageSensor.html">VoltageSensor</a></li><li><a href="WeDo2SmartHub.html">WeDo2SmartHub</a></li></ul><h3>Events</h3><ul><li><a href="AbsoluteMotor.html#event:absolute">absolute</a></li><li><a href="AbsoluteMotor.html#event:rotate">rotate</a></li><li><a href="ColorDistanceSensor.html#event:ambient">ambient</a></li><li><a href="ColorDistanceSensor.html#event:color">color</a></li><li><a href="ColorDistanceSensor.html#event:colorAndDistance">colorAndDistance</a></li><li><a href="ColorDistanceSensor.html#event:distance">distance</a></li><li><a href="ColorDistanceSensor.html#event:distanceCount">distanceCount</a></li><li><a href="ColorDistanceSensor.html#event:reflect">reflect</a></li><li><a href="ColorDistanceSensor.html#event:rgbIntensity">rgbIntensity</a></li><li><a href="CurrentSensor.html#event:current">current</a></li><li><a href="DuploTrainBase.html#event:button">button</a></li><li><a href="DuploTrainBaseColorSensor.html#event:color">color</a></li><li><a href="DuploTrainBaseColorSensor.html#event:intensity">intensity</a></li><li><a href="DuploTrainBaseColorSensor.html#event:reflect">reflect</a></li><li><a href="DuploTrainBaseColorSensor.html#event:rgb">rgb</a></li><li><a href="DuploTrainBaseSpeedometer.html#event:speed">speed</a></li><li><a href="Hub.html#event:attach">attach</a></li><li><a href="Hub.html#event:button">button</a></li><li><a href="Hub.html#event:detach">detach</a></li><li><a href="Hub.html#event:disconnect">disconnect</a></li><li><a href="LPF2Hub.html#event:button">button</a></li><li><a href="Mario.html#event:button">button</a></li><li><a href="MarioAccelerometer.html#event:accel">accel</a></li><li><a href="MarioAccelerometer.html#event:gest">gest</a></li><li><a href="MarioBarcodeSensor.html#event:barcode">barcode</a></li><li><a href="MarioBarcodeSensor.html#event:rgb">rgb</a></li><li><a href="MarioPantsSensor.html#event:pants">pants</a></li><li><a href="MediumLinearMotor.html#event:rotate">rotate</a></li><li><a href="MotionSensor.html#event:distance">distance</a></li><li><a href="MoveHub.html#event:button">button</a></li><li><a href="MoveHubMediumLinearMotor.html#event:rotate">rotate</a></li><li><a href="MoveHubTiltSensor.html#event:tilt">tilt</a></li><li><a href="PoweredUP.html#event:discover">discover</a></li><li><a href="RemoteControl.html#event:button">button</a></li><li><a href="RemoteControlButton.html#event:button">button</a></li><li><a href="TachoMotor.html#event:rotate">rotate</a></li><li><a href="TechnicColorSensor.html#event:ambient">ambient</a></li><li><a href="TechnicColorSensor.html#event:color">color</a></li><li><a href="TechnicColorSensor.html#event:reflect">reflect</a></li><li><a href="TechnicDistanceSensor.html#event:distance">distance</a></li><li><a href="TechnicDistanceSensor.html#event:fastDistance">fastDistance</a></li><li><a href="TechnicForceSensor.html#event:force">force</a></li><li><a href="TechnicForceSensor.html#event:tapped">tapped</a></li><li><a href="TechnicForceSensor.html#event:touch">touch</a></li><li><a href="TechnicLargeAngularMotor.html#event:absolute">absolute</a></li><li><a href="TechnicLargeAngularMotor.html#event:rotate">rotate</a></li><li><a href="TechnicLargeLinearMotor.html#event:absolute">absolute</a></li><li><a href="TechnicLargeLinearMotor.html#event:rotate">rotate</a></li><li><a href="TechnicMediumAngularMotor.html#event:absolute">absolute</a></li><li><a href="TechnicMediumAngularMotor.html#event:rotate">rotate</a></li><li><a href="TechnicMediumHub.html#event:button">button</a></li><li><a href="TechnicMediumHubAccelerometerSensor.html#event:accel">accel</a></li><li><a href="TechnicMediumHubGyroSensor.html#event:gyro">gyro</a></li><li><a href="TechnicMediumHubTiltSensor.html#event:impactCount">impactCount</a></li><li><a href="TechnicMediumHubTiltSensor.html#event:tilt">tilt</a></li><li><a href="TechnicSmallAngularMotor.html#event:absolute">absolute</a></li><li><a href="TechnicSmallAngularMotor.html#event:rotate">rotate</a></li><li><a href="TechnicXLargeLinearMotor.html#event:absolute">absolute</a></li><li><a href="TechnicXLargeLinearMotor.html#event:rotate">rotate</a></li><li><a href="TiltSensor.html#event:tilt">tilt</a></li><li><a href="VoltageSensor.html#event:voltage">voltage</a></li><li><a href="WeDo2SmartHub.html#event:button">button</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Apr 25 2024 16:38:07 GMT-0700 (Pacific Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>