Classes

Classes

BoostMoveHub

DuploTrainBase

Hub

LPF2Hub

PoweredUP

PUPHub

PUPRemote

SPIKEPrimeHub

WeDo2SmartHub

Events

---

attach

Emits when a motor or sensor is attached to the Hub.

Parameters:

Name	Type	Description
port	string
type	DeviceType

Inherited From:

• Hub#event:attach

Overrides:

• Hub#event:attach

Source:

• hub.js, line 216

---

button

Emits when a button is pressed.

Parameters:

Name	Type	Description
button	string
state	ButtonState

Inherited From:

• LPF2Hub#event:button

Source:

• lpf2hub.js, line 167

---

color

Emits when a color sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color

Inherited From:

• LPF2Hub#event:color

Source:

• lpf2hub.js, line 267

---

colorAndDistance

A combined color and distance event, emits when the sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color
distance	number	Distance, in millimeters.

Inherited From:

• LPF2Hub#event:colorAndDistance

Source:

• lpf2hub.js, line 283

---

detach

Emits when an attached motor or sensor is detached from the Hub.

Parameters:

Name	Type	Description
port	string

Inherited From:

• Hub#event:detach

Overrides:

• Hub#event:detach

Source:

• hub.js, line 228

---

distance

Emits when a distance sensor is activated.

Parameters:

Name	Type	Description
port	string
distance	number	Distance, in millimeters.

Inherited From:

• LPF2Hub#event:distance

Source:

• lpf2hub.js, line 257

---

rotate

Emits when a rotation sensor is activated.

Parameters:

Name	Type	Description
port	string
rotation	number

Inherited From:

• LPF2Hub#event:rotate

Source:

• lpf2hub.js, line 312

---

tilt

Emits when a tilt sensor is activated.

Parameters:

Name	Type	Description
port	string	If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.
x	number
y	number

Inherited From:

• LPF2Hub#event:tilt

Source:

• lpf2hub.js, line 300

---

color

Emits when a color sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color

Inherited From:

• LPF2Hub#event:color

Source:

• lpf2hub.js, line 267

---

speed

Emits on a speed change.

Parameters:

Name	Type	Description
port	string
speed	number

Inherited From:

• LPF2Hub#event:speed

Source:

• lpf2hub.js, line 360

---

attach

Emits when a motor or sensor is attached to the Hub.

Parameters:

Name	Type	Description
port	string
type	DeviceType

Source:

• hub.js, line 216

---

detach

Emits when an attached motor or sensor is detached from the Hub.

Parameters:

Name	Type	Description
port	string

Source:

• hub.js, line 228

---

attach

Emits when a motor or sensor is attached to the Hub.

Parameters:

Name	Type	Description
port	string
type	DeviceType

Inherited From:

• Hub#event:attach

Source:

• hub.js, line 216

---

button

Emits when a button is pressed.

Parameters:

Name	Type	Description
button	string
state	ButtonState

Source:

• lpf2hub.js, line 167

---

color

Emits when a color sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color

Source:

• lpf2hub.js, line 267

---

colorAndDistance

A combined color and distance event, emits when the sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color
distance	number	Distance, in millimeters.

Source:

• lpf2hub.js, line 283

---

detach

Emits when an attached motor or sensor is detached from the Hub.

Parameters:

Name	Type	Description
port	string

Inherited From:

• Hub#event:detach

Source:

• hub.js, line 228

---

distance

Emits when a distance sensor is activated.

Parameters:

Name	Type	Description
port	string
distance	number	Distance, in millimeters.

Source:

• lpf2hub.js, line 257

---

rotate

Emits when a rotation sensor is activated.

Parameters:

Name	Type	Description
port	string
rotation	number

Source:

• lpf2hub.js, line 312

---

speed

Emits on a speed change.

Parameters:

Name	Type	Description
port	string
speed	number

Source:

• lpf2hub.js, line 360

---

tilt

Emits when a tilt sensor is activated.

Parameters:

Name	Type	Description
port	string	If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.
x	number
y	number

Source:

• lpf2hub.js, line 300

---

discover

Emits when a Powered UP Hub device is found.

Parameters:

Name	Type	Description
hub	WeDo2SmartHub | BoostMoveHub | PUPHub | PUPRemote | DuploTrainBase

Source:

• poweredup-node.js, line 131

---

attach

Emits when a motor or sensor is attached to the Hub.

Parameters:

Name	Type	Description
port	string
type	DeviceType

Inherited From:

• Hub#event:attach

Overrides:

• Hub#event:attach

Source:

• hub.js, line 216

---

button

Emits when a button is pressed.

Parameters:

Name	Type	Description
button	string
state	ButtonState

Inherited From:

• LPF2Hub#event:button

Source:

• lpf2hub.js, line 167

---

color

Emits when a color sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color

Inherited From:

• LPF2Hub#event:color

Source:

• lpf2hub.js, line 267

---

colorAndDistance

A combined color and distance event, emits when the sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color
distance	number	Distance, in millimeters.

Inherited From:

• LPF2Hub#event:colorAndDistance

Source:

• lpf2hub.js, line 283

---

detach

Emits when an attached motor or sensor is detached from the Hub.

Parameters:

Name	Type	Description
port	string

Inherited From:

• Hub#event:detach

Overrides:

• Hub#event:detach

Source:

• hub.js, line 228

---

distance

Emits when a distance sensor is activated.

Parameters:

Name	Type	Description
port	string
distance	number	Distance, in millimeters.

Inherited From:

• LPF2Hub#event:distance

Source:

• lpf2hub.js, line 257

---

tilt

Emits when a tilt sensor is activated.

Parameters:

Name	Type	Description
port	string	If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.
x	number
y	number

Inherited From:

• LPF2Hub#event:tilt

Source:

• lpf2hub.js, line 300

---

button

Emits when a button is pressed.

Parameters:

Name	Type	Description
button	string
state	ButtonState

Inherited From:

• LPF2Hub#event:button

Source:

• lpf2hub.js, line 167

---

colorAndDistance

A combined color and distance event, emits when the sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color
distance	number	Distance, in millimeters.

Inherited From:

• LPF2Hub#event:colorAndDistance

Source:

• lpf2hub.js, line 283

---

attach

Emits when a motor or sensor is attached to the Hub.

Parameters:

Name	Type	Description
port	string
type	DeviceType

Inherited From:

• Hub#event:attach

Overrides:

• Hub#event:attach

Source:

• hub.js, line 216

---

button

Emits when a button is pressed.

Parameters:

Name	Type	Description
button	string
state	ButtonState

Inherited From:

• LPF2Hub#event:button

Source:

• lpf2hub.js, line 167

---

color

Emits when a color sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color

Inherited From:

• LPF2Hub#event:color

Source:

• lpf2hub.js, line 267

---

colorAndDistance

A combined color and distance event, emits when the sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color
distance	number	Distance, in millimeters.

Inherited From:

• LPF2Hub#event:colorAndDistance

Source:

• lpf2hub.js, line 283

---

detach

Emits when an attached motor or sensor is detached from the Hub.

Parameters:

Name	Type	Description
port	string

Inherited From:

• Hub#event:detach

Overrides:

• Hub#event:detach

Source:

• hub.js, line 228

---

distance

Emits when a distance sensor is activated.

Parameters:

Name	Type	Description
port	string
distance	number	Distance, in millimeters.

Inherited From:

• LPF2Hub#event:distance

Source:

• lpf2hub.js, line 257

---

rotate

Emits when a rotation sensor is activated.

Parameters:

Name	Type	Description
port	string
rotation	number

Inherited From:

• LPF2Hub#event:rotate

Source:

• lpf2hub.js, line 312

---

tilt

Emits when a tilt sensor is activated.

Parameters:

Name	Type	Description
port	string	If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.
x	number
y	number

Inherited From:

• LPF2Hub#event:tilt

Source:

• lpf2hub.js, line 300

---

attach

Emits when a motor or sensor is attached to the Hub.

Parameters:

Name	Type	Description
port	string
type	DeviceType

Inherited From:

• Hub#event:attach

Source:

• hub.js, line 216

---

button

Emits when a button is pressed.

Parameters:

Name	Type	Description
button	string
state	ButtonState

Source:

• wedo2smarthub.js, line 324

---

color

Emits when a color sensor is activated.

Parameters:

Name	Type	Description
port	string
color	Color

Source:

• wedo2smarthub.js, line 369

---

detach

Emits when an attached motor or sensor is detached from the Hub.

Parameters:

Name	Type	Description
port	string

Inherited From:

• Hub#event:detach

Source:

• hub.js, line 228

---

distance

Emits when a distance sensor is activated.

Parameters:

Name	Type	Description
port	string
distance	number	Distance, in millimeters.

Source:

• wedo2smarthub.js, line 358

---

rotate

Emits when a rotation sensor is activated.

Parameters:

Name	Type	Description
port	string
rotation	number

Source:

• wedo2smarthub.js, line 399

---

tilt

Emits when a tilt sensor is activated.

Parameters:

Name	Type	Description
port	string
x	number
y	number

Source:

• wedo2smarthub.js, line 387