From 217ab1c2eb38e7b20dfa6d4acffc6c9a40ff5e7a Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Wed, 4 Apr 2018 15:26:34 +0200 Subject: [PATCH] Cleanup --- RNS/Interfaces/AX25Interface.py | 215 ++++++++++++++++++ ...erialKISSInterface.py => KISSInterface.py} | 5 +- RNS/Reticulum.py | 6 +- RNS/Transport.py | 2 + RNS/Utilities/Echo.py | 10 +- 5 files changed, 230 insertions(+), 8 deletions(-) create mode 100644 RNS/Interfaces/AX25Interface.py rename RNS/Interfaces/{SerialKISSInterface.py => KISSInterface.py} (98%) diff --git a/RNS/Interfaces/AX25Interface.py b/RNS/Interfaces/AX25Interface.py new file mode 100644 index 0000000..9e572f8 --- /dev/null +++ b/RNS/Interfaces/AX25Interface.py @@ -0,0 +1,215 @@ +from __future__ import print_function +from Interface import Interface +from time import sleep +import sys +import serial +import threading +import time +import RNS + +class KISS(): + FEND = chr(0xC0) + FESC = chr(0xDB) + TFEND = chr(0xDC) + TFESC = chr(0xDD) + CMD_UNKNOWN = chr(0xFE) + CMD_DATA = chr(0x00) + CMD_TXDELAY = chr(0x01) + CMD_P = chr(0x02) + CMD_SLOTTIME = chr(0x03) + CMD_TXTAIL = chr(0x04) + CMD_FULLDUPLEX = chr(0x05) + CMD_SETHARDWARE = chr(0x06) + CMD_RETURN = chr(0xFF) + +# TODO: THIS CLASS IS NOT YET IMPLEMENTED --- PLACEHOLDER ONLY --- +class AX25Interface(Interface): + MAX_CHUNK = 32768 + + owner = None + port = None + speed = None + databits = None + parity = None + stopbits = None + serial = None + + def __init__(self, owner, port, speed, databits, parity, stopbits, preamble, txtail, persistence, slottime): + self.serial = None + self.owner = owner + self.port = port + self.speed = speed + self.databits = databits + self.parity = serial.PARITY_NONE + self.stopbits = stopbits + self.timeout = 100 + self.online = False + + self.preamble = preamble if preamble != None else 350; + self.txtail = txtail if txtail != None else 20; + self.persistence = persistence if persistence != None else 64; + self.slottime = slottime if slottime != None else 20; + + if parity.lower() == "e" or parity.lower() == "even": + self.parity = serial.PARITY_EVEN + + if parity.lower() == "o" or parity.lower() == "odd": + self.parity = serial.PARITY_ODD + + try: + RNS.log("Opening serial port "+self.port+"...") + self.serial = serial.Serial( + port = self.port, + baudrate = self.speed, + bytesize = self.databits, + parity = self.parity, + stopbits = self.stopbits, + xonxoff = False, + rtscts = False, + timeout = 0, + inter_byte_timeout = None, + write_timeout = None, + dsrdtr = False, + ) + except Exception as e: + RNS.log("Could not create serial port", RNS.LOG_ERROR) + raise e + + if self.serial.is_open: + # Allow time for interface to initialise before config + sleep(2.0) + thread = threading.Thread(target=self.readLoop) + thread.setDaemon(True) + thread.start() + self.online = True + RNS.log("Serial port "+self.port+" is now open") + RNS.log("Configuring KISS interface parameters...") + self.setPreamble(self.preamble) + self.setTxTail(self.txtail) + self.setPersistence(self.persistence) + self.setSlotTime(self.slottime) + RNS.log("KISS interface configured") + sleep(2) + else: + raise IOError("Could not open serial port") + + + def setPreamble(self, preamble): + preamble_ms = preamble + preamble = int(preamble_ms / 10) + if preamble < 0: + preamble = 0 + if preamble > 255: + preamble = 255 + + RNS.log("Setting preamble to "+str(preamble)+" "+chr(preamble)) + kiss_command = KISS.FEND+KISS.CMD_TXDELAY+chr(preamble)+KISS.FEND + written = self.serial.write(kiss_command) + if written != len(kiss_command): + raise IOError("Could not configure KISS interface preamble to "+str(preamble_ms)+" (command value "+str(preamble)+")") + + def setTxTail(self, txtail): + txtail_ms = txtail + txtail = int(txtail_ms / 10) + if txtail < 0: + txtail = 0 + if txtail > 255: + txtail = 255 + + kiss_command = KISS.FEND+KISS.CMD_TXTAIL+chr(txtail)+KISS.FEND + written = self.serial.write(kiss_command) + if written != len(kiss_command): + raise IOError("Could not configure KISS interface TX tail to "+str(txtail_ms)+" (command value "+str(txtail)+")") + + def setPersistence(self, persistence): + if persistence < 0: + persistence = 0 + if persistence > 255: + persistence = 255 + + kiss_command = KISS.FEND+KISS.CMD_P+chr(persistence)+KISS.FEND + written = self.serial.write(kiss_command) + if written != len(kiss_command): + raise IOError("Could not configure KISS interface persistence to "+str(persistence)) + + def setSlotTime(self, slottime): + slottime_ms = slottime + slottime = int(slottime_ms / 10) + if slottime < 0: + slottime = 0 + if slottime > 255: + slottime = 255 + + kiss_command = KISS.FEND+KISS.CMD_SLOTTIME+chr(slottime)+KISS.FEND + written = self.serial.write(kiss_command) + if written != len(kiss_command): + raise IOError("Could not configure KISS interface slot time to "+str(slottime_ms)+" (command value "+str(slottime)+")") + + + def processIncoming(self, data): + self.owner.inbound(data, self) + + + def processOutgoing(self,data): + if self.online: + data = data.replace(chr(0xdb), chr(0xdb)+chr(0xdd)) + data = data.replace(chr(0xc0), chr(0xdb)+chr(0xdc)) + frame = chr(0xc0)+chr(0x00)+data+chr(0xc0) + written = self.serial.write(frame) + if written != len(frame): + raise IOError("Serial interface only wrote "+str(written)+" bytes of "+str(len(data))) + + + def readLoop(self): + try: + in_frame = False + escape = False + command = KISS.CMD_UNKNOWN + data_buffer = "" + last_read_ms = int(time.time()*1000) + + while self.serial.is_open: + if self.serial.in_waiting: + byte = self.serial.read(1) + last_read_ms = int(time.time()*1000) + + if (in_frame and byte == KISS.FEND and command == KISS.CMD_DATA): + in_frame = False + self.processIncoming(data_buffer) + elif (byte == KISS.FEND): + in_frame = True + command = KISS.CMD_UNKNOWN + data_buffer = "" + elif (in_frame and len(data_buffer) < RNS.Reticulum.MTU): + if (len(data_buffer) == 0 and command == KISS.CMD_UNKNOWN): + # We only support one HDLC port for now, so + # strip off port nibble + byte = chr(ord(byte) & 0x0F) + command = byte + elif (command == KISS.CMD_DATA): + if (byte == KISS.FESC): + escape = True + else: + if (escape): + if (byte == KISS.TFEND): + byte = KISS.FEND + if (byte == KISS.TFESC): + byte = KISS.FESC + data_buffer = data_buffer+byte + else: + time_since_last = int(time.time()*1000) - last_read_ms + if len(data_buffer) > 0 and time_since_last > self.timeout: + data_buffer = "" + in_frame = False + command = KISS.CMD_UNKNOWN + escape = False + sleep(0.08) + + except Exception as e: + self.online = False + RNS.log("A serial port error occurred, the contained exception was: "+str(e), RNS.LOG_ERROR) + RNS.log("The interface "+str(self.name)+" is now offline. Restart Reticulum to attempt reconnection.", RNS.LOG_ERROR) + + def __str__(self): + return "SerialKISSInterface["+self.name+"]" + diff --git a/RNS/Interfaces/SerialKISSInterface.py b/RNS/Interfaces/KISSInterface.py similarity index 98% rename from RNS/Interfaces/SerialKISSInterface.py rename to RNS/Interfaces/KISSInterface.py index 4939dfd..b23ba1b 100644 --- a/RNS/Interfaces/SerialKISSInterface.py +++ b/RNS/Interfaces/KISSInterface.py @@ -22,7 +22,7 @@ class KISS(): CMD_SETHARDWARE = chr(0x06) CMD_RETURN = chr(0xFF) -class SerialKISSInterface(Interface): +class KISSInterface(Interface): MAX_CHUNK = 32768 owner = None @@ -194,6 +194,7 @@ class SerialKISSInterface(Interface): byte = KISS.FEND if (byte == KISS.TFESC): byte = KISS.FESC + escape = False data_buffer = data_buffer+byte else: time_since_last = int(time.time()*1000) - last_read_ms @@ -210,5 +211,5 @@ class SerialKISSInterface(Interface): RNS.log("The interface "+str(self.name)+" is now offline. Restart Reticulum to attempt reconnection.", RNS.LOG_ERROR) def __str__(self): - return "SerialKISSInterface["+self.name+"]" + return "KISSInterface["+self.name+"]" diff --git a/RNS/Reticulum.py b/RNS/Reticulum.py index 8b2ed80..556d034 100755 --- a/RNS/Reticulum.py +++ b/RNS/Reticulum.py @@ -87,7 +87,7 @@ class Reticulum: if port == None: raise ValueError("No port specified for serial interface") - interface = SerialKISSInterface.SerialKISSInterface( + interface = SerialInterface.SerialInterface( RNS.Transport, port, speed, @@ -104,7 +104,7 @@ class Reticulum: interface.name = name RNS.Transport.interfaces.append(interface) - if c["type"] == "SerialKISSInterface": + if c["type"] == "KISSInterface": preamble = int(c["preamble"]) if "preamble" in c else None txtail = int(c["txtail"]) if "txtail" in c else None persistence = int(c["persistence"]) if "persistence" in c else None @@ -119,7 +119,7 @@ class Reticulum: if port == None: raise ValueError("No port specified for serial interface") - interface = SerialKISSInterface.SerialKISSInterface( + interface = KISSInterface.KISSInterface( RNS.Transport, port, speed, diff --git a/RNS/Transport.py b/RNS/Transport.py index dc1e8ed..3da2e04 100755 --- a/RNS/Transport.py +++ b/RNS/Transport.py @@ -18,12 +18,14 @@ class Transport: for interface in Transport.interfaces: if interface.OUT: RNS.log("Transmitting via: "+str(interface), RNS.LOG_DEBUG) + RNS.log(str(len(raw))+" bytes of data: "+RNS.hexrep(raw), RNS.LOG_DEBUG) interface.processOutgoing(raw) @staticmethod def inbound(raw, interface=None): packet_hash = RNS.Identity.fullHash(raw) RNS.log(str(interface)+" received packet with hash "+RNS.prettyhexrep(packet_hash), RNS.LOG_DEBUG) + RNS.log(str(len(raw))+" bytes of data: "+RNS.hexrep(raw), RNS.LOG_DEBUG) if not packet_hash in Transport.packet_hashlist: Transport.packet_hashlist.append(packet_hash) diff --git a/RNS/Utilities/Echo.py b/RNS/Utilities/Echo.py index bfbbbd3..69256f0 100644 --- a/RNS/Utilities/Echo.py +++ b/RNS/Utilities/Echo.py @@ -12,7 +12,7 @@ APP_NAME = "example_utilitites" # to run as a server def server(configpath): # We must first initialise Reticulum - RNS = RNS.Reticulum(configpath) + reticulum = RNS.Reticulum(configpath) # Randomly create a new identity for our echo server server_identity = RNS.Identity() @@ -98,11 +98,11 @@ def client(destination_hexhash, configpath): raise ValueError("Destination length is invalid, must be 20 hexadecimal characters (10 bytes)") destination_hash = destination_hexhash.decode("hex") except: - RNS.log("Invalid destination entered. Check your input!") + RNS.log("Invalid destination entered. Check your input!\n") exit() # We must first initialise Reticulum - RNS = RNS.Reticulum(configpath) + reticulum = RNS.Reticulum(configpath) # Randomly create a new identity for our echo server client_identity = RNS.Identity() @@ -244,6 +244,10 @@ if __name__ == "__main__": configarg=None if args.config: configarg = args.config + if (args.destination == None): + print("") + parser.print_help() + print("") client(args.destination, configarg) except KeyboardInterrupt: exit() \ No newline at end of file