Class: LPF2Hub

LPF2Hub


new LPF2Hub()

Source:

Extends

Members


<readonly> batteryLevel

Properties:
Name Type Description
batteryLevel number

Battery level of the hub (Percentage between 0-100)

Inherited From:
Source:

<readonly> firmwareVersion

Properties:
Name Type Description
firmwareVersion string

Firmware version of the hub

Inherited From:
Source:

<readonly> hardwareVersion

Properties:
Name Type Description
hardwareVersion string

Hardware version of the hub

Inherited From:
Source:

<readonly> name

Properties:
Name Type Description
name string

Name of the hub

Inherited From:
Source:

<readonly> ports

Properties:
Name Type Description
ports Array.<string>

Array of port names

Inherited From:
Source:

<readonly> primaryMACAddress

Properties:
Name Type Description
primaryMACAddress string

Primary MAC address of the hub

Inherited From:
Source:

<readonly> rssi

Properties:
Name Type Description
rssi number

Signal strength of the hub

Inherited From:
Source:

<readonly> type

Properties:
Name Type Description
type string

Hub type

Inherited From:
Source:

<readonly> uuid

Properties:
Name Type Description
uuid string

UUID of the hub

Inherited From:
Source:

Methods


createVirtualPort(firstPortName, secondPortName)

Combines two ports with into a single virtual port.

Note: The devices attached to the ports must be of the same device type.

Parameters:
Name Type Description
firstPortName string

First port name

secondPortName string

Second port name

Source:
Returns:

Resolved upon successful issuance of command.

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).

Source:
Returns:

Resolved upon successful issuance of command.

Type
Promise

shutdown()

Shutdown the Hub.

Source:
Returns:

Resolved upon successful disconnect.

Type
Promise

Events


button

Emits when a button is pressed.

Parameters:
Name Type Description
button string
state ButtonState
Source: