Extends
Members
-
<readonly> connected
-
- Inherited From:
- Source:
Properties:
Name Type Description connected
boolean Check if the device is still attached.
-
<readonly> hub
-
- Inherited From:
- Source:
Properties:
Name Type Description hub
Hub The Hub the device is attached to.
-
<readonly> isVirtualPort
-
- Inherited From:
- Source:
Properties:
Name Type Description isVirtualPort
boolean Is this device attached to a virtual port (ie. a combined device)
-
<readonly> mode
-
- Inherited From:
- Source:
Properties:
Name Type Description mode
number The mode the device is currently in
-
<readonly> portName
-
- Inherited From:
- Source:
Properties:
Name Type Description portName
string The port the device is attached to.
-
<readonly> type
-
- Inherited From:
- Source:
Properties:
Name Type Description type
number The type of the device
Methods
-
setBrightness(topLeft, bottomLeft, topRight, bottomRight)
-
Set the brightness (or turn on/off) the lights around the eyes.
Parameters:
Name Type Description topLeft
number Top left quadrant (above left eye). 0-100 brightness.
bottomLeft
number Bottom left quadrant (below left eye). 0-100 brightness.
topRight
number Top right quadrant (above right eye). 0-100 brightness.
bottomRight
number Bottom right quadrant (below right eye). 0-100 brightness.
- Source:
Returns:
Resolved upon successful issuance of the command.
- Type
- Promise
Events
-
distance
-
Emits when the detected distance changes (Slow sampling covers 40mm to 2500mm).
Type: object
Parameters:
Name Type Description distance
number Distance, from 40 to 2500mm
- Source:
-
fastDistance
-
Emits when the detected distance changes (Fast sampling covers 50mm to 320mm).
Type: object
Parameters:
Name Type Description fastDistance
number Distance, from 50 to 320mm
- Source: