peat-btle 0.3.1

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

//! Peat-Lite Sync Protocol
//!
//! Efficient CRDT synchronization over BLE GATT characteristics.
//!
//! ## Overview
//!
//! This module provides the sync layer for Peat-Lite nodes, enabling
//! efficient state synchronization over bandwidth-constrained BLE links.
//!
//! ## Key Components
//!
//! - **CRDTs**: Conflict-free replicated data types (LWW-Register, G-Counter)
//! - **Batching**: Accumulates changes to reduce radio activity
//! - **Delta Encoding**: Only sends changes since last sync
//! - **Chunking**: Splits large messages across MTU boundaries
//!
//! ## Architecture
//!
//! ```text
//! ┌────────────────────────────────────────────────────┐
//! │                  Application                        │
//! │    (position updates, health status, alerts)       │
//! └─────────────────────┬──────────────────────────────┘
//!                       │
//!                       ▼
//! ┌────────────────────────────────────────────────────┐
//! │              GattSyncProtocol                       │
//! │  ┌──────────────┐  ┌────────────┐  ┌────────────┐  │
//! │  │    Batch     │  │   Delta    │  │  Chunked   │  │
//! │  │ Accumulator  │─▶│  Encoder   │─▶│  Transfer  │  │
//! │  └──────────────┘  └────────────┘  └────────────┘  │
//! └─────────────────────┬──────────────────────────────┘
//!                       │
//!                       ▼
//! ┌────────────────────────────────────────────────────┐
//! │              GATT Characteristics                   │
//! │           (Sync Data, Sync State)                  │
//! └────────────────────────────────────────────────────┘
//! ```
//!
//! ## Usage
//!
//! ```ignore
//! use peat_btle::sync::{GattSyncProtocol, SyncConfig, CrdtOperation, Position};
//! use peat_btle::NodeId;
//!
//! // Create sync protocol
//! let mut sync = GattSyncProtocol::new(
//!     NodeId::new(0x12345678),
//!     SyncConfig::default(),
//! );
//!
//! // Add a peer
//! sync.add_peer(&peer_id);
//!
//! // Queue position update
//! sync.queue_operation(CrdtOperation::UpdatePosition {
//!     node_id: my_node_id,
//!     position: Position::new(37.7749, -122.4194),
//!     timestamp: current_time_ms,
//! });
//!
//! // Check if time to sync
//! if sync.should_sync() {
//!     let chunks = sync.prepare_sync(&peer_id);
//!     for chunk in chunks {
//!         // Write chunk to GATT characteristic
//!         gatt.write_sync_data(&chunk.encode());
//!     }
//! }
//!
//! // Process received data
//! if let Some(ops) = sync.process_received(chunk, &peer_id) {
//!     for op in ops {
//!         // Apply CRDT operation to local state
//!         apply_operation(op);
//!     }
//! }
//! ```
//!
//! ## Power Efficiency
//!
//! The sync protocol is designed for constrained devices:
//!
//! | Feature | Benefit |
//! |---------|---------|
//! | Batching | Reduces sync frequency (less radio time) |
//! | Delta Encoding | Sends only changes (less bytes) |
//! | Configurable Intervals | Trade freshness for battery |
//! | Compact CRDT Encoding | Minimal overhead |
//!
//! ## Sync Profiles
//!
//! ```ignore
//! // For smartwatch (battery critical)
//! let config = SyncConfig::low_power();
//!
//! // For tablet (responsiveness preferred)
//! let config = SyncConfig::responsive();
//! ```

pub mod batch;
pub mod crdt;
pub mod delta;
pub mod delta_document;
pub mod protocol;

pub use batch::{BatchAccumulator, BatchConfig, OperationBatch};
#[cfg(feature = "legacy-chat")]
pub use crdt::{ChatCRDT, ChatMessage, CHAT_MAX_MESSAGES, CHAT_MAX_SENDER_LEN, CHAT_MAX_TEXT_LEN};
pub use crdt::{
    CrdtOperation, EventType, GCounter, HealthStatus, LwwRegister, Peripheral, PeripheralEvent,
    PeripheralType, Position, Timestamp,
};
pub use delta::{DeltaEncoder, DeltaStats, PeerSyncState, VectorClock};
pub use delta_document::{DeltaDocument, DeltaFlags, Operation, DELTA_DOCUMENT_MARKER};
pub use protocol::{
    chunk_data, ChunkHeader, ChunkReassembler, GattSyncProtocol, SyncChunk, SyncConfig, SyncState,
    SyncStats, CHUNK_HEADER_SIZE, DEFAULT_MTU, MAX_MTU,
};