Class Bluetooth

Hierarchy

BluetoothCommon
- Bluetooth

Index

Constructors

constructor

Constructors

constructor

new Bluetooth(
restoreIndentifierOrOptions?: string | Partial<BluetoothOptions>,
): Bluetooth
restoreIdentifier is optional and only used on iOS
Parameters
- OptionalrestoreIndentifierOrOptions: string | Partial<BluetoothOptions>
Returns Bluetooth
Overrides BluetoothCommon.constructor
- Defined in packages/ble/index.d.ts:65

Properties

centralManager

centralManager: any

`Readonly`enabled

enabled: boolean

Property to determine if bluetooth is enabled.

events

events: any

`Static` `Optional` `Readonly`android

android?: {
    CallbackType: typeof CallbackType;
    MatchMode: typeof MatchMode;
    MatchNum: typeof MatchNum;
    ScanMode: typeof ScanMode;
}

`Static`bluetooth_status_event

bluetooth_status_event: string

`Static`characteristicUUIDKey

characteristicUUIDKey: string

`Static`device_connected_event

device_connected_event: string

`Static`device_disconnected_event

device_disconnected_event: string

`Static`device_discovered_event

device_discovered_event: string

`Static`msg_cant_open_settings

msg_cant_open_settings: string

`Static`msg_characteristic_cant_notify

msg_characteristic_cant_notify: string

`Static`msg_error_function_call

msg_error_function_call: string

`Static`msg_invalid_value

msg_invalid_value: string

`Static`msg_missing_parameter

msg_missing_parameter: string

`Static`msg_no_characteristic

msg_no_characteristic: string

`Static`msg_no_peripheral

msg_no_peripheral: string

`Static`msg_no_service

msg_no_service: string

`Static`msg_not_enabled

msg_not_enabled: string

`Static`msg_not_supported

msg_not_supported: string

`Static`msg_peripheral_disconnected

msg_peripheral_disconnected: string

`Static`msg_peripheral_not_connected

msg_peripheral_not_connected: string

`Static`peripheralUUIDKey

peripheralUUIDKey: string

`Static`serviceUUIDKey

serviceUUIDKey: string

`Static`UUIDKey

UUIDKey: string

Methods

clear

clear(): any
everything needed to clear on app close

Returns any
- Defined in packages/ble/index.d.ts:70

clearAdvertismentCache

clearAdvertismentCache(): any
Returns any
- Defined in packages/ble/index.d.ts:146

connect

connect(options: ConnectOptions): Promise<any>
Parameters
- options: ConnectOptions
Returns Promise<any>
- Defined in packages/ble/index.d.ts:117

disconnect

disconnect(options: DisconnectOptions): Promise<any>
Parameters
- options: DisconnectOptions
Returns Promise<any>
- Defined in packages/ble/index.d.ts:121

discoverAll

discoverAll(
args: DiscoverOptions,
): Promise<{ characteristics: Characteristic[]; services: Service[] }>
Parameters
- args: DiscoverOptions
Returns Promise<{ characteristics: Characteristic[]; services: Service[] }>
Overrides BluetoothCommon.discoverAll
- Defined in packages/ble/index.d.ts:142

discoverCharacteristics

discoverCharacteristics(
args: DiscoverCharacteristicsOptions,
): Promise<{ characteristics: Characteristic[] }>
Parameters
- args: DiscoverCharacteristicsOptions
Returns Promise<{ characteristics: Characteristic[] }>
Overrides BluetoothCommon.discoverCharacteristics
- Defined in packages/ble/index.d.ts:140

discoverServices

discoverServices(
args: DiscoverServicesOptions,
): Promise<{ services: Service[] }>
Parameters
- args: DiscoverServicesOptions
Returns Promise<{ services: Service[] }>
Overrides BluetoothCommon.discoverServices
- Defined in packages/ble/index.d.ts:139

enable

enable(): Promise<boolean>
Android only. Will return false if the user denied turning Bluetooth on.

Returns Promise<boolean>
- Defined in packages/ble/index.d.ts:83

enableGPS

enableGPS(): Promise<void>
Android only. Will reject if the user denied turning GPS on.

Returns Promise<void>
Overrides BluetoothCommon.enableGPS
- Defined in packages/ble/index.d.ts:95

getAndroidLocationManager

getAndroidLocationManager(): any
Returns any
- Defined in packages/ble/index.d.ts:152

getDevice

getDevice(args: DisconnectOptions): any
Parameters
- args: DisconnectOptions
Returns any
- Defined in packages/ble/index.d.ts:154

hasLocationPermission

hasLocationPermission(): Promise<boolean>
Required for Android 6+ to be able to scan for peripherals in the background.

Returns Promise<boolean>
Overrides BluetoothCommon.hasLocationPermission
- Defined in packages/ble/index.d.ts:106

isBluetoothEnabled

isBluetoothEnabled(): Promise<boolean>
Returns Promise<boolean>
Overrides BluetoothCommon.isBluetoothEnabled
- Defined in packages/ble/index.d.ts:77

isConnected

isConnected(options: ConnectOptions): Promise<boolean>
Parameters
- options: ConnectOptions
Returns Promise<boolean>
- Defined in packages/ble/index.d.ts:119

isGPSEnabled

isGPSEnabled(): Promise<boolean>
Android only. check if GPS is enabled.

Returns Promise<boolean>
Overrides BluetoothCommon.isGPSEnabled
- Defined in packages/ble/index.d.ts:89

openBluetoothSettings

openBluetoothSettings(url?: string): any
open device bluetooth settings
Parameters
- Optionalurl: string
Returns any
- Defined in packages/ble/index.d.ts:101

read

read(options: ReadOptions): Promise<ReadResult>
Parameters
- options: ReadOptions
Returns Promise<ReadResult>
- Defined in packages/ble/index.d.ts:123

readRssi

readRssi(args: ReadRSSIOptions): Promise<number>
Parameters
- args: ReadRSSIOptions
Returns Promise<number>
- Defined in packages/ble/index.d.ts:137

requestLocationPermission

requestLocationPermission(): Promise<any>
Required for Android 6+ to be able to scan for peripherals in the background.

Returns Promise<any>
Overrides BluetoothCommon.requestLocationPermission
- Defined in packages/ble/index.d.ts:111

requestMtu

requestMtu(options: MtuOptions): Promise<number>
Parameters
- options: MtuOptions
Returns Promise<number>
- Defined in packages/ble/index.d.ts:135

sendEvent

sendEvent(eventName: string, data?: any, msg?: string): void
Notify events by name and optionally pass data
Parameters
- eventName: string
- Optionaldata: any
- Optionalmsg: string
Returns void
Inherited from BluetoothCommon.sendEvent
- Defined in packages/ble/index.common.d.ts:59

startNotifying

startNotifying(options: StartNotifyingOptions): Promise<any>
Parameters
- options: StartNotifyingOptions
Returns Promise<any>
- Defined in packages/ble/index.d.ts:129

startScanning

startScanning(options: StartScanningOptions): Promise<void>
Parameters
- options: StartScanningOptions
Returns Promise<void>
- Defined in packages/ble/index.d.ts:113

stop

stop(): any
Returns any
Overrides BluetoothCommon.stop
- Defined in packages/ble/index.d.ts:144

stopNotifying

stopNotifying(options: StopNotifyingOptions): Promise<any>
Parameters
- options: StopNotifyingOptions
Returns Promise<any>
- Defined in packages/ble/index.d.ts:131

stopScanning

stopScanning(): Promise<any>
Returns Promise<any>
- Defined in packages/ble/index.d.ts:115

write

write(options: WriteOptions): Promise<any>
Parameters
- options: WriteOptions
Returns Promise<any>
- Defined in packages/ble/index.d.ts:125

writeWithoutResponse

writeWithoutResponse(options: WriteOptions): Promise<any>
Parameters
- options: WriteOptions
Returns Promise<any>
- Defined in packages/ble/index.d.ts:127

Class Bluetooth

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Bluetooth

Properties

centralManager

Readonlyenabled

events

Static Optional Readonlyandroid

Staticbluetooth_status_event

StaticcharacteristicUUIDKey

Staticdevice_connected_event

Staticdevice_disconnected_event

Staticdevice_discovered_event

Staticmsg_cant_open_settings

Staticmsg_characteristic_cant_notify

Staticmsg_error_function_call

Staticmsg_invalid_value

Staticmsg_missing_parameter

Staticmsg_no_characteristic

Staticmsg_no_peripheral

Staticmsg_no_service

Staticmsg_not_enabled

Staticmsg_not_supported

Staticmsg_peripheral_disconnected

Staticmsg_peripheral_not_connected

StaticperipheralUUIDKey

StaticserviceUUIDKey

StaticUUIDKey

Methods

clear

Returns any

clearAdvertismentCache

Returns any

connect

Parameters

Returns Promise<any>

disconnect

Parameters

Returns Promise<any>

discoverAll

Parameters

Returns Promise<{ characteristics: Characteristic[]; services: Service[] }>

discoverCharacteristics

Parameters

Returns Promise<{ characteristics: Characteristic[] }>

discoverServices

Parameters

Returns Promise<{ services: Service[] }>

enable

Returns Promise<boolean>

enableGPS

Returns Promise<void>

getAndroidLocationManager

Returns any

getDevice

Parameters

Returns any

hasLocationPermission

Returns Promise<boolean>

isBluetoothEnabled

Returns Promise<boolean>

isConnected

Parameters

Returns Promise<boolean>

isGPSEnabled

Returns Promise<boolean>

openBluetoothSettings

Parameters

Returns any

read

Parameters

Returns Promise<ReadResult>

readRssi

`Readonly`enabled

`Static` `Optional` `Readonly`android

`Static`bluetooth_status_event

`Static`characteristicUUIDKey

`Static`device_connected_event

`Static`device_disconnected_event

`Static`device_discovered_event

`Static`msg_cant_open_settings

`Static`msg_characteristic_cant_notify

`Static`msg_error_function_call

`Static`msg_invalid_value

`Static`msg_missing_parameter

`Static`msg_no_characteristic

`Static`msg_no_peripheral

`Static`msg_no_service

`Static`msg_not_enabled

`Static`msg_not_supported

`Static`msg_peripheral_disconnected

`Static`msg_peripheral_not_connected

`Static`peripheralUUIDKey

`Static`serviceUUIDKey

`Static`UUIDKey