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