diff --git a/ABOUT.md b/ABOUT.md deleted file mode 100644 index cc45000..0000000 --- a/ABOUT.md +++ /dev/null @@ -1,93 +0,0 @@ -[![CircleCI](https://circleci.com/gh/nathankellenicki/node-poweredup.svg?style=shield)](https://circleci.com/gh/nathankellenicki/node-poweredup) -[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/node-poweredup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -![NPM Version](https://img.shields.io/npm/v/node-poweredup.svg?style=flat) - -# **node-poweredup** - A Node.js module to interface with LEGO Powered UP components. - -### Introduction - -LEGO Powered UP is the successor to Power Functions, the system for adding electronics to LEGO models. Powered UP is a collection of ranges - starting with LEGO WeDo 2.0 released in 2016, LEGO Boost released in 2017, and LEGO Powered UP released in 2018. It also includes the 2018 Duplo App-Controlled Train sets. - -Powered UP has a few improvements over Power Functions: - -1. The use of Bluetooth Low Energy makes it easy to control from a computer, and even write code for. - -2. The ability to use sensors to react to events happening in the real world opens up a whole new world of possibilities. - -3. As Powered UP hubs and remotes pair with each other, the system allows for a near unlimited number of independently controlled models in the same room. Power Functions was limited to 8 due to the use of infra-red for communication. - -### Installation - -Node.js v8.0 required. - -```javascript -npm install node-poweredup --save -``` - -node-poweredup uses the Noble BLE library by Sandeep Mistry. On macOS everything should function out of the box. On Linux and Windows there are [certain dependencies which may need installed first](https://github.com/noble/noble#prerequisites). - -Note: node-poweredup has been tested on macOS 10.13 and Debian/Raspbian on the Raspberry Pi 3 Model B. - -### Compatibility - -While most Powered UP components and Hubs are compatible with each other, there are exceptions. For example, there is limited backwards compatibility between newer components and the WeDo 2.0 Smart Hub. However WeDo 2.0 components are fully forwards compatible with newer Hubs. - -| Device Name | Product Code | Type | WeDo 2.0 Smart Hub | Boost Move Hub | Powered UP Hub | Availability | -| ------------------------------- | ------------ | ------------- | ------------------ | -------------- | -------------- | ------------ | -| WeDo 2.0 Tilt Sensor | 45305 | Sensor | Yes | Yes | Yes | 45300 | -| WeDo 2.0 Motion Sensor | 45304 | Sensor | Yes | Yes | Yes | 45300 | -| WeDo 2.0 Medium Motor | 45303 | Motor | Yes | Yes | Yes | 45300
76112 | -| Boost Color and Distance Sensor | 88007 | Sensor | *Partial* | Yes | Yes | 17101 | -| Boost Tacho Motor | 88008 | Motor/Sensor | *Partial* | Yes | *Partial* | 17101 | -| Powered UP Train Motor | 88011 | Motor | Yes | Yes | Yes | 60197
60198 | -| Powered UP LED Lights | 88005 | Light | Yes | Yes | Yes | 88005 | - -In addition, the Hubs themselves have certain built-in features which this library exposes. - -| Hub Name | Product Code | Built-In Features | Availability | -| ------------------ | ------------ | ---------------------- | ------------ | -| WeDo 2.0 Smart hub | 45301 | RGB LED
Piezo Buzzer
Button | 45300 | -| Boost Move Hub | 88006 | RGB LED
Tilt Sensor
2x Tacho Motors
Button | 17101 | -| Powered UP Hub | 88009 | RGB LED
Button | 60197
60198
76112 | -| Powered UP Remote | 88010 | RGB LED
Left and Right Control Buttons
Button | 60197
60198 | -| Duplo Train Base | 28743 | RGB LED/Headlights
Speaker
Speedometer
Motor
Color and Distance Sensor
Button | 10874
10875 | - - -### Known Issues and Limitations - -* The Boost Color and Distance sensor only works in color mode with the WeDo 2.0 Smart Hub. - -* When used with the WeDo 2.0 Smart Hub, the Boost Tacho Motor does not support rotating the motor by angle. - -* When used with the Powered UP Hub, the Boost Tacho Motor does not support rotating the motor by angle. It also does not support rotation detection. - -* Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix). - -### Usage - -```javascript -const PoweredUP = require("node-poweredup"); -const poweredUP = new PoweredUP.PoweredUP(); - -poweredUP.on("discover", async (hub) => { // Wait to discover a Hub - await hub.connect(); // Connect to the Hub - await hub.sleep(3000); // Sleep for 3 seconds before starting - - while (true) { // Repeat indefinitely - hub.setMotorSpeed("B", 75); // Start a motor attached to port B to run a 3/4 speed (75) indefinitely - await hub.setMotorSpeed("A", 100, 2000); // Run a motor attached to port A for 2 seconds at maximum speed (100) then stop - await hub.sleep(1000); // Do nothing for 1 second - await hub.setMotorSpeed("A", -50, 1000); // Run a motor attached to port A for 1 second at 1/2 speed in reverse (-50) then stop - await hub.sleep(1000); // Do nothing for 1 second - } -}); - -poweredUP.scan(); // Start scanning for Hubs -``` - -More examples are available in the "examples" directory. - -### Credits - -Thanks go to Jorge Pereira ([@JorgePe](https://github.com/JorgePe)), Sebastian Raff ([@hobbyquaker](https://github.com/hobbyquaker)), Valentin Heun ([@vheun](https://github.com/vheun)), Johan Korten ([@jakorten](https://github.com/jakorten)), and Andrey Pokhilko ([@undera](https://github.com/undera)) for their various works, contributions, and assistance on figuring out the LEGO Boost, WeDo 2.0, and Powered UP protocols. - diff --git a/DOCS.md b/DOCS.md deleted file mode 100644 index ee1b98c..0000000 --- a/DOCS.md +++ /dev/null @@ -1,1819 +0,0 @@ -## Classes - -
-
PoweredUPEventEmitter
-
-
WeDo2SmartHubHub
-
-
BoostMoveHubLPF2Hub
-
-
PUPHubLPF2Hub
-
-
PUPRemoteLPF2Hub
-
-
DuploTrainBaseLPF2Hub
-
-
- -## Typedefs - -
-
HubType
-
-
DeviceType
-
-
Color
-
-
ButtonState
-
-
DuploTrainBaseSound
-
-
- - - -## PoweredUP ⇐ EventEmitter -**Kind**: global class -**Extends**: EventEmitter - -* [PoweredUP](#PoweredUP) ⇐ EventEmitter - * [.scan()](#PoweredUP+scan) - * [.stop()](#PoweredUP+stop) - * [.getConnectedHubByUUID(uuid)](#PoweredUP+getConnectedHubByUUID) ⇒ Hub \| null - * [.getConnectedHubs()](#PoweredUP+getConnectedHubs) ⇒ Array.<Hub> - * ["discover" (hub)](#PoweredUP+event_discover) - - - -### poweredUP.scan() -Begin scanning for Powered UP Hub devices. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - - -### poweredUP.stop() -Stop scanning for Powered UP Hub devices. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - - -### poweredUP.getConnectedHubByUUID(uuid) ⇒ Hub \| null -Retrieve a Powered UP Hub by UUID. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - -| Param | Type | -| --- | --- | -| uuid | string | - - - -### poweredUP.getConnectedHubs() ⇒ Array.<Hub> -Retrieve a list of Powered UP Hubs. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - - -### "discover" (hub) -Emits when a Powered UP Hub device is found. - -**Kind**: event emitted by [PoweredUP](#PoweredUP) - -| Param | Type | -| --- | --- | -| hub | [WeDo2SmartHub](#WeDo2SmartHub) \| [BoostMoveHub](#BoostMoveHub) \| [PUPHub](#PUPHub) \| [PUPRemote](#PUPRemote) \| [DuploTrainBase](#DuploTrainBase) | - - - -## WeDo2SmartHub ⇐ Hub -**Kind**: global class -**Extends**: Hub - -* [WeDo2SmartHub](#WeDo2SmartHub) ⇐ Hub - * [new WeDo2SmartHub()](#new_WeDo2SmartHub_new) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setName(name)](#WeDo2SmartHub+setName) ⇒ Promise - * [.setLEDColor(color)](#WeDo2SmartHub+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#WeDo2SmartHub+setLEDRGB) ⇒ Promise - * [.setMotorSpeed(port, speed, [time])](#WeDo2SmartHub+setMotorSpeed) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#WeDo2SmartHub+rampMotorSpeed) ⇒ Promise - * [.playTone(frequency, time)](#WeDo2SmartHub+playTone) ⇒ Promise - * [.setLightBrightness(port, brightness, [time])](#WeDo2SmartHub+setLightBrightness) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#WeDo2SmartHub+event_button) - * ["distance" (port, distance)](#WeDo2SmartHub+event_distance) - * ["color" (port, color)](#WeDo2SmartHub+event_color) - * ["tilt" (port, x, y)](#WeDo2SmartHub+event_tilt) - * ["rotate" (port, rotation)](#WeDo2SmartHub+event_rotate) - * ["attach" (port, type)](#Hub+event_attach) - * ["detach" (port)](#Hub+event_detach) - - - -### new WeDo2SmartHub() -The WeDo2SmartHub is emitted if the discovered device is a WeDo 2.0 Smart Hub. - - - -### weDo2SmartHub.name -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### weDo2SmartHub.uuid -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### weDo2SmartHub.rssi -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### weDo2SmartHub.batteryLevel -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### weDo2SmartHub.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### weDo2SmartHub.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Hub via a color value. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### weDo2SmartHub.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### weDo2SmartHub.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### weDo2SmartHub.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### weDo2SmartHub.playTone(frequency, time) ⇒ Promise -Play a tone on the Hub's in-built buzzer - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command (ie. once the tone has finished playing). - -| Param | Type | Description | -| --- | --- | --- | -| frequency | number | | -| time | number | How long the tone should play for (in milliseconds). | - - - -### weDo2SmartHub.setLightBrightness(port, brightness, [time]) ⇒ Promise -Set the light brightness on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the light is turned off. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| brightness | number | Brightness value between 0-100 (0 is off) | -| [time] | number | How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely. | - - - -### weDo2SmartHub.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### weDo2SmartHub.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful disconnect. - - -### weDo2SmartHub.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### weDo2SmartHub.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### weDo2SmartHub.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### weDo2SmartHub.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### weDo2SmartHub.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) - - -### weDo2SmartHub.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "distance" (port, distance) -Emits when a distance sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| distance | number | Distance, in millimeters. | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "tilt" (port, x, y) -Emits when a tilt sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| x | number | -| y | number | - - - -### "rotate" (port, rotation) -Emits when a rotation sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| rotation | number | - - - -### "attach" (port, type) -Emits when a motor or sensor is attached to the Hub. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| type | [DeviceType](#DeviceType) | - - - -### "detach" (port) -Emits when an attached motor or sensor is detached from the Hub. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | - - - -## BoostMoveHub ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [BoostMoveHub](#BoostMoveHub) ⇐ LPF2Hub - * [new BoostMoveHub()](#new_BoostMoveHub_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setMotorSpeed(port, speed, [time])](#BoostMoveHub+setMotorSpeed) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#BoostMoveHub+rampMotorSpeed) ⇒ Promise - * [.setMotorAngle(port, angle, [speed])](#BoostMoveHub+setMotorAngle) ⇒ Promise - * [.setLightBrightness(port, brightness, [time])](#BoostMoveHub+setLightBrightness) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#LPF2Hub+event_button) - * ["distance" (port, distance)](#LPF2Hub+event_distance) - * ["color" (port, color)](#LPF2Hub+event_color) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - * ["tilt" (port, x, y)](#LPF2Hub+event_tilt) - * ["rotate" (port, rotation)](#LPF2Hub+event_rotate) - * ["attach" (port, type)](#Hub+event_attach) - * ["detach" (port)](#Hub+event_detach) - - - -### new BoostMoveHub() -The BoostMoveHub is emitted if the discovered device is a Boost Move Hub. - - - -### boostMoveHub.current -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### boostMoveHub.name -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### boostMoveHub.uuid -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### boostMoveHub.rssi -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### boostMoveHub.batteryLevel -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### boostMoveHub.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number \| Array.<number> | 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. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### boostMoveHub.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### boostMoveHub.setMotorAngle(port, angle, [speed]) ⇒ Promise -Rotate a motor by a given angle. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command (ie. once the motor is finished). - -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| port | string | | | -| angle | number | | How much the motor should be rotated (in degrees). | -| [speed] | number \| Array.<number> | 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. | - - - -### boostMoveHub.setLightBrightness(port, brightness, [time]) ⇒ Promise -Set the light brightness on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the light is turned off. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| brightness | number | Brightness value between 0-100 (0 is off) | -| [time] | number | How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely. | - - - -### boostMoveHub.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### boostMoveHub.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Hub via a color value. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### boostMoveHub.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### boostMoveHub.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### boostMoveHub.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### boostMoveHub.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### boostMoveHub.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### boostMoveHub.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### boostMoveHub.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### boostMoveHub.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [getHubType](#Hub+getHubType) - - -### boostMoveHub.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "distance" (port, distance) -Emits when a distance sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| distance | number | Distance, in millimeters. | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -### "tilt" (port, x, y) -Emits when a tilt sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used. | -| x | number | | -| y | number | | - - - -### "rotate" (port, rotation) -Emits when a rotation sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | -| --- | --- | -| port | string | -| rotation | number | - - - -### "attach" (port, type) -Emits when a motor or sensor is attached to the Hub. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) -**Overrides**: [attach](#Hub+event_attach) - -| Param | Type | -| --- | --- | -| port | string | -| type | [DeviceType](#DeviceType) | - - - -### "detach" (port) -Emits when an attached motor or sensor is detached from the Hub. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) -**Overrides**: [detach](#Hub+event_detach) - -| Param | Type | -| --- | --- | -| port | string | - - - -## PUPHub ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [PUPHub](#PUPHub) ⇐ LPF2Hub - * [new PUPHub()](#new_PUPHub_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setMotorSpeed(port, speed, [time])](#PUPHub+setMotorSpeed) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#PUPHub+rampMotorSpeed) ⇒ Promise - * [.setLightBrightness(port, brightness, [time])](#PUPHub+setLightBrightness) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#LPF2Hub+event_button) - * ["distance" (port, distance)](#LPF2Hub+event_distance) - * ["color" (port, color)](#LPF2Hub+event_color) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - * ["tilt" (port, x, y)](#LPF2Hub+event_tilt) - * ["attach" (port, type)](#Hub+event_attach) - * ["detach" (port)](#Hub+event_detach) - - - -### new PUPHub() -The PUPHub is emitted if the discovered device is a Powered UP Hub. - - - -### pupHub.current -**Kind**: instance property of [PUPHub](#PUPHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### pupHub.name -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### pupHub.uuid -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### pupHub.rssi -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### pupHub.batteryLevel -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### pupHub.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number \| Array.<number> | 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. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### pupHub.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### pupHub.setLightBrightness(port, brightness, [time]) ⇒ Promise -Set the light brightness on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the light is turned off. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| brightness | number | Brightness value between 0-100 (0 is off) | -| [time] | number | How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely. | - - - -### pupHub.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### pupHub.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Hub via a color value. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### pupHub.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### pupHub.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### pupHub.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### pupHub.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### pupHub.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### pupHub.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### pupHub.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### pupHub.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [getHubType](#Hub+getHubType) - - -### pupHub.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "distance" (port, distance) -Emits when a distance sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| distance | number | Distance, in millimeters. | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -### "tilt" (port, x, y) -Emits when a tilt sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used. | -| x | number | | -| y | number | | - - - -### "attach" (port, type) -Emits when a motor or sensor is attached to the Hub. - -**Kind**: event emitted by [PUPHub](#PUPHub) -**Overrides**: [attach](#Hub+event_attach) - -| Param | Type | -| --- | --- | -| port | string | -| type | [DeviceType](#DeviceType) | - - - -### "detach" (port) -Emits when an attached motor or sensor is detached from the Hub. - -**Kind**: event emitted by [PUPHub](#PUPHub) -**Overrides**: [detach](#Hub+event_detach) - -| Param | Type | -| --- | --- | -| port | string | - - - -## PUPRemote ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [PUPRemote](#PUPRemote) ⇐ LPF2Hub - * [new PUPRemote()](#new_PUPRemote_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setLEDColor(color)](#PUPRemote+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#PUPRemote+setLEDRGB) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#LPF2Hub+event_button) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - - - -### new PUPRemote() -The PUPRemote is emitted if the discovered device is a Powered UP Remote. - - - -### pupRemote.current -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### pupRemote.name -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### pupRemote.uuid -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### pupRemote.rssi -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### pupRemote.batteryLevel -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### pupRemote.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Remote via a color value. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [setLEDColor](#LPF2Hub+setLEDColor) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### pupRemote.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [setLEDRGB](#LPF2Hub+setLEDRGB) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### pupRemote.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### pupRemote.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### pupRemote.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### pupRemote.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### pupRemote.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### pupRemote.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### pupRemote.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### pupRemote.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [getHubType](#Hub+getHubType) - - -### pupRemote.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [PUPRemote](#PUPRemote) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [PUPRemote](#PUPRemote) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -## DuploTrainBase ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [DuploTrainBase](#DuploTrainBase) ⇐ LPF2Hub - * [new DuploTrainBase()](#new_DuploTrainBase_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setLEDColor(color)](#DuploTrainBase+setLEDColor) ⇒ Promise - * [.setMotorSpeed(port, speed, [time])](#DuploTrainBase+setMotorSpeed) ⇒ Promise - * [.playSound(sound)](#DuploTrainBase+playSound) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#DuploTrainBase+rampMotorSpeed) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["color" (port, color)](#LPF2Hub+event_color) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - * ["speed" (port, speed)](#LPF2Hub+event_speed) - - - -### new DuploTrainBase() -The DuploTrainBase is emitted if the discovered device is a Duplo Train Base. - - - -### duploTrainBase.current -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### duploTrainBase.name -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### duploTrainBase.uuid -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### duploTrainBase.rssi -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### duploTrainBase.batteryLevel -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### duploTrainBase.setLEDColor(color) ⇒ Promise -Set the color of the LED on the train via a color value. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [setLEDColor](#LPF2Hub+setLEDColor) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### duploTrainBase.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number \| Array.<number> | 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. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### duploTrainBase.playSound(sound) ⇒ Promise -Play a built-in train sound. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| sound | [DuploTrainBaseSound](#DuploTrainBaseSound) | - - - -### duploTrainBase.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### duploTrainBase.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### duploTrainBase.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### duploTrainBase.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### duploTrainBase.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### duploTrainBase.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### duploTrainBase.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### duploTrainBase.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### duploTrainBase.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### duploTrainBase.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [getHubType](#Hub+getHubType) - - -### duploTrainBase.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [DuploTrainBase](#DuploTrainBase) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [DuploTrainBase](#DuploTrainBase) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -### "speed" (port, speed) -Emits on a speed change. - -**Kind**: event emitted by [DuploTrainBase](#DuploTrainBase) - -| Param | Type | -| --- | --- | -| port | string | -| speed | number | - - - -## HubType -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| UNKNOWN | number | 0 | -| WEDO2_SMART_HUB | number | 1 | -| BOOST_MOVE_HUB | number | 2 | -| POWERED_UP_HUB | number | 3 | -| POWERED_UP_REMOTE | number | 4 | -| DUPLO_TRAIN_HUB | number | 5 | - - - -## DeviceType -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| UNKNOWN | number | 0 | -| BASIC_MOTOR | number | 1 | -| TRAIN_MOTOR | number | 2 | -| LED_LIGHTS | number | 8 | -| BOOST_LED | number | 22 | -| WEDO2_TILT | number | 34 | -| WEDO2_DISTANCE | number | 35 | -| BOOST_DISTANCE | number | 37 | -| BOOST_TACHO_MOTOR | number | 38 | -| BOOST_MOVE_HUB_MOTOR | number | 39 | -| BOOST_TILT | number | 40 | -| DUPLO_TRAIN_BASE_MOTOR | number | 41 | -| DUPLO_TRAIN_BASE_SPEAKER | number | 42 | -| DUPLO_TRAIN_BASE_COLOR | number | 43 | -| DUPLO_TRAIN_BASE_SPEEDOMETER | number | 44 | -| POWERED_UP_REMOTE_BUTTON | number | 55 | - - - -## Color -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| BLACK | number | 0 | -| PINK | number | 1 | -| PURPLE | number | 2 | -| BLUE | number | 3 | -| LIGHT_BLUE | number | 4 | -| CYAN | number | 5 | -| GREEN | number | 6 | -| YELLOW | number | 7 | -| ORANGE | number | 8 | -| RED | number | 9 | -| WHITE | number | 10 | -| NONE | number | 255 | - - - -## ButtonState -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| PRESSED | number | 0 | -| RELEASED | number | 1 | -| UP | number | 2 | -| DOWN | number | 3 | -| STOP | number | 4 | - - - -## DuploTrainBaseSound -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| BRAKE | number | 3 | -| STATION_DEPARTURE | number | 5 | -| WATER_REFILL | number | 7 | -| HORN | number | 9 | -| STEAM | number | 10 | - diff --git a/README.md b/README.md index 2dadfb8..ef956f1 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,11 @@ In addition, the Hubs themselves have certain built-in features which this libra * Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix). -### Usage +### Documentation + +[Full documentation is available here.](https://nathankellenicki.github.io/node-poweredup/) + +### Sample Usage ```javascript const PoweredUP = require("node-poweredup"); @@ -91,1822 +95,3 @@ More examples are available in the "examples" directory. Thanks go to Jorge Pereira ([@JorgePe](https://github.com/JorgePe)), Sebastian Raff ([@hobbyquaker](https://github.com/hobbyquaker)), Valentin Heun ([@vheun](https://github.com/vheun)), Johan Korten ([@jakorten](https://github.com/jakorten)), and Andrey Pokhilko ([@undera](https://github.com/undera)) for their various works, contributions, and assistance on figuring out the LEGO Boost, WeDo 2.0, and Powered UP protocols. -## Classes - -
-
PoweredUPEventEmitter
-
-
WeDo2SmartHubHub
-
-
BoostMoveHubLPF2Hub
-
-
PUPHubLPF2Hub
-
-
PUPRemoteLPF2Hub
-
-
DuploTrainBaseLPF2Hub
-
-
- -## Typedefs - -
-
HubType
-
-
DeviceType
-
-
Color
-
-
ButtonState
-
-
DuploTrainBaseSound
-
-
- - - -## PoweredUP ⇐ EventEmitter -**Kind**: global class -**Extends**: EventEmitter - -* [PoweredUP](#PoweredUP) ⇐ EventEmitter - * [.scan()](#PoweredUP+scan) - * [.stop()](#PoweredUP+stop) - * [.getConnectedHubByUUID(uuid)](#PoweredUP+getConnectedHubByUUID) ⇒ Hub \| null - * [.getConnectedHubs()](#PoweredUP+getConnectedHubs) ⇒ Array.<Hub> - * ["discover" (hub)](#PoweredUP+event_discover) - - - -### poweredUP.scan() -Begin scanning for Powered UP Hub devices. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - - -### poweredUP.stop() -Stop scanning for Powered UP Hub devices. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - - -### poweredUP.getConnectedHubByUUID(uuid) ⇒ Hub \| null -Retrieve a Powered UP Hub by UUID. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - -| Param | Type | -| --- | --- | -| uuid | string | - - - -### poweredUP.getConnectedHubs() ⇒ Array.<Hub> -Retrieve a list of Powered UP Hubs. - -**Kind**: instance method of [PoweredUP](#PoweredUP) - - -### "discover" (hub) -Emits when a Powered UP Hub device is found. - -**Kind**: event emitted by [PoweredUP](#PoweredUP) - -| Param | Type | -| --- | --- | -| hub | [WeDo2SmartHub](#WeDo2SmartHub) \| [BoostMoveHub](#BoostMoveHub) \| [PUPHub](#PUPHub) \| [PUPRemote](#PUPRemote) \| [DuploTrainBase](#DuploTrainBase) | - - - -## WeDo2SmartHub ⇐ Hub -**Kind**: global class -**Extends**: Hub - -* [WeDo2SmartHub](#WeDo2SmartHub) ⇐ Hub - * [new WeDo2SmartHub()](#new_WeDo2SmartHub_new) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setName(name)](#WeDo2SmartHub+setName) ⇒ Promise - * [.setLEDColor(color)](#WeDo2SmartHub+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#WeDo2SmartHub+setLEDRGB) ⇒ Promise - * [.setMotorSpeed(port, speed, [time])](#WeDo2SmartHub+setMotorSpeed) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#WeDo2SmartHub+rampMotorSpeed) ⇒ Promise - * [.playTone(frequency, time)](#WeDo2SmartHub+playTone) ⇒ Promise - * [.setLightBrightness(port, brightness, [time])](#WeDo2SmartHub+setLightBrightness) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#WeDo2SmartHub+event_button) - * ["distance" (port, distance)](#WeDo2SmartHub+event_distance) - * ["color" (port, color)](#WeDo2SmartHub+event_color) - * ["tilt" (port, x, y)](#WeDo2SmartHub+event_tilt) - * ["rotate" (port, rotation)](#WeDo2SmartHub+event_rotate) - * ["attach" (port, type)](#Hub+event_attach) - * ["detach" (port)](#Hub+event_detach) - - - -### new WeDo2SmartHub() -The WeDo2SmartHub is emitted if the discovered device is a WeDo 2.0 Smart Hub. - - - -### weDo2SmartHub.name -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### weDo2SmartHub.uuid -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### weDo2SmartHub.rssi -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### weDo2SmartHub.batteryLevel -**Kind**: instance property of [WeDo2SmartHub](#WeDo2SmartHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### weDo2SmartHub.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### weDo2SmartHub.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Hub via a color value. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### weDo2SmartHub.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### weDo2SmartHub.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### weDo2SmartHub.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### weDo2SmartHub.playTone(frequency, time) ⇒ Promise -Play a tone on the Hub's in-built buzzer - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command (ie. once the tone has finished playing). - -| Param | Type | Description | -| --- | --- | --- | -| frequency | number | | -| time | number | How long the tone should play for (in milliseconds). | - - - -### weDo2SmartHub.setLightBrightness(port, brightness, [time]) ⇒ Promise -Set the light brightness on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the light is turned off. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| brightness | number | Brightness value between 0-100 (0 is off) | -| [time] | number | How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely. | - - - -### weDo2SmartHub.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### weDo2SmartHub.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful disconnect. - - -### weDo2SmartHub.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### weDo2SmartHub.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### weDo2SmartHub.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### weDo2SmartHub.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### weDo2SmartHub.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) - - -### weDo2SmartHub.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "distance" (port, distance) -Emits when a distance sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| distance | number | Distance, in millimeters. | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "tilt" (port, x, y) -Emits when a tilt sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| x | number | -| y | number | - - - -### "rotate" (port, rotation) -Emits when a rotation sensor is activated. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| rotation | number | - - - -### "attach" (port, type) -Emits when a motor or sensor is attached to the Hub. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | -| type | [DeviceType](#DeviceType) | - - - -### "detach" (port) -Emits when an attached motor or sensor is detached from the Hub. - -**Kind**: event emitted by [WeDo2SmartHub](#WeDo2SmartHub) - -| Param | Type | -| --- | --- | -| port | string | - - - -## BoostMoveHub ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [BoostMoveHub](#BoostMoveHub) ⇐ LPF2Hub - * [new BoostMoveHub()](#new_BoostMoveHub_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setMotorSpeed(port, speed, [time])](#BoostMoveHub+setMotorSpeed) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#BoostMoveHub+rampMotorSpeed) ⇒ Promise - * [.setMotorAngle(port, angle, [speed])](#BoostMoveHub+setMotorAngle) ⇒ Promise - * [.setLightBrightness(port, brightness, [time])](#BoostMoveHub+setLightBrightness) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#LPF2Hub+event_button) - * ["distance" (port, distance)](#LPF2Hub+event_distance) - * ["color" (port, color)](#LPF2Hub+event_color) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - * ["tilt" (port, x, y)](#LPF2Hub+event_tilt) - * ["rotate" (port, rotation)](#LPF2Hub+event_rotate) - * ["attach" (port, type)](#Hub+event_attach) - * ["detach" (port)](#Hub+event_detach) - - - -### new BoostMoveHub() -The BoostMoveHub is emitted if the discovered device is a Boost Move Hub. - - - -### boostMoveHub.current -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### boostMoveHub.name -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### boostMoveHub.uuid -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### boostMoveHub.rssi -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### boostMoveHub.batteryLevel -**Kind**: instance property of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### boostMoveHub.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number \| Array.<number> | 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. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### boostMoveHub.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### boostMoveHub.setMotorAngle(port, angle, [speed]) ⇒ Promise -Rotate a motor by a given angle. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command (ie. once the motor is finished). - -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| port | string | | | -| angle | number | | How much the motor should be rotated (in degrees). | -| [speed] | number \| Array.<number> | 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. | - - - -### boostMoveHub.setLightBrightness(port, brightness, [time]) ⇒ Promise -Set the light brightness on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the light is turned off. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| brightness | number | Brightness value between 0-100 (0 is off) | -| [time] | number | How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely. | - - - -### boostMoveHub.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### boostMoveHub.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Hub via a color value. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### boostMoveHub.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### boostMoveHub.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### boostMoveHub.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### boostMoveHub.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### boostMoveHub.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### boostMoveHub.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### boostMoveHub.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### boostMoveHub.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [getHubType](#Hub+getHubType) - - -### boostMoveHub.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [BoostMoveHub](#BoostMoveHub) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "distance" (port, distance) -Emits when a distance sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| distance | number | Distance, in millimeters. | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -### "tilt" (port, x, y) -Emits when a tilt sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used. | -| x | number | | -| y | number | | - - - -### "rotate" (port, rotation) -Emits when a rotation sensor is activated. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) - -| Param | Type | -| --- | --- | -| port | string | -| rotation | number | - - - -### "attach" (port, type) -Emits when a motor or sensor is attached to the Hub. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) -**Overrides**: [attach](#Hub+event_attach) - -| Param | Type | -| --- | --- | -| port | string | -| type | [DeviceType](#DeviceType) | - - - -### "detach" (port) -Emits when an attached motor or sensor is detached from the Hub. - -**Kind**: event emitted by [BoostMoveHub](#BoostMoveHub) -**Overrides**: [detach](#Hub+event_detach) - -| Param | Type | -| --- | --- | -| port | string | - - - -## PUPHub ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [PUPHub](#PUPHub) ⇐ LPF2Hub - * [new PUPHub()](#new_PUPHub_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setMotorSpeed(port, speed, [time])](#PUPHub+setMotorSpeed) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#PUPHub+rampMotorSpeed) ⇒ Promise - * [.setLightBrightness(port, brightness, [time])](#PUPHub+setLightBrightness) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#LPF2Hub+event_button) - * ["distance" (port, distance)](#LPF2Hub+event_distance) - * ["color" (port, color)](#LPF2Hub+event_color) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - * ["tilt" (port, x, y)](#LPF2Hub+event_tilt) - * ["attach" (port, type)](#Hub+event_attach) - * ["detach" (port)](#Hub+event_detach) - - - -### new PUPHub() -The PUPHub is emitted if the discovered device is a Powered UP Hub. - - - -### pupHub.current -**Kind**: instance property of [PUPHub](#PUPHub) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### pupHub.name -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### pupHub.uuid -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### pupHub.rssi -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### pupHub.batteryLevel -**Kind**: instance property of [PUPHub](#PUPHub) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### pupHub.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number \| Array.<number> | 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. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### pupHub.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### pupHub.setLightBrightness(port, brightness, [time]) ⇒ Promise -Set the light brightness on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the light is turned off. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| brightness | number | Brightness value between 0-100 (0 is off) | -| [time] | number | How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely. | - - - -### pupHub.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### pupHub.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Hub via a color value. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### pupHub.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### pupHub.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### pupHub.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### pupHub.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### pupHub.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### pupHub.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### pupHub.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### pupHub.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [getHubType](#Hub+getHubType) - - -### pupHub.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [PUPHub](#PUPHub) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "distance" (port, distance) -Emits when a distance sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| distance | number | Distance, in millimeters. | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -### "tilt" (port, x, y) -Emits when a tilt sensor is activated. - -**Kind**: event emitted by [PUPHub](#PUPHub) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used. | -| x | number | | -| y | number | | - - - -### "attach" (port, type) -Emits when a motor or sensor is attached to the Hub. - -**Kind**: event emitted by [PUPHub](#PUPHub) -**Overrides**: [attach](#Hub+event_attach) - -| Param | Type | -| --- | --- | -| port | string | -| type | [DeviceType](#DeviceType) | - - - -### "detach" (port) -Emits when an attached motor or sensor is detached from the Hub. - -**Kind**: event emitted by [PUPHub](#PUPHub) -**Overrides**: [detach](#Hub+event_detach) - -| Param | Type | -| --- | --- | -| port | string | - - - -## PUPRemote ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [PUPRemote](#PUPRemote) ⇐ LPF2Hub - * [new PUPRemote()](#new_PUPRemote_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setLEDColor(color)](#PUPRemote+setLEDColor) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#PUPRemote+setLEDRGB) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["button" (button, state)](#LPF2Hub+event_button) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - - - -### new PUPRemote() -The PUPRemote is emitted if the discovered device is a Powered UP Remote. - - - -### pupRemote.current -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### pupRemote.name -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### pupRemote.uuid -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### pupRemote.rssi -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### pupRemote.batteryLevel -**Kind**: instance property of [PUPRemote](#PUPRemote) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### pupRemote.setLEDColor(color) ⇒ Promise -Set the color of the LED on the Remote via a color value. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [setLEDColor](#LPF2Hub+setLEDColor) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### pupRemote.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [setLEDRGB](#LPF2Hub+setLEDRGB) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### pupRemote.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### pupRemote.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### pupRemote.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### pupRemote.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### pupRemote.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### pupRemote.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### pupRemote.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### pupRemote.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [getHubType](#Hub+getHubType) - - -### pupRemote.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [PUPRemote](#PUPRemote) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "button" (button, state) -Emits when a button is pressed. - -**Kind**: event emitted by [PUPRemote](#PUPRemote) - -| Param | Type | -| --- | --- | -| button | string | -| state | [ButtonState](#ButtonState) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [PUPRemote](#PUPRemote) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -## DuploTrainBase ⇐ LPF2Hub -**Kind**: global class -**Extends**: LPF2Hub, Hub - -* [DuploTrainBase](#DuploTrainBase) ⇐ LPF2Hub - * [new DuploTrainBase()](#new_DuploTrainBase_new) - * [.current](#LPF2Hub+current) - * [.name](#Hub+name) - * [.uuid](#Hub+uuid) - * [.rssi](#Hub+rssi) - * [.batteryLevel](#Hub+batteryLevel) - * [.setLEDColor(color)](#DuploTrainBase+setLEDColor) ⇒ Promise - * [.setMotorSpeed(port, speed, [time])](#DuploTrainBase+setMotorSpeed) ⇒ Promise - * [.playSound(sound)](#DuploTrainBase+playSound) ⇒ Promise - * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#DuploTrainBase+rampMotorSpeed) ⇒ Promise - * [.setName(name)](#LPF2Hub+setName) ⇒ Promise - * [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ Promise - * [.connect()](#Hub+connect) ⇒ Promise - * [.disconnect()](#Hub+disconnect) ⇒ Promise - * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ Promise - * [.unsubscribe(port)](#Hub+unsubscribe) ⇒ Promise - * [.sleep(delay)](#Hub+sleep) ⇒ Promise - * [.wait(commands)](#Hub+wait) ⇒ Promise - * [.getHubType()](#Hub+getHubType) ⇒ [HubType](#HubType) - * [.getPortDeviceType(port)](#Hub+getPortDeviceType) ⇒ [DeviceType](#DeviceType) - * ["color" (port, color)](#LPF2Hub+event_color) - * ["colorAndDistance" (port, color, distance)](#LPF2Hub+event_colorAndDistance) - * ["speed" (port, speed)](#LPF2Hub+event_speed) - - - -### new DuploTrainBase() -The DuploTrainBase is emitted if the discovered device is a Duplo Train Base. - - - -### duploTrainBase.current -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| current | number | Current usage of the hub (Amps) | - - - -### duploTrainBase.name -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [name](#Hub+name) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| name | string | Name of the hub | - - - -### duploTrainBase.uuid -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [uuid](#Hub+uuid) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| uuid | string | UUID of the hub | - - - -### duploTrainBase.rssi -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [rssi](#Hub+rssi) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| rssi | number | Signal strength of the hub | - - - -### duploTrainBase.batteryLevel -**Kind**: instance property of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [batteryLevel](#Hub+batteryLevel) -**Read only**: true -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| batteryLevel | number | Battery level of the hub (Percentage between 0-100) | - - - -### duploTrainBase.setLEDColor(color) ⇒ Promise -Set the color of the LED on the train via a color value. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [setLEDColor](#LPF2Hub+setLEDColor) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| color | [Color](#Color) | - - - -### duploTrainBase.setMotorSpeed(port, speed, [time]) ⇒ Promise -Set the motor speed on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful completion of command. If time is specified, this is once the motor is finished. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| speed | number \| Array.<number> | 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. | -| [time] | number | How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely. | - - - -### duploTrainBase.playSound(sound) ⇒ Promise -Play a built-in train sound. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| sound | [DuploTrainBaseSound](#DuploTrainBaseSound) | - - - -### duploTrainBase.rampMotorSpeed(port, fromSpeed, toSpeed, time) ⇒ Promise -Ramp the motor speed on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful completion of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| fromSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| toSpeed | number | For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. | -| time | number | How long the ramp should last (in milliseconds). | - - - -### duploTrainBase.setName(name) ⇒ Promise -Set the name of the Hub. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| name | string | New name of the hub (14 characters or less, ASCII only). | - - - -### duploTrainBase.setLEDRGB(red, green, blue) ⇒ Promise -Set the color of the LED on the Hub via RGB values. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| red | number | -| green | number | -| blue | number | - - - -### duploTrainBase.connect() ⇒ Promise -Connect to the Hub. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [connect](#Hub+connect) -**Returns**: Promise - Resolved upon successful connect. - - -### duploTrainBase.disconnect() ⇒ Promise -Disconnect the Hub. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [disconnect](#Hub+disconnect) -**Returns**: Promise - Resolved upon successful disconnect. - - -### duploTrainBase.subscribe(port, [mode]) ⇒ Promise -Subscribe to sensor notifications on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [subscribe](#Hub+subscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| [mode] | number | The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen. | - - - -### duploTrainBase.unsubscribe(port) ⇒ Promise -Unsubscribe to sensor notifications on a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [unsubscribe](#Hub+unsubscribe) -**Returns**: Promise - Resolved upon successful issuance of command. - -| Param | Type | -| --- | --- | -| port | string | - - - -### duploTrainBase.sleep(delay) ⇒ Promise -Sleep a given amount of time. - -This is a helper method to make it easier to add delays into a chain of commands. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [sleep](#Hub+sleep) -**Returns**: Promise - Resolved after the delay is finished. - -| Param | Type | Description | -| --- | --- | --- | -| delay | number | How long to sleep (in milliseconds). | - - - -### duploTrainBase.wait(commands) ⇒ Promise -Wait until a given list of concurrently running commands are complete. - -This is a helper method to make it easier to wait for concurrent commands to complete. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [wait](#Hub+wait) -**Returns**: Promise - Resolved after the commands are finished. - -| Param | Type | Description | -| --- | --- | --- | -| commands | Array.<Promise.<any>> | Array of executing commands. | - - - -### duploTrainBase.getHubType() ⇒ [HubType](#HubType) -Get the hub type. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [getHubType](#Hub+getHubType) - - -### duploTrainBase.getPortDeviceType(port) ⇒ [DeviceType](#DeviceType) -Get the device type for a given port. - -**Kind**: instance method of [DuploTrainBase](#DuploTrainBase) -**Overrides**: [getPortDeviceType](#Hub+getPortDeviceType) - -| Param | Type | -| --- | --- | -| port | string | - - - -### "color" (port, color) -Emits when a color sensor is activated. - -**Kind**: event emitted by [DuploTrainBase](#DuploTrainBase) - -| Param | Type | -| --- | --- | -| port | string | -| color | [Color](#Color) | - - - -### "colorAndDistance" (port, color, distance) -A combined color and distance event, emits when the sensor is activated. - -**Kind**: event emitted by [DuploTrainBase](#DuploTrainBase) - -| Param | Type | Description | -| --- | --- | --- | -| port | string | | -| color | [Color](#Color) | | -| distance | number | Distance, in millimeters. | - - - -### "speed" (port, speed) -Emits on a speed change. - -**Kind**: event emitted by [DuploTrainBase](#DuploTrainBase) - -| Param | Type | -| --- | --- | -| port | string | -| speed | number | - - - -## HubType -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| UNKNOWN | number | 0 | -| WEDO2_SMART_HUB | number | 1 | -| BOOST_MOVE_HUB | number | 2 | -| POWERED_UP_HUB | number | 3 | -| POWERED_UP_REMOTE | number | 4 | -| DUPLO_TRAIN_HUB | number | 5 | - - - -## DeviceType -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| UNKNOWN | number | 0 | -| BASIC_MOTOR | number | 1 | -| TRAIN_MOTOR | number | 2 | -| LED_LIGHTS | number | 8 | -| BOOST_LED | number | 22 | -| WEDO2_TILT | number | 34 | -| WEDO2_DISTANCE | number | 35 | -| BOOST_DISTANCE | number | 37 | -| BOOST_TACHO_MOTOR | number | 38 | -| BOOST_MOVE_HUB_MOTOR | number | 39 | -| BOOST_TILT | number | 40 | -| DUPLO_TRAIN_BASE_MOTOR | number | 41 | -| DUPLO_TRAIN_BASE_SPEAKER | number | 42 | -| DUPLO_TRAIN_BASE_COLOR | number | 43 | -| DUPLO_TRAIN_BASE_SPEEDOMETER | number | 44 | -| POWERED_UP_REMOTE_BUTTON | number | 55 | - - - -## Color -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| BLACK | number | 0 | -| PINK | number | 1 | -| PURPLE | number | 2 | -| BLUE | number | 3 | -| LIGHT_BLUE | number | 4 | -| CYAN | number | 5 | -| GREEN | number | 6 | -| YELLOW | number | 7 | -| ORANGE | number | 8 | -| RED | number | 9 | -| WHITE | number | 10 | -| NONE | number | 255 | - - - -## ButtonState -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| PRESSED | number | 0 | -| RELEASED | number | 1 | -| UP | number | 2 | -| DOWN | number | 3 | -| STOP | number | 4 | - - - -## DuploTrainBaseSound -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| BRAKE | number | 3 | -| STATION_DEPARTURE | number | 5 | -| WATER_REFILL | number | 7 | -| HORN | number | 9 | -| STEAM | number | 10 | - diff --git a/docs/BoostMoveHub.html b/docs/BoostMoveHub.html new file mode 100644 index 0000000..f10abce --- /dev/null +++ b/docs/BoostMoveHub.html @@ -0,0 +1,5679 @@ + + + + + + + DocStrap Class: BoostMoveHub + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: BoostMoveHub

+
+ +
+ +

+ BoostMoveHub +

+ + +
+ + +
+
+ + +
+
+

new BoostMoveHub()

+ + +
+
+ + +
+

The BoostMoveHub is emitted if the discovered device is a Boost Move Hub.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ +
+ +
+
+

<readonly> batteryLevel

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
batteryLevel + + +number + + + + +

Battery level of the hub (Percentage between 0-100)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> firmwareVersion

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
firmwareVersion + + +string + + + + +

Firmware version of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

Name of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> rssi

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rssi + + +number + + + + +

Signal strength of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> uuid

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +

UUID of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> voltage

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
voltage + + +number + + + + +

Voltage of the hub (Volts)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

brakeMotor(port)

+ + +
+
+ + +
+

Fully (hard) stop the motor on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

connect()

+ + +
+
+ + +
+

Connect to the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful connect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

getHubType()

+ + +
+
+ + +
+

Get the hub type.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +HubType + + + +
+
+ + + + + +
+ + + +
+
+

getPortDeviceType(port)

+ + +
+
+ + +
+

Get the device type for a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +DeviceType + + + +
+
+ + + + + +
+ + + +
+
+

rampMotorSpeed(port, fromSpeed, toSpeed, time)

+ + +
+
+ + +
+

Ramp the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
fromSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

toSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

time + + +number + + + + +

How long the ramp should last (in milliseconds).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDColor(color)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via a color value.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDRGB(red, green, blue)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via RGB values.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
red + + +number + + + + +
green + + +number + + + + +
blue + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLightBrightness(port, brightness [, time])

+ + +
+
+ + +
+

Set the light brightness on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
brightness + + +number + + + + + + + + + + +

Brightness value between 0-100 (0 is off)

time + + +number + + + + + + + <optional>
+ + + + + +

How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command. If time is specified, this is once the light is turned off.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setMotorAngle(port, angle [, speed])

+ + +
+
+ + +
+

Rotate a motor by a given angle.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDefaultDescription
port + + +string + + + + + + + + + + + + +
angle + + +number + + + + + + + + + + + + +

How much the motor should be rotated (in degrees).

speed + + +number +| + +Array.<number> + + + + + + + <optional>
+ + + + + +
+ + 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.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command (ie. once the motor is finished).

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setMotorSpeed(port, speed [, time])

+ + +
+
+ + +
+

Set the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
speed + + +number +| + +Array.<number> + + + + + + + + + + +

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.

time + + +number + + + + + + + <optional>
+ + + + + +

How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command. If time is specified, this is once the motor is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setName(name)

+ + +
+
+ + +
+

Set the name of the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

New name of the hub (14 characters or less, ASCII only).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

shutdown()

+ + +
+
+ + +
+

Shutdown the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

sleep(delay)

+ + +
+
+ + +
+

Sleep a given amount of time.

+

This is a helper method to make it easier to add delays into a chain of commands.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
delay + + +number + + + + +

How long to sleep (in milliseconds).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the delay is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

subscribe(port [, mode])

+ + +
+
+ + +
+

Subscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
mode + + +number + + + + + + + <optional>
+ + + + + +

The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

unsubscribe(port)

+ + +
+
+ + +
+

Unsubscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

wait(commands)

+ + +
+
+ + +
+

Wait until a given list of concurrently running commands are complete.

+

This is a helper method to make it easier to wait for concurrent commands to complete.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
commands + + +Array.<Promise.<any>> + + + + +

Array of executing commands.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the commands are finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

rotate

+ + +
+
+ + +
+

Emits when a rotation sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
rotation + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +

If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/DuploTrainBase.html b/docs/DuploTrainBase.html new file mode 100644 index 0000000..6027706 --- /dev/null +++ b/docs/DuploTrainBase.html @@ -0,0 +1,4282 @@ + + + + + + + DocStrap Class: DuploTrainBase + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: DuploTrainBase

+
+ +
+ +

+ DuploTrainBase +

+ + +
+ + +
+
+ + +
+
+

new DuploTrainBase()

+ + +
+
+ + +
+

The DuploTrainBase is emitted if the discovered device is a Duplo Train Base.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ +
+ +
+
+

<readonly> batteryLevel

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
batteryLevel + + +number + + + + +

Battery level of the hub (Percentage between 0-100)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> firmwareVersion

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
firmwareVersion + + +string + + + + +

Firmware version of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

Name of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> rssi

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rssi + + +number + + + + +

Signal strength of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> uuid

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +

UUID of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> voltage

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
voltage + + +number + + + + +

Voltage of the hub (Volts)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

brakeMotor(port)

+ + +
+
+ + +
+

Fully (hard) stop the motor on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

connect()

+ + +
+
+ + +
+

Connect to the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful connect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

getHubType()

+ + +
+
+ + +
+

Get the hub type.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +HubType + + + +
+
+ + + + + +
+ + + +
+
+

getPortDeviceType(port)

+ + +
+
+ + +
+

Get the device type for a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +DeviceType + + + +
+
+ + + + + +
+ + + +
+
+

playSound(sound)

+ + +
+
+ + +
+

Play a built-in train sound.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sound + + +DuploTrainBaseSound + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

rampMotorSpeed(port, fromSpeed, toSpeed, time)

+ + +
+
+ + +
+

Ramp the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
fromSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

toSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

time + + +number + + + + +

How long the ramp should last (in milliseconds).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDColor(color)

+ + +
+
+ + +
+

Set the color of the LED on the train via a color value.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDRGB(red, green, blue)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via RGB values.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
red + + +number + + + + +
green + + +number + + + + +
blue + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setMotorSpeed(port, speed [, time])

+ + +
+
+ + +
+

Set the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
speed + + +number +| + +Array.<number> + + + + + + + + + + +

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.

time + + +number + + + + + + + <optional>
+ + + + + +

How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command. If time is specified, this is once the motor is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setName(name)

+ + +
+
+ + +
+

Set the name of the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

New name of the hub (14 characters or less, ASCII only).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

shutdown()

+ + +
+
+ + +
+

Shutdown the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

sleep(delay)

+ + +
+
+ + +
+

Sleep a given amount of time.

+

This is a helper method to make it easier to add delays into a chain of commands.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
delay + + +number + + + + +

How long to sleep (in milliseconds).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the delay is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

subscribe(port [, mode])

+ + +
+
+ + +
+

Subscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
mode + + +number + + + + + + + <optional>
+ + + + + +

The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

unsubscribe(port)

+ + +
+
+ + +
+

Unsubscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

wait(commands)

+ + +
+
+ + +
+

Wait until a given list of concurrently running commands are complete.

+

This is a helper method to make it easier to wait for concurrent commands to complete.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
commands + + +Array.<Promise.<any>> + + + + +

Array of executing commands.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the commands are finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

speed

+ + +
+
+ + +
+

Emits on a speed change.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
speed + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/Hub.html b/docs/Hub.html new file mode 100644 index 0000000..b905d28 --- /dev/null +++ b/docs/Hub.html @@ -0,0 +1,2561 @@ + + + + + + + DocStrap Class: Hub + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: Hub

+
+ +
+ +

+ Hub +

+ + +
+ + +
+
+ + +
+
+

new Hub()

+ + +
+
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + +
    +
  • EventEmitter
  • +
+ + + + + + + + + + + + + +

Members

+ +
+ +
+
+

<readonly> batteryLevel

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
batteryLevel + + +number + + + + +

Battery level of the hub (Percentage between 0-100)

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> firmwareVersion

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
firmwareVersion + + +string + + + + +

Firmware version of the hub

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

Name of the hub

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> rssi

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rssi + + +number + + + + +

Signal strength of the hub

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> uuid

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +

UUID of the hub

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> voltage

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
voltage + + +number + + + + +

Voltage of the hub (Volts)

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

connect()

+ + +
+
+ + +
+

Connect to the Hub.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful connect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect the Hub.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

getHubType()

+ + +
+
+ + +
+

Get the hub type.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +HubType + + + +
+
+ + + + + +
+ + + +
+
+

getPortDeviceType(port)

+ + +
+
+ + +
+

Get the device type for a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +DeviceType + + + +
+
+ + + + + +
+ + + +
+
+

sleep(delay)

+ + +
+
+ + +
+

Sleep a given amount of time.

+

This is a helper method to make it easier to add delays into a chain of commands.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
delay + + +number + + + + +

How long to sleep (in milliseconds).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the delay is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

subscribe(port [, mode])

+ + +
+
+ + +
+

Subscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
mode + + +number + + + + + + + <optional>
+ + + + + +

The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

unsubscribe(port)

+ + +
+
+ + +
+

Unsubscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

wait(commands)

+ + +
+
+ + +
+

Wait until a given list of concurrently running commands are complete.

+

This is a helper method to make it easier to wait for concurrent commands to complete.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
commands + + +Array.<Promise.<any>> + + + + +

Array of executing commands.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the commands are finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/LPF2Hub.html b/docs/LPF2Hub.html new file mode 100644 index 0000000..1b7bb69 --- /dev/null +++ b/docs/LPF2Hub.html @@ -0,0 +1,4538 @@ + + + + + + + DocStrap Class: LPF2Hub + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: LPF2Hub

+
+ +
+ +

+ LPF2Hub +

+ + +
+ + +
+
+ + +
+
+

new LPF2Hub()

+ + +
+
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ +
+ +
+
+

<readonly> batteryLevel

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
batteryLevel + + +number + + + + +

Battery level of the hub (Percentage between 0-100)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> firmwareVersion

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
firmwareVersion + + +string + + + + +

Firmware version of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

Name of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> rssi

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rssi + + +number + + + + +

Signal strength of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> uuid

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +

UUID of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> voltage

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
voltage + + +number + + + + +

Voltage of the hub (Volts)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

connect()

+ + +
+
+ + +
+

Connect to the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful connect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

getHubType()

+ + +
+
+ + +
+

Get the hub type.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +HubType + + + +
+
+ + + + + +
+ + + +
+
+

getPortDeviceType(port)

+ + +
+
+ + +
+

Get the device type for a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +DeviceType + + + +
+
+ + + + + +
+ + + +
+
+

setLEDColor(color)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via a color value.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDRGB(red, green, blue)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via RGB values.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
red + + +number + + + + +
green + + +number + + + + +
blue + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setName(name)

+ + +
+
+ + +
+

Set the name of the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

New name of the hub (14 characters or less, ASCII only).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

shutdown()

+ + +
+
+ + +
+

Shutdown the Hub.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

sleep(delay)

+ + +
+
+ + +
+

Sleep a given amount of time.

+

This is a helper method to make it easier to add delays into a chain of commands.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
delay + + +number + + + + +

How long to sleep (in milliseconds).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the delay is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

subscribe(port [, mode])

+ + +
+
+ + +
+

Subscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
mode + + +number + + + + + + + <optional>
+ + + + + +

The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

unsubscribe(port)

+ + +
+
+ + +
+

Unsubscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

wait(commands)

+ + +
+
+ + +
+

Wait until a given list of concurrently running commands are complete.

+

This is a helper method to make it easier to wait for concurrent commands to complete.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
commands + + +Array.<Promise.<any>> + + + + +

Array of executing commands.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the commands are finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

rotate

+ + +
+
+ + +
+

Emits when a rotation sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
rotation + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

speed

+ + +
+
+ + +
+

Emits on a speed change.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
speed + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +

If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/PUPHub.html b/docs/PUPHub.html new file mode 100644 index 0000000..adfe834 --- /dev/null +++ b/docs/PUPHub.html @@ -0,0 +1,5251 @@ + + + + + + + DocStrap Class: PUPHub + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: PUPHub

+
+ +
+ +

+ PUPHub +

+ + +
+ + +
+
+ + +
+
+

new PUPHub()

+ + +
+
+ + +
+

The PUPHub is emitted if the discovered device is a Powered UP Hub.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ +
+ +
+
+

<readonly> batteryLevel

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
batteryLevel + + +number + + + + +

Battery level of the hub (Percentage between 0-100)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> firmwareVersion

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
firmwareVersion + + +string + + + + +

Firmware version of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

Name of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> rssi

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rssi + + +number + + + + +

Signal strength of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> uuid

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +

UUID of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> voltage

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
voltage + + +number + + + + +

Voltage of the hub (Volts)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

brakeMotor(port)

+ + +
+
+ + +
+

Fully (hard) stop the motor on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

connect()

+ + +
+
+ + +
+

Connect to the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful connect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

getHubType()

+ + +
+
+ + +
+

Get the hub type.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +HubType + + + +
+
+ + + + + +
+ + + +
+
+

getPortDeviceType(port)

+ + +
+
+ + +
+

Get the device type for a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +DeviceType + + + +
+
+ + + + + +
+ + + +
+
+

rampMotorSpeed(port, fromSpeed, toSpeed, time)

+ + +
+
+ + +
+

Ramp the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
fromSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

toSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

time + + +number + + + + +

How long the ramp should last (in milliseconds).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDColor(color)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via a color value.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDRGB(red, green, blue)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via RGB values.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
red + + +number + + + + +
green + + +number + + + + +
blue + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLightBrightness(port, brightness [, time])

+ + +
+
+ + +
+

Set the light brightness on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
brightness + + +number + + + + + + + + + + +

Brightness value between 0-100 (0 is off)

time + + +number + + + + + + + <optional>
+ + + + + +

How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command. If time is specified, this is once the light is turned off.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setMotorSpeed(port, speed [, time])

+ + +
+
+ + +
+

Set the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
speed + + +number +| + +Array.<number> + + + + + + + + + + +

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.

time + + +number + + + + + + + <optional>
+ + + + + +

How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command. If time is specified, this is once the motor is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setName(name)

+ + +
+
+ + +
+

Set the name of the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

New name of the hub (14 characters or less, ASCII only).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

shutdown()

+ + +
+
+ + +
+

Shutdown the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

sleep(delay)

+ + +
+
+ + +
+

Sleep a given amount of time.

+

This is a helper method to make it easier to add delays into a chain of commands.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
delay + + +number + + + + +

How long to sleep (in milliseconds).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the delay is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

subscribe(port [, mode])

+ + +
+
+ + +
+

Subscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
mode + + +number + + + + + + + <optional>
+ + + + + +

The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

unsubscribe(port)

+ + +
+
+ + +
+

Unsubscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

wait(commands)

+ + +
+
+ + +
+

Wait until a given list of concurrently running commands are complete.

+

This is a helper method to make it easier to wait for concurrent commands to complete.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
commands + + +Array.<Promise.<any>> + + + + +

Array of executing commands.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the commands are finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +

If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/PUPRemote.html b/docs/PUPRemote.html new file mode 100644 index 0000000..00230ea --- /dev/null +++ b/docs/PUPRemote.html @@ -0,0 +1,3503 @@ + + + + + + + DocStrap Class: PUPRemote + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: PUPRemote

+
+ +
+ +

+ PUPRemote +

+ + +
+ + +
+
+ + +
+
+

new PUPRemote()

+ + +
+
+ + +
+

The PUPRemote is emitted if the discovered device is a Powered UP Remote.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ +
+ +
+
+

<readonly> batteryLevel

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
batteryLevel + + +number + + + + +

Battery level of the hub (Percentage between 0-100)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> firmwareVersion

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
firmwareVersion + + +string + + + + +

Firmware version of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

Name of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> rssi

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rssi + + +number + + + + +

Signal strength of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> uuid

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +

UUID of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> voltage

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
voltage + + +number + + + + +

Voltage of the hub (Volts)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

connect()

+ + +
+
+ + +
+

Connect to the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful connect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

getHubType()

+ + +
+
+ + +
+

Get the hub type.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +HubType + + + +
+
+ + + + + +
+ + + +
+
+

getPortDeviceType(port)

+ + +
+
+ + +
+

Get the device type for a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +DeviceType + + + +
+
+ + + + + +
+ + + +
+
+

setLEDColor(color)

+ + +
+
+ + +
+

Set the color of the LED on the Remote via a color value.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDRGB(red, green, blue)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via RGB values.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
red + + +number + + + + +
green + + +number + + + + +
blue + + +number + + + + +
+ + + + +
+ + + + + + + + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setName(name)

+ + +
+
+ + +
+

Set the name of the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

New name of the hub (14 characters or less, ASCII only).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

shutdown()

+ + +
+
+ + +
+

Shutdown the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

sleep(delay)

+ + +
+
+ + +
+

Sleep a given amount of time.

+

This is a helper method to make it easier to add delays into a chain of commands.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
delay + + +number + + + + +

How long to sleep (in milliseconds).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the delay is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

subscribe(port [, mode])

+ + +
+
+ + +
+

Subscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
mode + + +number + + + + + + + <optional>
+ + + + + +

The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

unsubscribe(port)

+ + +
+
+ + +
+

Unsubscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

wait(commands)

+ + +
+
+ + +
+

Wait until a given list of concurrently running commands are complete.

+

This is a helper method to make it easier to wait for concurrent commands to complete.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
commands + + +Array.<Promise.<any>> + + + + +

Array of executing commands.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the commands are finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/PoweredUP.html b/docs/PoweredUP.html new file mode 100644 index 0000000..126961e --- /dev/null +++ b/docs/PoweredUP.html @@ -0,0 +1,1112 @@ + + + + + + + DocStrap Class: PoweredUP + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: PoweredUP

+
+ +
+ +

+ PoweredUP +

+ + +
+ + +
+
+ + +
+
+

new PoweredUP()

+ + +
+
+ + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + +
    +
  • EventEmitter
  • +
+ + + + + + + + + + + + + + + +

Methods

+ +
+ +
+
+

getConnectedHubByUUID(uuid)

+ + +
+
+ + +
+

Retrieve a Powered UP Hub by UUID.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Hub +| + +null + + + +
+
+ + + + + +
+ + + +
+
+

getConnectedHubs()

+ + +
+
+ + +
+

Retrieve a list of Powered UP Hubs.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Array.<Hub> + + + +
+
+ + + + + +
+ + + +
+
+

getConnectedHubsByName(name)

+ + +
+
+ + +
+

Retrieve a list of Powered UP Hub by name.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +Array.<Hub> + + + +
+
+ + + + + +
+ + + +
+
+

scan()

+ + +
+
+ + +
+

Begin scanning for Powered UP Hub devices.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

stop()

+ + +
+
+ + +
+

Stop scanning for Powered UP Hub devices.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

discover

+ + +
+
+ + +
+

Emits when a Powered UP Hub device is found.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
hub + + +WeDo2SmartHub +| + +BoostMoveHub +| + +PUPHub +| + +PUPRemote +| + +DuploTrainBase + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/WeDo2SmartHub.html b/docs/WeDo2SmartHub.html new file mode 100644 index 0000000..a39c253 --- /dev/null +++ b/docs/WeDo2SmartHub.html @@ -0,0 +1,5252 @@ + + + + + + + DocStrap Class: WeDo2SmartHub + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Class: WeDo2SmartHub

+
+ +
+ +

+ WeDo2SmartHub +

+ + +
+ + +
+
+ + +
+
+

new WeDo2SmartHub()

+ + +
+
+ + +
+

The WeDo2SmartHub is emitted if the discovered device is a WeDo 2.0 Smart Hub.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + +
+ + +

Extends

+ + + + + + + + + + + + + + + + + + +

Members

+ +
+ +
+
+

<readonly> batteryLevel

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
batteryLevel + + +number + + + + +

Battery level of the hub (Percentage between 0-100)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> firmwareVersion

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
firmwareVersion + + +string + + + + +

Firmware version of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

Name of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> rssi

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
rssi + + +number + + + + +

Signal strength of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> uuid

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
uuid + + +string + + + + +

UUID of the hub

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<readonly> voltage

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
voltage + + +number + + + + +

Voltage of the hub (Volts)

+
+ + + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

brakeMotor(port)

+ + +
+
+ + +
+

Fully (hard) stop the motor on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

connect()

+ + +
+
+ + +
+

Connect to the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful connect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

disconnect()

+ + +
+
+ + +
+

Disconnect the Hub.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

getHubType()

+ + +
+
+ + +
+

Get the hub type.

+
+ + + + + + + + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +HubType + + + +
+
+ + + + + +
+ + + +
+
+

getPortDeviceType(port)

+ + +
+
+ + +
+

Get the device type for a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +DeviceType + + + +
+
+ + + + + +
+ + + +
+
+

playTone(frequency, time)

+ + +
+
+ + +
+

Play a tone on the Hub's in-built buzzer

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
frequency + + +number + + + + +
time + + +number + + + + +

How long the tone should play for (in milliseconds).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command (ie. once the tone has finished playing).

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

rampMotorSpeed(port, fromSpeed, toSpeed, time)

+ + +
+
+ + +
+

Ramp the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
fromSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

toSpeed + + +number + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

time + + +number + + + + +

How long the ramp should last (in milliseconds).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDColor(color)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via a color value.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLEDRGB(red, green, blue)

+ + +
+
+ + +
+

Set the color of the LED on the Hub via RGB values.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
red + + +number + + + + +
green + + +number + + + + +
blue + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setLightBrightness(port, brightness [, time])

+ + +
+
+ + +
+

Set the light brightness on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
brightness + + +number + + + + + + + + + + +

Brightness value between 0-100 (0 is off)

time + + +number + + + + + + + <optional>
+ + + + + +

How long to turn the light on (in milliseconds). Leave empty to turn the light on indefinitely.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command. If time is specified, this is once the light is turned off.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setMotorSpeed(port, speed [, time])

+ + +
+
+ + +
+

Set the motor speed on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
speed + + +number + + + + + + + + + + +

For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.

time + + +number + + + + + + + <optional>
+ + + + + +

How long to activate the motor for (in milliseconds). Leave empty to turn the motor on indefinitely.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful completion of command. If time is specified, this is once the motor is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

setName(name)

+ + +
+
+ + +
+

Set the name of the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +string + + + + +

New name of the hub (14 characters or less, ASCII only).

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

shutdown()

+ + +
+
+ + +
+

Shutdown the Hub.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful disconnect.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

sleep(delay)

+ + +
+
+ + +
+

Sleep a given amount of time.

+

This is a helper method to make it easier to add delays into a chain of commands.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
delay + + +number + + + + +

How long to sleep (in milliseconds).

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the delay is finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

subscribe(port [, mode])

+ + +
+
+ + +
+

Subscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
port + + +string + + + + + + + + + + +
mode + + +number + + + + + + + <optional>
+ + + + + +

The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

unsubscribe(port)

+ + +
+
+ + +
+

Unsubscribe to sensor notifications on a given port.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved upon successful issuance of command.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ + + +
+
+

wait(commands)

+ + +
+
+ + +
+

Wait until a given list of concurrently running commands are complete.

+

This is a helper method to make it easier to wait for concurrent commands to complete.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
commands + + +Array.<Promise.<any>> + + + + +

Array of executing commands.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Resolved after the commands are finished.

+
+ + + +
+
+ Type +
+
+ +Promise + + + +
+
+ + + + + +
+ +
+ + + + + +

Events

+ +
+ +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

rotate

+ + +
+
+ + +
+

Emits when a rotation sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
rotation + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/boostmovehub.js.html b/docs/boostmovehub.js.html new file mode 100644 index 0000000..1bde08a --- /dev/null +++ b/docs/boostmovehub.js.html @@ -0,0 +1,443 @@ + + + + + + + DocStrap Source: boostmovehub.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: boostmovehub.js

+ +
+
+
"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;
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/classes.list.html b/docs/classes.list.html new file mode 100644 index 0000000..f4dd319 --- /dev/null +++ b/docs/classes.list.html @@ -0,0 +1,6775 @@ + + + + + + + DocStrap Classes + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Classes

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +

Classes

+ +
+
BoostMoveHub
+
+ +
DuploTrainBase
+
+ +
Hub
+
+ +
LPF2Hub
+
+ +
PoweredUP
+
+ +
PUPHub
+
+ +
PUPRemote
+
+ +
WeDo2SmartHub
+
+
+ + + + + + + + + + + + + +

Events

+ +
+ +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

rotate

+ + +
+
+ + +
+

Emits when a rotation sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
rotation + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +

If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

speed

+ + +
+
+ + +
+

Emits on a speed change.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
speed + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

rotate

+ + +
+
+ + +
+

Emits when a rotation sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
rotation + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

speed

+ + +
+
+ + +
+

Emits on a speed change.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
speed + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +

If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

discover

+ + +
+
+ + +
+

Emits when a Powered UP Hub device is found.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
hub + + +WeDo2SmartHub +| + +BoostMoveHub +| + +PUPHub +| + +PUPRemote +| + +DuploTrainBase + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + +
Overrides:
+
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +

If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

colorAndDistance

+ + +
+
+ + +
+

A combined color and distance event, emits when the sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

attach

+ + +
+
+ + +
+

Emits when a motor or sensor is attached to the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
type + + +DeviceType + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

button

+ + +
+
+ + +
+

Emits when a button is pressed.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + + +string + + + + +
state + + +ButtonState + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

color

+ + +
+
+ + +
+

Emits when a color sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
color + + +Color + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

detach

+ + +
+
+ + +
+

Emits when an attached motor or sensor is detached from the Hub.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
+ + + + +
+ + + + + + + +
Inherited From:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

distance

+ + +
+
+ + +
+

Emits when a distance sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
distance + + +number + + + + +

Distance, in millimeters.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

rotate

+ + +
+
+ + +
+

Emits when a rotation sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
rotation + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + +
+
+

tilt

+ + +
+
+ + +
+

Emits when a tilt sensor is activated.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
port + + +string + + + + +
x + + +number + + + + +
y + + +number + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/consts.js.html b/docs/consts.js.html new file mode 100644 index 0000000..797c441 --- /dev/null +++ b/docs/consts.js.html @@ -0,0 +1,372 @@ + + + + + + + DocStrap Source: consts.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: consts.js

+ +
+
+
"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @typedef HubType
+ * @property {number} UNKNOWN 0
+ * @property {number} WEDO2_SMART_HUB 1
+ * @property {number} BOOST_MOVE_HUB 2
+ * @property {number} POWERED_UP_HUB 3
+ * @property {number} POWERED_UP_REMOTE 4
+ * @property {number} DUPLO_TRAIN_HUB 5
+ */
+var HubType;
+(function (HubType) {
+    HubType[HubType["UNKNOWN"] = 0] = "UNKNOWN";
+    HubType[HubType["WEDO2_SMART_HUB"] = 1] = "WEDO2_SMART_HUB";
+    HubType[HubType["BOOST_MOVE_HUB"] = 2] = "BOOST_MOVE_HUB";
+    HubType[HubType["POWERED_UP_HUB"] = 3] = "POWERED_UP_HUB";
+    HubType[HubType["POWERED_UP_REMOTE"] = 4] = "POWERED_UP_REMOTE";
+    HubType[HubType["DUPLO_TRAIN_HUB"] = 5] = "DUPLO_TRAIN_HUB";
+})(HubType = exports.HubType || (exports.HubType = {}));
+/**
+ * @typedef DeviceType
+ * @property {number} UNKNOWN 0
+ * @property {number} BASIC_MOTOR 1
+ * @property {number} TRAIN_MOTOR 2
+ * @property {number} LED_LIGHTS 8
+ * @property {number} BOOST_LED 22
+ * @property {number} WEDO2_TILT 34
+ * @property {number} WEDO2_DISTANCE 35
+ * @property {number} BOOST_DISTANCE 37
+ * @property {number} BOOST_TACHO_MOTOR 38
+ * @property {number} BOOST_MOVE_HUB_MOTOR 39
+ * @property {number} BOOST_TILT 40
+ * @property {number} DUPLO_TRAIN_BASE_MOTOR 41
+ * @property {number} DUPLO_TRAIN_BASE_SPEAKER 42
+ * @property {number} DUPLO_TRAIN_BASE_COLOR 43
+ * @property {number} DUPLO_TRAIN_BASE_SPEEDOMETER 44
+ * @property {number} POWERED_UP_REMOTE_BUTTON 55
+ */
+var DeviceType;
+(function (DeviceType) {
+    DeviceType[DeviceType["UNKNOWN"] = 0] = "UNKNOWN";
+    DeviceType[DeviceType["BASIC_MOTOR"] = 1] = "BASIC_MOTOR";
+    DeviceType[DeviceType["TRAIN_MOTOR"] = 2] = "TRAIN_MOTOR";
+    DeviceType[DeviceType["LED_LIGHTS"] = 8] = "LED_LIGHTS";
+    DeviceType[DeviceType["BOOST_LED"] = 22] = "BOOST_LED";
+    DeviceType[DeviceType["WEDO2_TILT"] = 34] = "WEDO2_TILT";
+    DeviceType[DeviceType["WEDO2_DISTANCE"] = 35] = "WEDO2_DISTANCE";
+    DeviceType[DeviceType["BOOST_DISTANCE"] = 37] = "BOOST_DISTANCE";
+    DeviceType[DeviceType["BOOST_TACHO_MOTOR"] = 38] = "BOOST_TACHO_MOTOR";
+    DeviceType[DeviceType["BOOST_MOVE_HUB_MOTOR"] = 39] = "BOOST_MOVE_HUB_MOTOR";
+    DeviceType[DeviceType["BOOST_TILT"] = 40] = "BOOST_TILT";
+    DeviceType[DeviceType["DUPLO_TRAIN_BASE_MOTOR"] = 41] = "DUPLO_TRAIN_BASE_MOTOR";
+    DeviceType[DeviceType["DUPLO_TRAIN_BASE_SPEAKER"] = 42] = "DUPLO_TRAIN_BASE_SPEAKER";
+    DeviceType[DeviceType["DUPLO_TRAIN_BASE_COLOR"] = 43] = "DUPLO_TRAIN_BASE_COLOR";
+    DeviceType[DeviceType["DUPLO_TRAIN_BASE_SPEEDOMETER"] = 44] = "DUPLO_TRAIN_BASE_SPEEDOMETER";
+    DeviceType[DeviceType["POWERED_UP_REMOTE_BUTTON"] = 55] = "POWERED_UP_REMOTE_BUTTON";
+})(DeviceType = exports.DeviceType || (exports.DeviceType = {}));
+/**
+ * @typedef Color
+ * @property {number} BLACK 0
+ * @property {number} PINK 1
+ * @property {number} PURPLE 2
+ * @property {number} BLUE 3
+ * @property {number} LIGHT_BLUE 4
+ * @property {number} CYAN 5
+ * @property {number} GREEN 6
+ * @property {number} YELLOW 7
+ * @property {number} ORANGE 8
+ * @property {number} RED 9
+ * @property {number} WHITE 10
+ * @property {number} NONE 255
+ */
+var Color;
+(function (Color) {
+    Color[Color["BLACK"] = 0] = "BLACK";
+    Color[Color["PINK"] = 1] = "PINK";
+    Color[Color["PURPLE"] = 2] = "PURPLE";
+    Color[Color["BLUE"] = 3] = "BLUE";
+    Color[Color["LIGHT_BLUE"] = 4] = "LIGHT_BLUE";
+    Color[Color["CYAN"] = 5] = "CYAN";
+    Color[Color["GREEN"] = 6] = "GREEN";
+    Color[Color["YELLOW"] = 7] = "YELLOW";
+    Color[Color["ORANGE"] = 8] = "ORANGE";
+    Color[Color["RED"] = 9] = "RED";
+    Color[Color["WHITE"] = 10] = "WHITE";
+    Color[Color["NONE"] = 255] = "NONE";
+})(Color = exports.Color || (exports.Color = {}));
+/**
+ * @typedef ButtonState
+ * @property {number} PRESSED 0
+ * @property {number} RELEASED 1
+ * @property {number} UP 2
+ * @property {number} DOWN 3
+ * @property {number} STOP 4
+ */
+var ButtonState;
+(function (ButtonState) {
+    ButtonState[ButtonState["PRESSED"] = 0] = "PRESSED";
+    ButtonState[ButtonState["RELEASED"] = 1] = "RELEASED";
+    ButtonState[ButtonState["UP"] = 2] = "UP";
+    ButtonState[ButtonState["DOWN"] = 3] = "DOWN";
+    ButtonState[ButtonState["STOP"] = 4] = "STOP";
+})(ButtonState = exports.ButtonState || (exports.ButtonState = {}));
+/**
+ * @typedef DuploTrainBaseSound
+ * @property {number} BRAKE 3
+ * @property {number} STATION_DEPARTURE 5
+ * @property {number} WATER_REFILL 7
+ * @property {number} HORN 9
+ * @property {number} STEAM 10
+ */
+var DuploTrainBaseSound;
+(function (DuploTrainBaseSound) {
+    DuploTrainBaseSound[DuploTrainBaseSound["BRAKE"] = 3] = "BRAKE";
+    DuploTrainBaseSound[DuploTrainBaseSound["STATION_DEPARTURE"] = 5] = "STATION_DEPARTURE";
+    DuploTrainBaseSound[DuploTrainBaseSound["WATER_REFILL"] = 7] = "WATER_REFILL";
+    DuploTrainBaseSound[DuploTrainBaseSound["HORN"] = 9] = "HORN";
+    DuploTrainBaseSound[DuploTrainBaseSound["STEAM"] = 10] = "STEAM";
+})(DuploTrainBaseSound = exports.DuploTrainBaseSound || (exports.DuploTrainBaseSound = {}));
+var BLEManufacturerData;
+(function (BLEManufacturerData) {
+    BLEManufacturerData[BLEManufacturerData["BOOST_MOVE_HUB_ID"] = 64] = "BOOST_MOVE_HUB_ID";
+    BLEManufacturerData[BLEManufacturerData["POWERED_UP_HUB_ID"] = 65] = "POWERED_UP_HUB_ID";
+    BLEManufacturerData[BLEManufacturerData["POWERED_UP_REMOTE_ID"] = 66] = "POWERED_UP_REMOTE_ID";
+    BLEManufacturerData[BLEManufacturerData["DUPLO_TRAIN_HUB_ID"] = 32] = "DUPLO_TRAIN_HUB_ID";
+})(BLEManufacturerData = exports.BLEManufacturerData || (exports.BLEManufacturerData = {}));
+var BLEService;
+(function (BLEService) {
+    BLEService["WEDO2_SMART_HUB"] = "00001523-1212-efde-1523-785feabcd123";
+    BLEService["LPF2_HUB"] = "00001623-1212-efde-1623-785feabcd123";
+})(BLEService = exports.BLEService || (exports.BLEService = {}));
+var BLECharacteristic;
+(function (BLECharacteristic) {
+    BLECharacteristic["WEDO2_BATTERY"] = "2a19";
+    BLECharacteristic["WEDO2_FIRMWARE_REVISION"] = "2a26";
+    BLECharacteristic["WEDO2_BUTTON"] = "00001526-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_PORT_TYPE"] = "00001527-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_LOW_VOLTAGE_ALERT"] = "00001528-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_HIGH_CURRENT_ALERT"] = "00001529-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_LOW_SIGNAL_ALERT"] = "0000152a-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_DISCONNECT"] = "0000152b-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_SENSOR_VALUE"] = "00001560-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_VALUE_FORMAT"] = "00001561-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_PORT_TYPE_WRITE"] = "00001563-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_MOTOR_VALUE_WRITE"] = "00001565-1212-efde-1523-785feabcd123";
+    BLECharacteristic["WEDO2_NAME_ID"] = "00001524-1212-efde-1523-785feabcd123";
+    BLECharacteristic["LPF2_ALL"] = "00001624-1212-efde-1623-785feabcd123";
+})(BLECharacteristic = exports.BLECharacteristic || (exports.BLECharacteristic = {}));
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/duplotrainbase.js.html b/docs/duplotrainbase.js.html new file mode 100644 index 0000000..617adcd --- /dev/null +++ b/docs/duplotrainbase.js.html @@ -0,0 +1,392 @@ + + + + + + + DocStrap Source: duplotrainbase.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: duplotrainbase.js

+ +
+
+
"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("duplotrainbase");
+/**
+ * The DuploTrainBase is emitted if the discovered device is a Duplo Train Base.
+ * @class DuploTrainBase
+ * @extends LPF2Hub
+ * @extends Hub
+ */
+class DuploTrainBase extends lpf2hub_1.LPF2Hub {
+    // We set JSDoc to ignore these events as a Duplo Train Base will never emit them.
+    /**
+     * @event DuploTrainBase#distance
+     * @ignore
+     */
+    /**
+     * @event DuploTrainBase#colorAndDistance
+     * @ignore
+     */
+    /**
+     * @event DuploTrainBase#tilt
+     * @ignore
+     */
+    /**
+     * @event DuploTrainBase#rotate
+     * @ignore
+     */
+    /**
+     * @event DuploTrainBase#button
+     * @ignore
+     */
+    /**
+     * @event DuploTrainBase#attach
+     * @ignore
+     */
+    /**
+     * @event DuploTrainBase#detach
+     * @ignore
+     */
+    static IsDuploTrainBase(peripheral) {
+        return (peripheral.advertisement.serviceUuids.indexOf(Consts.BLEService.LPF2_HUB.replace(/-/g, "")) >= 0 && peripheral.advertisement.manufacturerData[3] === Consts.BLEManufacturerData.DUPLO_TRAIN_HUB_ID);
+    }
+    constructor(peripheral, autoSubscribe = true) {
+        super(peripheral, autoSubscribe);
+        this.type = Consts.HubType.DUPLO_TRAIN_HUB;
+        this._ports = {
+            "MOTOR": new port_1.Port("MOTOR", 0),
+            "COLOR": new port_1.Port("COLOR", 18),
+            "SPEEDOMETER": new port_1.Port("SPEEDOMETER", 19)
+        };
+        debug("Discovered Duplo Train Base");
+    }
+    connect() {
+        return new Promise(async (resolve, reject) => {
+            debug("Connecting to Duplo Train Base");
+            await super.connect();
+            debug("Connect completed");
+            return resolve();
+        });
+    }
+    /**
+     * Set the color of the LED on the train via a color value.
+     * @method DuploTrainBase#setLEDColor
+     * @param {Color} color
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    setLEDColor(color) {
+        return new Promise((resolve, reject) => {
+            if (color === false) {
+                color = 0;
+            }
+            const data = Buffer.from([0x81, 0x11, 0x11, 0x51, 0x00, color]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            return resolve();
+        });
+    }
+    /**
+     * Set the motor speed on a given port.
+     * @method DuploTrainBase#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);
+        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") {
+                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();
+                }, time);
+                portObj.setEventTimer(timeout);
+            }
+            else {
+                const data = Buffer.from([0x81, portObj.value, 0x11, 0x51, 0x00, this._mapSpeed(speed)]);
+                this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+                return resolve();
+            }
+        });
+    }
+    /**
+     * Ramp the motor speed on a given port.
+     * @method DuploTrainBase#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 DuploTrainBase#brakeMotor
+     * @param {string} port
+     * @returns {Promise} Resolved upon successful completion of command.
+     */
+    brakeMotor(port) {
+        return this.setMotorSpeed(port, 127);
+    }
+    /**
+     * Play a built-in train sound.
+     * @method DuploTrainBase#playSound
+     * @param {DuploTrainBaseSound} sound
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    playSound(sound) {
+        return new Promise((resolve, reject) => {
+            const data = Buffer.from([0x81, 0x01, 0x11, 0x51, 0x01, sound]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            return resolve();
+        });
+    }
+}
+exports.DuploTrainBase = DuploTrainBase;
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/fonts/OpenSans-Bold-webfont.eot b/docs/fonts/OpenSans-Bold-webfont.eot new file mode 100644 index 0000000..5d20d91 Binary files /dev/null and b/docs/fonts/OpenSans-Bold-webfont.eot differ diff --git a/docs/fonts/OpenSans-Bold-webfont.svg b/docs/fonts/OpenSans-Bold-webfont.svg new file mode 100644 index 0000000..3ed7be4 --- /dev/null +++ b/docs/fonts/OpenSans-Bold-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Bold-webfont.woff b/docs/fonts/OpenSans-Bold-webfont.woff new file mode 100644 index 0000000..1205787 Binary files /dev/null and b/docs/fonts/OpenSans-Bold-webfont.woff differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.eot b/docs/fonts/OpenSans-BoldItalic-webfont.eot new file mode 100644 index 0000000..1f639a1 Binary files /dev/null and b/docs/fonts/OpenSans-BoldItalic-webfont.eot differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.svg b/docs/fonts/OpenSans-BoldItalic-webfont.svg new file mode 100644 index 0000000..6a2607b --- /dev/null +++ b/docs/fonts/OpenSans-BoldItalic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.woff b/docs/fonts/OpenSans-BoldItalic-webfont.woff new file mode 100644 index 0000000..ed760c0 Binary files /dev/null and b/docs/fonts/OpenSans-BoldItalic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Italic-webfont.eot b/docs/fonts/OpenSans-Italic-webfont.eot new file mode 100644 index 0000000..0c8a0ae Binary files /dev/null and b/docs/fonts/OpenSans-Italic-webfont.eot differ diff --git a/docs/fonts/OpenSans-Italic-webfont.svg b/docs/fonts/OpenSans-Italic-webfont.svg new file mode 100644 index 0000000..e1075dc --- /dev/null +++ b/docs/fonts/OpenSans-Italic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Italic-webfont.woff b/docs/fonts/OpenSans-Italic-webfont.woff new file mode 100644 index 0000000..ff652e6 Binary files /dev/null and b/docs/fonts/OpenSans-Italic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Light-webfont.eot b/docs/fonts/OpenSans-Light-webfont.eot new file mode 100644 index 0000000..1486840 Binary files /dev/null and b/docs/fonts/OpenSans-Light-webfont.eot differ diff --git a/docs/fonts/OpenSans-Light-webfont.svg b/docs/fonts/OpenSans-Light-webfont.svg new file mode 100644 index 0000000..11a472c --- /dev/null +++ b/docs/fonts/OpenSans-Light-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Light-webfont.woff b/docs/fonts/OpenSans-Light-webfont.woff new file mode 100644 index 0000000..e786074 Binary files /dev/null and b/docs/fonts/OpenSans-Light-webfont.woff differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.eot b/docs/fonts/OpenSans-LightItalic-webfont.eot new file mode 100644 index 0000000..8f44592 Binary files /dev/null and b/docs/fonts/OpenSans-LightItalic-webfont.eot differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.svg b/docs/fonts/OpenSans-LightItalic-webfont.svg new file mode 100644 index 0000000..431d7e3 --- /dev/null +++ b/docs/fonts/OpenSans-LightItalic-webfont.svg @@ -0,0 +1,1835 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-LightItalic-webfont.woff b/docs/fonts/OpenSans-LightItalic-webfont.woff new file mode 100644 index 0000000..43e8b9e Binary files /dev/null and b/docs/fonts/OpenSans-LightItalic-webfont.woff differ diff --git a/docs/fonts/OpenSans-Regular-webfont.eot b/docs/fonts/OpenSans-Regular-webfont.eot new file mode 100644 index 0000000..6bbc3cf Binary files /dev/null and b/docs/fonts/OpenSans-Regular-webfont.eot differ diff --git a/docs/fonts/OpenSans-Regular-webfont.svg b/docs/fonts/OpenSans-Regular-webfont.svg new file mode 100644 index 0000000..25a3952 --- /dev/null +++ b/docs/fonts/OpenSans-Regular-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/OpenSans-Regular-webfont.woff b/docs/fonts/OpenSans-Regular-webfont.woff new file mode 100644 index 0000000..e231183 Binary files /dev/null and b/docs/fonts/OpenSans-Regular-webfont.woff differ diff --git a/docs/fonts/glyphicons-halflings-regular.eot b/docs/fonts/glyphicons-halflings-regular.eot new file mode 100644 index 0000000..b93a495 Binary files /dev/null and b/docs/fonts/glyphicons-halflings-regular.eot differ diff --git a/docs/fonts/glyphicons-halflings-regular.svg b/docs/fonts/glyphicons-halflings-regular.svg new file mode 100644 index 0000000..94fb549 --- /dev/null +++ b/docs/fonts/glyphicons-halflings-regular.svg @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/fonts/glyphicons-halflings-regular.ttf b/docs/fonts/glyphicons-halflings-regular.ttf new file mode 100644 index 0000000..1413fc6 Binary files /dev/null and b/docs/fonts/glyphicons-halflings-regular.ttf differ diff --git a/docs/fonts/glyphicons-halflings-regular.woff b/docs/fonts/glyphicons-halflings-regular.woff new file mode 100644 index 0000000..9e61285 Binary files /dev/null and b/docs/fonts/glyphicons-halflings-regular.woff differ diff --git a/docs/fonts/glyphicons-halflings-regular.woff2 b/docs/fonts/glyphicons-halflings-regular.woff2 new file mode 100644 index 0000000..64539b5 Binary files /dev/null and b/docs/fonts/glyphicons-halflings-regular.woff2 differ diff --git a/docs/global.html b/docs/global.html new file mode 100644 index 0000000..83d2d37 --- /dev/null +++ b/docs/global.html @@ -0,0 +1,3366 @@ + + + + + + + DocStrap Global + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Global

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + +

Type Definitions

+ +
+ +
+
+

ButtonState

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
PRESSED + + +number + + + + +

0

RELEASED + + +number + + + + +

1

UP + + +number + + + + +

2

DOWN + + +number + + + + +

3

STOP + + +number + + + + +

4

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

ButtonState

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
PRESSED + + +number + + + + +

0

RELEASED + + +number + + + + +

1

UP + + +number + + + + +

2

DOWN + + +number + + + + +

3

STOP + + +number + + + + +

4

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

Color

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
BLACK + + +number + + + + +

0

PINK + + +number + + + + +

1

PURPLE + + +number + + + + +

2

BLUE + + +number + + + + +

3

LIGHT_BLUE + + +number + + + + +

4

CYAN + + +number + + + + +

5

GREEN + + +number + + + + +

6

YELLOW + + +number + + + + +

7

ORANGE + + +number + + + + +

8

RED + + +number + + + + +

9

WHITE + + +number + + + + +

10

NONE + + +number + + + + +

255

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

Color

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
BLACK + + +number + + + + +

0

PINK + + +number + + + + +

1

PURPLE + + +number + + + + +

2

BLUE + + +number + + + + +

3

LIGHT_BLUE + + +number + + + + +

4

CYAN + + +number + + + + +

5

GREEN + + +number + + + + +

6

YELLOW + + +number + + + + +

7

ORANGE + + +number + + + + +

8

RED + + +number + + + + +

9

WHITE + + +number + + + + +

10

NONE + + +number + + + + +

255

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

DeviceType

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
UNKNOWN + + +number + + + + +

0

BASIC_MOTOR + + +number + + + + +

1

TRAIN_MOTOR + + +number + + + + +

2

LED_LIGHTS + + +number + + + + +

8

BOOST_LED + + +number + + + + +

22

WEDO2_TILT + + +number + + + + +

34

WEDO2_DISTANCE + + +number + + + + +

35

BOOST_DISTANCE + + +number + + + + +

37

BOOST_TACHO_MOTOR + + +number + + + + +

38

BOOST_MOVE_HUB_MOTOR + + +number + + + + +

39

BOOST_TILT + + +number + + + + +

40

DUPLO_TRAIN_BASE_MOTOR + + +number + + + + +

41

DUPLO_TRAIN_BASE_SPEAKER + + +number + + + + +

42

DUPLO_TRAIN_BASE_COLOR + + +number + + + + +

43

DUPLO_TRAIN_BASE_SPEEDOMETER + + +number + + + + +

44

POWERED_UP_REMOTE_BUTTON + + +number + + + + +

55

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

DeviceType

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
UNKNOWN + + +number + + + + +

0

BASIC_MOTOR + + +number + + + + +

1

TRAIN_MOTOR + + +number + + + + +

2

LED_LIGHTS + + +number + + + + +

8

BOOST_LED + + +number + + + + +

22

WEDO2_TILT + + +number + + + + +

34

WEDO2_DISTANCE + + +number + + + + +

35

BOOST_DISTANCE + + +number + + + + +

37

BOOST_TACHO_MOTOR + + +number + + + + +

38

BOOST_MOVE_HUB_MOTOR + + +number + + + + +

39

BOOST_TILT + + +number + + + + +

40

DUPLO_TRAIN_BASE_MOTOR + + +number + + + + +

41

DUPLO_TRAIN_BASE_SPEAKER + + +number + + + + +

42

DUPLO_TRAIN_BASE_COLOR + + +number + + + + +

43

DUPLO_TRAIN_BASE_SPEEDOMETER + + +number + + + + +

44

POWERED_UP_REMOTE_BUTTON + + +number + + + + +

55

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

DuploTrainBaseSound

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
BRAKE + + +number + + + + +

3

STATION_DEPARTURE + + +number + + + + +

5

WATER_REFILL + + +number + + + + +

7

HORN + + +number + + + + +

9

STEAM + + +number + + + + +

10

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

DuploTrainBaseSound

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
BRAKE + + +number + + + + +

3

STATION_DEPARTURE + + +number + + + + +

5

WATER_REFILL + + +number + + + + +

7

HORN + + +number + + + + +

9

STEAM + + +number + + + + +

10

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

HubType

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
UNKNOWN + + +number + + + + +

0

WEDO2_SMART_HUB + + +number + + + + +

1

BOOST_MOVE_HUB + + +number + + + + +

2

POWERED_UP_HUB + + +number + + + + +

3

POWERED_UP_REMOTE + + +number + + + + +

4

DUPLO_TRAIN_HUB + + +number + + + + +

5

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

HubType

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
UNKNOWN + + +number + + + + +

0

WEDO2_SMART_HUB + + +number + + + + +

1

BOOST_MOVE_HUB + + +number + + + + +

2

POWERED_UP_HUB + + +number + + + + +

3

POWERED_UP_REMOTE + + +number + + + + +

4

DUPLO_TRAIN_HUB + + +number + + + + +

5

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +
+ +
+ + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/hub.js.html b/docs/hub.js.html new file mode 100644 index 0000000..1905713 --- /dev/null +++ b/docs/hub.js.html @@ -0,0 +1,579 @@ + + + + + + + DocStrap Source: hub.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: hub.js

+ +
+
+
"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 events_1 = require("events");
+const Consts = __importStar(require("./consts"));
+const Debug = require("debug");
+const debug = Debug("hub");
+/**
+ * @class Hub
+ * @extends EventEmitter
+ */
+class Hub extends events_1.EventEmitter {
+    constructor(peripheral, autoSubscribe = true) {
+        super();
+        this.autoSubscribe = true;
+        this.useSpeedMap = true;
+        this.type = Consts.HubType.UNKNOWN;
+        this._ports = {};
+        this._characteristics = {};
+        this._name = "";
+        this._firmwareInfo = { major: 0, minor: 0, bugFix: 0, build: 0 };
+        this._batteryLevel = 100;
+        this._voltage = 0;
+        this._current = 0;
+        this._rssi = -100;
+        this.autoSubscribe = !!autoSubscribe;
+        this._peripheral = peripheral;
+        this._uuid = peripheral.uuid;
+        // NK: This hack allows LPF2.0 hubs to send a second advertisement packet consisting of the hub name before we try to read it
+        setTimeout(() => {
+            this._name = peripheral.advertisement.localName;
+            this.emit("discoverComplete");
+        }, 1000);
+    }
+    /**
+     * @readonly
+     * @property {string} name Name of the hub
+     */
+    get name() {
+        return this._name;
+    }
+    /**
+     * @readonly
+     * @property {string} firmwareVersion Firmware version of the hub
+     */
+    get firmwareVersion() {
+        return `${this._firmwareInfo.major}.${this._firmwareInfo.minor}.${this._lpad(this._firmwareInfo.bugFix.toString(), 2)}.${this._lpad(this._firmwareInfo.build.toString(), 4)}`;
+    }
+    /**
+     * @readonly
+     * @property {string} uuid UUID of the hub
+     */
+    get uuid() {
+        return this._uuid;
+    }
+    /**
+     * @readonly
+     * @property {number} rssi Signal strength of the hub
+     */
+    get rssi() {
+        return this._rssi;
+    }
+    /**
+     * @readonly
+     * @property {number} batteryLevel Battery level of the hub (Percentage between 0-100)
+     */
+    get batteryLevel() {
+        return this._batteryLevel;
+    }
+    /**
+     * @readonly
+     * @property {number} voltage Voltage of the hub (Volts)
+     */
+    get voltage() {
+        return this._voltage;
+    }
+    // /**
+    //  * @readonly
+    //  * @property {number} current Current usage of the hub (Amps)
+    //  */
+    // public get current () {
+    //     return this._current;
+    // }
+    /**
+     * Connect to the Hub.
+     * @method Hub#connect
+     * @returns {Promise} Resolved upon successful connect.
+     */
+    connect() {
+        return new Promise((connectResolve, connectReject) => {
+            const self = this;
+            this._peripheral.connect((err) => {
+                this._rssi = this._peripheral.rssi;
+                const rssiUpdateInterval = setInterval(() => {
+                    this._peripheral.updateRssi((err, rssi) => {
+                        if (!err) {
+                            if (this._rssi !== rssi) {
+                                this._rssi = rssi;
+                            }
+                        }
+                    });
+                }, 2000);
+                self._peripheral.on("disconnect", () => {
+                    clearInterval(rssiUpdateInterval);
+                    this.emit("disconnect");
+                });
+                self._peripheral.discoverServices([], (err, services) => {
+                    if (err) {
+                        this.emit("error", err);
+                        return;
+                    }
+                    debug("Service/characteristic discovery started");
+                    const servicePromises = [];
+                    services.forEach((service) => {
+                        servicePromises.push(new Promise((resolve, reject) => {
+                            service.discoverCharacteristics([], (err, characteristics) => {
+                                characteristics.forEach((characteristic) => {
+                                    this._characteristics[characteristic.uuid] = characteristic;
+                                });
+                                return resolve();
+                            });
+                        }));
+                    });
+                    Promise.all(servicePromises).then(() => {
+                        debug("Service/characteristic discovery finished");
+                        this.emit("connect");
+                        return connectResolve();
+                    });
+                });
+            });
+        });
+    }
+    /**
+     * Disconnect the Hub.
+     * @method Hub#disconnect
+     * @returns {Promise} Resolved upon successful disconnect.
+     */
+    disconnect() {
+        return new Promise((resolve, reject) => {
+            this._peripheral.disconnect(() => {
+                return resolve();
+            });
+        });
+    }
+    /**
+     * Subscribe to sensor notifications on a given port.
+     * @method Hub#subscribe
+     * @param {string} port
+     * @param {number} [mode] The sensor mode to activate. If no mode is provided, the default for that sensor will be chosen.
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    subscribe(port, mode) {
+        return new Promise((resolve, reject) => {
+            let newMode = this._getModeForDeviceType(this._portLookup(port).type);
+            if (mode) {
+                newMode = mode;
+            }
+            this._activatePortDevice(this._portLookup(port).value, this._portLookup(port).type, newMode, 0x00, () => {
+                return resolve();
+            });
+        });
+    }
+    /**
+     * Unsubscribe to sensor notifications on a given port.
+     * @method Hub#unsubscribe
+     * @param {string} port
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    unsubscribe(port) {
+        return new Promise((resolve, reject) => {
+            const mode = this._getModeForDeviceType(this._portLookup(port).type);
+            this._deactivatePortDevice(this._portLookup(port).value, this._portLookup(port).type, mode, 0x00, () => {
+                return resolve();
+            });
+        });
+    }
+    /**
+     * Sleep a given amount of time.
+     *
+     * This is a helper method to make it easier to add delays into a chain of commands.
+     * @method Hub#sleep
+     * @param {number} delay How long to sleep (in milliseconds).
+     * @returns {Promise} Resolved after the delay is finished.
+     */
+    sleep(delay) {
+        return new Promise((resolve) => {
+            global.setTimeout(resolve, delay);
+        });
+    }
+    /**
+     * Wait until a given list of concurrently running commands are complete.
+     *
+     * This is a helper method to make it easier to wait for concurrent commands to complete.
+     * @method Hub#wait
+     * @param {Array<Promise<any>>} commands Array of executing commands.
+     * @returns {Promise} Resolved after the commands are finished.
+     */
+    wait(commands) {
+        return Promise.all(commands);
+    }
+    /**
+     * Get the hub type.
+     * @method Hub#getHubType
+     * @returns {HubType}
+     */
+    getHubType() {
+        return this.type;
+    }
+    /**
+     * Get the device type for a given port.
+     * @method Hub#getPortDeviceType
+     * @param {string} port
+     * @returns {DeviceType}
+     */
+    getPortDeviceType(port) {
+        return this._portLookup(port).type;
+    }
+    _getCharacteristic(uuid) {
+        return this._characteristics[uuid.replace(/-/g, "")];
+    }
+    _subscribeToCharacteristic(characteristic, callback) {
+        characteristic.on("data", (data) => {
+            return callback(data);
+        });
+        characteristic.subscribe((err) => {
+            if (err) {
+                this.emit("error", err);
+            }
+        });
+    }
+    _activatePortDevice(port, type, mode, format, callback) {
+        if (callback) {
+            callback();
+        }
+    }
+    _deactivatePortDevice(port, type, mode, format, callback) {
+        if (callback) {
+            callback();
+        }
+    }
+    _registerDeviceAttachment(port, type) {
+        if (port.connected) {
+            port.type = type;
+            if (this.autoSubscribe) {
+                this._activatePortDevice(port.value, type, this._getModeForDeviceType(type), 0x00);
+                /**
+                 * Emits when a motor or sensor is attached to the Hub.
+                 * @event Hub#attach
+                 * @param {string} port
+                 * @param {DeviceType} type
+                 */
+                this.emit("attach", port.id, type);
+            }
+        }
+        else {
+            port.type = Consts.DeviceType.UNKNOWN;
+            debug(`Port ${port.id} disconnected`);
+            /**
+             * Emits when an attached motor or sensor is detached from the Hub.
+             * @event Hub#detach
+             * @param {string} port
+             */
+            this.emit("detach", port.id);
+        }
+    }
+    _getPortForPortNumber(num) {
+        for (const key of Object.keys(this._ports)) {
+            if (this._ports[key].value === num) {
+                return this._ports[key];
+            }
+        }
+        return false;
+    }
+    _mapSpeed(speed) {
+        if (!this.useSpeedMap) {
+            return speed;
+        }
+        if (speed === 127) {
+            return 127; // Hard stop
+        }
+        if (speed > 100) {
+            speed = 100;
+        }
+        else if (speed < -100) {
+            speed = -100;
+        }
+        return speed;
+    }
+    _calculateRamp(fromSpeed, toSpeed, time, port) {
+        const emitter = new events_1.EventEmitter();
+        const steps = Math.abs(toSpeed - fromSpeed);
+        let delay = time / steps;
+        let increment = 1;
+        if (delay < 50 && steps > 0) {
+            increment = 50 / delay;
+            delay = 50;
+        }
+        if (fromSpeed > toSpeed) {
+            increment = -increment;
+        }
+        let i = 0;
+        const interval = setInterval(() => {
+            let speed = Math.round(fromSpeed + (++i * increment));
+            if (toSpeed > fromSpeed && speed > toSpeed) {
+                speed = toSpeed;
+            }
+            else if (fromSpeed > toSpeed && speed < toSpeed) {
+                speed = toSpeed;
+            }
+            emitter.emit("changeSpeed", speed);
+            if (speed === toSpeed) {
+                clearInterval(interval);
+                emitter.emit("finished");
+            }
+        }, delay);
+        port.setEventTimer(interval);
+        return emitter;
+    }
+    _portLookup(port) {
+        if (!this._ports[port.toUpperCase()]) {
+            throw new Error(`Port ${port.toUpperCase()} does not exist on this Hub type`);
+        }
+        return this._ports[port];
+    }
+    _lpad(str, length) {
+        while (str.length < length) {
+            str = "0" + str;
+        }
+        return str;
+    }
+    _getModeForDeviceType(type) {
+        switch (type) {
+            case Consts.DeviceType.BASIC_MOTOR:
+                return 0x02;
+            case Consts.DeviceType.TRAIN_MOTOR:
+                return 0x02;
+            case Consts.DeviceType.BOOST_TACHO_MOTOR:
+                return 0x02;
+            case Consts.DeviceType.BOOST_MOVE_HUB_MOTOR:
+                return 0x02;
+            case Consts.DeviceType.BOOST_DISTANCE:
+                return (this.type === Consts.HubType.WEDO2_SMART_HUB ? 0x00 : 0x08);
+            case Consts.DeviceType.BOOST_TILT:
+                return 0x04;
+            default:
+                return 0x00;
+        }
+    }
+}
+exports.Hub = Hub;
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/img/glyphicons-halflings-white.png b/docs/img/glyphicons-halflings-white.png new file mode 100644 index 0000000..3bf6484 Binary files /dev/null and b/docs/img/glyphicons-halflings-white.png differ diff --git a/docs/img/glyphicons-halflings.png b/docs/img/glyphicons-halflings.png new file mode 100644 index 0000000..a996999 Binary files /dev/null and b/docs/img/glyphicons-halflings.png differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..40feb73 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,408 @@ + + + + + + + DocStrap Index + + + + + + + + + + + + + +
+
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + +
+

CircleCI
Gitter
NPM Version

+

node-poweredup - A Node.js module to interface with LEGO Powered UP components.

Introduction

LEGO Powered UP is the successor to Power Functions, the system for adding electronics to LEGO models. Powered UP is a collection of ranges - starting with LEGO WeDo 2.0 released in 2016, LEGO Boost released in 2017, and LEGO Powered UP released in 2018. It also includes the 2018 Duplo App-Controlled Train sets.

+

Powered UP has a few improvements over Power Functions:

+
    +
  1. The use of Bluetooth Low Energy makes it easy to control from a computer, and even write code for.

    +
  2. +
  3. The ability to use sensors to react to events happening in the real world opens up a whole new world of possibilities.

    +
  4. +
  5. As Powered UP hubs and remotes pair with each other, the system allows for a near unlimited number of independently controlled models in the same room. Power Functions was limited to 8 due to the use of infra-red for communication.

    +
  6. +
+

Installation

Node.js v8.0 required.

+
npm install node-poweredup --save

node-poweredup uses the Noble BLE library by Sandeep Mistry. On macOS everything should function out of the box. On Linux and Windows there are certain dependencies which may need installed first.

+

Note: node-poweredup has been tested on macOS 10.13 and Debian/Raspbian on the Raspberry Pi 3 Model B.

+

Compatibility

While most Powered UP components and Hubs are compatible with each other, there are exceptions. For example, there is limited backwards compatibility between newer components and the WeDo 2.0 Smart Hub. However WeDo 2.0 components are fully forwards compatible with newer Hubs.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Device NameProduct CodeTypeWeDo 2.0 Smart HubBoost Move HubPowered UP HubAvailability
WeDo 2.0 Tilt Sensor45305SensorYesYesYes45300
WeDo 2.0 Motion Sensor45304SensorYesYesYes45300
WeDo 2.0 Medium Motor45303MotorYesYesYes45300
76112
Boost Color and Distance Sensor88007SensorPartialYesYes17101
Boost Tacho Motor88008Motor/SensorPartialYesPartial17101
Powered UP Train Motor88011MotorYesYesYes60197
60198
Powered UP LED Lights88005LightYesYesYes88005
+

In addition, the Hubs themselves have certain built-in features which this library exposes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Hub NameProduct CodeBuilt-In FeaturesAvailability
WeDo 2.0 Smart hub45301RGB LED
Piezo Buzzer
Button
45300
Boost Move Hub88006RGB LED
Tilt Sensor
2x Tacho Motors
Button
17101
Powered UP Hub88009RGB LED
Button
60197
60198
76112
Powered UP Remote88010RGB LED
Left and Right Control Buttons
Button
60197
60198
Duplo Train Base28743RGB LED/Headlights
Speaker
Speedometer
Motor
Color and Distance Sensor
Button
10874
10875
+

Known Issues and Limitations

    +
  • The Boost Color and Distance sensor only works in color mode with the WeDo 2.0 Smart Hub.

    +
  • +
  • When used with the WeDo 2.0 Smart Hub, the Boost Tacho Motor does not support rotating the motor by angle.

    +
  • +
  • When used with the Powered UP Hub, the Boost Tacho Motor does not support rotating the motor by angle. It also does not support rotation detection.

    +
  • +
  • Plugging two Boost Tacho Motors into the Powered UP Hub will crash the Hub (This requires a firmware update from LEGO to fix).

    +
  • +
+

Documentation

Full documentation is available here.

+

Sample Usage

const PoweredUP = require("node-poweredup");
+const poweredUP = new PoweredUP.PoweredUP();
+
+poweredUP.on("discover", async (hub) => { // Wait to discover a Hub
+    await hub.connect(); // Connect to the Hub
+    await hub.sleep(3000); // Sleep for 3 seconds before starting
+
+    while (true) { // Repeat indefinitely
+        hub.setMotorSpeed("B", 75); // Start a motor attached to port B to run a 3/4 speed (75) indefinitely
+        await hub.setMotorSpeed("A", 100,  2000); // Run a motor attached to port A for 2 seconds at maximum speed (100) then stop
+        await hub.sleep(1000); // Do nothing for 1 second
+        await hub.setMotorSpeed("A", -50,  1000); // Run a motor attached to port A for 1 second at 1/2 speed in reverse (-50) then stop
+        await hub.sleep(1000); // Do nothing for 1 second
+    }
+});
+
+poweredUP.scan(); // Start scanning for Hubs

More examples are available in the "examples" directory.

+

Credits

Thanks go to Jorge Pereira (@JorgePe), Sebastian Raff (@hobbyquaker), Valentin Heun (@vheun), Johan Korten (@jakorten), and Andrey Pokhilko (@undera) for their various works, contributions, and assistance on figuring out the LEGO Boost, WeDo 2.0, and Powered UP protocols.

+
+ + + + + + + +
+
+ +
+ + +
+ +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/lpf2hub.js.html b/docs/lpf2hub.js.html new file mode 100644 index 0000000..674bd2b --- /dev/null +++ b/docs/lpf2hub.js.html @@ -0,0 +1,601 @@ + + + + + + + DocStrap Source: lpf2hub.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: lpf2hub.js

+ +
+
+
"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 hub_1 = require("./hub");
+const Consts = __importStar(require("./consts"));
+const Debug = require("debug");
+const debug = Debug("lpf2hub");
+/**
+ * @class LPF2Hub
+ * @extends Hub
+ */
+class LPF2Hub extends hub_1.Hub {
+    constructor() {
+        super(...arguments);
+        this._lastTiltX = 0;
+        this._lastTiltY = 0;
+        this._messageBuffer = Buffer.alloc(0);
+    }
+    connect() {
+        return new Promise(async (resolve, reject) => {
+            await super.connect();
+            const characteristic = this._getCharacteristic(Consts.BLECharacteristic.LPF2_ALL);
+            this._subscribeToCharacteristic(characteristic, this._parseMessage.bind(this));
+            setTimeout(() => {
+                this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x02, 0x02])); // Activate button reports
+                this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x03, 0x05])); // Request firmware version
+                this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x01, 0x06, 0x02])); // Activate battery level reports
+                this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x3c, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01])); // Activate voltage reports
+                this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x3b, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01])); // Activate current reports
+                if (this.type === Consts.HubType.DUPLO_TRAIN_HUB) {
+                    this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x01, 0x01, 0x01, 0x00, 0x00, 0x00, 0x01]));
+                }
+            }, 1000);
+            return resolve();
+        });
+    }
+    /**
+     * Shutdown the Hub.
+     * @method LPF2Hub#shutdown
+     * @returns {Promise} Resolved upon successful disconnect.
+     */
+    shutdown() {
+        return new Promise((resolve, reject) => {
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x02, 0x01]), () => {
+                return resolve();
+            });
+        });
+    }
+    /**
+     * 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.
+     */
+    setName(name) {
+        if (name.length > 14) {
+            throw new Error("Name must be 14 characters or less");
+        }
+        return new Promise((resolve, reject) => {
+            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
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            this._name = name;
+            return resolve();
+        });
+    }
+    /**
+     * Set the color of the LED on the Hub via a color value.
+     * @method LPF2Hub#setLEDColor
+     * @param {Color} color
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    setLEDColor(color) {
+        return new Promise((resolve, reject) => {
+            let data = Buffer.from([0x41, 0x32, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            if (color === false) {
+                color = 0;
+            }
+            data = Buffer.from([0x81, 0x32, 0x11, 0x51, 0x00, color]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            return resolve();
+        });
+    }
+    /**
+     * Set the color of the LED on the Hub via RGB values.
+     * @method LPF2Hub#setLEDRGB
+     * @param {number} red
+     * @param {number} green
+     * @param {number} blue
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    setLEDRGB(red, green, blue) {
+        return new Promise((resolve, reject) => {
+            let data = Buffer.from([0x41, 0x32, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            data = Buffer.from([0x81, 0x32, 0x11, 0x51, 0x01, red, green, blue]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            return resolve();
+        });
+    }
+    sendRaw(message) {
+        return new Promise((resolve, reject) => {
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, message, () => {
+                return resolve();
+            });
+        });
+    }
+    _activatePortDevice(port, type, mode, format, callback) {
+        this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, port, mode, 0x01, 0x00, 0x00, 0x00, 0x01]), callback);
+    }
+    _deactivatePortDevice(port, type, mode, format, callback) {
+        this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, port, mode, 0x01, 0x00, 0x00, 0x00, 0x00]), callback);
+    }
+    _writeMessage(uuid, message, callback) {
+        const characteristic = this._getCharacteristic(uuid);
+        if (characteristic) {
+            message = Buffer.concat([Buffer.alloc(2), message]);
+            message[0] = message.length;
+            debug("Sent Message (LPF2_ALL)", message);
+            characteristic.write(message, false, callback);
+        }
+    }
+    _parseMessage(data) {
+        if (data) {
+            this._messageBuffer = Buffer.concat([this._messageBuffer, data]);
+        }
+        if (this._messageBuffer.length <= 0) {
+            return;
+        }
+        const len = this._messageBuffer[0];
+        if (len >= 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 0x01: {
+                    this._parseDeviceInfo(message);
+                    break;
+                }
+                case 0x04: {
+                    this._parsePortMessage(message);
+                    break;
+                }
+                case 0x45: {
+                    this._parseSensorMessage(message);
+                    break;
+                }
+                case 0x82: {
+                    this._parsePortAction(message);
+                    break;
+                }
+            }
+            if (this._messageBuffer.length > 0) {
+                this._parseMessage();
+            }
+        }
+    }
+    _parseDeviceInfo(data) {
+        // Button press reports
+        if (data[3] === 0x02) {
+            if (data[5] === 1) {
+                /**
+                 * Emits when a button is pressed.
+                 * @event LPF2Hub#button
+                 * @param {string} button
+                 * @param {ButtonState} state
+                 */
+                this.emit("button", "GREEN", Consts.ButtonState.PRESSED);
+                return;
+            }
+            else if (data[5] === 0) {
+                this.emit("button", "GREEN", Consts.ButtonState.RELEASED);
+                return;
+            }
+            // Firmware version
+        }
+        else if (data[3] === 0x03) {
+            const build = data.readUInt16LE(5);
+            const bugFix = data.readUInt8(7);
+            const major = data.readUInt8(8) >>> 4;
+            const minor = data.readUInt8(8) & 0xf;
+            this._firmwareInfo = { major, minor, bugFix, build };
+            // Battery level reports
+        }
+        else if (data[3] === 0x06) {
+            this._batteryLevel = data[5];
+        }
+    }
+    _parsePortMessage(data) {
+        const port = this._getPortForPortNumber(data[3]);
+        if (!port) {
+            return;
+        }
+        port.connected = (data[4] === 1 || data[4] === 2) ? true : false;
+        this._registerDeviceAttachment(port, data[5]);
+    }
+    _parsePortAction(data) {
+        const port = this._getPortForPortNumber(data[3]);
+        if (!port) {
+            return;
+        }
+        if (data[4] === 0x0a) {
+            port.busy = false;
+            if (port.finished) {
+                port.finished();
+                port.finished = null;
+            }
+        }
+    }
+    _padMessage(data, len) {
+        if (data.length < len) {
+            data = Buffer.concat([data, Buffer.alloc(len - data.length)]);
+        }
+        return data;
+    }
+    _parseSensorMessage(data) {
+        if ((data[3] === 0x3b && this.type === Consts.HubType.POWERED_UP_REMOTE)) { // Voltage (PUP Remote)
+            data = this._padMessage(data, 6);
+            const voltage = data.readUInt16LE(4) / 500;
+            this._voltage = voltage;
+            return;
+        }
+        else if (data[3] === 0x3c && this.type === Consts.HubType.POWERED_UP_REMOTE) { // Current (PUP Remote)
+            data = this._padMessage(data, 6);
+            const current = data.readUInt16LE(4);
+            this._current = current;
+            return;
+        }
+        else if (data[3] === 0x3c && this.type !== Consts.HubType.POWERED_UP_REMOTE) { // Voltage (Non-PUP Remote)
+            data = this._padMessage(data, 6);
+            const voltage = data.readUInt16LE(4) / 400;
+            this._voltage = voltage;
+            return;
+        }
+        else if (data[3] === 0x3b && this.type !== Consts.HubType.POWERED_UP_REMOTE) { // Current (Non-PUP Remote)
+            data = this._padMessage(data, 6);
+            const current = data.readUInt16LE(4) / 1000;
+            this._current = current;
+            return;
+        }
+        const port = this._getPortForPortNumber(data[3]);
+        if (!port) {
+            return;
+        }
+        if (port && port.connected) {
+            switch (port.type) {
+                case Consts.DeviceType.WEDO2_DISTANCE: {
+                    let distance = data[4];
+                    if (data[5] === 1) {
+                        distance = data[4] + 255;
+                    }
+                    /**
+                     * Emits when a distance sensor is activated.
+                     * @event LPF2Hub#distance
+                     * @param {string} port
+                     * @param {number} distance Distance, in millimeters.
+                     */
+                    this.emit("distance", port.id, distance * 10);
+                    break;
+                }
+                case Consts.DeviceType.BOOST_DISTANCE: {
+                    /**
+                     * Emits when a color sensor is activated.
+                     * @event LPF2Hub#color
+                     * @param {string} port
+                     * @param {Color} color
+                     */
+                    if (data[4] <= 10) {
+                        this.emit("color", port.id, data[4]);
+                    }
+                    let distance = data[5];
+                    const partial = data[7];
+                    if (partial > 0) {
+                        distance += 1.0 / partial;
+                    }
+                    distance = Math.floor(distance * 25.4) - 20;
+                    this.emit("distance", port.id, distance);
+                    /**
+                     * A combined color and distance event, emits when the sensor is activated.
+                     * @event LPF2Hub#colorAndDistance
+                     * @param {string} port
+                     * @param {Color} color
+                     * @param {number} distance Distance, in millimeters.
+                     */
+                    if (data[4] <= 10) {
+                        this.emit("colorAndDistance", port.id, data[4], distance);
+                    }
+                    break;
+                }
+                case Consts.DeviceType.WEDO2_TILT: {
+                    const tiltX = data[4] > 160 ? data[4] - 255 : data[4] - (data[4] * 2);
+                    const tiltY = data[5] > 160 ? 255 - data[5] : data[5] - (data[5] * 2);
+                    this._lastTiltX = tiltX;
+                    this._lastTiltY = tiltY;
+                    /**
+                     * Emits when a tilt sensor is activated.
+                     * @event LPF2Hub#tilt
+                     * @param {string} port If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.
+                     * @param {number} x
+                     * @param {number} y
+                     */
+                    this.emit("tilt", port.id, this._lastTiltX, this._lastTiltY);
+                    break;
+                }
+                case Consts.DeviceType.BOOST_TACHO_MOTOR: {
+                    const rotation = data.readInt32LE(4);
+                    /**
+                     * Emits when a rotation sensor is activated.
+                     * @event LPF2Hub#rotate
+                     * @param {string} port
+                     * @param {number} rotation
+                     */
+                    this.emit("rotate", port.id, rotation);
+                    break;
+                }
+                case Consts.DeviceType.BOOST_MOVE_HUB_MOTOR: {
+                    const rotation = data.readInt32LE(4);
+                    this.emit("rotate", port.id, rotation);
+                    break;
+                }
+                case Consts.DeviceType.BOOST_TILT: {
+                    const tiltX = data[4] > 160 ? data[4] - 255 : data[4];
+                    const tiltY = data[5] > 160 ? 255 - data[5] : data[5] - (data[5] * 2);
+                    this.emit("tilt", port.id, tiltX, tiltY);
+                    break;
+                }
+                case Consts.DeviceType.POWERED_UP_REMOTE_BUTTON: {
+                    switch (data[4]) {
+                        case 0x01: {
+                            this.emit("button", port.id, Consts.ButtonState.UP);
+                            break;
+                        }
+                        case 0xff: {
+                            this.emit("button", port.id, Consts.ButtonState.DOWN);
+                            break;
+                        }
+                        case 0x7f: {
+                            this.emit("button", port.id, Consts.ButtonState.STOP);
+                            break;
+                        }
+                        case 0x00: {
+                            this.emit("button", port.id, Consts.ButtonState.RELEASED);
+                            break;
+                        }
+                    }
+                    break;
+                }
+                case Consts.DeviceType.DUPLO_TRAIN_BASE_COLOR: {
+                    if (data[4] <= 10) {
+                        this.emit("color", port.id, data[4]);
+                    }
+                    break;
+                }
+                case Consts.DeviceType.DUPLO_TRAIN_BASE_SPEEDOMETER: {
+                    /**
+                     * Emits on a speed change.
+                     * @event LPF2Hub#speed
+                     * @param {string} port
+                     * @param {number} speed
+                     */
+                    const speed = data.readInt16LE(4);
+                    this.emit("speed", port.id, speed);
+                    break;
+                }
+            }
+        }
+    }
+}
+exports.LPF2Hub = LPF2Hub;
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/poweredup.js.html b/docs/poweredup.js.html new file mode 100644 index 0000000..c0f8e66 --- /dev/null +++ b/docs/poweredup.js.html @@ -0,0 +1,378 @@ + + + + + + + DocStrap Source: poweredup.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: poweredup.js

+ +
+
+
"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 boostmovehub_1 = require("./boostmovehub");
+const duplotrainbase_1 = require("./duplotrainbase");
+const puphub_1 = require("./puphub");
+const pupremote_1 = require("./pupremote");
+const wedo2smarthub_1 = require("./wedo2smarthub");
+const utils_1 = require("./utils");
+const Consts = __importStar(require("./consts"));
+const events_1 = require("events");
+const Debug = require("debug");
+const debug = Debug("poweredup");
+const noble = require("noble-mac");
+let ready = false;
+let wantScan = false;
+let discoveryEventAttached = false;
+const startScanning = () => {
+    if (utils_1.isBrowserContext) {
+        noble.startScanning([Consts.BLEService.WEDO2_SMART_HUB, Consts.BLEService.LPF2_HUB]);
+    }
+    else {
+        noble.startScanning();
+    }
+};
+noble.on("stateChange", (state) => {
+    ready = (state === "poweredOn");
+    if (ready) {
+        if (wantScan) {
+            debug("Scanning started");
+            startScanning();
+        }
+    }
+    else {
+        noble.stopScanning();
+    }
+});
+/**
+ * @class PoweredUP
+ * @extends EventEmitter
+ */
+class PoweredUP extends events_1.EventEmitter {
+    constructor() {
+        super();
+        this.autoSubscribe = true;
+        this._connectedHubs = {};
+        this._discoveryEventHandler = this._discoveryEventHandler.bind(this);
+    }
+    /**
+     * Begin scanning for Powered UP Hub devices.
+     * @method PoweredUP#scan
+     */
+    scan() {
+        wantScan = true;
+        if (!discoveryEventAttached) {
+            noble.on("discover", this._discoveryEventHandler);
+            discoveryEventAttached = true;
+        }
+        if (ready) {
+            debug("Scanning started");
+            startScanning();
+        }
+    }
+    /**
+     * Stop scanning for Powered UP Hub devices.
+     * @method PoweredUP#stop
+     */
+    stop() {
+        wantScan = false;
+        if (discoveryEventAttached) {
+            noble.removeListener("discover", this._discoveryEventHandler);
+            discoveryEventAttached = false;
+        }
+        noble.stopScanning();
+    }
+    /**
+     * Retrieve a list of Powered UP Hubs.
+     * @method PoweredUP#getConnectedHubs
+     * @returns {Hub[]}
+     */
+    getConnectedHubs() {
+        return Object.keys(this._connectedHubs).map((uuid) => this._connectedHubs[uuid]);
+    }
+    /**
+     * Retrieve a Powered UP Hub by UUID.
+     * @method PoweredUP#getConnectedHubByUUID
+     * @param {string} uuid
+     * @returns {Hub | null}
+     */
+    getConnectedHubByUUID(uuid) {
+        return this._connectedHubs[uuid];
+    }
+    /**
+     * Retrieve a list of Powered UP Hub by name.
+     * @method PoweredUP#getConnectedHubsByName
+     * @param {string} name
+     * @returns {Hub[]}
+     */
+    getConnectedHubsByName(name) {
+        return Object.keys(this._connectedHubs).map((uuid) => this._connectedHubs[uuid]).filter((hub) => hub.name === name);
+    }
+    async _discoveryEventHandler(peripheral) {
+        let hub;
+        if (await wedo2smarthub_1.WeDo2SmartHub.IsWeDo2SmartHub(peripheral)) {
+            hub = new wedo2smarthub_1.WeDo2SmartHub(peripheral, this.autoSubscribe);
+        }
+        else if (await boostmovehub_1.BoostMoveHub.IsBoostMoveHub(peripheral)) {
+            hub = new boostmovehub_1.BoostMoveHub(peripheral, this.autoSubscribe);
+        }
+        else if (await puphub_1.PUPHub.IsPUPHub(peripheral)) {
+            hub = new puphub_1.PUPHub(peripheral, this.autoSubscribe);
+        }
+        else if (await pupremote_1.PUPRemote.IsPUPRemote(peripheral)) {
+            hub = new pupremote_1.PUPRemote(peripheral, this.autoSubscribe);
+        }
+        else if (await duplotrainbase_1.DuploTrainBase.IsDuploTrainBase(peripheral)) {
+            hub = new duplotrainbase_1.DuploTrainBase(peripheral, this.autoSubscribe);
+        }
+        else {
+            return;
+        }
+        peripheral.removeAllListeners();
+        // noble.stopScanning();
+        // if (!isBrowserContext) {
+        //     startScanning();
+        // }
+        hub.on("discoverComplete", () => {
+            hub.on("connect", () => {
+                debug(`Hub ${hub.uuid} connected`);
+                this._connectedHubs[hub.uuid] = hub;
+            });
+            hub.on("disconnect", () => {
+                debug(`Hub ${hub.uuid} disconnected`);
+                delete this._connectedHubs[hub.uuid];
+                if (wantScan) {
+                    startScanning();
+                }
+            });
+            debug(`Hub ${hub.uuid} discovered`);
+            /**
+             * Emits when a Powered UP Hub device is found.
+             * @event PoweredUP#discover
+             * @param {WeDo2SmartHub | BoostMoveHub | PUPHub | PUPRemote | DuploTrainBase} hub
+             */
+            this.emit("discover", hub);
+        });
+    }
+}
+exports.PoweredUP = PoweredUP;
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/puphub.js.html b/docs/puphub.js.html new file mode 100644 index 0000000..094618a --- /dev/null +++ b/docs/puphub.js.html @@ -0,0 +1,400 @@ + + + + + + + DocStrap Source: puphub.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: puphub.js

+ +
+
+
"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#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 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;
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/pupremote.js.html b/docs/pupremote.js.html new file mode 100644 index 0000000..32caa92 --- /dev/null +++ b/docs/pupremote.js.html @@ -0,0 +1,330 @@ + + + + + + + DocStrap Source: pupremote.js + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +

Source: pupremote.js

+ +
+
+
"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("pupremote");
+/**
+ * The PUPRemote is emitted if the discovered device is a Powered UP Remote.
+ * @class PUPRemote
+ * @extends LPF2Hub
+ * @extends Hub
+ */
+class PUPRemote extends lpf2hub_1.LPF2Hub {
+    // We set JSDoc to ignore these events as a Powered UP Remote will never emit them.
+    /**
+     * @event PUPRemote#distance
+     * @ignore
+     */
+    /**
+     * @event PUPRemote#color
+     * @ignore
+     */
+    /**
+     * @event PUPRemote#tilt
+     * @ignore
+     */
+    /**
+     * @event PUPRemote#rotate
+     * @ignore
+     */
+    /**
+     * @event PUPRemote#speed
+     * @ignore
+     */
+    /**
+     * @event PUPRemote#attach
+     * @ignore
+     */
+    /**
+     * @event PUPRemote#detach
+     * @ignore
+     */
+    static IsPUPRemote(peripheral) {
+        return (peripheral.advertisement.serviceUuids.indexOf(Consts.BLEService.LPF2_HUB.replace(/-/g, "")) >= 0 && peripheral.advertisement.manufacturerData[3] === Consts.BLEManufacturerData.POWERED_UP_REMOTE_ID);
+    }
+    constructor(peripheral, autoSubscribe = true) {
+        super(peripheral, autoSubscribe);
+        this.type = Consts.HubType.POWERED_UP_REMOTE;
+        this._ports = {
+            "LEFT": new port_1.Port("LEFT", 0),
+            "RIGHT": new port_1.Port("RIGHT", 1)
+        };
+        debug("Discovered Powered UP Remote");
+    }
+    connect() {
+        return new Promise(async (resolve, reject) => {
+            debug("Connecting to Powered UP Remote");
+            await super.connect();
+            debug("Connect completed");
+            return resolve();
+        });
+    }
+    /**
+     * Set the color of the LED on the Remote via a color value.
+     * @method PUPRemote#setLEDColor
+     * @param {Color} color
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    setLEDColor(color) {
+        return new Promise((resolve, reject) => {
+            let data = Buffer.from([0x41, 0x34, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            if (color === false) {
+                color = 0;
+            }
+            data = Buffer.from([0x81, 0x34, 0x11, 0x51, 0x00, color]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            return resolve();
+        });
+    }
+    /**
+     * Set the color of the LED on the Hub via RGB values.
+     * @method PUPRemote#setLEDRGB
+     * @param {number} red
+     * @param {number} green
+     * @param {number} blue
+     * @returns {Promise} Resolved upon successful issuance of command.
+     */
+    setLEDRGB(red, green, blue) {
+        return new Promise((resolve, reject) => {
+            let data = Buffer.from([0x41, 0x34, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            data = Buffer.from([0x81, 0x34, 0x11, 0x51, 0x01, red, green, blue]);
+            this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, data);
+            return resolve();
+        });
+    }
+}
+exports.PUPRemote = PUPRemote;
+
+
+
+ + + + + +
+
+ +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/quicksearch.html b/docs/quicksearch.html new file mode 100644 index 0000000..4f4fcab --- /dev/null +++ b/docs/quicksearch.html @@ -0,0 +1,31 @@ + + + + + + + + + + + + + diff --git a/docs/scripts/docstrap.lib.js b/docs/scripts/docstrap.lib.js new file mode 100644 index 0000000..09d9272 --- /dev/null +++ b/docs/scripts/docstrap.lib.js @@ -0,0 +1,11 @@ +if(!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){function c(a){var b="length"in a&&a.length,c=_.type(a);return"function"!==c&&!_.isWindow(a)&&(!(1!==a.nodeType||!b)||("array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a))}function d(a,b,c){if(_.isFunction(b))return _.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return _.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(ha.test(b))return _.filter(b,a,c);b=_.filter(b,a)}return _.grep(a,function(a){return U.call(b,a)>=0!==c})}function e(a,b){for(;(a=a[b])&&1!==a.nodeType;);return a}function f(a){var b=oa[a]={};return _.each(a.match(na)||[],function(a,c){b[c]=!0}),b}function g(){Z.removeEventListener("DOMContentLoaded",g,!1),a.removeEventListener("load",g,!1),_.ready()}function h(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=_.expando+h.uid++}function i(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(ua,"-$1").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c="true"===c||"false"!==c&&("null"===c?null:+c+""===c?+c:ta.test(c)?_.parseJSON(c):c)}catch(a){}sa.set(a,b,c)}else c=void 0;return c}function j(){return!0}function k(){return!1}function l(){try{return Z.activeElement}catch(a){}}function m(a,b){return _.nodeName(a,"table")&&_.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function n(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function o(a){var b=Ka.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function p(a,b){for(var c=0,d=a.length;d>c;c++)ra.set(a[c],"globalEval",!b||ra.get(b[c],"globalEval"))}function q(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(ra.hasData(a)&&(f=ra.access(a),g=ra.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;d>c;c++)_.event.add(b,e,j[e][c])}sa.hasData(a)&&(h=sa.access(a),i=_.extend({},h),sa.set(b,i))}}function r(a,b){var c=a.getElementsByTagName?a.getElementsByTagName(b||"*"):a.querySelectorAll?a.querySelectorAll(b||"*"):[];return void 0===b||b&&_.nodeName(a,b)?_.merge([a],c):c}function s(a,b){var c=b.nodeName.toLowerCase();"input"===c&&ya.test(a.type)?b.checked=a.checked:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}function t(b,c){var d,e=_(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:_.css(e[0],"display");return e.detach(),f}function u(a){var b=Z,c=Oa[a];return c||(c=t(a,b),"none"!==c&&c||(Na=(Na||_("