Constructor
new BoostMotor(parent, index)
Construct a Boost Motor instance.
Parameters:
| Name | Type | Description |
|---|---|---|
parent |
Boost | the Boost peripheral which owns this motor. |
index |
int | the zero-based index of this motor on its parent peripheral. |
Members
(private) _direction :number
This motor's current direction: 1 for "this way" or -1 for "that way"
Type:
- number
(private) _index :int
The zero-based index of this motor on its parent peripheral.
Type:
- int
(private) _parent :Boost
The Boost peripheral which owns this motor.
Type:
(private) _pendingDurationTimeoutDelay :number
The delay/duration of the pending duration timeout.
Type:
- number
(private) _pendingDurationTimeoutId :Object
If the motor has been turned on or is actively braking for a specific duration, this is the timeout ID for the end-of-action handler. Cancel this when changing plans.
Type:
- Object
(private) _pendingDurationTimeoutStartTime :number
The starting time for the pending duration timeout.
Type:
- number
(private) _pendingRotationDestination :number
The target position of a turn-based command.
Type:
- number
(private) _pendingRotationPromise :Object
If the motor has been turned on run for a specific rotation, this is the function that will be called once Scratch VM gets a notification from the Move Hub.
Type:
- Object
(private) _position :number
This motor's current relative position
Type:
- number
(private) _power :number
This motor's current power level, in the range [0,100].
Type:
- number
(private) _status :boolean
Is this motor currently moving?
Type:
- boolean
direction
direction
pendingDurationTimeoutDelay
pendingDurationTimeoutStartTime
pendingRotationDestination
pendingRotationPromise
pendingRotationPromise
position
position
power
power
status
status
Methods
(private) _clearDurationTimeout()
Clear the motor action timeout, if any. Safe to call even when there is no pending timeout.
(private) _clearRotationState()
Clear the motor states related to rotation-based commands, if any. Safe to call even when there is no pending promise function.
(private) _setNewDurationTimeout(callback, delay)
Set a new motor action timeout, after clearing an existing one if necessary.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | to be called at the end of the timeout. |
delay |
int | wait this many milliseconds before calling the callback. |
(private) _turnOn()
Turn this motor on indefinitely
turnOff(useLimiteropt)
Turn this motor off.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
useLimiter |
boolean |
<optional> |
true
|
if true, use the rate limiter |
turnOnFor(milliseconds)
Turn this motor on for a specific duration.
Parameters:
| Name | Type | Description |
|---|---|---|
milliseconds |
number | run the motor for this long. |
turnOnForDegrees(degrees, direction)
Turn this motor on for a specific rotation in degrees.
Parameters:
| Name | Type | Description |
|---|---|---|
degrees |
number | run the motor for this amount of degrees. |
direction |
number | rotate in this direction |
turnOnForever()
Turn this motor on indefinitely