Merge pull request #14 from MrClock8163/feature/terminal-timeout

Adding timeout option to terminal

Author: MrClock8163

src/instrumentman/terminal/app.py

@@ -47,7 +47,8 @@ def __init__(self, port: str):
 
     _CMD = re.compile(
         r"^%R1Q,"
-        r"(?P<rpc>\d+):"
+        r"(?P<rpc>\d+)"
+        r"(?P<trid>,\d+)?:"
         r"(?:(?P<params>.*))?$"
     )
 
@@ -66,14 +67,29 @@ def close(self) -> None:
     def send(self, message: str) -> None:
         return
 
+    def receive(self) -> str:
+        return ""
+
+    def is_open(self) -> bool:
+        return True
+
+    def reset(self) -> None:
+        return
+
     def exchange(self, cmd: str) -> str:
         if not self._CMD.match(cmd):
             return "%R1P,0,0:2"
 
-        if cmd == "%R1Q,5008:":
-            return "%R1P,0,0:0,1996,'07','19','10','13','2f'"
+        head, _ = cmd.split(":")
+        match head.split(","):
+            case [_, _, trid_str]:
+                pass
+            case _:
+                trid_str = "0"
+
+        trid = int(trid_str)
 
-        return "%R1P,0,0:0"
+        return f"%R1P,0,{trid}:0"
 
 
 # def open_serial(port: str, **kwargs: Any) -> DummyGeoComConnection:
@@ -328,6 +344,19 @@ def compose(self) -> ComposeResult:
                         value=9600,
                         id="select_baud"
                     )
+                    yield Label("Timeout")
+                    yield Input(
+                        valid_empty=False,
+                        value="15",
+                        type="integer",
+                        validators=[Timeout()],
+                        id="edit_timeout"
+                    )
+                    yield Button(
+                        "Update",
+                        id="btn_update_timeout",
+                        disabled=True
+                    )
                 with HorizontalGroup(id="hg_buttons"):
                     yield Button("Test Connection", id="btn_test_com")
                     yield Button(
@@ -401,8 +430,22 @@ def btn_test_com_pressed(self, event: Button.Pressed) -> None:
             )
             self.bell()
             return
+        baud = cast(int, self.query_one("#select_baud", Select).value)
+        timeout = self.query_one("#edit_timeout", Input)
+        if not timeout.is_valid:
+            self.notify(
+                "Invalid timeout value given!",
+                severity="error",
+                title="Error"
+            )
+            self.app.bell()
+            return
         try:
-            with open_serial(port.value) as com:
+            with open_serial(
+                port.value,
+                speed=baud,
+                timeout=int(timeout.value)
+            ) as com:
                 match self.query_one("#select_protocol", Select).value:
                     case Protocol.GEOCOM:
                         ans = com.exchange(r"%R1Q,0:\r\n")
@@ -440,9 +483,22 @@ def btn_connect_pressed(self, event: Button.Pressed) -> None:
             self.app.bell()
             return
         baud = cast(int, self.query_one("#select_baud", Select).value)
+        timeout = self.query_one("#edit_timeout", Input)
+        if not timeout.is_valid:
+            self.notify(
+                "Invalid timeout value given!",
+                severity="error",
+                title="Error"
+            )
+            self.app.bell()
+            return
         try:
             log = get_app_logger(self, port.value)
-            com = open_serial(port.value, speed=baud)
+            com = open_serial(
+                port.value,
+                speed=baud,
+                timeout=int(timeout.value)
+            )
             match self.query_one("#select_protocol", Select).value:
                 case Protocol.GEOCOM:
                     self.protocol = GeoCom(com, log)
@@ -457,6 +513,7 @@ def btn_connect_pressed(self, event: Button.Pressed) -> None:
             self.query_one("#edit_com", Input).disabled = True
             self.query_one("#select_protocol", Select).disabled = True
             self.query_one("#select_baud", Select).disabled = True
+            self.query_one("#btn_update_timeout", Button).disabled = False
             self.query_one("#tab_cmd", TabPane).disabled = False
 
             self.notify("Connection successful.", title="Success")
@@ -487,6 +544,7 @@ def btn_disconnect_pressed(self, event: Button.Pressed) -> None:
             self.query_one("#edit_com", Input).disabled = False
             self.query_one("#select_protocol", Select).disabled = False
             self.query_one("#select_baud", Select).disabled = False
+            self.query_one("#btn_update_timeout", Button).disabled = True
             self.query_one("#tab_cmd", TabPane).disabled = True
             self.sub_title = ""
         except Exception as e:
@@ -501,6 +559,37 @@ def btn_disconnect_pressed(self, event: Button.Pressed) -> None:
         self.notify("Disconnected.", title="Success")
         self.bell()
 
+    @on(Button.Pressed, "#btn_update_timeout")
+    def btn_update_timeout_pressed(self, event: Button.Pressed) -> None:
+        if self.protocol is None:
+            return
+
+        edit = self.query_one("#edit_timeout", Input)
+        if not edit.is_valid:
+            self.notify(
+                f"{edit.value} is not a valid timeout",
+                title="Error",
+                severity="error"
+            )
+            return
+
+        com = self.protocol._conn
+        try:
+            com._port.timeout = int(  # type: ignore[attr-defined]
+                edit.value
+            )
+            self.notify(
+                "Timeout updated",
+                title="Success",
+                severity="information"
+            )
+        except Exception:
+            self.notify(
+                f"{edit.value} is not a valid timeout",
+                title="Error",
+                severity="error"
+            )
+
 
 class ComPort(Validator):
     _WINCOM = re.compile(r"COM\d+")
@@ -511,3 +600,11 @@ def validate(self, value: str) -> ValidationResult:
             return self.success()
 
         return self.failure("Not a valid COM port")
+
+
+class Timeout(Validator):
+    def validate(self, value: str) -> ValidationResult:
+        if value != "-" and int(value) < 0:
+            return self.failure("Timeout cannot be negative")
+
+        return self.success()

src/instrumentman/terminal/app.tcss

@@ -1,10 +1,22 @@
 .connect {
-    grid-size: 2;
+    grid-size: 3;
     grid-columns: auto 1fr;
     grid-rows: auto;
     grid-gutter: 1;
 }
 
+#edit_com {
+    column-span: 2;
+}
+
+#select_protocol {
+    column-span: 2;
+}
+
+#select_baud {
+    column-span: 2;
+}
+
 #hg_buttons {
     height: auto;
 }