@ovok/native/bt-management

isHistoryTransfer()

isHistoryTransfer(): boolean;

True when accepted results are records downloaded from device history.

Returns

boolean

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Returning undefined sends nothing, which is how a sequencer waits: an unidentified device is left alone rather than addressed with an opcode that may mean something else on the hardware actually present.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

A606Device

Viatom/Lepu ZH-SG-A606 meter, which uploads stored records after connection.

Extends

BTManagedDevice<ZH_SG_A606>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new A606Device(device, params): A606Device;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`ZH_SG_A606`>

Returns

A606Device

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

A606FrameReader

Reads the & C/D ... checksum frames used by Viatom's ZH-SG glucose protocol.

Implements

FrameReader

Constructors

Constructor

new A606FrameReader(): A606FrameReader;

Returns

A606FrameReader

Methods

readFrame()

readFrame(buffer): FrameReadResult;

Extracts the next complete frame from the notification buffer.

Parameters

Parameter	Type
`buffer`	readonly `string`[]

Returns

FrameReadResult

Implementation of

FrameReader.readFrame

Aoj20aDevice

AOJ-20A driver with clock sync, offline history and named device errors.

Extends

BTManagedDevice<AOJ20A>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new Aoj20aDevice(device, params): Aoj20aDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`AOJ20A`>

Returns

Aoj20aDevice

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

CommandSequencer.commandProgress

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

AojCommandSequencer

Walks AOJ's clock, metadata, history and optional clear exchange.

Implements

CommandSequencer

Constructors

Constructor

new AojCommandSequencer(params): AojCommandSequencer;

Parameters

Parameter	Type
`params`	`AojCommandSequencerParams`

Returns

AojCommandSequencer

Methods

commandProgress()

commandProgress(frame): "ignored" | "partial" | "complete";

Describes whether a frame is ignored, partial, or completes the outstanding command.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

"ignored" | "partial" | "complete"

Implementation of

initialCommands()

initialCommands(): readonly DeviceCommand[];

Sent once every characteristic is subscribed. Empty starts a device that only listens.

May resolve later, for a first command that depends on state read from storage.

Returns

readonly DeviceCommand[]

Implementation of

isHistoryTransfer()

isHistoryTransfer(): boolean;

True when accepted results are records downloaded from device history.

Returns

boolean

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

AojFrameReader

Reads AOJ's aa 01 command length payload xor notifications.

Implements

FrameReader

Constructors

Constructor

new AojFrameReader(): AojFrameReader;

Returns

AojFrameReader

Methods

readFrame()

readFrame(buffer): FrameReadResult;

Extracts the next complete frame from the notification buffer.

Parameters

Parameter	Type
`buffer`	readonly `string`[]

Returns

FrameReadResult

Implementation of

FrameReader.readFrame

BackgroundSyncCoordinator

Queues results for the signed-in account and delivers them, retrying failed deliveries.

Type Parameters

Type Parameter
`T` extends `DeviceKey`

Constructors

Constructor

new BackgroundSyncCoordinator<T>(options): BackgroundSyncCoordinator<T>;

Parameters

Parameter	Type
`options`	`CoordinatorOptions`<`T`>

Returns

BackgroundSyncCoordinator<T>

Methods

enqueue()

enqueue(result): Promise<void>;

Queues a result for the current account and tries to deliver the queue.

Parameters

Parameter	Type
`result`	`ResultCallback`<`T`>

Returns

Promise<void>

flush()

flush(options?): Promise<void>;

Tries to deliver the queued results; resolves once the attempt is done.

Parameters

Parameter	Type
`options?`	`BackgroundSyncFlushOptions`

Returns

Promise<void>

getQueued()

getQueued(): readonly BackgroundSyncResult<T>[];

The current account's results still waiting to be accepted, oldest first: readings to show as not saved yet. Kept up to date by every enqueue and flush; subscribe reads the stored queue in first.

Returns

readonly BackgroundSyncResult<T>[]

subscribe(listener): () => void;

Calls listener whenever the waiting results change; the first subscriber reads the stored queue in.

Parameters

Parameter	Type
`listener`	() => `void`

Returns

() => void

updateOptions()

updateOptions(options): void;

Replaces the coordinator options.

Parameters

Parameter	Type
`options`	`CoordinatorOptions`<`T`>

Returns

void

BloodGlucoseDevice

Decodes the legacy TaiDoc, GlucoCheck Gold and TeleBGM glucose protocols.

Extends

BTManagedDevice<GlucoseDevice>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new BloodGlucoseDevice(device, params): BloodGlucoseDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`GlucoseDevice`>

Returns

BloodGlucoseDevice

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

IBTManagedDevice.connect

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

BluetoothError

Error carrying a stable code and an optional translation key.

Extends

Error

Constructors

Constructor

new BluetoothError(
   code,
   message,
   translationKey?,
   originalError?
): BluetoothError;

Parameters

Parameter	Type	Description
`code`	`BluetoothErrorCode`	Stable machine-readable failure code.
`message`	`string`	-
`translationKey?`	`string`	Translation key, when the message is one.
`originalError?`	`unknown`	Underlying error this one was created from.

Returns

BluetoothError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides
`code`	`public readonly`	`BluetoothErrorCode`	`undefined`	Stable machine-readable failure code.	-
`name`	`public readonly`	`"BluetoothError"`	`"BluetoothError"`	Always `"BluetoothError"`.	`Error.name`
`originalError?`	`public readonly`	`unknown`	`undefined`	Underlying error this one was created from.	-
`translationKey?`	`public readonly`	`string`	`undefined`	Translation key, when the message is one.	-

`abstract` BTManagedDevice

Base class for a Bluetooth device managed by the SDK: connects, subscribes, parses frames and reports results, status changes and connection events through its callbacks.

Type Parameters

Type Parameter	Default type
`T` extends `DeviceKey`	`BP2`

Implements

IBTManagedDevice

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Constructors

Constructor

new BTManagedDevice<T>(device, __namedParameters): BTManagedDevice<T>;

Parameters

Parameter	Type	Description
`device`	`Device`	The underlying BLE device.
`__namedParameters`	`CreateDeviceParams`<`T`>	-

Returns

BTManagedDevice<T>

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Implementation of

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Implementation of

IBTManagedDevice.disconnect

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Properties

Property	Modifier	Type	Description
`device`	`public readonly`	`Device`	The underlying BLE device.
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.
`id`	`public`	`string`	Platform identifier of the underlying BLE device.
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.

BTManager

Scans for, connects to and reports readings from the accepted Bluetooth devices.

Type Parameters

Type Parameter
`T` extends readonly `AcceptedDevice`[]

Constructors

Constructor

new BTManager<T>(
   bleManager,
   acceptedDevices,
   options?
): BTManager<T>;

Parameters

Parameter	Type
`bleManager`	`BleManager`
`acceptedDevices`	`T`
`options?`	`BTManagerOptions`

Returns

BTManager<T>

Methods

destroy()

destroy(): void;

Stops scanning, disconnects devices and releases the manager.

Returns

void

disconnectDevice()

disconnectDevice(deviceId): Promise<void>;

Disconnects one device so it can be rediscovered by a later advertisement.

Parameters

Parameter	Type
`deviceId`	`string`

Returns

Promise<void>

forget()

forget(deviceId): Promise<void>;

Disconnects one device and ignores later advertisements for this manager's lifetime.

Parameters

Parameter	Type
`deviceId`	`string`

Returns

Promise<void>

getOpenSeries()

getOpenSeries(): readonly OpenSeries[];

The series being recorded, each with its latest values: what to show while a device streams.

Returns

readonly OpenSeries[]

keepConnecting()

keepConnecting(deviceIds): void;

On iOS, keeps a connection request pending for each device, so the system reconnects it when it advertises and the app can read it in the background without the advertisement carrying a service UUID. Use it for the devices the user has paired. Does nothing on other platforms.

A device that connects is handled like one the scan found, and its request is made again if it drops the link. Explicitly disconnecting, forgetting or stopping the scan ends the request.

Parameters

Parameter	Type
`deviceIds`	readonly `string`[]

Returns

void

onConnectionEvent()

onConnectionEvent(callback?): void;

Sets the callback called for device connection events.

Parameters

Parameter	Type
`callback?`	(`data`) => `void`

Returns

void

onDeviceFound()

onDeviceFound(callback?): void;

Sets the callback called with each newly discovered device.

Parameters

Parameter	Type
`callback?`	(`device`, `manager`) => `Promise`<`void`>

Returns

void

onDeviceStatusChanged()

onDeviceStatusChanged(callback?): void;

Sets the callback called when a device's connection status changes.

Parameters

Parameter	Type
`callback?`	(`data`) => `void`

Returns

void

onError()

onError(callback?): void;

Sets the callback called with Bluetooth errors.

Parameters

Parameter	Type
`callback?`	(`data`) => `void`

Returns

void

onResult()

onResult(callback?): void;

Sets the callback called with each result; series that closed while nobody listened are delivered first. It may return a promise that resolves once the result is queued or saved: with recordCursorStorage set, the stored file the result came from (a Viatom ER1's or BP2's) is then not read again. A file whose promise rejects, or whose callback returns nothing, is read again on the next history sync.

Parameters

Parameter	Type
`callback?`	(`data`) => `void` \| `Promise`<`unknown`>

Returns

void

onWaveform()

onWaveform(callback?): void;

Sets the callback called with the live ECG samples of recording devices; for display, never saved.

Parameters

Parameter	Type
`callback?`	(`waveform`) => `void`

Returns

void

pauseScan()

pauseScan(): void;

Pauses discovery without tearing down devices or their callbacks.

Use this when an app temporarily stops scanning, for example while it is in the background but an already-connected device may still deliver a measurement.

Returns

void

restoreDevices()

restoreDevices(devices): void;

Treats already-known BLE devices as freshly discovered and clears their forgotten state.

Parameters

Parameter	Type
`devices`	readonly `Device`[]

Returns

void

resumeScan()

resumeScan(): void;

Resumes discovery without clearing devices or callbacks.

Restarting unconditionally also recovers when an app stopped the underlying BLE scan directly while BTManager still believed it was active.

Returns

void

setAutoConnect()

setAutoConnect(
   enabledOrOptions,
   delayMs?,
   onDeviceSelectionRequired?
): void;

Enables or disables automatic connection, either with positional arguments or an options object.

Parameters

Parameter	Type
`enabledOrOptions`	\| `boolean` \| { `delayMs?`: `number`; `enabled`: `boolean`; `onDeviceSelectionRequired?`: (`selection`) => `void`; }
`delayMs?`	`number`
`onDeviceSelectionRequired?`	(`selection`) => `void`

Returns

void

setBackgroundScanEnabled()

setBackgroundScanEnabled(enabled): void;

Switches only the scan policy; the app can keep a foreground scan broad.

Parameters

Parameter	Type
`enabled`	`boolean`

Returns

void

startScan()

startScan(): void;

Starts scanning once the Bluetooth adapter is powered on; does nothing while a scan is running.

Returns

void

stopRecording()

stopRecording(deviceId): Promise<void>;

Stops the recording a connected recorder holds open, for instance once the user confirms it after a recording event with leadOff. Rejects when the device is not connected or holds no recording.

Parameters

Parameter	Type
`deviceId`	`string`

Returns

Promise<void>

stopScan()

stopScan(): void;

Stops scanning, disconnects the devices and clears the callbacks.

Returns

void

subscribeOpenSeries()

subscribeOpenSeries(listener): () => void;

Calls listener whenever a series gets a value or closes; returns the unsubscribe.

Parameters

Parameter	Type
`listener`	() => `void`

Returns

() => void

CheckmeFrameReader

Handles split notifications, concatenated notifications, and both vendor envelopes.

Implements

FrameReader

Constructors

Constructor

new CheckmeFrameReader(): CheckmeFrameReader;

Returns

CheckmeFrameReader

Methods

readFrame()

readFrame(buffer): FrameReadResult;

Extracts the next complete frame from the notification buffer.

Parameters

Parameter	Type
`buffer`	readonly `string`[]

Returns

FrameReadResult

Implementation of

FrameReader.readFrame

CheckmePodDevice

Checkme Pod and Checkme Pod-WPS's realtime protocol from ViHealth.

Extends

BTManagedDevice<CHECKME_POD>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new CheckmePodDevice(device, params): CheckmePodDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`CHECKME_POD`>

Returns

CheckmePodDevice

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

CheckmePodFrameReader

Reads split and concatenated Checkme Pod notifications with CRC validation.

Implements

FrameReader

Constructors

Constructor

new CheckmePodFrameReader(): CheckmePodFrameReader;

Returns

CheckmePodFrameReader

Methods

readFrame()

readFrame(buffer): FrameReadResult;

Extracts the next CRC-valid frame from the notification buffer.

Parameters

Parameter	Type
`buffer`	readonly `string`[]

Returns

FrameReadResult

Implementation of

FrameReader.readFrame

CheckmePodSequencer

Drives the info -> clock sync -> realtime exchange used by Checkme Pod.

Implements

CommandSequencer

Constructors

Constructor

new CheckmePodSequencer(params): CheckmePodSequencer;

Parameters

Parameter	Type
`params`	`CheckmePodSequencerParams`

Returns

CheckmePodSequencer

Methods

initialCommands()

initialCommands(): readonly DeviceCommand[];

Sent once every characteristic is subscribed. Empty starts a device that only listens.

May resolve later, for a first command that depends on state read from storage.

Returns

readonly DeviceCommand[]

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

CheckmeProDevice

Viatom Checkme Pro history transfer, matching the CheckmeBleInterface in ViHealth.

Extends

BTManagedDevice<CHECKME>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new CheckmeProDevice(device, params): CheckmeProDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`CHECKME`>

Returns

CheckmeProDevice

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

CommandSequencer.commandTimeoutMs

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

CheckmeProSequencer

Downloads Checkme Pro history using the command exchange in ViHealth's CheckmeBleInterface. The device returns list records first; the daily list and ECG list then point to waveform files, which are read with the same offset-based transfer.

Implements

CommandSequencer

Constructors

Constructor

new CheckmeProSequencer(params): CheckmeProSequencer;

Parameters

Parameter	Type
`params`	`CheckmeTransferParams`

Returns

CheckmeProSequencer

Methods

commandTimeoutMs()

commandTimeoutMs(): number | undefined;

The response timeout for the currently outstanding command, when a protocol needs one.

Returns

number | undefined

Implementation of

initialCommands()

initialCommands(): readonly DeviceCommand[];

Sent once every characteristic is subscribed. Empty starts a device that only listens.

May resolve later, for a first command that depends on state read from storage.

Returns

readonly DeviceCommand[]

Implementation of

isHistoryTransfer()

isHistoryTransfer(): boolean;

True when accepted results are records downloaded from device history.

Returns

boolean

Implementation of

CommandSequencer.isNormalDisconnect

isNormalDisconnect()

isNormalDisconnect(): boolean;

True when a timeout-style disconnect is the device's normal completion signal.

Returns

boolean

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

CommandSequencer.onCommandTimeout

onCommandTimeout()

onCommandTimeout(): CommandTimeoutResult;

Re-sends the current command or ends the exchange after a response timeout.

Returns

CommandTimeoutResult

Implementation of

CustomDevice

Runs a device registered with defineCustomDevice.

Everything specific to the device is data: the services and characteristics it exposes, how a complete frame is recognised, which frame carries which reading, and how each byte range becomes a number. What is left here is the safety net - a reading is reported only when every property the declaration named decoded to a finite number inside the range the catalog accepts. Anything else is reported through onError and no measurement is emitted.

Extends

BTManagedDevice<CustomDeviceId>

Extended by

VerovalDuoControlDevice

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

A Lepu device that polls live keeps its stored files until asked; without polling it reads them on connect.

Returns

boolean

Overrides

Constructors

Constructor

new CustomDevice(
   device,
   params,
   definition
): CustomDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`CustomDeviceId`>
`definition`	`CustomDeviceDefinition`

Returns

CustomDevice

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops the open recording; the device stores it when it is long enough, and the files are then read.

Returns

Promise<void>

Overrides

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

DeviceSelectionRequiredError

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

DeviceSelectionRequiredError

Thrown when several devices match and none was selected.

Extends

Error

Constructors

Constructor

new DeviceSelectionRequiredError(model, ids): DeviceSelectionRequiredError;

Parameters

Parameter	Type
`model`	`string`
`ids`	readonly `string`[]

Returns

Overrides

Error.constructor

GenialT31CommandSequencer

Answers Genial's handshake, clock request, temperature and error frames.

Implements

CommandSequencer

Constructors

Constructor

new GenialT31CommandSequencer(now?): GenialT31CommandSequencer;

Parameters

Parameter	Type
`now?`	() => `Date`

Returns

GenialT31CommandSequencer

Methods

initialCommands()

initialCommands(): readonly DeviceCommand[];

Sent once every characteristic is subscribed. Empty starts a device that only listens.

May resolve later, for a first command that depends on state read from storage.

Returns

readonly DeviceCommand[]

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

GenialT31Device

Genial T31 Bluetooth thermometer, as used by the ViHealth app.

Extends

BTManagedDevice<GENIAL_T31>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new GenialT31Device(device, params): GenialT31Device;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`GENIAL_T31`>

Returns

GenialT31Device

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

GenialT31FrameReader

Reads the A6 ... checksum 6A frames used by Genial T31 thermometers.

Implements

FrameReader

Constructors

Constructor

new GenialT31FrameReader(): GenialT31FrameReader;

Returns

GenialT31FrameReader

Methods

readFrame()

readFrame(buffer): FrameReadResult;

Extracts the next complete frame from the notification buffer.

Parameters

Parameter	Type
`buffer`	readonly `string`[]

Returns

FrameReadResult

Implementation of

FrameReader.readFrame

LepuFileTransfer

Downloads the records a Lepu device has stored.

Every opcode this uses is generic and inert - list, open, read, close - so unlike a realtime poll it is safe on hardware whose model is not known. That is what makes it the one thing the whole family can be asked for without identifying it first.

The exchange is self-clocking and has no windowing: each reply decides the next request, and the device chooses how much to send, so the offset advances by what actually arrived rather than by an assumed chunk size. There is no retry in the protocol either - a single dropped reply stalls the transfer with nothing to resume it - which is what the data processor's stuck-data timeout is the watchdog for.

A short read is an error, not a truncated success: the device is asked to close the file and the reading is discarded, because half an ECG that looks like a whole one is worse than none.

Implements

CommandSequencer

Constructors

Constructor

new LepuFileTransfer(params): LepuFileTransfer;

Parameters

Parameter	Type
`params`	`LepuFileTransferParams`

Returns

LepuFileTransfer

Methods

initialCommands()

initialCommands(delayBeforeWriteMs?): readonly DeviceCommand[];

Sent once every characteristic is subscribed. Empty starts a device that only listens.

May resolve later, for a first command that depends on state read from storage.

Parameters

Parameter	Type
`delayBeforeWriteMs?`	`number`

Returns

readonly DeviceCommand[]

Implementation of

isHistoryTransfer()

isHistoryTransfer(): boolean;

True when accepted results are records downloaded from device history.

Returns

boolean

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

CommandSequencer.commandProgress

S9CommandSequencer

Runs only the SH09 commands verified on firmware image 1.

Implements

CommandSequencer

Constructors

Constructor

new S9CommandSequencer(params): S9CommandSequencer;

Parameters

Parameter	Type
`params`	`S9CommandSequencerParams`

Returns

S9CommandSequencer

Methods

commandProgress()

commandProgress(frame): "ignored" | "partial" | "complete";

Describes whether a frame is ignored, partial, or completes the outstanding command.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

"ignored" | "partial" | "complete"

Implementation of

commandTimeoutMs()

commandTimeoutMs(): number;

The response timeout for the currently outstanding command, when a protocol needs one.

Returns

number

Implementation of

CommandSequencer.commandTimeoutMs

initialCommands()

initialCommands(): readonly DeviceCommand[];

Sent once every characteristic is subscribed. Empty starts a device that only listens.

May resolve later, for a first command that depends on state read from storage.

Returns

readonly DeviceCommand[]

Implementation of

isHistoryTransfer()

isHistoryTransfer(): boolean;

True when accepted results are records downloaded from device history.

Returns

boolean

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

CommandSequencer.onCommandTimeout

onCommandTimeout()

onCommandTimeout(): CommandTimeoutResult;

Re-sends the current command or ends the exchange after a response timeout.

Returns

CommandTimeoutResult

Implementation of

S9FrameReader

SH09 notifications are fixed-width, zero-padded 20-byte replies.

Implements

FrameReader

Constructors

Constructor

new S9FrameReader(): S9FrameReader;

Returns

S9FrameReader

Methods

readFrame()

readFrame(buffer): FrameReadResult;

Returns the next fixed-width frame in the buffer.

Parameters

Parameter	Type
`buffer`	readonly `string`[]

Returns

FrameReadResult

Implementation of

FrameReader.readFrame

TrasenseS9Device

Trasense SH09. Its address and advertisement data are sensitive and never logged.

Extends

BTManagedDevice<TRASENSE_S9>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new TrasenseS9Device(device, params): TrasenseS9Device;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`TRASENSE_S9`>

Returns

TrasenseS9Device

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

VerovalActivityDevice

HARTMANN's Veroval Activity wristband, including stored step and heart-rate history.

Extends

BTManagedDevice<VEROVAL_ACTIVITY>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new VerovalActivityDevice(device, params): VerovalActivityDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`VEROVAL_ACTIVITY`>

Returns

VerovalActivityDevice

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

VerovalActivitySequencer

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

VerovalActivitySequencer

Drives the private history protocol used by the Veroval Activity wristband.

Implements

CommandSequencer

Constructors

Constructor

new VerovalActivitySequencer(params): VerovalActivitySequencer;

Parameters

Parameter	Type
`params`	`VerovalActivitySequencerParams`

Returns

Methods

initialCommands()

initialCommands(): readonly DeviceCommand[];

Sent once every characteristic is subscribed. Empty starts a device that only listens.

May resolve later, for a first command that depends on state read from storage.

Returns

readonly DeviceCommand[]

Implementation of

nextCommand()

nextCommand(frame): readonly DeviceCommand[] | undefined;

Answers one complete frame, with the characteristic it arrived on.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

readonly DeviceCommand[] | undefined

Implementation of

CustomDevice.readsHistoryOnRequest

VerovalDuoControlDevice

The Veroval duo control.

A device class rather than a declaration, because reading it is a conversation: the two user memories are asked in turn, and the device answers with bare control bytes as often as with payload. The decoding is still declared - the class supplies the framing and the walk, and nothing else.

Readings are stored measurements, not live ones. The device hands over its history when asked, so what arrives was taken before the connection and may be days old.

Extends

CustomDevice

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

A Lepu device that polls live keeps its stored files until asked; without polling it reads them on connect.

Returns

boolean

Inherited from

Constructors

Constructor

new VerovalDuoControlDevice(device, params): VerovalDuoControlDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`CustomDeviceId`>

Returns

VerovalDuoControlDevice

Overrides

CustomDevice.constructor

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

CustomDevice.connect

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

CustomDevice.destroy

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

CustomDevice.disconnect

stopRecording()

stopRecording(): Promise<void>;

Stops the open recording; the device stores it when it is long enough, and the files are then read.

Returns

Promise<void>

Inherited from

CustomDevice.stopRecording

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

CustomDevice.syncHistory

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`CustomDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`CustomDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`CustomDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`CustomDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`CustomDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`CustomDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`CustomDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`CustomDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`CustomDevice`.`onWaveform`

VerovalEcgDevice

The Veroval ECG.

Reading it is a download rather than a decode, so the whole recording is assembled before anything is reported: thirty-four seconds of samples at 128 Hz, two bytes each, converted to millivolts with the device's own calibration.

The vendor's app plots a thirty-second window of this with a baseline-wander filter applied. That is a display transform, not calibration, so it is deliberately not reproduced here - what is reported is what the device recorded.

Extends

BTManagedDevice<VEROVAL_ECG>

Accessors

readsHistoryOnRequest

Get Signature

get readsHistoryOnRequest(): boolean;

Whether the records the device stored are read only on syncHistory. Such a device goes live as soon as it connects; any other reads its stored records each time it connects.

Returns

boolean

Inherited from

Constructors

Constructor

new VerovalEcgDevice(device, params): VerovalEcgDevice;

Parameters

Parameter	Type
`device`	`Device`
`params`	`CreateDeviceParams`<`VEROVAL_ECG`>

Returns

VerovalEcgDevice

Overrides

Methods

connect()

connect(): Promise<void>;

Connects to the device and starts reading.

Resolves immediately if already connected and shares the pending promise while connecting.

Returns

Promise<void>

Throws

If the device has been destroyed.

Inherited from

destroy()

destroy(): void;

Stops the connection and data processing and clears the callbacks.

Returns

void

Inherited from

disconnect()

disconnect(): Promise<void>;

Stops this device's subscriptions and closes its BLE connection.

Returns

Promise<void>

Inherited from

stopRecording()

stopRecording(): Promise<void>;

Stops a recording the device holds open; only recorders that report one support it.

Returns

Promise<void>

Inherited from

syncHistory()

syncHistory(): Promise<void>;

Reads the records the device stored: over the open connection, or once it next connects.

Returns

Promise<void>

Inherited from

Properties

Property	Modifier	Type	Description	Inherited from
`device`	`public readonly`	`Device`	The underlying BLE device.	`BTManagedDevice`.`device`
`deviceData`	`public`	`DeviceData`	Identity and capabilities of this device, updated as device information is read.	`BTManagedDevice`.`deviceData`
`id`	`public`	`string`	Platform identifier of the underlying BLE device.	`BTManagedDevice`.`id`
`onConnectionEvent?`	`public`	(`data`) => `void`	Called for connection lifecycle events such as connected, bonded or history download.	`BTManagedDevice`.`onConnectionEvent`
`onDeviceDisconnected?`	`public`	() => `void`	Called when the device disconnects.	`BTManagedDevice`.`onDeviceDisconnected`
`onDeviceStatusChanged?`	`public`	(`status`, `measurementTypeKey?`) => `void`	Called when the connection status changes.	`BTManagedDevice`.`onDeviceStatusChanged`
`onError?`	`public`	(`error`) => `void`	Called with a normalised error; cleared by `destroy`.	`BTManagedDevice`.`onError`
`onResult?`	`public`	(`data`, `delivered?`) => `void`	Called with each measurement that passes the result policy; cleared by `destroy`. `delivered` is called once the app took it: the promise its result callback returned resolved.	`BTManagedDevice`.`onResult`
`onWaveform?`	`public`	(`waveform`) => `void`	Called with the ECG samples of each realtime answer while a recorder records; for display only.	`BTManagedDevice`.`onWaveform`

Functions

aoj20aThermometer()

function aoj20aThermometer(params): CustomDeviceDefinition;

The AOJ-20A infrared thermometer.

Declared without a write characteristic, because the device sends its reading rather than waiting to be asked: the vendor app has a request for it, calls it from nowhere, and still displays temperatures - so the reply arrives when someone takes a measurement. Not writing also means not polling, which for a spot-check device would otherwise re-report the same reading for as long as the link stayed up.

Only the realtime reply is declared. The stored-history reply shares the header and would need its own case; nothing reads history yet, and a case that decoded it into the same measurement would post old readings as though they had just been taken.

Parameters

Parameter	Type
`params`	`AojDeviceParams`

Returns

aojCommandByte()

function aojCommandByte(frame): number;

Reads the command byte of a frame.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

number

bluetoothErrorCodeFor()

function bluetoothErrorCodeFor(error): BluetoothErrorCode;

Classifies any thrown value into a BluetoothErrorCode.

Parameters

Parameter	Type
`error`	`unknown`

Returns

BluetoothErrorCode

bosoMedicusMonitor()

function bosoMedicusMonitor(params): CustomDeviceDefinition;

Declares a boso medicus system monitor.

The monitor stores readings and sends them through the standard 0x1810/0x2A35 profile after pairing. The shared profile declaration handles mmHg, optional timestamps, pulse rate and the profile's user/status bytes without inventing a boso-specific wire format.

Parameters

Parameter	Type
`params`	`BosoMedicusParams`

Returns

bp2aMonitor()

function bp2aMonitor(params): CustomDeviceDefinition;

BP2A, the arm-cuff monitor of the series.

Parameters

Parameter	Type
`params`	`ViatomBpParams`

Returns

bp2tMonitor()

function bp2tMonitor(params): CustomDeviceDefinition;

BP2T, documented by the vendor alongside BP2 and BP2A as the same protocol.

Parameters

Parameter	Type
`params`	`ViatomBpParams`

Returns

bp2vMonitor()

function bp2vMonitor(params): CustomDeviceDefinition;

BP2V, the WiFi variant that uses the BP2 realtime layout without ECG frames.

Parameters

Parameter	Type
`params`	`ViatomBpParams`

Returns

bp2wMonitor()

function bp2wMonitor(params): CustomDeviceDefinition;

BP2W. Documented in its own section, but decoding the same realtime struct.

Parameters

Parameter	Type
`params`	`ViatomBpParams`

Returns

bpu26Monitor()

function bpu26Monitor(params): CustomDeviceDefinition;

BPU 26, the Veroval compact+ upper-arm monitor.

Parameters

Parameter	Type
`params`	`VerovalBpParams`

Returns

bpw26Monitor()

function bpw26Monitor(params): CustomDeviceDefinition;

BPW 26, the Veroval compact+ wrist monitor.

Parameters

Parameter	Type
`params`	`VerovalBpParams`

Returns

btDeviceMatches()

function btDeviceMatches(device, filter): boolean;

Whether a runtime device is one filter asks for.

Parameters

Parameter	Type
`device`	`RuntimeDevice`
`filter`	`BTDeviceFilter`

Returns

boolean

buildA606ConnectedCommand()

function buildA606ConnectedCommand(): string[];

The vendor's post-connect command for the ZH-SG family.

Returns

string[]

buildA606TimeCommand()

function buildA606TimeCommand(now): string[];

Writes the local clock in the six-byte YY MM DD hh mm ss payload.

Parameters

Parameter	Type
`now`	`Date`

Returns

string[]

buildA606UploadCommand()

function buildA606UploadCommand(ack?): string[];

Requests the next stored record after the current one was accepted.

Parameters

Parameter	Type	Default value
`ack?`	`boolean`	`false`

Returns

string[]

buildAojFrame()

function buildAojFrame(command, payload?): string[];

Builds an AOJ frame for a command and payload, with its XOR checksum.

Parameters

Parameter	Type	Default value
`command`	`number`	`undefined`
`payload?`	readonly `number`[]	`[]`

Returns

string[]

buildGenialT31TimeCommand()

function buildGenialT31TimeCommand(now?): string[];

Builds the vendor's A6 05 37 weekday hour minute second checksum 6A clock frame.

Parameters

Parameter	Type
`now?`	`Date`

Returns

string[]

checkmeCommand()

function checkmeCommand(command, payload?): string[];

Builds the frame for a command with an optional hex payload.

Parameters

Parameter	Type	Default value
`command`	`number`	`undefined`
`payload?`	readonly `string`[]	`[]`

Returns

string[]

checkmePodCommand()

function checkmePodCommand(
   command,
   payload?,
   sequence?
): string[];

Builds the AA command envelope used by Checkme Pod and Checkme Pod-WPS.

Parameters

Parameter	Type	Default value
`command`	`number`	`undefined`
`payload?`	readonly `string`[]	`[]`
`sequence?`	`number`	`0`

Returns

string[]

checkmePodSyncTime()

function checkmePodSyncTime(now?): string[];

Builds the frame that sets the device clock to the given time.

Parameters

Parameter	Type
`now?`	`Date`

Returns

string[]

checkmeReadContent()

function checkmeReadContent(sequence): string[];

Builds the frame that requests the chunk with the given sequence number.

Parameters

Parameter	Type
`sequence`	`number`

Returns

string[]

checkmeReadEnd()

function checkmeReadEnd(): string[];

Builds the frame that closes the open file.

Returns

string[]

checkmeReadFileStart()

function checkmeReadFileStart(name): string[];

Builds the frame that opens the named file for reading.

Parameters

Parameter	Type
`name`	`string`

Returns

string[]

clockSyncCapabilityForDevice()

function clockSyncCapabilityForDevice(deviceName): ClockSyncCapability;

Built-in capability declarations; custom declarations provide their own value.

Parameters

Parameter	Type
`deviceName`	`string`

Returns

ClockSyncCapability

createBackgroundBleManager()

function createBackgroundBleManager(__namedParameters?): BleManager;

Creates a BLE manager configured for iOS CoreBluetooth state restoration. The returned manager must be created once at module scope, not inside a React render.

Parameters

Parameter	Type
`__namedParameters?`	`BackgroundBleManagerOptions`

Returns

BleManager

createBluetoothRuntime()

function createBluetoothRuntime(bleManager?, initialBackgroundScanEnabled?): BluetoothRuntime;

Creates the store that backs the Bluetooth hooks.

Parameters

Parameter	Type
`bleManager?`	`BleManager`
`initialBackgroundScanEnabled?`	`boolean`

Returns

BluetoothRuntime

createFakeBleDevice()

function createFakeBleDevice(__namedParameters): FakeBleDevice;

Creates a GATT-capable fake device for connection and notification tests.

Parameters

Parameter	Type
`__namedParameters`	`FakeBleDeviceOptions`

Returns

FakeBleDevice

createFakeBleManager()

function createFakeBleManager(__namedParameters?): FakeBleManager;

Creates a fake BLE manager with a controllable adapter state and scan results.

Parameters

Parameter	Type
`__namedParameters?`	`FakeBleManagerOptions`

Returns

FakeBleManager

createFileQueueStorage()

function createFileQueueStorage(prefix?): BackgroundSyncStorage;

Stores each queue key in its own document file, so ECGs are not limited by KV entry sizes.

Parameters

Parameter	Type	Default value
`prefix?`	`string`	`"ovok-native-background-sync"`

Returns

BackgroundSyncStorage

createLegacyResultId()

function createLegacyResultId(deviceData, data): string;

The id SDKs before 1.16.1 gave the same reading, to find what they saved.

Parameters

Parameter	Type
`deviceData`	`DeviceData`
`data`	`Measurement`

Returns

string

createStableResultId()

function createStableResultId(
   deviceData,
   data,
   receivedAt?
): string;

Creates an identity that is stable when a device sends its stored history again, in any time zone. A reading without a time of its own is a new measurement each time, so it is told apart by when it arrived.

Parameters

Parameter	Type
`deviceData`	`DeviceData`
`data`	`Measurement`
`receivedAt?`	`Date`

Returns

string

decodeAojError()

function decodeAojError(code): string | undefined;

Describes a temperature error code in words, or undefined for an unknown code.

Parameters

Parameter	Type
`code`	`number`

Returns

string | undefined

decodeCheckmeEcgFile()

function decodeCheckmeEcgFile(bytes): CheckmeEcgFile | undefined;

Decodes Checkme's 21-byte ECG header and little-endian signed waveform.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

CheckmeEcgFile | undefined

decodeCheckmePodResponse()

function decodeCheckmePodResponse(frame): CheckmePodResponse | undefined;

Decodes a complete response frame, or returns undefined if its header or length is invalid.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

CheckmePodResponse | undefined

decodeCheckmeResponse()

function decodeCheckmeResponse(bytes): CheckmeResponse | undefined;

Decodes the two response envelopes used by Checkme Pro's vendor library.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

CheckmeResponse | undefined

decodePulsebitEcgFile()

function decodePulsebitEcgFile(bytes): CheckmeEcgFile | undefined;

Decodes the 44-byte Pulsebit ECG header and its signed waveform.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

CheckmeEcgFile | undefined

decodeVerovalEcgSamples()

function decodeVerovalEcgSamples(bytes, calibration?): number[];

Turns the bytes of a recording into millivolts.

A trailing odd byte is ignored: half a sample is not a sample. The conversion is the device's own, applied as it states it rather than reduced to a single factor, so a header that reports a different range still decodes correctly.

Parameters

Parameter	Type	Default value
`bytes`	readonly `string`[]	`undefined`
`calibration?`	`EcgCalibration`	`DEFAULT_CALIBRATION`

Returns

number[]

decodeViatomEcgRecording()

function decodeViatomEcgRecording(bytes): ViatomEcgRecording;

Decodes an ER1/ER2 recording. A file whose waveform does not last as long as its tail records is returned empty, because that file is in a format this decoder does not read.

Parameters

Parameter	Type
`bytes`	`Uint8Array`

Returns

ViatomEcgRecording

defineCustomDevice()

function defineCustomDevice(spec, options?): CustomDeviceDefinition;

Validates a declaration and compiles it into a runnable device.

Every rule the declarative decoder relies on is checked here, at registration, because the alternative is a plausible wrong number at read time. Registration fails loudly - it throws, naming the exact position in the declaration - and a device that fails to compile is never scanned for.

Parameters

Parameter	Type
`spec`	`CustomDeviceSpec`
`options?`	{ `createCommandSequencer?`: `CustomSequencerFactory`; `createFrameHandler?`: `CustomFrameHandlerFactory`; `decorateReading?`: `CustomReadingDecorator`; `frameReader?`: `FrameReader`; }
`options.createCommandSequencer?`	`CustomSequencerFactory`
`options.createFrameHandler?`	`CustomFrameHandlerFactory`
`options.decorateReading?`	`CustomReadingDecorator`
`options.frameReader?`	`FrameReader`

Returns

defineRecordedDeviceFrames()

function defineRecordedDeviceFrames<T>(fixtures): Readonly<Record<T, readonly RecordedBleFrame[]>>;

A registry helper lets an app keep fixtures for every device it supports.

Type Parameters

Type Parameter
`T` extends `string`

Parameters

Parameter	Type
`fixtures`	`Record`<`T`, readonly `RecordedBleFrame`[]>

Returns

Readonly<Record<T, readonly RecordedBleFrame[]>>

describeLepuResponseType()

function describeLepuResponseType(frame): string;

Why a device refused, in words, for an error a person will read.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

string

deviceTitle()

function deviceTitle(deviceData): string;

Returns the most useful human-readable name for a connected device. A product sharing a parser with other brands is named by its variant. Known integrated and catalog devices keep their product name even when the peripheral reports a radio-module manufacturer and model. Unknown devices fall back to their reported identity and then their advertised name.

Parameters

Parameter	Type
`deviceData`	`DeviceData`

Returns

string

er1Recorder()

function er1Recorder(advertisedName, params): CustomDeviceDefinition;

The ER1, and the handheld recorders sold under other names on the same protocol.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`ViatomEcgParams`

Returns

er2Recorder()

function er2Recorder(advertisedName, params): CustomDeviceDefinition;

The ER2, which reads the same block but over a link that grants nothing beyond the minimum. Asking it for the MTU the rest of the family grants is what the vendor's own SDK declines to do, and a command longer than the link carries is truncated rather than refused.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`ViatomEcgParams`

Returns

er3Recorder()

function er3Recorder(advertisedName, params): CustomDeviceDefinition;

The ER3, which reads the same parameter block from a different opcode.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`ViatomEcgParams`

Returns

findDeviceVariant()

function findDeviceVariant(device, advertisedName): DeviceVariant | undefined;

The brand and model behind an advertised name, for a parser listed in DEVICE_VARIANTS.

Parameters

Parameter	Type
`device`	`string`
`advertisedName`	`string`

Returns

DeviceVariant | undefined

getBackgroundServiceUUIDs()

function getBackgroundServiceUUIDs(acceptedDevices, additionalServiceUUIDs?): string[];

The services a background scan asks for: those of every accepted device whose services are known, and additionalServiceUUIDs. In the background iOS (and Android with the screen off) reports only devices advertising a listed service, so an accepted device whose services aren't known is found by a foreground scan only. One such device must not empty the list: iOS can't scan in the background without one.

Parameters

Parameter	Type	Default value
`acceptedDevices`	readonly `AcceptedDevice`[]	`undefined`
`additionalServiceUUIDs?`	readonly `string`[]	`[]`

Returns

string[]

getClockParts()

function getClockParts(date, timezone?): object;

Splits a date into calendar and clock parts in the given timezone.

Parameters

Parameter	Type	Default value
`date`	`Date`	`undefined`
`timezone?`	`ClockSyncTimezone`	`"local"`

Returns

Name	Type	Description
`day`	`number`	Day of the month.
`hours`	`number`	Hours, 0-23.
`milliseconds`	`number`	Milliseconds, 0-999.
`minutes`	`number`	Minutes, 0-59.
`month`	`number`	Month, 1-12.
`seconds`	`number`	Seconds, 0-59.
`year`	`number`	Full year.

getRestoredBleState()

function getRestoredBleState(restoreStateIdentifier?): BleRestoredState | null | undefined;

Returns the state restored for an identifier, or undefined if restoration has not run yet.

Parameters

Parameter	Type	Default value
`restoreStateIdentifier?`	`string`	`DEFAULT_RESTORE_STATE_IDENTIFIER`

Returns

BleRestoredState | null | undefined

isClockSyncEnabled()

function isClockSyncEnabled(options?): boolean;

True unless clock synchronisation is explicitly disabled.

Parameters

Parameter	Type
`options?`	`ClockSyncOptions`

Returns

boolean

isLepuSuccess()

function isLepuSuccess(frame): boolean;

Whether the frame reports success.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

boolean

isTrasenseS9Advertisement()

function isTrasenseS9Advertisement(advertisedName, manufacturerData?): boolean;

The SH09 reuses company ID 0x0A0A and advertises only as "S9". Require both fields and the exact manufacturer payload length; the name alone is ambiguous. react-native-ble-plx exposes the manufacturer-specific bytes as base64, including the two company-ID bytes at the start of the AD structure.

Parameters

Parameter	Type
`advertisedName`	`string`
`manufacturerData?`	`string`

Returns

boolean

lepodMonitor()

function lepodMonitor(advertisedName, params): CustomDeviceDefinition;

Declares a Lepod, reporting every reading its realtime frame carries.

An instrument that is not attached reports a value outside the physiological range for what it measures, so that reading is discarded and reported while the others in the same frame are still delivered. The device also marks those conditions in bits of a lead-off byte, which a declaration cannot select on - reading them quietly needs a device class.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`LepodParams`

Returns

lepuDevice()

function lepuDevice(params): CustomDeviceDefinition;

Builds a custom device definition for a Lepu/Viatom family product from its params.

Parameters

Parameter	Type
`params`	`LepuDeviceParams`

Returns

lepuNameMatch()

function lepuNameMatch(name, vocabulary?): RegExp;

Builds a matcher for one advertised name that cannot also match a longer one.

The vendor tests these names with a substring check in a hand-ordered cascade, so BP2 only fails to match a BP2W because BP2W happens to be checked first. Order is a fragile place to keep a safety property: it lives in whoever wrote the list, is invisible at the point of use, and an insertion in the wrong place silently binds the wrong driver.

Here the exclusions are derived instead. Every name in the vocabulary that extends this one becomes a negative lookahead, so the matcher is correct wherever it is used and in whatever order it is tried.

The match is deliberately open at the end, because these devices advertise a serial after the model - BP2 1234 - and the serial's shape varies across the family.

Parameters

Parameter	Type	Default value
`name`	`string`	`undefined`
`vocabulary?`	readonly `string`[]	`LEPU_DEVICE_NAMES`

Returns

RegExp

lepuResponseType()

function lepuResponseType(frame): number;

Reads the response type byte of a frame.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

number

lpBp2wMonitor()

function lpBp2wMonitor(params): CustomDeviceDefinition;

LP-BP2W, the Lepu-branded WiFi variant of the BP2 family.

Parameters

Parameter	Type
`params`	`ViatomBpParams`

Returns

CheckmeBloodPressureRecord[]

parseA606Record()

function parseA606Record(frame): A606Record | undefined;

Decodes the 12-byte glucose payload inside a verified 16-byte ZH-SG record.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

A606Record | undefined

parseCheckmeBloodPressureRecords()

function parseCheckmeBloodPressureRecords(bytes): CheckmeBloodPressureRecord[];

Parses a blood pressure list file into records, skipping entries with an invalid date.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

parseCheckmeDailyRecords()

function parseCheckmeDailyRecords(bytes): CheckmeDailyRecord[];

Parses a daily list file into records, skipping entries with an invalid date.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

CheckmeDailyRecord[]

parseCheckmeEcgRecords()

function parseCheckmeEcgRecords(bytes): CheckmeEcgRecord[];

Parses an ECG list file into records, skipping entries with an invalid date.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

CheckmeEcgRecord[]

parseCheckmeOxygenRecords()

function parseCheckmeOxygenRecords(bytes): CheckmeOxygenRecord[];

Parses an oxygen list file into records, skipping entries with an invalid date.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

CheckmeOxygenRecord[]

parseCheckmePodRealtimeReading()

function parseCheckmePodRealtimeReading(content): CheckmePodRealtimeReading | undefined;

Decodes the 20-byte RtParam prefix used by the vendor's realtime response.

Parameters

Parameter	Type
`content`	readonly `string`[]

Returns

CheckmePodRealtimeReading | undefined

parseCheckmeTemperatureRecords()

function parseCheckmeTemperatureRecords(bytes): CheckmeTemperatureRecord[];

Parses a temperature list file into records, skipping entries with an invalid date.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

CheckmeTemperatureRecord[]

parseLepuDeviceInfo()

function parseLepuDeviceInfo(frame): LepuDeviceInfo | undefined;

Reads the reply to GET_INFO, or nothing if the frame is not one.

The command byte is checked rather than assumed, because this is the answer a driver decides its identity on: parsing some other frame as device info would produce a model number out of whatever bytes happened to sit at offset 20, and the gate would then pass on a coincidence.

A frame too short to hold the layout is refused for the same reason, as is one whose response type is anything but success: an error reply carries a reason where the device information would be, and reading it as a model number would identify the hardware from an error code. The vendor's own struct is at least 56 bytes; anything shorter than the serial length field cannot be read without inventing the parts that are missing.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

LepuDeviceInfo | undefined

parsePulsebitEcgRecords()

function parsePulsebitEcgRecords(bytes): PulsebitEcgRecord[];

Decodes the 17-byte ECG index used by Pulsebit and Checkme EX.

Parameters

Parameter	Type
`bytes`	readonly `string`[]

Returns

PulsebitEcgRecord[]

parseRecordedAt()

function parseRecordedAt(frame): Date | undefined;

Reads the recording time from a history frame, or undefined if it is not a valid date.

Parameters

Parameter	Type
`frame`	readonly `string`[]

Returns

Date | undefined

parseVerovalDuoControlRecordMetadata()

function parseVerovalDuoControlRecordMetadata(frame, recordOffset):
  | Pick<VerovalDuoControlMeasurement, "recordedAt" | "irregularHeartbeat">
  | undefined;

Reads the timestamp and irregular heartbeat flag of a stored record, or undefined if invalid.

Parameters

Parameter	Type
`frame`	readonly `string`[]
`recordOffset`	`number`

Returns

| Pick<VerovalDuoControlMeasurement, "recordedAt" | "irregularHeartbeat"> | undefined

recordedAtFromT31Frame()

function recordedAtFromT31Frame(frame, now): Date | undefined;

Reconstructs when a reading was taken from the weekday and time in a frame, or undefined if invalid.

Parameters

Parameter	Type
`frame`	readonly `string`[]
`now`	`Date`

Returns

Date | undefined

recordedAtFromViatomFileName()

function recordedAtFromViatomFileName(name): Date | undefined;

Reads the recording time encoded in the ER file name, when present.

Parameters

Parameter	Type
`name`	`string`

Returns

Date | undefined

replayRecordedFrames()

function replayRecordedFrames(frames, sink): Promise<void>;

Replays captured characteristic frames through an app-provided test sink.

Parameters

Parameter	Type
`frames`	readonly `RecordedBleFrame`[]
`sink`	`RecordedFrameSink`

Returns

Promise<void>

requestBluetoothPermission()

function requestBluetoothPermission(): Promise<boolean>;

Asks the OS for the Bluetooth permissions the platform needs; resolves to whether all were granted.

Returns

Promise<boolean>

reviveResultDates()

function reviveResultDates<T>(value): T;

Converts the ISO date strings of recordedAt, start and end fields back to Dates, recursively.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`value`	`T`

Returns

T

setDeviceSecretStorage()

function setDeviceSecretStorage(next): void;

Sets the durable storage used for device secrets; pass undefined to keep them in memory only.

Parameters

Parameter	Type
`next`	`DeviceSecretStorage` \| `undefined`

Returns

void

standardBloodPressureDevice()

function standardBloodPressureDevice(params): CustomDeviceDefinition;

Declares a Bluetooth SIG blood pressure profile device.

Parameters

Parameter	Type
`params`	`StandardDeviceParams`

Returns

standardGlucoseDevice()

function standardGlucoseDevice(params): CustomDeviceDefinition;

Declares a Bluetooth SIG glucose profile device.

Parameters

Parameter	Type
`params`	`StandardDeviceParams`

Returns

standardHeartRateDevice()

function standardHeartRateDevice(params): CustomDeviceDefinition;

Heart Rate Service 0x180D, Heart Rate Measurement 0x2A37.

Both heart-rate layouts are declared. A contact-not-detected frame is idle, so it cannot become a false reading while the strap is off the body. RR intervals, a list of any length, are read from the frame by the decorator and reported as rrIntervals.

Parameters

Parameter	Type
`params`	`StandardDeviceParams`

Returns

standardPulseOximeterDevice()

function standardPulseOximeterDevice(params): CustomDeviceDefinition;

Pulse Oximeter Service 0x1822, PLX Spot-Check Measurement 0x2A5E.

Saturation and pulse rate are both required by the catalog, which matches the specification: a spot-check measurement always carries both, at bytes 1-4 whatever the flags say, so every flags value selects the same fields. The optional ones follow them.

Parameters

Parameter	Type
`params`	`StandardDeviceParams`

Returns

standardThermometerDevice()

function standardThermometerDevice(params): CustomDeviceDefinition;

Health Thermometer Service 0x1809, Temperature Measurement 0x2A1C.

Parameters

Parameter	Type
`params`	`StandardDeviceParams`

Returns

standardWeightScaleDevice()

function standardWeightScaleDevice(params): CustomDeviceDefinition;

Weight Scale Service 0x181D, Weight Measurement 0x2A9D.

The reading is a scaled integer rather than a float, so the resolution is applied here. A weight of 0xFFFF means the measurement failed, so it yields no reading.

Parameters

Parameter	Type
`params`	`StandardDeviceParams`

Returns

tmbBpMonitor()

function tmbBpMonitor(advertisedName, params): CustomDeviceDefinition;

Declares a Viatom TMB monitor, whose history protocol is separate from the BP3 Lepu flow.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`ViatomBpParams`

Returns

toBluetoothError()

function toBluetoothError(error): BluetoothError;

Wraps any thrown value in a BluetoothError, keeping an existing one as is.

Parameters

Parameter	Type
`error`	`unknown`

Returns

BluetoothError

verovalCompactMonitor()

function verovalCompactMonitor(advertisedName, params): CustomDeviceDefinition;

Declares a compact Veroval blood pressure monitor by its advertised name.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`VerovalBpParams`

Returns

verovalFusionMonitor()

function verovalFusionMonitor(params?): CustomDeviceDefinition;

Declares the Veroval fusion wireless blood-pressure monitor.

Parameters

Parameter	Type
`params?`	`VerovalFusionParams`

Returns

viatomBpMonitor()

function viatomBpMonitor(advertisedName, params): CustomDeviceDefinition;

Declares one monitor of the BP2 series.

advertisedName is the name the vendor's SDK matches - BP2A, BP2T - and the matcher derived from it excludes every longer name in the family, so a declaration for BP2 cannot pick up a BP2W.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`ViatomBpParams`

Returns

viatomOximeter()

function viatomOximeter(advertisedName, params): CustomDeviceDefinition;

Declares one oximeter of the range.

The ViHealth wire protocol uses a distinct AA request / 55 response envelope. Replies carry a status byte rather than echoing the opcode, and the sensor state at byte 18 tells us whether the reading is usable. No-finger and acquiring frames are deliberately idle: they are normal states while the user puts the ring on, not decoding failures.

Parameters

Parameter	Type
`advertisedName`	`string`
`params`	`ViatomOximeterParams`

Returns

viatomOxyIiMonitor()

function viatomOxyIiMonitor(advertisedName, params?): CustomDeviceDefinition;

Declares one model on the dedicated OxyII service and A5 frame.

Parameters

Parameter	Type
`advertisedName`	`string`
`params?`	`ViatomOxyIiParams`

Returns

visomatComfortSoftBtMonitor()

function visomatComfortSoftBtMonitor(params): CustomDeviceDefinition;

Declares the visomat comfort soft BT upper-arm monitor.

The monitor uses the Bluetooth SIG Blood Pressure Service and Measurement characteristic, so the shared profile handles the 0x2A35 measurement without a vendor-specific command or pairing flow.

Parameters

Parameter	Type
`params`	`VisomatComfortSoftBtParams`

Returns