Rename to egui_serial_term

- Serial TTY considered TerminalBackend
- PTY prefix to TTY
- macOS PL2303 hotfix (serialport/serialport-rs#194 (comment))
- basic example for serial monitor

Author: pmnxis

Cargo.lock

@@ -1,10 +1,10 @@
 [package]
-name = "egui_term"
-description = "Terminal emulator widget powered by EGUI framework and alacritty terminal backend."
-authors = ["Ilya Shvyryalkin <[email protected]>"]
+name = "egui_serial_term"
+description = "Serial monitor widget powered by EGUI framework and alacritty terminal backend."
+authors = ["Jinwoo Park <[email protected]>", "Ilya Shvyryalkin <[email protected]>"]
 version = "0.1.0"
 edition = "2021"
-repository = "https://github.com/Harzu/egui_term"
+repository = "https://github.com/pmnxis/egui_serial_term"
 categories = ["gui", "terminal", "tty", "shell"]
 license = "MIT"
 

Cargo.toml

@@ -1,16 +1,15 @@
 <div align="center">
 
-# egui_term
+# egui_serial_term
 
-![GitHub License](https://img.shields.io/github/license/Harzu/iced_term)
+![GitHub License](https://img.shields.io/github/license/pmxnis/egui_serial_term)
 
 Terminal emulator widget powered by EGUI framework and alacritty terminal backend.
 
-<a href="./examples/full_screen">
-  <img src="examples/full_screen/assets/screenshot.png" width="275px">
-</a>
-<a href="./examples/tabs">
-  <img src="examples/tabs/assets/screenshot.png" width="273px">
+Forked from [egui_term](https://github.com/Harzu/egui_term) to use serial TTY monitor.
+
+<a href="./examples/serial_monitor">
+  <img src="examples/serial_monitor/assets/screenshot.png" width="275px">
 </a>
 
 </div>
@@ -19,7 +18,7 @@ Terminal emulator widget powered by EGUI framework and alacritty terminal backen
 
 The widget is currently under development and does not provide full terminal features make sure that widget is covered everything you want.
 
-- PTY content rendering
+- TTY content rendering
 - Multiple instance support
 - Basic keyboard input
 - Adding custom keyboard or mouse bindings
@@ -36,11 +35,7 @@ This widget tested on MacOS and Linux and is not tested on Windows.
 
 You can also look at [examples](./examples) directory for more information about widget using.
 
-- [full_screen](./examples/full_screen/) - The basic example of terminal emulator.
-- [tabs](./examples/tabs/) - The example with tab widget that show how multiple instance feature work.
-- [custom_bindings](./examples/custom_bindings/) - The example that show how you can add custom keyboard or mouse bindings to your terminal emulator app.
-- [themes](./examples/themes/) - The example that show how you can change terminal color scheme.
-- [fonts](./examples/fonts/) - The examples that show how you can change font type or font size in your terminal emulator app.
+- [serial_monitor](./examples/serial_monitor/) - The basic example of serial monitor.
 
 ## Dependencies
 

README.md

@@ -1,13 +1,13 @@
 use egui::{Key, Modifiers, Vec2};
-use egui_term::{
+use egui_serial_term::{
     generate_bindings, Binding, BindingAction, InputKind, KeyboardBinding,
-    PtyEvent, TerminalBackend, TerminalMode, TerminalView,
+    TtyEvent, TerminalBackend, TerminalMode, TerminalView,
 };
 use std::sync::mpsc::Receiver;
 
 pub struct App {
     terminal_backend: TerminalBackend,
-    pty_proxy_receiver: Receiver<(u64, egui_term::PtyEvent)>,
+    pty_proxy_receiver: Receiver<(u64, egui_term::TtyEvent)>,
     custom_terminal_bindings: Vec<(Binding<InputKind>, BindingAction)>,
 }
 
@@ -79,7 +79,7 @@ impl App {
 
 impl eframe::App for App {
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        if let Ok((_, PtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
+        if let Ok((_, TtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
             ctx.send_viewport_cmd(egui::ViewportCommand::Close);
             return;
         }

examples/custom_bindings/src/app.rs

@@ -1,6 +1,6 @@
 use egui::{FontId, Vec2};
 use egui_term::{
-    FontSettings, PtyEvent, TerminalBackend, TerminalFont, TerminalView,
+    FontSettings, TtyEvent, TerminalBackend, TerminalFont, TerminalView,
 };
 use std::sync::{mpsc::Receiver, Arc};
 
@@ -49,7 +49,7 @@ fn setup_font(ctx: &egui::Context, name: &str) {
 pub struct App {
     terminal_backend: TerminalBackend,
     font_size: f32,
-    pty_proxy_receiver: Receiver<(u64, egui_term::PtyEvent)>,
+    pty_proxy_receiver: Receiver<(u64, egui_term::TtyEvent)>,
 }
 
 impl App {
@@ -81,7 +81,7 @@ impl App {
 
 impl eframe::App for App {
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        if let Ok((_, PtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
+        if let Ok((_, TtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
             ctx.send_viewport_cmd(egui::ViewportCommand::Close);
             return;
         }

examples/fonts/src/app.rs

@@ -1,10 +1,10 @@
 use egui::Vec2;
-use egui_term::{PtyEvent, TerminalBackend, TerminalView};
+use egui_term::{TtyEvent, TerminalBackend, TerminalView};
 use std::sync::mpsc::Receiver;
 
 pub struct App {
     terminal_backend: TerminalBackend,
-    pty_proxy_receiver: Receiver<(u64, egui_term::PtyEvent)>,
+    pty_proxy_receiver: Receiver<(u64, egui_term::TtyEvent)>,
 }
 
 impl App {
@@ -34,7 +34,7 @@ impl App {
 
 impl eframe::App for App {
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        if let Ok((_, PtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
+        if let Ok((_, TtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
             ctx.send_viewport_cmd(egui::ViewportCommand::Close);
             return;
         }

examples/full_screen/src/app.rs

@@ -11,7 +11,7 @@ eframe = { version = "0.31.0", default-features = false, features = [
     "persistence",   # Enable restoring app state when restarting the app.
 ] }
 log = "0.4"
-egui_term = { path = "../../" }
+egui_serial_term = { path = "../../" }
 mio-serial = { version = "5.0.6", features = ["libudev", "serde"] }
 
 # native:

examples/serial_monitor/Cargo.lock

@@ -1,6 +1,6 @@
 use egui::{Color32, RichText, Vec2};
-use egui_term::{PtyEvent, SerialMonitorView, TerminalTheme};
-use egui_term::{SerialMonitorBackend, SerialTtyOptions};
+use egui_serial_term::{TtyEvent, SerialMonitorView, TerminalTheme};
+use egui_serial_term::{SerialMonitorBackend, SerialTtyOptions};
 use mio_serial::{DataBits, FlowControl, Parity, StopBits};
 use std::sync::mpsc::{Receiver, Sender};
 
@@ -21,8 +21,8 @@ pub struct App {
     tty_list: Vec<String>,
     tty_conn: SerialTtyOptions,
     last_failed: Option<std::time::Instant>,
-    pty_proxy_sender: Sender<(u64, egui_term::PtyEvent)>,
-    pty_proxy_receiver: Receiver<(u64, egui_term::PtyEvent)>,
+    pty_proxy_sender: Sender<(u64, egui_serial_term::TtyEvent)>,
+    pty_proxy_receiver: Receiver<(u64, egui_serial_term::TtyEvent)>,
 }
 
 impl App {
@@ -53,7 +53,7 @@ impl App {
 
 impl eframe::App for App {
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        if let Ok((_, PtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
+        if let Ok((_, TtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
             ctx.send_viewport_cmd(egui::ViewportCommand::Close);
             return;
         }

examples/serial_monitor/Cargo.toml

@@ -2,7 +2,7 @@ use eframe::epaint::FontId;
 use egui::{Context, Ui};
 use egui_dock::{DockArea, DockState, NodeIndex, Style};
 use egui_term::{
-    BackendSettings, FontSettings, PtyEvent, TerminalBackend, TerminalFont,
+    BackendSettings, FontSettings, TtyEvent, TerminalBackend, TerminalFont,
     TerminalView,
 };
 use log::error;
@@ -35,7 +35,7 @@ pub struct Tab {
 }
 
 impl Tab {
-    pub fn term(ctx: Context, command_sender: Sender<(u64, PtyEvent)>) -> Self {
+    pub fn term(ctx: Context, command_sender: Sender<(u64, TtyEvent)>) -> Self {
         let id = GLOBAL_COUNTER.next();
         let backend = TerminalBackend::new(
             id,
@@ -50,7 +50,7 @@ impl Tab {
 }
 
 struct TabViewer<'a> {
-    command_sender: &'a Sender<(u64, PtyEvent)>,
+    command_sender: &'a Sender<(u64, TtyEvent)>,
 }
 
 impl egui_dock::TabViewer for TabViewer<'_> {
@@ -71,7 +71,7 @@ impl egui_dock::TabViewer for TabViewer<'_> {
     }
 
     fn on_close(&mut self, tab: &mut Self::Tab) -> bool {
-        match self.command_sender.send((tab.id, PtyEvent::Exit)) {
+        match self.command_sender.send((tab.id, TtyEvent::Exit)) {
             Err(err) => {
                 error!("close tab {} failed: {err}", tab.id);
                 false
@@ -82,7 +82,7 @@ impl egui_dock::TabViewer for TabViewer<'_> {
 }
 
 pub struct App {
-    command_sender: Sender<(u64, PtyEvent)>,
+    command_sender: Sender<(u64, TtyEvent)>,
     dock_state: DockState<Tab>,
 }
 

examples/serial_monitor/src/app.rs

@@ -1,12 +1,12 @@
-use egui_term::{PtyEvent, TerminalBackend, TerminalView};
+use egui_term::{TtyEvent, TerminalBackend, TerminalView};
 use std::{
     collections::BTreeMap,
     sync::mpsc::{self, Receiver, Sender},
 };
 
 pub struct App {
-    command_sender: Sender<(u64, egui_term::PtyEvent)>,
-    command_receiver: Receiver<(u64, egui_term::PtyEvent)>,
+    command_sender: Sender<(u64, egui_term::TtyEvent)>,
+    command_receiver: Receiver<(u64, egui_term::TtyEvent)>,
     tab_manager: TabManager,
 }
 
@@ -29,10 +29,10 @@ impl eframe::App for App {
 
         if let Ok((tab_id, event)) = self.command_receiver.try_recv() {
             match event {
-                egui_term::PtyEvent::Exit => {
+                egui_term::TtyEvent::Exit => {
                     self.tab_manager.remove(tab_id);
                 },
-                egui_term::PtyEvent::Title(title) => {
+                egui_term::TtyEvent::Title(title) => {
                     self.tab_manager.set_title(tab_id, title);
                 },
                 _ => {},
@@ -88,7 +88,7 @@ impl TabManager {
 
     fn add(
         &mut self,
-        command_sender: Sender<(u64, PtyEvent)>,
+        command_sender: Sender<(u64, TtyEvent)>,
         ctx: egui::Context,
     ) {
         let id = self.tabs.len() as u64;
@@ -156,7 +156,7 @@ struct Tab {
 impl Tab {
     fn new(
         ctx: egui::Context,
-        command_sender: Sender<(u64, PtyEvent)>,
+        command_sender: Sender<(u64, TtyEvent)>,
         id: u64,
     ) -> Self {
         let system_shell = std::env::var("SHELL")

examples/split_view/src/app.rs

@@ -1,13 +1,13 @@
 use egui::Vec2;
 use egui_term::{
-    ColorPalette, PtyEvent, TerminalBackend, TerminalTheme, TerminalView,
+    ColorPalette, TtyEvent, TerminalBackend, TerminalTheme, TerminalView,
 };
 use std::sync::mpsc::Receiver;
 
 pub struct App {
     terminal_backend: TerminalBackend,
     terminal_theme: TerminalTheme,
-    pty_proxy_receiver: Receiver<(u64, egui_term::PtyEvent)>,
+    pty_proxy_receiver: Receiver<(u64, egui_term::TtyEvent)>,
 }
 
 impl App {
@@ -38,7 +38,7 @@ impl App {
 
 impl eframe::App for App {
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
-        if let Ok((_, PtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
+        if let Ok((_, TtyEvent::Exit)) = self.pty_proxy_receiver.try_recv() {
             ctx.send_viewport_cmd(egui::ViewportCommand::Close);
             return;
         }

examples/tabs/src/app.rs

@@ -26,7 +26,7 @@ use std::sync::mpsc::Sender;
 use std::sync::{mpsc, Arc};
 
 pub type TerminalMode = TermMode;
-pub type PtyEvent = Event;
+pub type TtyEvent = Event;
 pub type SelectionType = AlacrittySelectionType;
 
 #[derive(Debug, Clone)]
@@ -146,7 +146,7 @@ impl SerialMonitorBackend {
     pub fn new(
         id: u64,
         app_context: egui::Context,
-        pty_event_proxy_sender: Sender<(u64, PtyEvent)>,
+        pty_event_proxy_sender: Sender<(u64, TtyEvent)>,
         serial_settings: SerialTtyOptions,
     ) -> Result<Self> {
         let config = term::Config::default();
@@ -178,7 +178,7 @@ impl SerialMonitorBackend {
                         pty_event_proxy_sender
                             .send((id, event.clone()))
                             .unwrap_or_else(|_| {
-                                panic!("pty_event_subscription_{}: sending PtyEvent is failed", id)
+                                panic!("pty_event_subscription_{}: sending TtyEvent is failed", id)
                             });
                         app_context.clone().request_repaint();
                         if let Event::Exit = event {

examples/themes/src/app.rs

@@ -8,7 +8,7 @@ mod view;
 
 // pub use backend::settings::BackendSettings;
 pub use backend::{
-    BackendCommand, PtyEvent, SerialMonitorBackend, TerminalMode,
+    BackendCommand, SerialMonitorBackend, TerminalMode, TtyEvent,
 };
 pub use bindings::{Binding, BindingAction, InputKind, KeyboardBinding};
 pub use font::{FontSettings, TerminalFont};