0.0.6 • Published 8 months ago

@matfire/ionic_bluetooth_classic v0.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

bluetooth

bluetooth classic discovery and communication

currently only works on Android, IOS coming eventually

Install

npm install @matfire/ionic_bluetooth_classic
npx cap sync

Permissions

Android

add the following lines to your AndroidManifest.xml file:

    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
    <uses-permission android:name="android.permission.BLUETOOTH" />
    <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

API

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>


requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>


startListening()

startListening() => Promise<boolean>

Returns: Promise<boolean>


stopListening()

stopListening() => Promise<boolean>

Returns: Promise<boolean>


write(...)

write(data: { message: string; }) => Promise<boolean>
ParamType
data{ message: string; }

Returns: Promise<boolean>


addListener('deviceConnectionStatusChanged', ...)

addListener(eventName: 'deviceConnectionStatusChanged', listenerFunc: ({ data }: { data: IDeviceStatus; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'deviceConnectionStatusChanged'
listenerFunc({ data }: { data: IDeviceStatus; }) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('deviceDataReceived', ...)

addListener(eventName: 'deviceDataReceived', listenerFunc: ({ data }: { data: IDataReceived; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'deviceDataReceived'
listenerFunc({ data }: { data: IDataReceived; }) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


addListener('deviceDiscovered', ...)

addListener(eventName: 'deviceDiscovered', listenerFunc: ({ device }: { device: IDevice; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
ParamType
eventName'deviceDiscovered'
listenerFunc({ device }: { device: IDevice; }) => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle


getPairedDevices()

getPairedDevices() => Promise<{ devices: any[]; }>

Returns: Promise<{ devices: any[]; }>


connect(...)

connect(data: { deviceId: string; appUUID: string; }) => Promise<boolean>
ParamType
data{ deviceId: string; appUUID: string; }

Returns: Promise<boolean>


disconnect()

disconnect() => Promise<boolean>

Returns: Promise<boolean>


Interfaces

PermissionStatus

PropType
bluetoothPermissionState
locationPermissionState

PluginListenerHandle

PropType
remove() => Promise<void>

IDeviceStatus

PropType
deviceIdstring
statusDeviceStatus

IDataReceived

PropType
bytesstring
sizenumber

IDevice

PropType
addressstring
namestring

Type Aliases

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

Enums

DeviceStatus

MembersValue
DISCONNECTED0
CONNECTED1
CONNECTING2
0.0.6

8 months ago

0.0.5

8 months ago

0.0.4

8 months ago

0.0.3

9 months ago

0.0.2

9 months ago

0.0.1

9 months ago