aranet-cli 0.2.0

Command-line interface for Aranet environmental sensors
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

#![deny(unsafe_code)]

//! Command-line interface for Aranet environmental sensors.
//!
//! This crate provides a comprehensive CLI for interacting with Aranet devices
//! including the Aranet4, Aranet2, AranetRn+ (Radon), and Aranet Radiation sensors.
//!
//! # Features
//!
//! - **Device scanning**: Discover nearby Aranet devices via BLE
//! - **Current readings**: Display real-time sensor values with color-coded status
//! - **Historical data**: Download and export measurement history
//! - **Device configuration**: Adjust measurement interval, Bluetooth range, and Smart Home mode
//! - **Continuous monitoring**: Watch mode for ongoing data collection
//! - **Multiple output formats**: Text, JSON, and CSV output support
//! - **Configuration file**: Persistent settings for default device and preferences
//! - **Shell completions**: Generate completions for bash, zsh, fish, and PowerShell
//!
//! # Commands
//!
//! | Command | Description |
//! |---------|-------------|
//! | `scan` | Scan for nearby Aranet devices |
//! | `read` | Read current sensor values |
//! | `status` | Quick one-line status display |
//! | `history` | Download historical data |
//! | `info` | Display device information |
//! | `set` | Configure device settings |
//! | `watch` | Continuously monitor a device |
//! | `config` | Manage CLI configuration |
//! | `alias` | Manage device aliases |
//! | `sync` | Sync history to the local cache |
//! | `cache` | Query cached data |
//! | `report` | Summarize cached history |
//! | `doctor` | Run Bluetooth diagnostics |
//! | `completions` | Generate shell completions |
//!
//! # Output Formats
//!
//! The CLI supports three output formats:
//!
//! - **Text** (default): Human-readable colored output
//! - **JSON**: Machine-readable JSON format
//! - **CSV**: Comma-separated values for spreadsheets and data analysis
//!
//! # Configuration
//!
//! The CLI stores configuration in `~/.config/aranet/config.toml` (or platform equivalent).
//! Configuration options include:
//!
//! - `device`: Default device address
//! - `format`: Default output format
//! - `no_color`: Disable colored output
//! - `fahrenheit`: Use Fahrenheit for temperature display
//!
//! # Environment Variables
//!
//! - `ARANET_DEVICE`: Default device address (overridden by `--device` flag)
//! - `NO_COLOR`: Disable colored output when set
//!
//! # Examples
//!
//! Scan for devices:
//! ```bash
//! aranet scan
//! ```
//!
//! Read current values from a specific device:
//! ```bash
//! aranet read --device AA:BB:CC:DD:EE:FF
//! ```
//!
//! Download history as CSV:
//! ```bash
//! aranet history --device AA:BB:CC:DD:EE:FF --format csv --output data.csv
//! ```
//!
//! Watch a device continuously:
//! ```bash
//! aranet watch --device AA:BB:CC:DD:EE:FF --interval 60
//! ```
//!
//! Set measurement interval:
//! ```bash
//! aranet set --device AA:BB:CC:DD:EE:FF interval 5
//! ```

// This crate is primarily a binary CLI application.
// The main entry point and command implementations are in main.rs.
// This lib.rs serves as documentation and could be extended to expose
// public APIs for programmatic use if needed in the future.

// Re-export core dependencies for convenience
pub use aranet_core;
pub use aranet_types;

/// Get the current local time formatted with the given `time` format description string.
///
/// Falls back to UTC if the local timezone cannot be determined.
pub fn local_now_fmt(fmt: &str) -> String {
    let now = time::OffsetDateTime::now_local().unwrap_or_else(|_| time::OffsetDateTime::now_utc());
    let format = time::format_description::parse(fmt).unwrap_or_default();
    now.format(&format).unwrap_or_default()
}

// Config module - needed by both TUI and GUI
pub mod config;

// TUI module - publicly exposed for aranet-tui crate to use
#[cfg(feature = "tui")]
pub mod tui;

// GUI module - publicly exposed for aranet-gui crate to use
#[cfg(feature = "gui")]
pub mod gui;