nkellenicki/node-poweredup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added RGB color mode to LED lights on Boost Move Hub and PUP Hub and Remote

Browse Source
This commit is contained in:
Nathan Kellenicki 2018-10-14 10:40:26 -07:00
parent 67b5e84e15
commit 439a115e74
2 changed files with 122 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
DOCS.md
View File

@ -415,6 +415,7 @@ Emits when an attached motor or sensor is detached from the Hub.
* [.setLightBrightness(port, brightness, [time])](#BoostMoveHub+setLightBrightness) ⇒ <code>Promise</code> * [.setLightBrightness(port, brightness, [time])](#BoostMoveHub+setLightBrightness) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code> * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
* [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code> * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code>
@ -570,6 +571,20 @@ Set the color of the LED on the Hub via a color value.
| --- | --- | --- | | --- | --- | --- |
| color | <code>number</code> | A number representing one of the LED color consts. | | color | <code>number</code> | A number representing one of the LED color consts. |
<a name="LPF2Hub+setLEDRGB"></a>
### boostMoveHub.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="Hub+connect"></a> <a name="Hub+connect"></a>
### boostMoveHub.connect() ⇒ <code>Promise</code> ### boostMoveHub.connect() ⇒ <code>Promise</code>
@ -740,6 +755,7 @@ Emits when an attached motor or sensor is detached from the Hub.
* [.setLightBrightness(port, brightness, [time])](#PUPHub+setLightBrightness) ⇒ <code>Promise</code> * [.setLightBrightness(port, brightness, [time])](#PUPHub+setLightBrightness) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code> * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
* [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code> * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code>
@ -880,6 +896,20 @@ Set the color of the LED on the Hub via a color value.
| --- | --- | --- | | --- | --- | --- |
| color | <code>number</code> | A number representing one of the LED color consts. | | color | <code>number</code> | A number representing one of the LED color consts. |
<a name="LPF2Hub+setLEDRGB"></a>
### pupHub.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="Hub+connect"></a> <a name="Hub+connect"></a>
### pupHub.connect() ⇒ <code>Promise</code> ### pupHub.connect() ⇒ <code>Promise</code>
@ -1034,6 +1064,7 @@ Emits when an attached motor or sensor is detached from the Hub.
* [.rssi](#Hub+rssi) * [.rssi](#Hub+rssi)
* [.batteryLevel](#Hub+batteryLevel) * [.batteryLevel](#Hub+batteryLevel)
* [.setLEDColor(color)](#PUPRemote+setLEDColor) ⇒ <code>Promise</code> * [.setLEDColor(color)](#PUPRemote+setLEDColor) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#PUPRemote+setLEDRGB) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
@ -1116,6 +1147,21 @@ Set the color of the LED on the Remote via a color value.
| --- | --- | --- | | --- | --- | --- |
| color | <code>number</code> | A number representing one of the LED color consts. | | color | <code>number</code> | A number representing one of the LED color consts. |
<a name="PUPRemote+setLEDRGB"></a>
### pupRemote.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>setLEDRGB</code>](#LPF2Hub+setLEDRGB)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="LPF2Hub+setName"></a> <a name="LPF2Hub+setName"></a>
### pupRemote.setName(name) ⇒ <code>Promise</code> ### pupRemote.setName(name) ⇒ <code>Promise</code>
@ -1226,6 +1272,7 @@ Emits when a button is pressed.
* [.playSound(sound)](#DuploTrainBase+playSound) ⇒ <code>Promise</code> * [.playSound(sound)](#DuploTrainBase+playSound) ⇒ <code>Promise</code>
* [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#DuploTrainBase+rampMotorSpeed) ⇒ <code>Promise</code> * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#DuploTrainBase+rampMotorSpeed) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
* [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code> * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code>
@ -1365,6 +1412,20 @@ Set the name of the Hub.
| --- | --- | --- | | --- | --- | --- |
| name | <code>string</code> | New name of the hub (14 characters or less, ASCII only). | | name | <code>string</code> | New name of the hub (14 characters or less, ASCII only). |
<a name="LPF2Hub+setLEDRGB"></a>
### duploTrainBase.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>DuploTrainBase</code>](#DuploTrainBase)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="Hub+connect"></a> <a name="Hub+connect"></a>
### duploTrainBase.connect() ⇒ <code>Promise</code> ### duploTrainBase.connect() ⇒ <code>Promise</code>

61
README.md
View File

@ -494,6 +494,7 @@ Emits when an attached motor or sensor is detached from the Hub.
* [.setLightBrightness(port, brightness, [time])](#BoostMoveHub+setLightBrightness) ⇒ <code>Promise</code> * [.setLightBrightness(port, brightness, [time])](#BoostMoveHub+setLightBrightness) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code> * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
* [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code> * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code>
@ -649,6 +650,20 @@ Set the color of the LED on the Hub via a color value.
| --- | --- | --- | | --- | --- | --- |
| color | <code>number</code> | A number representing one of the LED color consts. | | color | <code>number</code> | A number representing one of the LED color consts. |
<a name="LPF2Hub+setLEDRGB"></a>
### boostMoveHub.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>BoostMoveHub</code>](#BoostMoveHub)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="Hub+connect"></a> <a name="Hub+connect"></a>
### boostMoveHub.connect() ⇒ <code>Promise</code> ### boostMoveHub.connect() ⇒ <code>Promise</code>
@ -819,6 +834,7 @@ Emits when an attached motor or sensor is detached from the Hub.
* [.setLightBrightness(port, brightness, [time])](#PUPHub+setLightBrightness) ⇒ <code>Promise</code> * [.setLightBrightness(port, brightness, [time])](#PUPHub+setLightBrightness) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code> * [.setLEDColor(color)](#LPF2Hub+setLEDColor) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
* [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code> * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code>
@ -959,6 +975,20 @@ Set the color of the LED on the Hub via a color value.
| --- | --- | --- | | --- | --- | --- |
| color | <code>number</code> | A number representing one of the LED color consts. | | color | <code>number</code> | A number representing one of the LED color consts. |
<a name="LPF2Hub+setLEDRGB"></a>
### pupHub.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>PUPHub</code>](#PUPHub)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="Hub+connect"></a> <a name="Hub+connect"></a>
### pupHub.connect() ⇒ <code>Promise</code> ### pupHub.connect() ⇒ <code>Promise</code>
@ -1113,6 +1143,7 @@ Emits when an attached motor or sensor is detached from the Hub.
* [.rssi](#Hub+rssi) * [.rssi](#Hub+rssi)
* [.batteryLevel](#Hub+batteryLevel) * [.batteryLevel](#Hub+batteryLevel)
* [.setLEDColor(color)](#PUPRemote+setLEDColor) ⇒ <code>Promise</code> * [.setLEDColor(color)](#PUPRemote+setLEDColor) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#PUPRemote+setLEDRGB) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
@ -1195,6 +1226,21 @@ Set the color of the LED on the Remote via a color value.
| --- | --- | --- | | --- | --- | --- |
| color | <code>number</code> | A number representing one of the LED color consts. | | color | <code>number</code> | A number representing one of the LED color consts. |
<a name="PUPRemote+setLEDRGB"></a>
### pupRemote.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>PUPRemote</code>](#PUPRemote)
**Overrides**: [<code>setLEDRGB</code>](#LPF2Hub+setLEDRGB)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="LPF2Hub+setName"></a> <a name="LPF2Hub+setName"></a>
### pupRemote.setName(name) ⇒ <code>Promise</code> ### pupRemote.setName(name) ⇒ <code>Promise</code>
@ -1305,6 +1351,7 @@ Emits when a button is pressed.
* [.playSound(sound)](#DuploTrainBase+playSound) ⇒ <code>Promise</code> * [.playSound(sound)](#DuploTrainBase+playSound) ⇒ <code>Promise</code>
* [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#DuploTrainBase+rampMotorSpeed) ⇒ <code>Promise</code> * [.rampMotorSpeed(port, fromSpeed, toSpeed, time)](#DuploTrainBase+rampMotorSpeed) ⇒ <code>Promise</code>
* [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code> * [.setName(name)](#LPF2Hub+setName) ⇒ <code>Promise</code>
* [.setLEDRGB(red, green, blue)](#LPF2Hub+setLEDRGB) ⇒ <code>Promise</code>
* [.connect()](#Hub+connect) ⇒ <code>Promise</code> * [.connect()](#Hub+connect) ⇒ <code>Promise</code>
* [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code> * [.disconnect()](#Hub+disconnect) ⇒ <code>Promise</code>
* [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code> * [.subscribe(port, [mode])](#Hub+subscribe) ⇒ <code>Promise</code>
@ -1444,6 +1491,20 @@ Set the name of the Hub.
| --- | --- | --- | | --- | --- | --- |
| name | <code>string</code> | New name of the hub (14 characters or less, ASCII only). | | name | <code>string</code> | New name of the hub (14 characters or less, ASCII only). |
<a name="LPF2Hub+setLEDRGB"></a>
### duploTrainBase.setLEDRGB(red, green, blue) ⇒ <code>Promise</code>
Set the color of the LED on the Hub via RGB values.
**Kind**: instance method of [<code>DuploTrainBase</code>](#DuploTrainBase)
**Returns**: <code>Promise</code> - Resolved upon successful issuance of command.
| Param | Type |
| --- | --- |
| red | <code>number</code> |
| green | <code>number</code> |
| blue | <code>number</code> |
<a name="Hub+connect"></a> <a name="Hub+connect"></a>
### duploTrainBase.connect() ⇒ <code>Promise</code> ### duploTrainBase.connect() ⇒ <code>Promise</code>