- Notifications
You must be signed in to change notification settings - Fork1
A Capacitor plugin that communicates with bluetooth low energy laird devices. Supports older devices with the BluetoothAdapter and newer devices uses the BluetoothLeScanner.
License
fits4all/laird-capacitor-plugin
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
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.
npm install laird-capacitor-pluginnpx cap sync
// 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});
startDiscovering(...)cancelDiscovering()connectToDevice(...)disconnectFromDevice()sendDataToDevice(...)addListener(...)addListener(...)addListener(...)addListener(...)- Interfaces
startDiscovering(options?:{periodically:boolean;}|undefined)=>any
Start the discovering process for finding bluetooth devices.
| Param | Type |
|---|---|
options | { periodically: boolean; } |
Returns:any
cancelDiscovering()=>any
Cancels the discovering process for finding bluetooth devices.
Returns:any
connectToDevice(options:{address:string;})=>any
Connects to the specified device with the address.
| Param | Type |
|---|---|
options | { address: string; } |
Returns:any
disconnectFromDevice()=>any
Disconnects the current connected device.
Returns:any
sendDataToDevice(options:{data:string;})=>any
Sends data to the connected device.
| Param | Type |
|---|---|
options | { data: string; } |
Returns:any
addListener(eventName:'discoveryStartEvent',callback:()=>void)=>Promise<PluginListenerHandle>&PluginListenerHandle
DiscoveryStartEvent
| Param | Type |
|---|---|
eventName | "discoveryStartEvent" |
callback | () => void |
Returns:any
addListener(eventName:'discoveryStopEvent',callback:()=>void)=>Promise<PluginListenerHandle>&PluginListenerHandle
DiscoveryStopEvent
| Param | Type |
|---|---|
eventName | "discoveryStopEvent" |
callback | () => void |
Returns:any
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(eventName:'deviceRecvDataEvent',callback:(data:DeviceData)=>void)=>Promise<PluginListenerHandle>&PluginListenerHandle
DeviceRecvDataListener
| Param | Type | Description |
|---|---|---|
eventName | "deviceRecvDataEvent" | DeviceRecvDataEvent |
callback | (data:DeviceData) => void | Callback |
Returns:any
| Prop | Type |
|---|---|
remove | () => any |
| Prop | Type |
|---|---|
name | string |
type | number |
address | string |
rssi | number |
| Prop | Type |
|---|---|
data | string |
About
A Capacitor plugin that communicates with bluetooth low energy laird devices. Supports older devices with the BluetoothAdapter and newer devices uses the BluetoothLeScanner.
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Contributors2
Uh oh!
There was an error while loading.Please reload this page.