Differences

This shows you the differences between two versions of the page.

--- simple-bpq-telnet-application [2026/01/01 22:41] – [Program Code] kc2ihx
+++ simple-bpq-telnet-application [2026/02/21 20:23] (current) – [Program Code] kc2ihx
@@ Line 34: / Line 34: @@
 from optparse import OptionParser
+# this sets up the command line options, primarily the file to read and the port to open for BPQ
 parser = OptionParser()
 parser.add_option("-f", "--file", dest="filename", help="which json file with message and welcome", metavar="FILE")
@@ Line 39: / Line 40: @@
 (options, args) = parser.parse_args()
+# read file with messages
 messages = json.load(open(options.filename,'r'))
+# logging method to write to stderr for journalctl to pick up
 def print_log(*a):
     print(*a, file=sys.stderr)
+# this is the main function that processes input from user and writes outputs
 async def shell(reader, writer):
+    # first thing provided is user's callsign
     incall = await reader.readline()
     print_log("%s connected" % incall)
     writer.write("\r\nWelcome %s" % incall)
     writer.write("\r\n%s" % messages["welcome"])
+    # make copy of blocks so we can pop 'em
     textblocks = messages["text"].copy()
-    leave = False #inp[0].upper() in ["Q", "B"]
+    # don't let them leave until they've been rolled
+    leave = False
     rolled = False
-    inp = await reader.read(1)
+    # take first input from user after welcome message
+    inp = await reader.readline()
+    text_count = 0
+    incall = incall.rstrip()
+    # loop on inputs until they leave
     while inp and not leave and len(textblocks) > 0:
-        # print("writing next block")
         writer.write(textblocks.pop(0))
         await writer.drain()
         inp = await reader.readline()
+        text_count += 1
         if not rolled:
-            # notify that rolling has happened
+            # log that rolling has happened
             print_log("%s rickrolled" % incall)
             rolled = True
+        # if they type something starting with Q or B (quit, bye, bye-bye, etc.) let them leave
         leave = inp[0].upper() in ["Q", "B"] and rolled
+        # log their input to journalctl via stderr
+        print_log("%s (%d): \"%s\"" % (incall, text_count, inp.rstrip()))
     writer.close()
+# sets up the async process to take inputs
 loop = asyncio.get_event_loop()
 coro = telnetlib3.create_server(port=options.port, shell=shell)
@@ Line 94: / Line 108: @@
 In my ''bpq32.cfg'' file, I added the port number to the telnet port, where the fourth entry, ''10001'' is the port for my new application:
 <code>
-CMDPORT=8005 63001 4565 10001
+CMDPORT=8005 63001 10001
 </code>
-and in the application list, I added a new entry, where ''3'' is the 0th-indexed 4th entry above.
+and in the application list, I added a new entry, where ''HOST 2'' is due to being the 0th-indexed 3rd entry above.
 <code>
-APPLICATION 4,ROLL,C 1 HOST 3 S
+APPLICATION 3,ROLL,C 1 HOST 2 S
 </code>