peat-btle 0.3.0

Bluetooth Low Energy mesh transport for Peat Protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

// Copyright (c) 2025-2026 (r)evolve - Revolve Team LLC
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Apple platform implementation (iOS/macOS)
//!
//! This module provides the BLE adapter implementation for Apple platforms using
//! CoreBluetooth framework bindings via the `objc2` crate.
//!
//! ## Requirements
//!
//! ### iOS
//! - iOS 13.0 or later
//! - `NSBluetoothAlwaysUsageDescription` in Info.plist
//! - Background modes: `bluetooth-central`, `bluetooth-peripheral`
//!
//! ### macOS
//! - macOS 10.15 (Catalina) or later
//! - Bluetooth entitlement in app sandbox
//!
//! ## Architecture
//!
//! CoreBluetooth uses a delegate-based pattern where callbacks are delivered
//! to Objective-C delegate objects. This module bridges those delegates to
//! Rust async channels.
//!
//! ```text
//! ┌─────────────────────────────────────────┐
//! │       CoreBluetoothAdapter (Rust)        │
//! ├─────────────────────────────────────────┤
//! │  CentralManager    │  PeripheralManager │
//! │   (scanning,       │   (advertising,    │
//! │    connecting)     │    GATT server)    │
//! ├─────────────────────────────────────────┤
//! │           Objective-C Delegates          │
//! │  (CentralDelegate, PeripheralDelegate)  │
//! ├─────────────────────────────────────────┤
//! │            CoreBluetooth Framework       │
//! └─────────────────────────────────────────┘
//! ```
//!
//! ## Usage
//!
//! ```ignore
//! use peat_btle::platform::apple::CoreBluetoothAdapter;
//! use peat_btle::{BleConfig, NodeId};
//!
//! let config = BleConfig::new(NodeId::new(0x12345678));
//! let mut adapter = CoreBluetoothAdapter::new()?;
//! adapter.init(&config).await?;
//! adapter.start().await?;
//! ```
//!
//! ## CoreBluetooth Concepts
//!
//! - **CBCentralManager**: Scans for and connects to peripherals (GATT client)
//! - **CBPeripheralManager**: Advertises and hosts GATT services (GATT server)
//! - **CBPeripheral**: Represents a remote BLE device
//! - **CBService/CBCharacteristic**: GATT service and characteristic objects
//!
//! ## iOS Background Execution
//!
//! For iOS apps to use BLE in the background, add to Info.plist:
//!
//! ```xml
//! <key>UIBackgroundModes</key>
//! <array>
//!     <string>bluetooth-central</string>
//!     <string>bluetooth-peripheral</string>
//! </array>
//! <key>NSBluetoothAlwaysUsageDescription</key>
//! <string>Peat uses Bluetooth to sync data with nearby devices</string>
//! ```

mod adapter;
mod central;
mod connection;
mod delegates;
mod peripheral;

pub use adapter::CoreBluetoothAdapter;
pub use connection::CoreBluetoothConnection;

// Export peripheral events for handling GATT client operations
pub use delegates::PeripheralEvent;

// These are used internally by adapter.rs
#[allow(unused_imports)]
pub(crate) use central::CentralManager;
#[allow(unused_imports)]
pub(crate) use peripheral::PeripheralManager;