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

// 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.

//! Windows platform implementation (WinRT Bluetooth APIs)
//!
//! This module provides the BLE adapter implementation for Windows using
//! the WinRT Bluetooth APIs via the `windows` crate.
//!
//! ## Requirements
//!
//! - Windows 10 version 1703+ (Creators Update) for scanning/connecting
//! - Windows 10 version 1803+ (April 2018 Update) for GATT server
//! - BLE-capable Bluetooth adapter
//!
//! ## Architecture
//!
//! Windows BLE uses two separate APIs:
//! - **Advertisement API**: For scanning (`BluetoothLEAdvertisementWatcher`) and
//!   broadcasting (`BluetoothLEAdvertisementPublisher`)
//! - **GATT API**: For client/server operations (`GattDeviceService`, `GattServiceProvider`)
//!
//! ```text
//! ┌─────────────────────────────────────────┐
//! │       WinRtBleAdapter (Rust)            │
//! ├─────────────────────────────────────────┤
//! │     Watcher      │      Publisher       │
//! │   (scanning)     │    (advertising)     │
//! ├─────────────────────────────────────────┤
//! │  GattClient      │    GattServer        │
//! │  (connecting,    │   (hosting Peat      │
//! │   reading)       │    service)          │
//! ├─────────────────────────────────────────┤
//! │           WinRT Bluetooth APIs          │
//! └─────────────────────────────────────────┘
//! ```
//!
//! ## Usage
//!
//! ```ignore
//! use peat_btle::platform::windows::WinRtBleAdapter;
//! use peat_btle::{BleConfig, NodeId};
//!
//! let config = BleConfig::new(NodeId::new(0x12345678));
//! let mut adapter = WinRtBleAdapter::new()?;
//! adapter.init(&config).await?;
//! adapter.start().await?;
//! ```
//!
//! ## Windows Version Notes
//!
//! | Feature | Minimum Version |
//! |---------|-----------------|
//! | BLE Scanning | Windows 10 1703 |
//! | BLE Advertising | Windows 10 1703 |
//! | GATT Client | Windows 10 1703 |
//! | GATT Server | Windows 10 1803 |
//! | Extended Advertising | Windows 10 1903 |

mod adapter;
mod advertiser;
mod connection;
mod gatt_server;
mod watcher;

pub use adapter::WinRtBleAdapter;
pub use connection::WinRtConnection;