Scratch3WeDo2Blocks

Scratch3WeDo2Blocks

Scratch 3.0 blocks to interact with a LEGO WeDo 2.0 peripheral.

Constructor

new Scratch3WeDo2Blocks(runtime)

Construct a set of WeDo 2.0 blocks.

Parameters:
Name Type Description
runtime Runtime

the Scratch 3.0 runtime.

Members

(static) EXTENSION_ID

(static) TILT_THRESHOLD

runtime :Runtime

The Scratch 3.0 runtime.

Type:

Methods

(private) _forEachMotor(motorID, callback)

Call a callback for each motor indexed by the provided motor ID.

Parameters:
Name Type Description
motorID MotorID

the ID specifier.
callback function

the function to call with the numeric motor index for each motor.

(private) _getTiltAngle(direction) → {number}

Parameters:
Name Type Description
direction TiltDirection

the direction (up, down, left, right) to check.
Returns:
  • the tilt sensor's angle in the specified direction. Note that getTiltAngle(up) = -getTiltAngle(down) and getTiltAngle(left) = -getTiltAngle(right).
Type
number

(private) _isTilted(direction) → {boolean}

Test whether the tilt sensor is currently tilted.

Parameters:
Name Type Description
direction TiltDirection

the tilt direction to test (up, down, left, right, or any).
Returns:
  • true if the tilt sensor is tilted past a threshold in the specified direction.
Type
boolean

(private) _noteToTone(midiNote) → {number}

Parameters:
Name Type Description
midiNote number

the MIDI note value to convert.
Returns:
  • the frequency, in Hz, corresponding to that MIDI note value.
Type
number

getDistance() → {number}

Returns:
  • the distance sensor's value, scaled to the [0,100] range.
Type
number

getInfo() → {object}

Returns:

metadata for this extension and its blocks.

Type
object

getTiltAngle(args) → {number}

Properties:
Name Type Description
TILT_DIRECTION TiltDirection

the direction (up, down, left, right) to check.
Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • the tilt sensor's angle in the specified direction. Note that getTiltAngle(up) = -getTiltAngle(down) and getTiltAngle(left) = -getTiltAngle(right).
Type
number

isTilted(args) → {boolean}

Properties:
Name Type Description
TILT_DIRECTION_ANY TiltDirection

the tilt direction to test (up, down, left, right, or any).

Test whether the tilt sensor is currently tilted.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • true if the tilt sensor is tilted past a threshold in the specified direction.
Type
boolean

motorOff(args) → {Promise}

Properties:
Name Type Description
MOTOR_ID MotorID

the motor(s) to deactivate.

Turn specified motor(s) off.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • a Promise that resolves after some delay.
Type
Promise

motorOn(args) → {Promise}

Properties:
Name Type Description
MOTOR_ID MotorID

the motor(s) to activate.

Turn specified motor(s) on indefinitely.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • a Promise that resolves after some delay.
Type
Promise

motorOnFor(args) → {Promise}

Properties:
Name Type Description
MOTOR_ID MotorID

the motor(s) to activate.
DURATION int

the amount of time to run the motors.

Turn specified motor(s) on for a specified duration.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • a promise which will resolve at the end of the duration.
Type
Promise

playNoteFor(args) → {Promise}

Properties:
Name Type Description
NOTE number

the MIDI note to play.
DURATION number

the duration of the note, in seconds.

Make the WeDo 2.0 peripheral play a MIDI note for the specified duration.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • a promise which will resolve at the end of the duration.
Type
Promise

setLightHue(args) → {Promise}

Properties:
Name Type Description
HUE number

the hue to set, in the range [0,100].

Set the LED's hue.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • a Promise that resolves after some delay.
Type
Promise

setMotorDirection(args) → {Promise}

Properties:
Name Type Description
MOTOR_ID MotorID

the motor(s) to be affected.
MOTOR_DIRECTION MotorDirection

the new direction for the motor(s).

Set the direction of rotation for specified motor(s). If the direction is 'reverse' the motor(s) will be reversed individually.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • a Promise that resolves after some delay.
Type
Promise

startMotorPower(args) → {Promise}

Properties:
Name Type Description
MOTOR_ID MotorID

the motor(s) to be affected.
POWER int

the new power level for the motor(s).

Turn specified motor(s) off.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • a Promise that resolves after some delay.
Type
Promise

whenDistance(args) → {boolean}

Properties:
Name Type Description
OP string

the comparison operation: '<' or '>'.
REFERENCE number

the value to compare against.

Compare the distance sensor's value to a reference.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • the result of the comparison, or false on error.
Type
boolean

whenTilted(args) → {boolean}

Properties:
Name Type Description
TILT_DIRECTION_ANY TiltDirection

the tilt direction to test (up, down, left, right, or any).

Test whether the tilt sensor is currently tilted.

Parameters:
Name Type Description
args object

the block's arguments.
Returns:
  • true if the tilt sensor is tilted past a threshold in the specified direction.
Type
boolean