Skip to main content

drew_connect/
lib.rs

1// Copyright (C) 2026 Jorge Andre Castro
2// GPL-2.0-or-later
3
4//! # drew-connect
5//!
6//! Couche d'I/O et de décodage de télémétrie, **agnostique et modulaire**.
7//!
8//! La bibliothèque repose sur deux traits totalement indépendants l'un de
9//! l'autre :
10//!
11//! - [`Transport`] : une source d'octets bruts (port série, socket UDP,
12//!   fichier, mock de test, etc.)
13//! - [`Decoder`] : la traduction de ces octets en un type de paquet
14//!   quelconque (le trait est générique sur `Output`, il ne connaît donc
15//!   rien de spécifique à la télémétrie)
16//!
17//! [`ConnectionWorker`] assemble les deux dans un thread de fond et expose
18//! un canal non bloquant. Grâce à cette séparation :
19//!
20//! - un transport peut être remplacé par un autre sans toucher au décodeur
21//!   (ni réciproquement)
22//! - un format propriétaire peut être décodé sans dépendre de JSON ni de
23//!   `serde`
24//! - les tests peuvent utiliser un `Transport`/`Decoder` factice, sans
25//!   matériel réel
26//!
27//! ## Features
28//!
29//! | Feature  | Ajoute                   | Débloque |
30//! |----------|--------------------------|----------|
31//! | `json`   | `serde`, `serde_json`    | `JsonDecoder`, dérive `Serialize`/`Deserialize` sur `TelemetryPacket` |
32//! | `serial` | `serialport`             | `SerialTransport` (UART/USB) |
33//! | `udp`    | *(rien, std uniquement)* | `UdpTransport` (Wi-Fi/Ethernet) |
34//!
35//! [`BinaryDecoder`] est toujours disponible : il ne dépend que de
36//! `core`/`std`, aucune feature requise.
37//!
38//! Aucune feature n'est activée par défaut : ajoutez uniquement celles dont
39//! votre binaire a besoin.
40//!
41//! ## Exemple minimal
42//!
43//! ```no_run
44//! # #[cfg(feature = "udp")]
45//! # fn main() -> std::io::Result<()> {
46//! use drew_connect::{ConnectionWorker, UdpTransport, BinaryDecoder};
47//!
48//! let transport = UdpTransport::bind("0.0.0.0:9000")?;
49//! let worker = ConnectionWorker::spawn(transport, BinaryDecoder);
50//!
51//! if let Some(packet) = worker.try_recv() {
52//!     println!("{packet:?}");
53//! }
54//! # Ok(())
55//! # }
56//! # #[cfg(not(feature = "udp"))]
57//! # fn main() {}
58//! ```
59//!
60//! ## Étendre la bibliothèque
61//!
62//! Un décodeur ou un transport maison n'a pas besoin de vivre dans ce
63//! crate : il suffit d'implémenter [`Decoder`] ou [`Transport`] dans votre
64//! propre code, puis de le passer à [`ConnectionWorker::spawn`] comme
65//! n'importe quelle implémentation fournie ici.
66
67pub mod decoder;
68pub mod transport;
69pub mod worker;
70
71pub use decoder::{BinaryDecoder, Decoder, TelemetryPacket};
72#[cfg(feature = "json")]
73pub use decoder::JsonDecoder;
74
75pub use transport::Transport;
76#[cfg(feature = "serial")]
77pub use transport::SerialTransport;
78#[cfg(feature = "udp")]
79pub use transport::UdpTransport;
80
81pub use worker::ConnectionWorker;