aranet_gui/lib.rs
1//! # Aranet GUI
2//!
3//! A native desktop GUI application for monitoring Aranet environmental sensors.
4//!
5//! ## Installation
6//!
7//! This crate provides a standalone binary. Install it with:
8//!
9//! ```sh
10//! cargo install aranet-gui
11//! ```
12//!
13//! Or via Homebrew on macOS:
14//!
15//! ```sh
16//! brew install cameronrye/aranet/aranet
17//! ```
18//!
19//! ## Usage
20//!
21//! Simply run the `aranet-gui` binary:
22//!
23//! ```sh
24//! aranet-gui
25//! ```
26//!
27//! ### Options
28//!
29//! - `--demo` - Run in demo mode with mock sensor data
30//! - `--screenshot <PATH>` - Take a screenshot and save to the specified path
31//! - `--screenshot-delay <N>` - Number of frames to wait before taking screenshot (default: 10)
32//!
33//! ## Features
34//!
35//! - Real-time sensor readings with color-coded CO2 levels
36//! - Support for Aranet4, Aranet2, AranetRn+, and Aranet Radiation sensors
37//! - Historical data visualization
38//! - Device settings configuration
39//! - Bluetooth Low Energy connectivity
40//!
41//! ## Library Usage
42//!
43//! This crate is primarily a binary application. For programmatic access to Aranet
44//! sensors, see the [`aranet-core`](https://docs.rs/aranet-core) crate.
45
46// This crate is a binary application; the library target exists for documentation purposes.