User Tools

Site Tools


simple-bpq-telnet-application

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
simple-bpq-telnet-application [2024/11/29 14:57] kc2ihxsimple-bpq-telnet-application [2026/02/21 20:23] (current) – [Program Code] kc2ihx
Line 31: Line 31:
  
 <code> <code>
-import asyncio, telnetlib3, json+import asyncio, telnetlib3, json, sys
 from optparse import OptionParser 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 = OptionParser()
 parser.add_option("-f", "--file", dest="filename", help="which json file with message and welcome", metavar="FILE") 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() (options, args) = parser.parse_args()
  
 +# read file with messages
 messages = json.load(open(options.filename,'r')) 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): async def shell(reader, writer):
 +    # first thing provided is user's callsign
     incall = await reader.readline()     incall = await reader.readline()
-    print("%s connected" % incall)+    print_log("%s connected" % incall)
     writer.write("\r\nWelcome %s" % incall)     writer.write("\r\nWelcome %s" % incall)
     writer.write("\r\n%s" % messages["welcome"])     writer.write("\r\n%s" % messages["welcome"])
 +    # make copy of blocks so we can pop 'em
     textblocks = messages["text"].copy()     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     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:     while inp and not leave and len(textblocks) > 0:
-        print("writing next block") 
         writer.write(textblocks.pop(0))         writer.write(textblocks.pop(0))
         await writer.drain()         await writer.drain()
         inp = await reader.readline()         inp = await reader.readline()
-        if not rolled: print("%s rickrolled" % incall) +        text_count += 1 
-        rolled = True+        if not rolled:  
 +            # 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         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()     writer.close()
  
 +# sets up the async process to take inputs
 loop = asyncio.get_event_loop() loop = asyncio.get_event_loop()
 coro = telnetlib3.create_server(port=options.port, shell=shell) coro = telnetlib3.create_server(port=options.port, shell=shell)
Line 88: 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: 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> <code>
-CMDPORT=8005 63001 4565 10001+CMDPORT=8005 63001 10001
 </code> </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> <code>
-APPLICATION 4,ROLL,C 1 HOST S+APPLICATION 3,ROLL,C 1 HOST S
 </code> </code>
  
Line 98: Line 118:
 Next we'll configure a ''systemd'' service to make sure this script is always running and ready to accept connections. Next we'll configure a ''systemd'' service to make sure this script is always running and ready to accept connections.
  
-I created this file as a "user" service, as ''~/.config/systemd/user/rick.service'', but it should probably run as a system service:+Put this file in ''/etc/systemd/system/rick.service'':
  
 <code> <code>
Line 107: Line 127:
 Description="RRoAX25 service" Description="RRoAX25 service"
 After=network.target After=network.target
 +# this might be backwards, but I do need linbpq for this to work.
 +Requires=linbpq.service
  
 [Service] [Service]
 Type=simple Type=simple
 +User=evan
 +Group=evan
 WorkingDirectory=/home/USER/.local/bpq-apps/ WorkingDirectory=/home/USER/.local/bpq-apps/
 ExecStart=/home/USER/.local/bpq-apps/bin/python /home/USER/.local/bpq-apps/scripts/rick.py -p 10001 -f /home/USER/.local/bpq-apps/data/messages.json ExecStart=/home/USER/.local/bpq-apps/bin/python /home/USER/.local/bpq-apps/scripts/rick.py -p 10001 -f /home/USER/.local/bpq-apps/data/messages.json
 Restart=always Restart=always
 +RestartSec=3
  
 [Install] [Install]
Line 120: Line 145:
 Activate it by running: Activate it by running:
 <code> <code>
-systemctl --user enable rick.service +sudo systemctl enable rick.service 
-systemctl --user start rick.service+sudo systemctl start rick.service
 </code> </code>
  
Line 127: Line 152:
  
 <code> <code>
-systemctl --user status rick.service+systemctl status rick.service
 </code> </code>
  
 If you need to edit the service file, reload it with: If you need to edit the service file, reload it with:
 <code> <code>
-systemctl --user daemon-reload+systemctl daemon-reload 
 +</code> 
 + 
 +Finally, to see who has used it: 
 +<code> 
 +journalctl -u rick.service -f
 </code> </code>
simple-bpq-telnet-application.1732892230.txt.gz · Last modified: by kc2ihx