twinleaf-tools 2.3.0

Tools for the Twinleaf I/O protocol for reading data from Twinleaf quantum 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

mod capture;
mod dump;
mod health;
mod log;
mod monitor;
mod proxy;
mod rpc;
mod simulate;
mod upgrade;

pub use capture::CaptureCli;
pub use dump::DumpCli;
pub use health::HealthCli;
pub use log::{
    parse_csv_target, CsvTarget, LogCli, LogSubcommands, MetaSubcommands, SplitLevel, SplitPolicy,
    StreamSel,
};
pub use monitor::MonitorCli;
pub use proxy::{MountArg, ProxyCli, ProxySubcommands};
pub use rpc::{RPCSubcommands, RpcCli};
pub use simulate::SimulateCli;
pub use upgrade::UpgradeCli;

use clap::{Parser, Subcommand};
use clap_complete::Shell;

pub(crate) fn nonneg_f64(s: &str) -> Result<f64, String> {
    let v: f64 = s
        .parse()
        .map_err(|e: std::num::ParseFloatError| e.to_string())?;
    if v < 0.0 {
        Err("must be >= 0".into())
    } else {
        Ok(v)
    }
}

#[derive(Parser, Debug)]
#[command(
    name = "tio",
    version,
    about = "Twinleaf sensor management and data logging tool",
    disable_help_subcommand = true
)]
pub struct TioCli {
    #[command(subcommand)]
    pub command: Commands,
}

#[derive(Subcommand, Debug)]
pub enum Commands {
    /// List connected devices
    List {
        /// Include serial ports with unknown VID/PID
        #[arg(short = 'a', long = "all")]
        all: bool,
    },

    /// Live sensor data display
    Monitor(MonitorCli),

    /// Live timing and rate diagnostics
    Health(HealthCli),

    /// Dump raw packets from a device
    Dump(DumpCli),

    /// Log samples to a file
    Log(LogCli),

    /// Execute a device RPC
    Rpc(RpcCli),

    /// Trigger and read a capture RPC
    Capture(CaptureCli),

    /// Upgrade device firmware
    #[command(alias = "firmware-upgrade")]
    Upgrade(UpgradeCli),

    /// Multiplex a sensor over TCP
    Proxy(ProxyCli),

    /// Run a simulated sine wave Twinleaf device over UDP
    Simulate(SimulateCli),

    /// (deprecated, use `simulate`) Run a simulated sine wave Twinleaf device over UDP
    #[command(hide = true)]
    Test(SimulateCli),

    /// Generate shell completions for tio
    #[command(long_about = "\
Generate shell completions for tio.

Add one of these lines to your shell's config file:

  Bash (~/.bashrc):
    eval \"$(tio completions bash)\"

  Zsh (~/.zshrc):
    eval \"$(tio completions zsh)\"

  Fish (~/.config/fish/config.fish):
    tio completions fish | source

  PowerShell ($PROFILE):
    tio completions powershell | Invoke-Expression")]
    Completions {
        #[arg(value_enum)]
        shell: Shell,
    },
}