trik/capacitor-bluetooth-le-peripheral

Capacitor plugin for Bluetooth Low Energy Peripheral

capacitor-bluetooth-le-peripheral

Capacitor plugin for Bluetooth Low Energy Peripheral

Install

npm install capacitor-bluetooth-le-peripheral
npx cap sync

API

• initialize()
• isEnabled()
• enable()
• disable()
• startServer()
• advertise(...)
• addService(...)
• addCharacteristic(...)
• setCharacteristicValue(...)
• onCharacteristicSubscribed(...)
• onCharacteristicUnsubscribed(...)
• unCharacteristicSubscribed(...)
• unCharacteristicUnsubscribed(...)
• Interfaces
• Type Aliases

initialize()

initialize() => Promise<void>

---

isEnabled()

isEnabled() => Promise<boolean>

Returns: Promise<boolean>

---

enable()

enable() => Promise<boolean>

Returns: Promise<boolean>

---

disable()

disable() => Promise<boolean>

Returns: Promise<boolean>

---

startServer()

startServer() => Promise<void>

---

advertise(...)

advertise(options: AdvertiseOptions) => Promise<void>

Param	Type
options	AdvertiseOptions

---

addService(...)

addService(options: AddServiceOptions) => Promise<boolean>

Param	Type
options	AddServiceOptions

Returns: Promise<boolean>

---

addCharacteristic(...)

addCharacteristic(options: AddCharacteristicOptions) => Promise<boolean>

Param	Type
options	AddCharacteristicOptions

Returns: Promise<boolean>

---

setCharacteristicValue(...)

setCharacteristicValue(options: SetCharacteristicValueOptions) => Promise<boolean>

Param	Type
options	SetCharacteristicValueOptions

Returns: Promise<boolean>

---

onCharacteristicSubscribed(...)

onCharacteristicSubscribed(options: CharacteristicOptions, callback: () => void) => Promise<CallbackID>

Param	Type
options	CharacteristicOptions
callback	() => void

Returns: Promise<string>

---

onCharacteristicUnsubscribed(...)

onCharacteristicUnsubscribed(options: CharacteristicOptions, callback: () => void) => Promise<CallbackID>

Param	Type
options	CharacteristicOptions
callback	() => void

Returns: Promise<string>

---

unCharacteristicSubscribed(...)

unCharacteristicSubscribed(options: RemoveCharacteristicWatcherOptions) => Promise<void>

Param	Type
options	RemoveCharacteristicWatcherOptions

---

unCharacteristicUnsubscribed(...)

unCharacteristicUnsubscribed(options: RemoveCharacteristicWatcherOptions) => Promise<void>

Param	Type
options	RemoveCharacteristicWatcherOptions

---

Interfaces

AdvertiseOptions

Prop	Type
uuids	string[]
mode	number
connectable	boolean
txPower	number

AddServiceOptions

Prop	Type
uuid	string
serviceType	number

AddCharacteristicOptions

Prop	Type
properties	number
permissions	number

SetCharacteristicValueOptions

Prop	Type
value	string
indicate	boolean

CharacteristicOptions

Prop	Type
service	string
uuid	string

RemoveWatcherOptions

Prop	Type
callbackId	CallbackID

Type Aliases

CallbackID

string

RemoveCharacteristicWatcherOptions

CharacteristicOptions & RemoveWatcherOptions