Merge pull request #392 from MorseKOB/es-wip

Telegram: Add option to do form advance on key open or not.

Author: AESilky

Documentation/Telegram/User-Manual-Telegram.adoc

@@ -100,9 +100,10 @@ There are four keyboard commands:
 3. ((ESC  - Toggle the key open/closed state))
 4. ((F8   - Toggle the wire connection (connect/disconnect)))
 5. ((F11   - Clear the form without showing a new Masthead))
-6. ((Ctrl-X   - Clear the form (instantly show a new form)))
-7. ((Ctrl-Q   - Quit/Exit))
-8. ((Ctrl-C   - Quit/Exit))
+6. ((Ctrl-A   - Advance in a new form (scroll current form up)))
+7. ((Ctrl-X   - Clear the form (instantly show a new form)))
+8. ((Ctrl-Q   - Quit/Exit))
+9. ((Ctrl-C   - Quit/Exit))
 
 If the key is open (either physically or by using '~'), other text typed will be sounded, displayed, and encoded and sent to the wire if connected.
 
@@ -232,6 +233,7 @@ The Telegram Configuration controls:
 * Masthead text color
 * Welcome message (shown on completely new form)
 * Display sender office/station ID (true/false)
+* Page (form) advance on key opened
 * Page (form) clear idle time
 * Page (form) page scroll speed
 
@@ -275,6 +277,7 @@ that you use the file provided as a starting point, as it is used for testing.
     "list_sender":false,
     "page_clear_idle_time":15.5,
     "page_advance_seconds":2.2,
+    "page_new_on_key_open":false,
     "wrap_columns":8
 }
 ```
@@ -416,7 +419,7 @@ wire or entered on the local key or keyboard.
 Default: 18.0
 
 [%nonfacing]
-==== ((page_clear_speed))
+==== ((page_advance_seconds))
 Specifies the amount of time, in seconds, for complete page (form) to be scrolled off
 and a new page to be displayed. A fractional value is allowed. A value of 0 will instantly replace the
 current page with a fresh one (full form without scrolling). The special value of -1 indicates that
@@ -425,6 +428,14 @@ cleared using the ((F11)) key, or cleared and a masthead displayed using the ((C
 
 Default: 2.8
 
+[%nonfacing]
+==== ((page_new_on_key_open))
+If true, a new form is scrolled in when the key is opened (from being closed). If false, opening
+the key will keep the current form and start displaying the locally keyed code. In this mode
+a new form can be scrolled in using the ((Ctrl-A)) key if desired.
+
+Default: false
+
 [%nonfacing]
 ==== ((list_sender))
 Specifies that the current sender's office/station ID be displayed when Telegram is started or the
@@ -439,8 +450,8 @@ endif::[]
 
 [colophon]
 = Colophon
-This document reflects the features of ((Telegram)) ((Version 1.1.0))
-Edit date: 12-20-2024
+This document reflects the features of ((Telegram)) ((Version 1.2.0))
+Edit date: 12-22-2024
 
 MIT License
 

Documentation/Telegram/User-Manual-Telegram.pdf

@@ -18,5 +18,6 @@
     "list_sender":false,
     "page_clear_idle_time":15.5,
     "page_advance_seconds":2.2,
+    "page_new_on_key_open":false,
     "wrap_columns":8
 }

Documentation/Telegram/tg_config.tgc

@@ -1 +1 @@
-4.5.0
+4.6.0

msuiteversion.txt

@@ -71,7 +71,7 @@
 from pykob.morse import Reader, Sender
 
 COMPILE_INFO = globals().get("__compiled__")
-__version__ = '1.1.0'
+__version__ = '1.2.0'
 VERSION = __version__ if COMPILE_INFO is None else __version__ + 'c'
 TELEGRAM_VERSION_TEXT = "Telegram " + VERSION
 
@@ -402,7 +402,7 @@ def print(self, text, bold=False, italic=False, update=True, spacing=0.0):  # ty
             pygame.display.flip()
         return
 
-    def show_closer_state(self, open):  # type: (bool) -> None
+    def show_closer_state(self, open, update=False):  # type: (bool,bool) -> None
         """
         Render a '~' or '+' in the bottom left corner of the screen
         based on the open/closed state. Erase what might have been
@@ -414,9 +414,11 @@ def show_closer_state(self, open):  # type: (bool) -> None
             self._screen.blit(self._KC_open_sprite, self._KC_state_pt)
         else:
             self._screen.blit(self._KC_closed_sprite, self._KC_state_pt)
+        if update:
+            pygame.display.flip()
         return
 
-    def show_wire_state(self, connected):  # type: (bool) -> None
+    def show_wire_state(self, connected, update=False):  # type: (bool,bool) -> None
         """
         Render a closed or open circle for connected or disconnected
         in the bottom right corner of the screen based on the connected
@@ -428,6 +430,8 @@ def show_wire_state(self, connected):  # type: (bool) -> None
             self._screen.blit(self._WC_sprite, self._W_state_pt)
         else:
             self._screen.blit(self._WD_sprite, self._W_state_pt)
+        if update:
+            pygame.display.flip()
         return
 
     def shutdown(self):  # type: () -> None
@@ -535,6 +539,7 @@ class TelegramConfig:
     FONT_SIZE_KEY = "font_size"
     PAGE_CLEAR_IDLE_TIME_KEY = "page_clear_idle_time"
     PAGE_ADVANCE_SECONDS_KEY = "page_advance_seconds"
+    PAGE_NEW_ON_KEY_OPEN_KEY = "page_new_on_key_open"
     PAGE_COLOR_KEY = "page_color"
     PAGE_WIDTH_KEY = "page_width"
     TEXT_COLOR_KEY = "text_color"
@@ -562,6 +567,7 @@ def __init__(self, tgcfg_file_path):  # type: (str|None) -> None
         self._text_color = "black"  # type: str|tuple[int,int,int]
         self._page_clear_idle_time = 18.0  # type: float  # Seconds of idle before clear
         self._page_advance_seconds = 2.8  # type: float  # Time to take to scroll the page (-1 means no 'new page')
+        self._page_new_on_key_open = False  # type: bool  # Scroll in a new form when the key is opened
         self._page_color = (198,189,150)  # type: str|tuple[int,int,int] # Tan
         self._page_width = 980  # type: int  # The page color portion width. 980 is reasonable.
         self._masthead_filep = None  # type: str|None
@@ -701,6 +707,14 @@ def page_color(self, color):  # type: (str|tuple[int,int,int]) -> None
         self._page_color = color
         return
 
+    @property
+    def page_new_on_key_open(self):  # type: () -> bool
+        return self._page_new_on_key_open
+    @page_new_on_key_open.setter
+    def page_new_on_key_open(self, b):  # type: (bool) -> None
+        self._page_new_on_key_open = b
+        return
+
     @property
     def page_width(self):  # type: () -> int
         return self._page_width
@@ -798,6 +812,8 @@ def load(self, filep=None):  # type: (str|None) -> None
                                 self._page_advance_seconds = value
                             case self.PAGE_COLOR_KEY:
                                 self._page_color = literal_eval(value) if value and value[0] == '(' else value
+                            case self.PAGE_NEW_ON_KEY_OPEN_KEY:
+                                self._page_new_on_key_open = value
                             case self.PAGE_WIDTH_KEY:
                                 self._page_width = value
                             case self.TEXT_COLOR_KEY:
@@ -990,7 +1006,7 @@ def _from_internet(self, code):
                 if code == STARTMSG:
                     self._form.new_form()
                     self._form.show_closer_state(self._kob.virtual_closer_is_open)
-                    self._form.show_wire_state(self._connected)
+                    self._form.show_wire_state(self._connected, update=True)
                 elif code == ENDMSG:
                     # Don't do anything at end. Timeout or new message (STARTMSG)
                     # will display a new form.
@@ -1124,15 +1140,16 @@ def _set_virtual_closer_closed(self, close):
         Handle change of Circuit Closer state.
 
         A state of:
-        True: 'latch'
-        False: 'unlatch'
+        close=True: 'latch'
+        close=False: 'unlatch'
         """
         was_closed = not self._kob.virtual_closer_is_open
+        log.debug("Telegram._set_virtual_closer_closed: {}:{}".format(was_closed, close), 2, dt="")
         if close and was_closed:
             return
         open = not close
         self._kob.virtual_closer_is_open = open
-        self._form.show_closer_state(open)
+        self._form.show_closer_state(open, update=True)
         code = LATCH_CODE if close else UNLATCH_CODE
         # if not self._internet_station_active:
         if True:  # Allow breaking in to an active wire message
@@ -1154,17 +1171,18 @@ def _set_virtual_closer_closed(self, close):
             self._set_local_loop_active(True)
         if was_closed:
             # The closer was closed and now it's open
-            #  Flush the reader and display a new form
+            #  Flush the reader
+            ignoring_inet = self._ignore_internet.is_set()
             self._ignore_internet.set()
             rdr = self._reader
             if rdr is not None:
                 rdr.setCallback(None)  # Don't have it call back
+            if self._tgcfg.page_new_on_key_open:
                 self._form.new_form()
-                self._form.show_closer_state(self._kob.virtual_closer_is_open)
-                self._form.show_wire_state(self._connected)
+            if rdr is not None:
                 self._new_Reader()
-        else:
-            self._ignore_internet.clear()
+            if not ignoring_inet:
+                self._ignore_internet.clear()
         return
 
 
@@ -1231,13 +1249,21 @@ def main_loop(self):
                             self._shutdown.set()
                             self._control_c_pressed.set()
                             break
+                        elif c == '\x01':  # advance the form on ^A
+                            ignoring_inet = self._ignore_internet.is_set()
+                            self._ignore_internet.set()
+                            self._form.new_form()
+                            self._last_display_t = sys.float_info.max
+                            if not ignoring_inet:
+                                self._ignore_internet.clear()
                         elif c == '\x18':  # display a new form on ^X
                             ignoring_inet = self._ignore_internet.is_set()
                             self._ignore_internet.set()
                             self._form.new_form(fresh=True)
                             if self._tgcfg.welcome_msg is not None:
                                 self._form.print(self._tgcfg.welcome_msg)
                                 self._form.new_line(2)
+                            self._last_display_t = sys.float_info.max
                             if not ignoring_inet:
                                 self._ignore_internet.clear()
                         else:
@@ -1257,6 +1283,7 @@ def main_loop(self):
                                 self._ignore_internet.set()
                                 self._form.new_form(fresh=True, disp_masthead=False)
                                 self._form.new_line(1)
+                                self._last_display_t = sys.float_info.max
                                 if not ignoring_inet:
                                     self._ignore_internet.clear()
                                 continue
@@ -1276,7 +1303,7 @@ def main_loop(self):
                         self._form.print(self._tgcfg.welcome_msg)
                         self._form.new_line(2)
                     self._form.show_closer_state(self._kob.virtual_closer_is_open)
-                    self._form.show_wire_state(self._connected)
+                    self._form.show_wire_state(self._connected, update=True)
                     if not ignoring_inet:
                         self._ignore_internet.clear()
                     self._last_display_t = sys.float_info.max
@@ -1366,7 +1393,7 @@ def start(self):
         self._clock = pygame.time.Clock()
         self._form.new_form(fresh=True)
         self._form.show_closer_state(self._kob.virtual_closer_is_open)
-        self._form.show_wire_state(self._connected)
+        self._form.show_wire_state(self._connected, update=True)
         self._running = True
         self._dt = 0
         return

src.py/Telegram.py

@@ -1 +1 @@
-1.1.0
+1.2.0