Skip to main content

CubeIDChar

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

+ new CubeIDChar(service: BluetoothRemoteGATTService): CubeIDChar

Inherited from CubeChar.constructor

Defined in cube/char/char.ts:19

Parameters:

NameType
serviceBluetoothRemoteGATTService

Returns: CubeIDChar

Properties

Protected characteristic

characteristic: BluetoothRemoteGATTCharacteristic

Inherited from CubeChar.characteristic

Defined in cube/char/char.ts:10


Protected errStrInProgress

errStrInProgress: string = "GATT operation already in progress."

Inherited from CubeChar.errStrInProgress

Defined in cube/char/char.ts:12


Readonly uuid

uuid: string = "10b20101-5b3b-4571-9508-cf3efcd7bbae"

Overrides CubeChar.uuid

Defined in cube/char/idChar.ts:31

Methods

addEventListener

addEventListener(type: string, listener: CubeIdCharListner): void

Defined in cube/char/idChar.ts:249

Register callback.

Parameters:

NameTypeDescription
typestringSpecify the type from 'positionid' or 'standardid'.
listenerCubeIdCharListner-

Returns: void


getPositionId

getPositionId(): positionIdInfo

Defined in cube/char/idChar.ts:85

Get current Position Id.

Returns: positionIdInfo

Position Id info.


getStandardId

getStandardId(): standardIdInfo

Defined in cube/char/idChar.ts:94

Get current Standard Id.

Returns: standardIdInfo

Standard Id info.


prepare

prepare(): Promise‹string | Error›

Implementation of CubeCharIF

Overrides CubeChar.prepare

Defined in cube/char/idChar.ts:46

Prepare for using id characteristic function.

Returns: Promise‹string | Error›

Promise. resolve handler says that methods are available in this class.


readValue

readValue(): Promise‹DataView›

Implementation of CubeCharIF

Inherited from CubeChar.readValue

Defined in cube/char/char.ts:110

Read value from remote GATT Characteristics.

Returns: Promise‹DataView›

Promise. resolve handler include data.


setFrameRate

setFrameRate(fps: number): void

Implementation of CubeCharIF

Inherited from CubeChar.setFrameRate

Defined in cube/char/char.ts:134

Set framerate.

Parameters:

NameType
fpsnumber

Returns: void


writeValue

writeValue(buf: ArrayBuffer): Promise‹string | Error›

Implementation of CubeCharIF

Inherited from CubeChar.writeValue

Defined in cube/char/char.ts:55

Write value to remote GATT Characteristics.

Parameters:

NameTypeDescription
bufArrayBufferdata buffer including command for Cube.

Returns: Promise‹string | Error›

Promise. resolve handler says that write command executed correctly.


writeValueCore

writeValueCore(buf: ArrayBuffer, countRetry: number): Promise‹string | Error›

Inherited from CubeChar.writeValueCore

Defined in cube/char/char.ts:78

Write value to remote GATT Characteristics. Core function.

Parameters:

NameTypeDescription
bufArrayBufferdata buffer including command for Cube.
countRetrynumberCounter for retry.

Returns: Promise‹string | Error›

Promise. resolve handler says that write command executed correctly.