Improved script docs and script usage description in README.md
Also introduced graceful error handling when trying to access interactive mode on Windows.
This commit is contained in:
@@ -6,51 +6,72 @@ To read the manual, simply run this script without any arguments.
|
||||
Stefan Mathis, April 2025
|
||||
"""
|
||||
|
||||
import platform
|
||||
|
||||
import struct
|
||||
import socket
|
||||
import curses
|
||||
|
||||
help = """
|
||||
Send commands to and receive replies from MasterMACS controllers
|
||||
|
||||
Option 1: Single Command
|
||||
------------------------
|
||||
|
||||
Usage: writeRead.py pmachost:port command
|
||||
This then returns the response for command.
|
||||
|
||||
Option 2: CLI Mode (Linux-only)
|
||||
-------------------------------
|
||||
|
||||
Usage: writeRead.py pmachost:port
|
||||
|
||||
ONLY AVAILABLE ON LINUX!
|
||||
|
||||
You can then type in a command, hit enter, and the response will see
|
||||
the reponse, before being prompted to again enter a command. Type
|
||||
'quit' to close prompt.
|
||||
"""
|
||||
|
||||
|
||||
def packMasterMacsCommand(command):
|
||||
# 0x0D = Carriage return
|
||||
buf = struct.pack('B',0x0D)
|
||||
buf = bytes(command,'utf-8') + buf
|
||||
return bytes(command,'utf-8')
|
||||
# 0x0D = Carriage return
|
||||
buf = struct.pack('B', 0x0D)
|
||||
buf = bytes(command, 'utf-8') + buf
|
||||
return bytes(command, 'utf-8')
|
||||
|
||||
|
||||
def readMasterMacsReply(input):
|
||||
msg = bytearray()
|
||||
expectAck = True
|
||||
while True:
|
||||
b = input.recv(1)
|
||||
bint = int.from_bytes(b,byteorder='little')
|
||||
if bint == 2 or bint == 7: #STX or BELL
|
||||
bint = int.from_bytes(b, byteorder='little')
|
||||
if bint == 2 or bint == 7: # STX or BELL
|
||||
expectAck = False
|
||||
continue
|
||||
if expectAck and bint == 6: # ACK
|
||||
if expectAck and bint == 6: # ACK
|
||||
return bytes(msg)
|
||||
else:
|
||||
if bint == 13 and not expectAck: # CR
|
||||
if bint == 13 and not expectAck: # CR
|
||||
return bytes(msg)
|
||||
else:
|
||||
msg.append(bint)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
from sys import argv
|
||||
|
||||
try:
|
||||
|
||||
if "-h" or "--help" in argv:
|
||||
print(help)
|
||||
else:
|
||||
addr = argv[1].split(':')
|
||||
s = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
|
||||
s.connect((addr[0],int(addr[1])))
|
||||
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||
s.connect((addr[0], int(addr[1])))
|
||||
|
||||
if len(argv) == 3:
|
||||
buf = packMasterMacsCommand(argv[2])
|
||||
s.send(buf)
|
||||
reply = readMasterMacsReply(s)
|
||||
print(reply.decode('utf-8') + '\n')
|
||||
if len(argv) == 2:
|
||||
|
||||
else:
|
||||
|
||||
try:
|
||||
if platform.system() == "Linux":
|
||||
import curses
|
||||
|
||||
stdscr = curses.initscr()
|
||||
curses.noecho()
|
||||
@@ -80,13 +101,13 @@ if __name__ == "__main__":
|
||||
if ptr > 0:
|
||||
ptr -= 1
|
||||
stdscr.addch("\r")
|
||||
stdscr.clrtoeol()
|
||||
stdscr.clrtoeol()
|
||||
stdscr.addstr(">> " + history[ptr])
|
||||
elif c == curses.KEY_DOWN:
|
||||
if ptr < len(history) - 1:
|
||||
ptr += 1
|
||||
stdscr.addch("\r")
|
||||
stdscr.clrtoeol()
|
||||
stdscr.clrtoeol()
|
||||
stdscr.addstr(">> " + history[ptr])
|
||||
elif c == curses.KEY_ENTER or c == ord('\n') or c == ord('\r'):
|
||||
if history[ptr] == 'quit':
|
||||
@@ -112,7 +133,7 @@ if __name__ == "__main__":
|
||||
stdscr.refresh()
|
||||
|
||||
else:
|
||||
if ptr < len(history) - 1: # Modifying previous input
|
||||
if ptr < len(history) - 1: # Modifying previous input
|
||||
if len(history[-1]) == 0:
|
||||
history[-1] = history[ptr]
|
||||
ptr = len(history) - 1
|
||||
@@ -125,47 +146,34 @@ if __name__ == "__main__":
|
||||
if len(history[ptr]) == 0:
|
||||
continue
|
||||
(y, x) = stdscr.getyx()
|
||||
history[ptr] = history[ptr][0:x-4] + history[ptr][x-3:]
|
||||
history[ptr] = history[ptr][0:x-4] + \
|
||||
history[ptr][x-3:]
|
||||
stdscr.addch("\r")
|
||||
stdscr.clrtoeol()
|
||||
stdscr.clrtoeol()
|
||||
stdscr.addstr(">> " + history[ptr])
|
||||
stdscr.move(y, x-1)
|
||||
stdscr.refresh()
|
||||
|
||||
else:
|
||||
(y, x) = stdscr.getyx()
|
||||
history[ptr] = history[ptr][0:x-3] + chr(c) + history[ptr][x-3:]
|
||||
history[ptr] = history[ptr][0:x-3] + \
|
||||
chr(c) + history[ptr][x-3:]
|
||||
stdscr.addch("\r")
|
||||
stdscr.clrtoeol()
|
||||
stdscr.clrtoeol()
|
||||
stdscr.addstr(">> " + history[ptr])
|
||||
stdscr.move(y, x+1)
|
||||
stdscr.refresh()
|
||||
|
||||
finally:
|
||||
|
||||
# to quit
|
||||
curses.nocbreak()
|
||||
stdscr.keypad(False)
|
||||
curses.echo()
|
||||
curses.endwin()
|
||||
|
||||
except:
|
||||
print("""
|
||||
Invalid Arguments
|
||||
|
||||
Option 1: Single Command
|
||||
------------------------
|
||||
|
||||
Usage: writeRead.py pmachost:port command
|
||||
This then returns the response for command.
|
||||
|
||||
Option 2: CLI Mode
|
||||
------------------
|
||||
|
||||
Usage: writeRead.py pmachost:port
|
||||
|
||||
You can then type in a command, hit enter, and the response will see
|
||||
the reponse, before being prompted to again enter a command. Type
|
||||
'quit' to close prompt.
|
||||
""")
|
||||
|
||||
# to quit
|
||||
curses.nocbreak()
|
||||
stdscr.keypad(False)
|
||||
curses.echo()
|
||||
curses.endwin()
|
||||
else:
|
||||
print(help)
|
||||
elif len(argv) == 3:
|
||||
buf = packMasterMacsCommand(argv[2])
|
||||
s.send(buf)
|
||||
reply = readMasterMacsReply(s)
|
||||
print(reply.decode('utf-8') + '\n')
|
||||
else:
|
||||
print(help)
|
||||
|
||||
Reference in New Issue
Block a user