Class: Hub

Extends

• LPF2Hub
• BaseHub

Members

---

<readonly> batteryLevel

Properties:

Name	Type	Description
batteryLevel	number	Battery level of the hub (Percentage between 0-100)

Inherited From:

• BaseHub#batteryLevel

Source:

• hubs/basehub.js, line 125

---

<readonly> firmwareVersion

Properties:

Name	Type	Description
firmwareVersion	string	Firmware version of the hub

Inherited From:

• BaseHub#firmwareVersion

Source:

• hubs/basehub.js, line 97

---

<readonly> hardwareVersion

Properties:

Name	Type	Description
firmwareVersion	string	Hardware version of the hub

Inherited From:

• BaseHub#hardwareVersion

Source:

• hubs/basehub.js, line 104

---

<readonly> name

Properties:

Name	Type	Description
name	string	Name of the hub

Inherited From:

• BaseHub#name

Source:

• hubs/basehub.js, line 76

---

<readonly> ports

Properties:

Name	Type	Description
ports	Array.<string>	Array of port names

Inherited From:

• BaseHub#ports

Source:

• hubs/basehub.js, line 90

---

<readonly> primaryMACAddress

Properties:

Name	Type	Description
primaryMACAddress	string	Primary MAC address of the hub

Inherited From:

• BaseHub#primaryMACAddress

Source:

• hubs/basehub.js, line 111

---

<readonly> rssi

Properties:

Name	Type	Description
rssi	number	Signal strength of the hub

Inherited From:

• BaseHub#rssi

Source:

• hubs/basehub.js, line 132

---

<readonly> type

Properties:

Name	Type	Description
type	string	Hub type

Inherited From:

• BaseHub#type

Source:

• hubs/basehub.js, line 83

---

<readonly> uuid

Properties:

Name	Type	Description
uuid	string	UUID of the hub

Inherited From:

• BaseHub#uuid

Source:

• hubs/basehub.js, line 118

Methods

---

connect()

Connect to the Hub.

Source:

• hubs/basehub.js, line 135

Returns:

Resolved upon successful connect.

Type

Promise

---

disconnect()

Disconnect the Hub.

Source:

• hubs/basehub.js, line 152

Returns:

Resolved upon successful disconnect.

Type

Promise

---

setName(name)

Set the name of the Hub.

Parameters:

Name	Type	Description
name	string	New name of the hub (14 characters or less, ASCII only).

Inherited From:

• LPF2Hub#setName

Source:

• hubs/lpf2hub.js, line 56

Returns:

Resolved upon successful issuance of command.

Type

Promise

---

shutdown()

Shutdown the Hub.

Inherited From:

• LPF2Hub#shutdown

Source:

• hubs/lpf2hub.js, line 44

Returns:

Resolved upon successful disconnect.

Type

Promise

---

sleep(delay)

Sleep a given amount of time.

This is a helper method to make it easier to add delays into a chain of commands.

Parameters:

Name	Type	Description
delay	number	How long to sleep (in milliseconds).

Source:

• hubs/basehub.js, line 220

Returns:

Resolved after the delay is finished.

Type

Promise

---

wait(commands)

Wait until a given list of concurrently running commands are complete.

This is a helper method to make it easier to wait for concurrent commands to complete.

Parameters:

Name	Type	Description
commands	Array.<Promise.<any>>	Array of executing commands.

Source:

• hubs/basehub.js, line 233

Returns:

Resolved after the commands are finished.

Type

Promise

Events

---

accel

Emits when accelerometer detects movement. Measured in mG.

Parameters:

Name	Type	Description
port	string
x	number
y	number
z	number

Inherited From:

• LPF2Hub#event:accel

Source:

• devices/technicmediumhubaccelerometersensor.js, line 20

---

attach

Emits when a device is attached to the Hub.

Parameters:

Name	Type	Description
device	Device

Source:

• hubs/basehub.js, line 257

---

attach

Emits when a device is detached from the Hub.

Parameters:

Name	Type	Description
device	Device

Source:

• hubs/basehub.js, line 274

---

button

Emits when a button is pressed.

Parameters:

Name	Type	Description
button	string
state	ButtonState

Inherited From:

• LPF2Hub#event:button

Source:

• hubs/lpf2hub.js, line 172

---

disconnect

Emits when the hub is disconnected.

Source:

• hubs/basehub.js, line 65

---

tilt

Emits when a tilt sensor is activated.

Parameters:

Name	Type	Description
x	number
y	number

Inherited From:

• LPF2Hub#event:tilt

Source:

• devices/tiltsensor.js, line 22