266 lines
17 KiB
HTML
266 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: hubs/wedo2smarthub.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/wedo2smarthub.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>"use strict";
|
|
var __createBinding = (this && 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 && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
}) : function(o, v) {
|
|
o["default"] = v;
|
|
});
|
|
var __importStar = (this && this.__importStar) || function (mod) {
|
|
if (mod && mod.__esModule) return mod;
|
|
var result = {};
|
|
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
__setModuleDefault(result, mod);
|
|
return result;
|
|
};
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.PortMap = exports.WeDo2SmartHub = void 0;
|
|
const basehub_1 = require("./basehub");
|
|
const Consts = __importStar(require("../consts"));
|
|
const utils_1 = require("../utils");
|
|
const Debug = require("debug");
|
|
const debug = Debug("wedo2smarthub");
|
|
/**
|
|
* The WeDo2SmartHub is emitted if the discovered device is a WeDo 2.0 Smart Hub.
|
|
* @class WeDo2SmartHub
|
|
* @extends BaseHub
|
|
*/
|
|
class WeDo2SmartHub extends basehub_1.BaseHub {
|
|
static IsWeDo2SmartHub(peripheral) {
|
|
return (peripheral.advertisement &&
|
|
peripheral.advertisement.serviceUuids &&
|
|
peripheral.advertisement.serviceUuids.indexOf(Consts.BLEService.WEDO2_SMART_HUB.replace(/-/g, "")) >= 0);
|
|
}
|
|
constructor(device) {
|
|
super(device, exports.PortMap, Consts.HubType.WEDO2_SMART_HUB);
|
|
this._lastTiltX = 0;
|
|
this._lastTiltY = 0;
|
|
debug("Discovered WeDo 2.0 Smart Hub");
|
|
}
|
|
connect() {
|
|
return new Promise(async (resolve) => {
|
|
debug("Connecting to WeDo 2.0 Smart Hub");
|
|
await super.connect();
|
|
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.WEDO2_SMART_HUB);
|
|
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.WEDO2_SMART_HUB_2);
|
|
if (!utils_1.isWebBluetooth) {
|
|
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.WEDO2_SMART_HUB_3);
|
|
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.WEDO2_SMART_HUB_4);
|
|
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.WEDO2_SMART_HUB_5);
|
|
}
|
|
else {
|
|
await this._bleDevice.discoverCharacteristicsForService("battery_service");
|
|
await this._bleDevice.discoverCharacteristicsForService("device_information");
|
|
}
|
|
debug("Connect completed");
|
|
this.emit("connect");
|
|
resolve();
|
|
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.WEDO2_PORT_TYPE, this._parsePortMessage.bind(this));
|
|
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.WEDO2_SENSOR_VALUE, this._parseSensorMessage.bind(this));
|
|
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.WEDO2_BUTTON, this._parseSensorMessage.bind(this));
|
|
if (!utils_1.isWebBluetooth) {
|
|
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.WEDO2_BATTERY, this._parseBatteryMessage.bind(this));
|
|
this._bleDevice.readFromCharacteristic(Consts.BLECharacteristic.WEDO2_BATTERY, (err, data) => {
|
|
if (data) {
|
|
this._parseBatteryMessage(data);
|
|
}
|
|
});
|
|
}
|
|
else {
|
|
this._bleDevice.readFromCharacteristic("00002a19-0000-1000-8000-00805f9b34fb", (err, data) => {
|
|
if (data) {
|
|
this._parseBatteryMessage(data);
|
|
}
|
|
});
|
|
this._bleDevice.subscribeToCharacteristic("00002a19-0000-1000-8000-00805f9b34fb", this._parseHighCurrentAlert.bind(this));
|
|
}
|
|
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.WEDO2_HIGH_CURRENT_ALERT, this._parseHighCurrentAlert.bind(this));
|
|
if (!utils_1.isWebBluetooth) {
|
|
this._bleDevice.readFromCharacteristic(Consts.BLECharacteristic.WEDO2_FIRMWARE_REVISION, (err, data) => {
|
|
if (data) {
|
|
this._parseFirmwareRevisionString(data);
|
|
}
|
|
});
|
|
}
|
|
else {
|
|
this._bleDevice.readFromCharacteristic("00002a26-0000-1000-8000-00805f9b34fb", (err, data) => {
|
|
if (data) {
|
|
this._parseFirmwareRevisionString(data);
|
|
}
|
|
});
|
|
}
|
|
});
|
|
}
|
|
/**
|
|
* Shutdown the Hub.
|
|
* @method WeDo2SmartHub#shutdown
|
|
* @returns {Promise} Resolved upon successful disconnect.
|
|
*/
|
|
shutdown() {
|
|
return this.send(Buffer.from([0x00]), Consts.BLECharacteristic.WEDO2_DISCONNECT);
|
|
}
|
|
/**
|
|
* Set the name of the Hub.
|
|
* @method WeDo2SmartHub#setName
|
|
* @param {string} name New name of the hub (14 characters or less, ASCII only).
|
|
* @returns {Promise} Resolved upon successful issuance of command.
|
|
*/
|
|
setName(name) {
|
|
if (name.length > 14) {
|
|
throw new Error("Name must be 14 characters or less");
|
|
}
|
|
return new Promise((resolve) => {
|
|
const data = Buffer.from(name, "ascii");
|
|
// Send this twice, as sometimes the first time doesn't take
|
|
this.send(data, Consts.BLECharacteristic.WEDO2_NAME_ID);
|
|
this.send(data, Consts.BLECharacteristic.WEDO2_NAME_ID);
|
|
this._name = name;
|
|
return resolve();
|
|
});
|
|
}
|
|
send(message, uuid) {
|
|
if (debug.enabled) {
|
|
debug(`Sent Message (${this._getCharacteristicNameFromUUID(uuid)})`, message);
|
|
}
|
|
return this._bleDevice.writeToCharacteristic(uuid, message);
|
|
}
|
|
subscribe(portId, deviceType, mode) {
|
|
this.send(Buffer.from([0x01, 0x02, portId, deviceType, mode, 0x01, 0x00, 0x00, 0x00, 0x00, 0x01]), Consts.BLECharacteristic.WEDO2_PORT_TYPE_WRITE);
|
|
}
|
|
unsubscribe(portId, deviceType, mode) {
|
|
this.send(Buffer.from([0x01, 0x02, portId, deviceType, mode, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00]), Consts.BLECharacteristic.WEDO2_PORT_TYPE_WRITE);
|
|
}
|
|
_getCharacteristicNameFromUUID(uuid) {
|
|
const keys = Object.keys(Consts.BLECharacteristic);
|
|
for (let i = 0; i < keys.length; i++) {
|
|
const key = keys[i];
|
|
if (Consts.BLECharacteristic[key] === uuid) {
|
|
return key;
|
|
}
|
|
}
|
|
return "UNKNOWN";
|
|
}
|
|
_parseHighCurrentAlert(data) {
|
|
debug("Received Message (WEDO2_HIGH_CURRENT_ALERT)", data);
|
|
}
|
|
_parseBatteryMessage(data) {
|
|
debug("Received Message (WEDO2_BATTERY)", data);
|
|
const batteryLevel = data[0];
|
|
if (batteryLevel !== this._batteryLevel) {
|
|
this._batteryLevel = batteryLevel;
|
|
this.emit("batteryLevel", { batteryLevel });
|
|
}
|
|
}
|
|
_parseFirmwareRevisionString(data) {
|
|
debug("Received Message (WEDO2_FIRMWARE_REVISION)", data);
|
|
this._firmwareVersion = data.toString();
|
|
}
|
|
_parsePortMessage(data) {
|
|
debug("Received Message (WEDO2_PORT_TYPE)", data);
|
|
const portId = data[0];
|
|
const event = data[1];
|
|
const deviceType = event ? data[3] : 0;
|
|
if (event === 0x01) {
|
|
const device = this._createDevice(deviceType, portId);
|
|
this._attachDevice(device);
|
|
}
|
|
else if (event === 0x00) {
|
|
const device = this._getDeviceByPortId(portId);
|
|
if (device) {
|
|
this._detachDevice(device);
|
|
}
|
|
}
|
|
}
|
|
_parseSensorMessage(message) {
|
|
debug("Received Message (WEDO2_SENSOR_VALUE)", message);
|
|
if (message[0] === 0x01) {
|
|
/**
|
|
* Emits when a button is pressed.
|
|
* @event WeDo2SmartHub#button
|
|
* @param {string} button
|
|
* @param {ButtonState} state
|
|
*/
|
|
this.emit("button", { event: Consts.ButtonState.PRESSED });
|
|
return;
|
|
}
|
|
else if (message[0] === 0x00) {
|
|
this.emit("button", { event: Consts.ButtonState.RELEASED });
|
|
return;
|
|
}
|
|
const portId = message[1];
|
|
const device = this._getDeviceByPortId(portId);
|
|
if (device) {
|
|
device.receive(message);
|
|
}
|
|
}
|
|
}
|
|
exports.WeDo2SmartHub = WeDo2SmartHub;
|
|
exports.PortMap = {
|
|
"A": 1,
|
|
"B": 2,
|
|
"CURRENT_SENSOR": 3,
|
|
"VOLTAGE_SENSOR": 4,
|
|
"PIEZO_BUZZER": 5,
|
|
"HUB_LED": 6
|
|
};
|
|
//# sourceMappingURL=wedo2smarthub.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:remoteButton">remoteButton</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 17:10:11 GMT-0700 (Pacific Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|