README.md

Laird Capacitor Plugin

This plugin is still in development and is not live on NPM yet!

A Capacitor plugin that communicates with bluetooth low energy laird devices. Supports older devices with the BluetoothAdapter and newer devices uses the BluetoothLeScanner.

Install

npm install laird-capacitor-plugin
npx cap sync

Example

// Import Laird and Device.
import { Laird, Device } from 'laird-capacitor-plugin';

// Initialize the listener first.
Laird.addListener("deviceFoundEvent", (device) => {
    console.log(device);
});

// Start discovering.
Laird.startDiscovering({ periodically: true });

API

• startDiscovering(...)
• cancelDiscovering()
• connectToDevice(...)
• disconnectFromDevice()
• sendDataToDevice(...)
• addListener(...)
• addListener(...)
• addListener(...)
• addListener(...)
• Interfaces

startDiscovering(...)

startDiscovering(options?: { periodically: boolean; } | undefined) => any

Start the discovering process for finding bluetooth devices.

Param	Type
options	{ periodically: boolean; }

Returns: any

---

cancelDiscovering()

cancelDiscovering() => any

Cancels the discovering process for finding bluetooth devices.

Returns: any

---

connectToDevice(...)

connectToDevice(options: { address: string; }) => any

Connects to the specified device with the address.

Param	Type
options	{ address: string; }

Returns: any

---

disconnectFromDevice()

disconnectFromDevice() => any

Disconnects the current connected device.

Returns: any

---

sendDataToDevice(...)

sendDataToDevice(options: { data: string; }) => any

Sends data to the connected device.

Param	Type
options	{ data: string; }

Returns: any

---

addListener(...)

addListener(eventName: 'discoveryStartEvent', callback: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

DiscoveryStartEvent

Param	Type
eventName	"discoveryStartEvent"
callback	() => void

Returns: any

---

addListener(...)

addListener(eventName: 'discoveryStopEvent', callback: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

DiscoveryStopEvent

Param	Type
eventName	"discoveryStopEvent"
callback	() => void

Returns: any

---

addListener(...)

addListener(eventName: 'deviceFoundEvent', callback: (device: Device) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

DeviceFoundListener

Param	Type	Description
eventName	"deviceFoundEvent"	DeviceFoundEvent
callback	(device: Device) => void	Callback

Returns: any

---

addListener(...)

addListener(eventName: 'deviceRecvDataEvent', callback: (data: DeviceData) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

DeviceRecvDataListener

Param	Type	Description
eventName	"deviceRecvDataEvent"	DeviceRecvDataEvent
callback	(data: DeviceData) => void	Callback

Returns: any

---

Interfaces

PluginListenerHandle

Prop	Type
remove	() => any

Device

Prop	Type
name	string
type	number
address	string
rssi	number

DeviceData

Prop	Type
data	string