boost-movehub 0.1.0 | Documentation

boost-movehub

0.1.0

Boost ▸
- Instance members
- #startScanning
- #stopScanning
- #onDiscover
Boost#hubConnected
Hub ▸
- Instance members
- #address
- #uuid
- #connect
- #disconnect
- #switchOff
- #immediateShutdown
- #sendMessage
- #activateAlerts
- #deactivateAlerts
- #_receiveMessage
Hub#error
Hub#disconnect
Hub#rssi
Hub#connect
Hub#hubAlert
R2D2 ▸
- Instance members
- #on
R2D2.rgbLed.setColor
R2D2.wheels.drive
R2D2.wheels.driveDistance
R2D2.wheels.driveTime
R2D2.wheels.stop
R2D2.chassis.isOpen
R2D2.chassis.open
R2D2.chassis.close
R2D2.head.turn
R2D2.head.stop
R2D2.head.turnDegrees
R2D2.head.turnTime
create
DeviceMessage ▸
- Instance members
- #length
GenericError
HubAction ▸
- Static members
- .build
HubAlert ▸
- Static members
- .build
- Instance members
- #alertTypeToString
HubAttachedMessage ▸
- Instance members
- #portId
- #eventType
- #ioMembers
PortInputFormat
PortInputFormatSetup ▸
- Static members
- .build
PortOutput ▸
- Static members
- .buildWriteDirectModeData
- .build
PortOutputCommandFeedbackMessage ▸
- Instance members
- #payload
- #valuesForPorts
PortValueSingleMessage
create
CurrentSensor ▸
- Instance members
- #receiveValue
Motor ▸
- Instance members
- #startPower
- #startSpeed
- #startSpeedForTime
- #startSpeedForDegrees
- #stop
- #combinedStartSpeed
- #combinedStartPower
- #combinedStartSpeedForTime
- #combinedStartSpeedForDegrees
- #combinedStop
- #receiveValue
- #receiveCommandFeedback
Motor#start
Motor#stop
Peripheral ▸
- Static members
- .DEV_MOTOR
- Instance members
- #subscribe
- #unsubscribe
- #receiveSubscriptionAck
- #setValue
- #getValueAsync
Peripheral#value
Peripheral#value
RgbLed ▸
- Instance members
- #setColor
- #setRgbColor
- #receiveValue
TiltSensor ▸
- Instance members
- #receiveValue
UnknownPeripheral
VisionSensor ▸
- Instance members
- #receiveValue
- #setValue
VisionSensor#distance
VisionSensor#color
VisionSensor#color
VoltageSensor ▸
- Instance members
- #receiveValue

Need help reading this?

Boost

The Boost instance scans for Boost devices like your movehub.

Boost

Extends EventEmitter

Parameters

hubAddressOrUuid (string) The UUID or MAC address of the movehub to connect to.

options (Object?) Some options.

Name	Description
options.logger `Object?`	Logger implementation when logging is desired.

Instance Members

▸ startScanning()

Starts scanning for peripherals.

startScanning()

▸ stopScanning()

Stops scanning for peripherals.

stopScanning()

▸ onDiscover(peripheral)

Called when noble is discovering a matching BLE Peripheral.

onDiscover(peripheral: Object)

Parameters

peripheral (Object) Peripheral data found by noble.

Boost#hubConnected

Parameters

hub (Hub) The hub that just connected.

Hub

Movehub implementation that handles all the sending and receiving of messages between us and the Movehub device.

Hub

Extends EventEmitter

Instance Members

▸ address

MAC Address of connected Movehub.

address

▸ uuid

UUID of connected Movehub.

uuid

▸ connect()

Tries connecting to initialized Movehub.

connect()

▸ disconnect()

Sends disconnection signal and disconnects from Movehub.

disconnect()

▸ switchOff()

Sends SwitchOff signal to Movehub.

switchOff()

▸ immediateShutdown()

Sends signal to immediately shut down Movehub.

immediateShutdown()

▸ sendMessage(msg, callback)

Sends given device message to connected Movehub.

sendMessage(msg: DeviceMessage, callback: function)

Parameters

msg (DeviceMessage) Message to send.

callback

(function
            = null)

▸ activateAlerts(filter = null)

This subscribes to all or specific Hub Alerts.

activateAlerts(filter: Array<number>?)

Parameters

filter

(Array<number>?
            = null)

List of HubAlert to subscribe to. Default are all.

▸ deactivateAlerts(filter = null)

This unsubscribes from all or specifc Hub Alerts.

deactivateAlerts(filter: Array<number>?)

Parameters

filter

(Array<number>?
            = null)

List of HubAlert to subscribe to. Default are all.

▸ _receiveMessage(msg)

Called when a Movehub sends a message.

_receiveMessage(msg: DeviceMessage)

Parameters

msg (DeviceMessage)

Hub#error

Fires when an error is received when connecting to the Movehub.

Hub#error

Parameters

error (Error)

Hub#disconnect

Fires when a Movehub gets disconnected.

Hub#disconnect

Hub#rssi

Fires when new RSSI value is received from BLE device.

Hub#rssi

Parameters

rssi (number) The received RSSI value.

Hub#connect

Fires when a connection to the Move Hub is established.

Hub#connect

Hub#hubAlert

Fires on received Hub Alert.

Hub#hubAlert

Parameters

value (any) {string} String representation of HubAlert that happened.

R2D2

Interface to work with your R2D2 robot.

R2D2

Instance Members

▸ on(what, cb)

on(what: string, cb: Function): Promise<void>

Parameters

what (string) Type of event to listen to.

cb (Function) Callback method to call when event is happening.

Returns

Promise<void>:

R2D2.rgbLed.setColor

Sets color of RGB to given index color.

R2D2.rgbLed.setColor(color: number): Promise<void>

Parameters

color (number) The index of color to use. (One of RgbLed.COLOR_* )

Returns

Promise<void>:

R2D2.wheels.drive

Starts both wheels synchronous using given speed.

R2D2.wheels.drive(speed: number): Promise<void>

Parameters

speed (number) Speed ranging from 0 to 100 (%).

Returns

Promise<void>:

R2D2.wheels.driveDistance

Starts both wheels synchronous using given speed until the traveled the given distance.

R2D2.wheels.driveDistance(centimeters: number, speed: number): Promise<void>

Parameters

centimeters (number) Number of centimeters until wheels stop.

speed (number) Speed ranging from 0 to 100 (%).

Returns

Promise<void>:

R2D2.wheels.driveTime

Starts both wheels synchronous using given speed for given amount of time.

R2D2.wheels.driveTime(time: number, speed: number): Promise<void>

Parameters

time (number) Number of milliseconds until wheels stop.

speed (number) Speed ranging from 0 to 100 (%).

Returns

Promise<void>:

R2D2.wheels.stop

Stop both wheels.

R2D2.wheels.stop(): Promise<void>

Returns

Promise<void>:

R2D2.chassis.isOpen

Resolves telling if the legs are behind the body of R2D2.

R2D2.chassis.isOpen(): Promise<boolean>

Returns

Promise<boolean>:

R2D2.chassis.open

Speeds up the wheels for a short amount of time, so the force will bring R2D2’s body in front of his legs.

R2D2.chassis.open(): Promise<void>

Returns

Promise<void>: Resolves when the movement is done.

R2D2.chassis.close

TODO: Brings the legs close to R2D2’s body.

R2D2.chassis.close(): Promise<void>

Returns

Promise<void>: Resolves when the movement is done.

R2D2.head.turn

Starts turning the head.

R2D2.head.turn(speed: number): Promise<void>

Parameters

speed (number) The speed ranging from -100 to 100 (%). (Clockwise or counter-clockwise)

Returns

Promise<void>: Resolves immediately.

R2D2.head.stop

Stops turning the head.

R2D2.head.stop(): Promise<void>

Returns

Promise<void>: Resolves immediately.

R2D2.head.turnDegrees

Starts turning the head for given amount of degrees.

R2D2.head.turnDegrees(degrees: number, speed: number): Promise<void>

Parameters

degrees (number) The amount of degrees to turn. Can be positive or negative for clockwise and counter-clockwise movement.

speed (number) The speed ranging from 0 to 100 (%).

Returns

Promise<void>: Resolves after movement finishes.

R2D2.head.turnTime

Starts turning the head for given amount of milliseconds.

R2D2.head.turnTime(time: number, speed: number): Promise<void>

Parameters

time (number) Milliseconds to turn

speed (number) The speed ranging from 0 to 100 (%).

Returns

Promise<void>: Resolves after movement finishes.

create

Creates an instance of a DeviceMessage implementation

create(data: Buffer): (DeviceMessage | UnknownMessage)

Parameters

data (Buffer)

Returns

(DeviceMessage | UnknownMessage): Returns an instance of DeviceMessage subclass, or null if message type is unknown to us

DeviceMessage

Base class for all Messages being send to or received from the MoveHub.

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#message-types

new DeviceMessage(data: Buffer)

Parameters

data (Buffer) Received Buffer data.

Instance Members

▸ length

From https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#common-message-header

length

GenericError

GenericError received from theMoveHub.

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#generic-error-messages

new GenericError()

Extends DeviceMessage

HubAction

Up- & Downstream messages for control actions on connected Hub.

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-actions

new HubAction()

Extends DeviceMessage

Static Members

▸ build(actionType)

Instanties a proper HubAction to send to Hub

build(actionType: number)

Parameters

actionType (number)

HubAlert

HubAlert Messages from MoveHub.

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-alerts

TODO: Test receiving them

new HubAlert()

Extends DeviceMessage

Static Members

▸ build(alertType, alertOp)

Instantiates a proper HubAlert message to send to Hub

build(alertType: number, alertOp: number): HubAlert

Parameters

alertType (number)

alertOp (number) One of HubAlert.OP_*

Returns

HubAlert:

Instance Members

▸ alertTypeToString

Returns string representation of alert type.

alertTypeToString

HubAttachedMessage

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#hub-attached-i-o.

Example data: <Buffer 0f 00 04 00 01 27 00 00 00 00 10 00 00 00 10>

new HubAttachedMessage()

Extends DeviceMessage

Instance Members

▸ portId

ID of port as defined in Port

portId

▸ eventType

One of HubAttachedMessage.EVENT_TYPE_*

eventType

▸ ioMembers

This only applies to eventType === EVENT_TYPE_ATTACHED_VIRTUAL_IO

ioMembers

PortInputFormat

Upstream message as answer to PortInputFormatSetup message.

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-single

new PortInputFormat(args: ...any)

Extends DeviceMessage

Parameters

args (...any)

PortInputFormatSetup

Downstream message to setup receiving single value sensor updates

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-input-format-setup-single

new PortInputFormatSetup(args: ...any)

Extends PortInputFormat

Parameters

args (...any)

Static Members

▸ build(portId, options = {})

Instantiates a proper PortInputFormatSetup to send to Hub

build(portId: number, options: Object?): PortInputFormatSetup

Parameters

portId (number) Port ID to subscribe updates for

options

(Object?
            = {})

Name	Description
options.mode `number?`
options.deltaInterval `number?`	Interval of change the value has to change to trigger update (1 is kind of live data).
options.notificationEnabled `number?`	Defines if messages should be send back on a regular base.

Returns

PortInputFormatSetup:

PortOutput

Downstream message to make peripherals do something.

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-output-command

new PortOutput()

Extends DeviceMessage

Static Members

▸ buildWriteDirectModeData(portId, startupCompletionFlags, subCommand, payload)

Instantiates a proper PortOutput to send to Hub encoded with writeDirectModeData

buildWriteDirectModeData(portId: number, startupCompletionFlags: (Array<number> | number), subCommand: number, payload: Array<number>): PortOutput

Parameters

portId (number)

startupCompletionFlags ((Array<number> | number)) Bitlist containing flags as defined in Startup and Completion Information or array of flags to set (Available flags: PortOutput.SC_FLAGS )

subCommand (number)

payload (Array<number>) Bytes of data to send

Returns

PortOutput:

▸ build(portId, startupCompletionFlags, subCommand, payload)

Instantiates a proper PortOutput to send to Hub

build(portId: number, startupCompletionFlags: (Array<number> | number), subCommand: number, payload: Array<number>): PortOutput

Parameters

portId (number)

startupCompletionFlags ((Array<number> | number)) Bitlist containing flags as defined in Startup and Completion Information or array of flags to set (Available flags: PortOutput.SC_FLAGS )

subCommand (number)

payload (Array<number>) Bytes of data to send

Returns

PortOutput:

PortOutputCommandFeedbackMessage

Message that holds values for multiple ports.

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-value-single

new PortOutputCommandFeedbackMessage()

Extends DeviceMessage

Instance Members

▸ payload

Object containing payloads with keys as port IDs.

payload

▸ valuesForPorts

Alias for payload.

valuesForPorts

PortValueSingleMessage

As defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#port-value-single

Example: <Buffer 06 00 45 3a 00 a6>

new PortValueSingleMessage()

Extends DeviceMessage

create

Creates an instance of a Peripheral implementation

create(ioType: Number, portId: Number, options: any): (Peripheral | UnknownPeripheral)

Parameters

ioType (Number)

portId (Number)

options (any)

Returns

(Peripheral | UnknownPeripheral): Returns an instance of DeviceMessage subclass, or null if message type is unknown to us

CurrentSensor

This handles the communication with the internal current sensor of Movehub. The values it produces are in milliamperes.

new CurrentSensor(ioType: Number, portId: Number, options: any)

Extends Peripheral

Parameters

ioType (Number) Peripheral Device Type ID (Should be Peripheral.DEV_CURRENT )

portId (Number) Port ID this peripheral is connected to

options

(any
            = undefined)

Instance Members

▸ receiveValue(msg)

Receives and processes message with value from sensor.

receiveValue(msg: PortValueSingleMessage)

Parameters

msg (PortValueSingleMessage)

Motor

Defines methods for internal and external Methods of a Movehub.

new Motor(ioType: Number, portId: Number, options: any)

Extends Peripheral

Parameters

ioType (Number) Peripheral Device Type ID (Either Peripheral.DEV_MOTOR , Peripheral.DEV_MOTOR_EXTERNAL_TACHO or Peripheral.DEV_MOTOR_INTERNAL_TACHO )

portId (Number) Port ID this peripheral is connected to

options

(any
            = undefined)

Instance Members

▸ startPower(dutyCycle)

Just starts/stops the motor. Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-startpower-power FIXME: 0 gives a piezo sound, so I guess that is not totally correct

startPower(dutyCycle: number)

Parameters

dutyCycle (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

▸ startSpeed(dutyCycle, maxSpeed = 100, useProfile)

Just starts/stops the motor. Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-startspeed-speed-maxpower-useprofile-0x07 FIXME: 0 gives a piezo sound, so I guess that is not totally correct

startSpeed(dutyCycle: number, maxSpeed: number?, useProfile: number)

Parameters

dutyCycle (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

maxSpeed

(number?
            = 100)

[0..100] %

useProfile

(number
            = Motor.PROFILE_ACCELERATION|Motor.PROFILE_DEACCELERATION)

Bitlist containing profiles to use (Select from Motor.PROFILE_* , defaults to Motor.PROFILE_ACCELERATION | Motor.PROFILE_DEACCELERATION )

▸ startSpeedForTime(time, dutyCycle, maxSpeed, endState, useProfile)

Starts the motor for given amount of time. Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-startspeedfortime-time-speed-maxpower-endstate-useprofile-0x09

startSpeedForTime(time: number, dutyCycle: number, maxSpeed: number, endState: number, useProfile: number)

Parameters

time (number) [0..2^15] milliseconds

dutyCycle (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

maxSpeed

(number
            = 100)

[0..100] %

endState

(number
            = Motor.END_STATE_FLOAT)

One of Motor.END_STATE_*

useProfile

(number
            = Motor.PROFILE_ACCELERATION|Motor.PROFILE_DEACCELERATION)

Bitlist containing profiles to use (Select from Motor.PROFILE_* , defaults to Motor.PROFILE_ACCELERATION | Motor.PROFILE_DEACCELERATION )

▸ startSpeedForDegrees(degrees, dutyCycle, maxSpeed, endState, useProfile)

Turns the motor for given number of degrees Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-startspeedfordegrees-degrees-speed-maxpower-endstate-useprofile-0x0b

startSpeedForDegrees(degrees: number, dutyCycle: number, maxSpeed: number, endState: number, useProfile: number)

Parameters

degrees (number) [0..2^31] milliseconds

dutyCycle (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

maxSpeed

(number
            = 100)

[0..100] %

endState

(number
            = Motor.END_STATE_BREAK)

One of Motor.END_STATE_*

useProfile

(number
            = Motor.PROFILE_ACCELERATION|Motor.PROFILE_DEACCELERATION)

Bitlist containing profiles to use (Select from Motor.PROFILE_* , defaults to Motor.PROFILE_ACCELERATION | Motor.PROFILE_DEACCELERATION )

▸ stop()

Creates stops message for motor.

stop()

▸ combinedStartSpeed(dutyCycleL, dutyCycleR, maxSpeed, useProfile)

combinedStartSpeed(dutyCycleL: number, dutyCycleR: number, maxSpeed: number, useProfile: number)

Parameters

dutyCycleL (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop for primary motor

dutyCycleR (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop for secondary motor

maxSpeed

(number
            = 100)

[0..100] %

useProfile

(number
            = Motor.PROFILE_ACCELERATION|Motor.PROFILE_DEACCELERATION)

Bitlist containing profiles to use (Select from Motor.PROFILE_* , defaults to Motor.PROFILE_ACCELERATION | Motor.PROFILE_DEACCELERATION )

▸ combinedStartPower(dutyCycleL, dutyCycleR)

Just starts/stops two motor in synchronized mode. Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-startpower-power

TODO: This does not work yet

combinedStartPower(dutyCycleL: number, dutyCycleR: number)

Parameters

dutyCycleL (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop of primary motor

dutyCycleR (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop of secondary motor

▸ combinedStartSpeedForTime(time, dutyCycleL, dutyCycleR, maxSpeed, endState, useProfile)

Starts two motors for given amount of time. Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-startspeedfortime-time-speed-maxpower-endstate-useprofile-0x0a

TODO: Does not work yet

combinedStartSpeedForTime(time: number, dutyCycleL: number, dutyCycleR: number, maxSpeed: number, endState: number, useProfile: number)

Parameters

time (number) [0..2^15] milliseconds

dutyCycleL (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

dutyCycleR (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

maxSpeed

(number
            = 100)

[0..100] %

endState

(number
            = Motor.END_STATE_FLOAT)

One of Motor.END_STATE_*

useProfile

(number
            = Motor.PROFILE_ACCELERATION|Motor.PROFILE_DEACCELERATION)

Bitlist containing profiles to use (Select from Motor.PROFILE_* , defaults to Motor.PROFILE_ACCELERATION | Motor.PROFILE_DEACCELERATION )

▸ combinedStartSpeedForDegrees(degrees, dutyCycleL, dutyCycleR, maxSpeed, endState, useProfile)

Turns two motors in sync for given number of degrees Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-startspeedfordegrees-degrees-speedl-speedr-maxpower-endstate-useprofile-0x0c

combinedStartSpeedForDegrees(degrees: number, dutyCycleL: number, dutyCycleR: number, maxSpeed: number, endState: number, useProfile: number)

Parameters

degrees (number) [0..2^31] milliseconds

dutyCycleL (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

dutyCycleR (number) [-100..-1] Percentage CCW, [1..100] Percentage CW, [0] to stop

maxSpeed

(number
            = 100)

[0..100] %

endState

(number
            = Motor.END_STATE_BREAK)

One of Motor.END_STATE_*

useProfile

(number
            = Motor.PROFILE_ACCELERATION|Motor.PROFILE_DEACCELERATION)

Bitlist containing profiles to use (Select from Motor.PROFILE_* , defaults to Motor.PROFILE_ACCELERATION | Motor.PROFILE_DEACCELERATION )

▸ combinedStop()

Creates stops message for motor.

combinedStop()

▸ receiveValue(msg)

Receives and processes message with value from sensor.

receiveValue(msg: PortValueSingleMessage)

Parameters

msg (PortValueSingleMessage)

▸ receiveCommandFeedback(value)

Called with feedback from Hub.

receiveCommandFeedback(value: number)

Parameters

value (number) One of PortOutputCommandFeedbackMessage.ACTION_*

Motor#start

Fires when Motor starts running.

Motor#start

Motor#stop

Fires when Motor finished running.

Motor#stop

Peripheral

This is the base class for all the peripherals of an Movehub.

new Peripheral(ioType: Number, portId: Number, options: any)

Extends EventEmitter

Parameters

ioType (Number) Peripheral Device Type ID (One of Peripheral.DEV_* )

portId (Number) Port ID this peripheral is connected to

options

(any
            = DEFAULT_OPTIONS)

Static Members

▸ DEV_MOTOR

Defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#io-type-id

DEV_MOTOR

Instance Members

▸ subscribe(mode = this.defaultMode)

Creates a message that starts subscribing to updates.

subscribe(mode: number?)

Parameters

mode

(number?
            = this.defaultMode)

Mode in which updates should come in (One of <YourPeripheral>.MODE_* )

▸ unsubscribe()

Disable from all updates from hub.

unsubscribe()

▸ receiveSubscriptionAck(msg)

Handle acknowledge message for prior subscribe or unsubscribe.

receiveSubscriptionAck(msg: PortInputFormat)

Parameters

msg (PortInputFormat)

▸ setValue(value)

Sets the value received by the Hub.

setValue(value: number)

Parameters

value (number)

▸ getValueAsync()

Async method to get the current value. If no value was received yet, it waits for a value to be received before resolving.

getValueAsync()

Peripheral#value

Fires when a new value is set on a Peripheral.

Peripheral#value

Parameters

value (number)

Peripheral#value

Fires when a new value is set on a Peripheral.

Peripheral#value

Parameters

value (number)

RgbLed

Class to set LED colors of the Movehub.

new RgbLed(ioType: Number, portId: Number, options: any)

Extends Peripheral

Parameters

ioType (Number) Peripheral Device Type ID (Should be Peripheral.DEV_RGB_LIGHT )

portId (Number) Port ID this peripheral is connected to

options

(any
            = undefined)

Instance Members

▸ setColor(color)

Creates a message that sets color to specific color by it’s number. Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-setrgbcolorno-redcolor-greencolor-bluecolor-n-a TODO: Make flags configurable via options

setColor(color: number)

Parameters

color (number) One of RgbLed.COLOR_*

▸ setRgbColor(red, green, blue)

Creates a message that sets LED to a specified RGB value Sends message as defined in https://lego.github.io/lego-ble-wireless-protocol-docs/index.html#output-sub-command-setrgbcolorno-colorno-n-a TODO: Make flags configurable via options

FIXME: This does not work yet

setRgbColor(red: number, green: number, blue: number)

Parameters

red (number) Red part of RGB value 0…255

green (number) Green part of RGB value 0…255

blue (number) Blue part of RGB value 0…255

▸ receiveValue(_msg)

Receives and processes message with value from sensor.

receiveValue(_msg: PortValueSingleMessage)

Parameters

_msg (PortValueSingleMessage)

TiltSensor

This handles the communication with the internal tilt sensor of Movehub. There seem to be different modes implemented in the device. We just made the one available that simply gets us the roll and pitch values.

new TiltSensor(ioType: Number, portId: Number, options: any)

Extends Peripheral

Parameters

ioType (Number) Peripheral Device Type ID (Should be Peripheral.DEV_TILT_SENSOR )

portId (Number) Port ID this peripheral is connected to

options

(any
            = undefined)

Instance Members

▸ receiveValue(msg)

Receives nd processes message with value from sensor.

receiveValue(msg: PortValueSingleMessage)

Parameters

msg (PortValueSingleMessage)

UnknownPeripheral

This class represents a peripheral we don't know what we can do with it.

UnknownPeripheral

Extends Peripheral

VisionSensor

This handles the communication and the values we receive from the external vision sensor of the Movehub. That one that measures the distance and the color it sees.

new VisionSensor(ioType: Number, portId: Number, options: any)

Extends Peripheral

Parameters

ioType (Number) Peripheral Device Type ID (Should be Peripheral.DEV_VISON_SENSORT )

portId (Number) Port ID this peripheral is connected to

options

(any
            = undefined)

Instance Members

▸ receiveValue(msg)

Receives and processes message with value from sensor.

receiveValue(msg: PortValueSingleMessage)

Parameters

msg (PortValueSingleMessage)

▸ setValue(value)

Sets the value received by the Hub.

setValue(value: number)

Parameters

value (number)

VisionSensor#distance

Fires when a VisionSensor receives a new distance value.

VisionSensor#distance

Parameters

distance (number)

VisionSensor#color

Fires when a VisionSensor receives a new color value.

VisionSensor#color

Parameters

color (number) The index value of the perceived color (One of RgbLed.COLOR_* ).

VisionSensor#color

Fires when a VisionSensor receives a new color value.

VisionSensor#color

Parameters

color (Array<number>) Red, green and blue values of the perceived color.

VoltageSensor

This handles the communication with the internal voltage sensor of Movehub. The values it produces are in volts.

new VoltageSensor(ioType: Number, portId: Number, options: any)

Extends Peripheral

Parameters

ioType (Number) Peripheral Device Type ID (Should be Peripheral.DEV_VOLTAGE )

portId (Number) Port ID this peripheral is connected to

options

(any
            = undefined)

Instance Members

▸ receiveValue(msg)

Receives and processes message with value from sensor.

receiveValue(msg: PortValueSingleMessage)

Parameters

msg (PortValueSingleMessage)