https://github.com/MnlPhlp/tauri-plugin-blec
BLE Client plugin for tauri
https://github.com/MnlPhlp/tauri-plugin-blec
Last synced: 1 day ago
JSON representation
BLE Client plugin for tauri
- Host: GitHub
- URL: https://github.com/MnlPhlp/tauri-plugin-blec
- Owner: MnlPhlp
- License: apache-2.0
- Created: 2024-10-19T14:25:31.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-05T13:22:23.000Z (about 1 month ago)
- Last Synced: 2025-04-11T01:11:20.358Z (29 days ago)
- Language: Rust
- Size: 1.16 MB
- Stars: 55
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE_APACHE
Awesome Lists containing this project
- awesome-tauri - tauri-plugin-blec - Cross platform Bluetooth Low Energy client based on `btleplug`. (Development / Plugins)
README
# Tauri Plugin blec
A BLE-Client plugin based on [btlelug](https://github.com/deviceplug/btleplug).
The main difference to using btleplug directly is that this uses the tauri plugin system for android.
All other platforms use the btleplug implementation.
## Docs
- [Rust docs](https://docs.rs/crate/tauri-plugin-blec/latest)
- [JavaScript docs](https://mnlphlp.github.io/tauri-plugin-blec/)
## Installation
### Install the rust part of the plugin:
```
cargo add tauri-plugin-blec
```
Or manually add it to the `src-tauri/Cargo.toml`
```toml
[dependencies]
tauri-plugin-blec = "0.4"
```
### Install the js bindings
use your preferred JavaScript package manager to add `@mnlphlp/plugin-blec`:
```
yarn add @mnlphlp/plugin-blec
```
```
npm add @mnlphlp/plugin-blec
```
### Register the plugin in Tauri
`src-tauri/src/lib.rs`
```rs
tauri::Builder::default()
.plugin(tauri_plugin_blec::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
```
### Allow calls from Frontend
Add `blec:default` to the permissions in your capabilities file.
[Explanation about capabilities](https://v2.tauri.app/security/capabilities/)
### IOS Setup
Add an entry to the info.plist of your app:
```xml
NSBluetoothAlwaysUsageDescription
The App uses Bluetooth to communicate with BLE devices
```
Add the CoreBluetooth Framework in your xcode procjet:
- open with `tauri ios dev --open`
- click on your project to open settings
- Add Framework under General -> Frameworks,Libraries and Embedded Content
## Usage in Frontend
See [examples/plugin-blec-example](examples/plugin-blec-example) for a full working example that scans for devices, connects and sends/receives data.
In order to use it run [examples/test-server](examples/test-server) on another device and connect to that server.
Short example:
```ts
import { connect, sendString } from '@mnlphlp/plugin-blec'
// get address by scanning for devices and selecting the desired one
let address = ...
// connect and run a callback on disconnect
await connect(address, () => console.log('disconnected'))
// send some text to a characteristic
const CHARACTERISTIC_UUID = '51FF12BB-3ED8-46E5-B4F9-D64E2FEC021B'
await sendString(CHARACTERISTIC_UUID, 'Test', 'withResponse')
```
## Usage in Backend
The plugin can also be used from the rust backend.
The handler returned by `get_handler()` is the same that is used by the frontend commands.
This means if you connect from the frontend you can send data from rust without having to call connect on the backend.
```rs
use uuid::{uuid, Uuid};
use tauri_plugin_blec::models::WriteType;
const CHARACTERISTIC_UUID: Uuid = uuid!("51FF12BB-3ED8-46E5-B4F9-D64E2FEC021B");
const DATA: [u8; 500] = [0; 500];
let handler = tauri_plugin_blec::get_handler().unwrap();
handler
.send_data(CHARACTERISTIC_UUID, &DATA, WriteType::WithResponse)
.await
.unwrap();
```