new Light()
- Source:
Extends
Members
(readonly) connected
Properties:
| Name | Type | Description |
|---|---|---|
connected |
boolean | Check if the device is still attached. |
- Inherited From:
- Source:
(readonly) hub
Properties:
| Name | Type | Description |
|---|---|---|
hub |
Hub | The Hub the device is attached to. |
- Inherited From:
- Source:
(readonly) isVirtualPort
Properties:
| Name | Type | Description |
|---|---|---|
isVirtualPort |
boolean | Is this device attached to a virtual port (ie. a combined device) |
- Inherited From:
- Source:
(readonly) mode
Properties:
| Name | Type | Description |
|---|---|---|
mode |
number | The mode the device is currently in |
- Inherited From:
- Source:
(readonly) portName
Properties:
| Name | Type | Description |
|---|---|---|
portName |
string | The port the device is attached to. |
- Inherited From:
- Source:
(readonly) type
Properties:
| Name | Type | Description |
|---|---|---|
type |
number | The type of the device |
- Inherited From:
- Source:
Methods
rampBrightness(fromBrightness, toBrightness, time) → {Promise}
Ramp the light brightness.
Parameters:
| Name | Type | Description |
|---|---|---|
fromBrightness |
number | Brightness value between 0-100 (0 is off) |
toBrightness |
number | Brightness value between 0-100 (0 is off) |
time |
number | How long the ramp should last (in milliseconds). |
- Source:
Returns:
Resolved upon successful completion of command.
- Type
- Promise
setBrightness(brightness) → {Promise}
Set the light brightness.
Parameters:
| Name | Type | Description |
|---|---|---|
brightness |
number | Brightness value between 0-100 (0 is off) |
- Source:
Returns:
Resolved upon successful completion of command.
- Type
- Promise