Crate bluer[−][src]

Expand description

BlueR - Official BlueZ Bindings for Rust

This library provides the official Rust interface to the Linux Bluetooth protocol stack (BlueZ). Both publishing local and consuming remote GATT services using idiomatic Rust code is supported. L2CAP sockets are presented using an API similar to Tokio networking.

This library depends on the tokio asynchronous runtime.

The following functionality is provided.

Bluetooth adapters
- enumeration
- configuration of power, discoverability, name, etc.
- hot-plug support through change events stream
Bluetooth devices
- discovery
- querying of address, name, class, signal strength (RSSI), etc.
- Bluetooth Low Energy advertisements
- change events stream
- connecting and pairing
consumption of remote GATT services
- GATT service discovery
- read, write and notify operations on characteristics
- read and write operations on characteristic descriptors
- optional use of low-overhead AsyncRead and AsyncWrite streams for notify and write operations
publishing local GATT services
- read, write and notify operations on characteristics
- read and write operations on characteristic descriptors
- two programming models supported
  - callback-based interface
  - low-overhead AsyncRead and AsyncWrite streams
sending Bluetooth Low Energy advertisements
Bluetooth authorization agent
efficient event dispatching
- not affected by D-Bus match rule count
- O(1) in number of subscriptions
L2CAP sockets
- stream oriented
- sequential packet oriented
- datagram oriented
- async IO interface with AsyncRead and AsyncWrite support
database of assigned numbers
- manufacturer ids
- GATT services, characteristics and descriptors

Currently, classic Bluetooth functionality is mostly unimplemented except for device discovery. However, pull requests and contributions are welcome!

Crate features

All crate features are enabled by default.

bluetoothd: Enables all functions requiring a running Bluetooth daemon.
id: Enables database of assigned numbers.
l2cap: Enables L2CAP sockets.

Basic usage

Create a Session using Session::new; this establishes a connection to the Bluetooth daemon. Then obtain a Bluetooth adapter using Session::adapter. From there on you can access most of the functionality using the methods provided by Adapter.