mtui 0.9.2

An extensive Modbus client for your terminal.
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

#[cfg(not(target_arch = "wasm32"))]
mod native {
    use clap::Parser;
    use mtui::app::{App, AppResult};
    use mtui::constants::EVENT_HANDLER_TICKRATE;
    use mtui::event::EventHandler;
    use mtui::logger;
    use mtui::tui::Tui;
    use ratatui::backend::CrosstermBackend;
    use ratatui::Terminal;
    use std::io;

    /// A TUI for Modbus reads and writes (RTU and TCP).
    #[derive(Parser)]
    #[command(version)]
    struct Args {
        /// Path to the configuration file [default: config.json]
        #[arg(long)]
        config: Option<String>,

        /// Create a default configuration file if none exists at the config path.
        #[arg(long)]
        make_config_if_none: bool,

        /// Run as an API server only, with no TUI; logs are printed to stderr.
        #[arg(long)]
        headless: bool,
    }

    #[tokio::main]
    pub async fn run() -> AppResult<()> {
        let args = Args::parse();
        logger::init();

        if args.headless {
            return run_headless(args.config, args.make_config_if_none).await;
        }

        let mut app = App::new(args.config, args.make_config_if_none).await;

        let writer = io::BufWriter::with_capacity(256 * 1024, io::stderr());
        let backend = CrosstermBackend::new(writer);
        let terminal = Terminal::new(backend)?;
        let events = EventHandler::new();
        let mut tui = Tui::new(terminal, events)?;

        while app.running {
            app.complete_background_task().await;
            tui.draw(&mut app)?;
            tui.process_events(&mut app).await?;
        }

        tui.exit()?;
        Ok(())
    }

    async fn run_headless(config: Option<String>, make_config_if_none: bool) -> AppResult<()> {
        logger::enable_echo();
        let mut app = App::new(config, make_config_if_none).await;
        app.headless = true;

        app.config
            .port
            .inspect(|port| log::info!("Headless mode - API server on port {port}"))
            .ok_or_else(|| {
                anyhow::anyhow!("Headless mode requires an API port; set `port` in the config")
            })?;

        let mut ticker = tokio::time::interval(EVENT_HANDLER_TICKRATE);
        while app.running {
            tokio::select! {
                _ = ticker.tick() => app.tick().await,
                _ = tokio::signal::ctrl_c() => {
                    log::info!("Shutdown requested, stopping");
                    break;
                }
            }
        }

        Ok(())
    }
}

#[cfg(not(target_arch = "wasm32"))]
fn main() -> mtui::app::AppResult<()> {
    native::run()
}

#[cfg(target_arch = "wasm32")]
fn main() {}