First version sent to some friends! Comments in examples, sync some TODOs, etc

Author: nullstalgia

build.rs

@@ -6,6 +6,7 @@ fn main() {
     let items_to_copy = [
         "example_configs/yap_colors.toml",
         "example_configs/yap_espflash_profiles.toml",
+        "example_configs/yap_keybinds.toml",
         "example_configs/macros",
     ];
 

example_configs/macros/example_macros.toml

@@ -1,4 +1,10 @@
-name = "Examples"
+# [[macro]]
+# name = "My Cool Macro" ## name in UI and for assigning macro to keybind
+# category = "Cool Guy Macros" ## (optional) group macros in the UI
+# content = "ping 1.1.1.1" ## content to send
+# line_ending = "\n\n\n" ## (optional) if not provided, uses the configured Macro line ending in Port Settings
+
+name = "Examples" ## name is optional, if missing, will use file name
 
 [[macro]]
 name = "Backspace"

example_configs/macros/openshock.toml

@@ -1,4 +1,4 @@
-name = "OpenShock"
+name = "OpenShock" ## name is optional, if missing, will use file name
 
 [[macro]]
 name = "Version"

example_configs/macros/openshock_setup.toml

@@ -1,4 +1,4 @@
-name = "OpenShock Setup"
+name = "OpenShock Setup" ## name is optional, if missing, will use file name
 
 [[macro]]
 name = "Factory Reset"
@@ -15,13 +15,13 @@ content = "keepalive false"
 
 [[macro]]
 name = "Setup Authtoken"
-content = "authtoken "
-sensitive = true
+content = 'authtoken '
+sensitive = true ## sensitive macro contents are hidden from view in-app
 
 [[macro]]
 name = "Setup Networks"
-content = "networks "
-sensitive = true
+content = 'networks []'
+sensitive = true ## sensitive macro contents are hidden from view in-app
 
 [[macro]]
 name = "CaiX Vib (ID 12345, 0.5s)"

example_configs/yap_colors.toml

@@ -1,3 +1,14 @@
+# Color Highlight Rule Example: case-insensitive match
+# Example
+# [[regex]] ## type of rule (regex/literal)
+# rule = '(?i)lorem' ## rule contents
+# line = true ## affect the whole line if any match found within
+# color = "cyan" ## ansi/hex color to highlight matches (optional if any below used)
+# censor = false ## if true, replace the matched content (or whole line) with `*`
+# hide = false ## if true, remove the matched content (or whole line) entirely.
+
+# Note: hidden/censored contents are still saved to log files raw.
+
 [[regex]]
 rule = '^\[\s*\d+\]\[D\]\[[^\]:]+(?::\d+)?\]'
 color = "blue"

example_configs/yap_espflash_profiles.toml

@@ -1,7 +1,28 @@
-# [[elf]]
-# #partition_table = "../"
-# chip = "esp32s3"
-# upload_baud = 921600
+# .bin example
+# [[bin]] ## type of profile (bin/elf)
+# name = "PlatformIO Core v2 Build" ## name in macros and UI
+# 0x0 = 'C:\Users\nullstalgia\Documents\PlatformIO\Projects\OpenShock\.pio\build\OpenShock-Core-V2\bootloader.bin' ## provide an offset then a binary
+# 0x8000 = 'C:\Users\nullstalgia\Documents\PlatformIO\Projects\OpenShock\.pio\build\OpenShock-Core-V2\partitions.bin'
+# 0xe000 = 'C:\Users\nullstalgia\.platformio\packages\framework-arduinoespressif32\tools\partitions\boot_app0.bin'
+# 0x10000 = 'C:\Users\nullstalgia\Documents\PlatformIO\Projects\OpenShock\.pio\build\OpenShock-Core-V2\app.bin'
+# chip = "esp32s3" ## expected chip, required. (set any_chip to true to skip check)
+# upload_baud = 2000000
+# any_chip = false ## (default: false) skip checking connected device matches expected chip
+# no_verify = false ## (default: false) skip verifying checksum of uploaded binaries
+# no_skip = false ## (default: false) don't attempt to skip sending segment by checking on-device flash checksum first
+
+# .elf example
+# [[elf]] ## type of profile (bin/elf)
+# name = "PIO Elf Core v2"
+# path = 'C:\Users\nullstalgia\Documents\PlatformIO\Projects\OpenShock\.pio\build\OpenShock-Core-V2\app.elf' ## path to .elf to flash
+# partition_table = 'C:\Users\nullstalgia\Documents\PlatformIO\Projects\OpenShock\chips\partitions_4MB_OTA.csv' ## path to partition bin/csv file (optional-ish)
+# bootloader = 'C:\Users\nullstalgia\Documents\PlatformIO\Projects\OpenShock\.pio\build\OpenShock-Core-V2\bootloader.bin' ## path to bootloader binary (optional-ish)
+# chip = "esp32s3" ## expected chip, required. (set any_chip to true to skip check)
+# upload_baud = 2000000
+# any_chip = false ## (default: false) skip checking connected device matches expected chip
+# no_verify = false ## (default: false) skip verifying checksum of uploaded binaries
+# no_skip = false ## (default: false) don't attempt to skip sending segment by checking on-device flash checksum first
+# ram = false ## (default: false) load .elf contents into RAM, skipping flash write
 
 [[bin]]
 name = "PIO Core v2"

example_configs/yap_keybinds.toml

@@ -0,0 +1,31 @@
+[keybindings]
+ctrl-w = "toggle-textwrap"
+ctrl-o = "toggle-dtr"
+ctrl-p = "toggle-rts"
+ctrl-e = "show-espflash"
+# ctrl-e = "reload-macros"
+# ctrl-e = "esp-bootloader"
+ctrl-t = "toggle-timestamps"
+ctrl-m = "show-macros"
+ctrl-b = "show-behavior"
+'ctrl-.' = "show-portsettings"
+ctrl-d = "toggle-indices"
+ctrl-f = "reload-colors"
+F20 = "esp-hard-reset"
+F21 = "esp-bootloader"
+shift-F21 = "esp-bootloader-unchecked"
+ctrl-z = "esp-bootloader-unchecked"
+ctrl-r = "show-rendering"
+ctrl-h = "toggle-hex"
+ctrl-l = "show-losgging"
+ctrl-k = "show-keybinds"
+
+# macros
+F19 = "Restart"
+ctrl-s = "CaiX Vib (ID 12345, 0.5s)"
+ctrl-g = "OpenShock Setup|Echo Off"
+ctrl-j = ["PAUSE_MS:2000", "OpenShock Setup|Factory Reset", "PAUSE_MS:2000", "OpenShock Setup|Factory Reset"]
+
+# espflash profiles
+F18 = ["Core v2 1.4.0", "pause_ms:1000", "CaiX Vib (ID 12345, 1s)", "Echo Off", "Setup Authtoken and Networks"]
+shift-F18 = ["esp-erase-flash", "Core v2 1.4.0"]

src/app.rs

@@ -394,6 +394,7 @@ impl App {
         let mut max_handle = Duration::default();
         while self.is_running() {
             let start = Instant::now();
+            // TODO performance widget?
             self.draw(&mut terminal)?;
             let end = Instant::now();
             let end1 = end.saturating_duration_since(start);
@@ -1764,8 +1765,11 @@ impl App {
         }
         match self.menu {
             Menu::PortSelection(Pse::Ports) => {
-                let selected = self.ports.get(self.table_state.selected().unwrap());
-                if let Some(info) = selected {
+                if let Some(info) = self
+                    .table_state
+                    .selected()
+                    .and_then(|index| self.ports.get(index))
+                {
                     info!("Port {}", info.port_name);
 
                     let baud_rate =

src/buffer/logging.rs

@@ -38,6 +38,10 @@ pub struct LoggingHandle {
 
 pub const DEFAULT_TIMESTAMP_FORMAT: &str = "%Y-%m-%d %H:%M:%S%.9f";
 
+// TODO have a toggle in settings for
+// Log to file: true/false
+// Log to socket: true/false (later)
+
 pub enum LoggingCommand {
     PortConnected(DateTime<Local>, SerialPortInfo, Option<ReconnectType>),
     PortDisconnect {

src/buffer/tui.rs

@@ -236,7 +236,7 @@ impl Buffer {
             } else {
                 // self.buflines_iter().count()
                 //
-                // instead inlining some of its functionality instead
+                // inlining some of its functionality instead
                 // to avoid .count()-ing a potentially huge iter (100k+ items)
                 // (especially when wrapping is disabled, when its even more dead simple)
                 // when we can just read the length of a vector