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
brake() → {Promise.<CommandFeedback>}
Brake the motor. Previous commands that have not completed are discarded.
- Source:
rampPower(fromPower, toPower, time) → {Promise.<CommandFeedback>}
Ramp the motor power.
Parameters:
| Name | Type | Description |
|---|---|---|
fromPower |
number |
For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
toPower |
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:
setPower(power, interruptopt) → {Promise.<CommandFeedback>}
Set the motor power.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
power |
number |
For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
||
interrupt |
boolean |
<optional> |
false |
If true, previous commands are discarded. |
- Source:
stop() → {Promise.<CommandFeedback>}
Stop the motor. Previous commands that have not completed are discarded.
- Source: