Extends
Members
(readonly) batteryLevel
Properties:
| Name | Type | Description |
|---|---|---|
batteryLevel |
number | Battery level of the hub (Percentage between 0-100) |
- Overrides:
- Source:
(readonly) connected
Properties:
| Name | Type | Description |
|---|---|---|
connected |
string | Connected status |
- Overrides:
- Source:
(readonly) connecting
Properties:
| Name | Type | Description |
|---|---|---|
connecting |
string | Connecting status |
- Overrides:
- Source:
(readonly) firmwareVersion
Properties:
| Name | Type | Description |
|---|---|---|
firmwareVersion |
string | Firmware version of the hub |
- Overrides:
- Source:
(readonly) hardwareVersion
Properties:
| Name | Type | Description |
|---|---|---|
hardwareVersion |
string | Hardware version of the hub |
- Overrides:
- Source:
(readonly) name
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the hub |
- Overrides:
- Source:
(readonly) ports
Properties:
| Name | Type | Description |
|---|---|---|
ports |
Array.<string> | Array of port names |
- Overrides:
- Source:
(readonly) primaryMACAddress
Properties:
| Name | Type | Description |
|---|---|---|
primaryMACAddress |
string | Primary MAC address of the hub |
- Overrides:
- Source:
(readonly) rssi
Properties:
| Name | Type | Description |
|---|---|---|
rssi |
number | Signal strength of the hub |
- Overrides:
- Source:
(readonly) type
Properties:
| Name | Type | Description |
|---|---|---|
type |
string | Hub type |
- Overrides:
- Source:
(readonly) uuid
Properties:
| Name | Type | Description |
|---|---|---|
uuid |
string | UUID of the hub |
- Overrides:
- Source:
Methods
connect() → {Promise}
Connect to the Hub.
- Source:
Returns:
Resolved upon successful connect.
- Type
- Promise
createVirtualPort(firstPortName, secondPortName) → {Promise}
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 |
- Overrides:
- Source:
Returns:
Resolved upon successful issuance of command.
- Type
- Promise
disconnect() → {Promise}
Disconnect the Hub.
- Source:
Returns:
Resolved upon successful disconnect.
- Type
- Promise
getDeviceAtPort(portName) → {Device|undefined}
Retrieves the device attached to a given port.
Parameters:
| Name | Type | Description |
|---|---|---|
portName |
string | The name of the port to retrieve the device from. |
- Source:
Returns:
The device attached to the port.
- Type
- Device | undefined
getDevices() → {Array.<Device>}
Retrieves all attached devices.
- Source:
Returns:
Array of all attached devices.
- Type
- Array.<Device>
getDevicesByType(deviceType) → {Array.<Device>}
Retrieves an array of devices of the specified type.
Parameters:
| Name | Type | Description |
|---|---|---|
deviceType |
number | The device type to lookup. |
- Source:
Returns:
Array of all devices of the specified type.
- Type
- Array.<Device>
setName(name) → {Promise}
Set the name of the Hub.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | New name of the hub (14 characters or less, ASCII only). |
- Overrides:
- Source:
Returns:
Resolved upon successful issuance of command.
- Type
- Promise
shutdown() → {Promise}
Shutdown the Hub.
- Overrides:
- Source:
Returns:
Resolved upon successful disconnect.
- Type
- Promise
sleep(delay) → {Promise}
Sleep a given amount of time.
Note: 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:
Returns:
Resolved after the delay is finished.
- Type
- Promise
wait(commands) → {Promise}
Wait until a given list of concurrently running commands are complete.
Note: 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:
Returns:
Resolved after the commands are finished.
- Type
- Promise
waitForDeviceAtPort(portName) → {Promise}
Retrieves the device attached to a given port, waiting until one is attached if there isn't one.
Note: If a device is never attached, the returned promise may never resolve.
Parameters:
| Name | Type | Description |
|---|---|---|
portName |
string | The name of the port to retrieve the device from. |
- Source:
Returns:
Resolved once a device is attached, or resolved immediately if a device is already attached.
- Type
- Promise
waitForDeviceByType(deviceType) → {Promise}
Retrieves the first device attached of the specified type, waiting until one is attached if there isn't one.
Note: If a device is never attached, the returned promise may never resolve.
Parameters:
| Name | Type | Description |
|---|---|---|
deviceType |
number | The device type to lookup. |
- Source:
Returns:
Resolved once a device is attached, or resolved immediately if a device is already attached.
- Type
- Promise
Events
attach
Emits when a device is attached to the Hub.
Parameters:
| Name | Type | Description |
|---|---|---|
device |
Device |
- Source:
button
Emits when a button is pressed.
Parameters:
| Name | Type | Description |
|---|---|---|
button |
string | |
state |
ButtonState |
- Overrides:
- Source:
detach
Emits when a device is detached from the Hub.
Parameters:
| Name | Type | Description |
|---|---|---|
device |
Device |
- Source:
disconnect
Emits when the hub is disconnected.
- Source: