# MIT License # # Copyright (c) 2016-2022 Mark Qvist / unsigned.io # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. from RNS.Interfaces.Interface import Interface from time import sleep import sys import threading import time import RNS class KISS(): FEND = 0xC0 FESC = 0xDB TFEND = 0xDC TFESC = 0xDD CMD_UNKNOWN = 0xFE CMD_DATA = 0x00 CMD_TXDELAY = 0x01 CMD_P = 0x02 CMD_SLOTTIME = 0x03 CMD_TXTAIL = 0x04 CMD_FULLDUPLEX = 0x05 CMD_SETHARDWARE = 0x06 CMD_READY = 0x0F CMD_RETURN = 0xFF @staticmethod def escape(data): data = data.replace(bytes([0xdb]), bytes([0xdb, 0xdd])) data = data.replace(bytes([0xc0]), bytes([0xdb, 0xdc])) return data class KISSInterface(Interface): MAX_CHUNK = 32768 BITRATE_GUESS = 1200 owner = None port = None speed = None databits = None parity = None stopbits = None serial = None def __init__(self, owner, name, port, speed, databits, parity, stopbits, preamble, txtail, persistence, slottime, flow_control, beacon_interval, beacon_data): import importlib if RNS.vendor.platformutils.is_android(): self.on_android = True if importlib.util.find_spec('usbserial4a') != None: if importlib.util.find_spec('jnius') == None: RNS.log("Could not load jnius API wrapper for Android, KISS interface cannot be created.", RNS.LOG_CRITICAL) RNS.log("This probably means you are trying to use an USB-based interface from within Termux or similar.", RNS.LOG_CRITICAL) RNS.log("This is currently not possible, due to this environment limiting access to the native Android APIs.", RNS.LOG_CRITICAL) RNS.panic() from usbserial4a import serial4a as serial self.parity = "N" else: RNS.log("Could not load USB serial module for Android, KISS interface cannot be created.", RNS.LOG_CRITICAL) RNS.log("You can install this module by issuing: pip install usbserial4a", RNS.LOG_CRITICAL) RNS.panic() else: raise SystemError("Android-specific interface was used on non-Android OS") super().__init__() self.HW_MTU = 564 if beacon_data == None: beacon_data = "" self.pyserial = serial self.serial = None self.owner = owner self.name = name self.port = port self.speed = speed self.databits = databits self.parity = "N" self.stopbits = stopbits self.timeout = 100 self.online = False self.beacon_i = beacon_interval self.beacon_d = beacon_data.encode("utf-8") self.first_tx = None self.bitrate = KISSInterface.BITRATE_GUESS self.packet_queue = [] self.flow_control = flow_control self.interface_ready = False self.flow_control_timeout = 5 self.flow_control_locked = time.time() 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 = "E" if parity.lower() == "o" or parity.lower() == "odd": self.parity = "O" try: self.open_port() except Exception as e: RNS.log(f"Could not open serial port {self.port}", RNS.LOG_ERROR) raise e if self.serial.is_open: self.configure_device() else: raise OSError("Could not open serial port") def open_port(self): RNS.log(f"Opening serial port {self.port}...") # Get device parameters from usb4a import usb device = usb.get_usb_device(self.port) if device: vid = device.getVendorId() pid = device.getProductId() # Driver overrides for speficic chips proxy = self.pyserial.get_serial_port if vid == 0x1A86 and pid == 0x55D4: # Force CDC driver for Qinheng CH34x RNS.log(f"{self} using CDC driver for {RNS.hexrep(vid)}:{RNS.hexrep(pid)}", RNS.LOG_DEBUG) from usbserial4a.cdcacmserial4a import CdcAcmSerial proxy = CdcAcmSerial self.serial = proxy( self.port, baudrate = self.speed, bytesize = self.databits, parity = self.parity, stopbits = self.stopbits, xonxoff = False, rtscts = False, timeout = None, inter_byte_timeout = None, # write_timeout = wtimeout, dsrdtr = False, ) if vid == 0x0403: # Hardware parameters for FTDI devices @ 115200 baud self.serial.DEFAULT_READ_BUFFER_SIZE = 16 * 1024 self.serial.USB_READ_TIMEOUT_MILLIS = 100 self.serial.timeout = 0.1 elif vid == 0x10C4: # Hardware parameters for SiLabs CP210x @ 115200 baud self.serial.DEFAULT_READ_BUFFER_SIZE = 64 self.serial.USB_READ_TIMEOUT_MILLIS = 12 self.serial.timeout = 0.012 elif vid == 0x1A86 and pid == 0x55D4: # Hardware parameters for Qinheng CH34x @ 115200 baud self.serial.DEFAULT_READ_BUFFER_SIZE = 64 self.serial.USB_READ_TIMEOUT_MILLIS = 12 self.serial.timeout = 0.1 else: # Default values self.serial.DEFAULT_READ_BUFFER_SIZE = 1 * 1024 self.serial.USB_READ_TIMEOUT_MILLIS = 100 self.serial.timeout = 0.1 RNS.log(f"{self} USB read buffer size set to {RNS.prettysize(self.serial.DEFAULT_READ_BUFFER_SIZE)}", RNS.LOG_DEBUG) RNS.log(f"{self} USB read timeout set to {self.serial.USB_READ_TIMEOUT_MILLIS}ms", RNS.LOG_DEBUG) RNS.log(f"{self} USB write timeout set to {self.serial.USB_WRITE_TIMEOUT_MILLIS}ms", RNS.LOG_DEBUG) def configure_device(self): # Allow time for interface to initialise before config sleep(2.0) thread = threading.Thread(target=self.readLoop) thread.daemon = True thread.start() self.online = True RNS.log(f"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) self.setFlowControl(self.flow_control) self.interface_ready = True RNS.log("KISS interface configured") def setPreamble(self, preamble): preamble_ms = preamble preamble = int(preamble_ms / 10) if preamble < 0: preamble = 0 if preamble > 255: preamble = 255 kiss_command = bytes([KISS.FEND])+bytes([KISS.CMD_TXDELAY])+bytes([preamble])+bytes([KISS.FEND]) written = self.serial.write(kiss_command) if written != len(kiss_command): raise OSError(f"Could not configure KISS interface preamble to {preamble_ms} (command value {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 = bytes([KISS.FEND])+bytes([KISS.CMD_TXTAIL])+bytes([txtail])+bytes([KISS.FEND]) written = self.serial.write(kiss_command) if written != len(kiss_command): raise OSError(f"Could not configure KISS interface TX tail to {txtail_ms} (command value {txtail})") def setPersistence(self, persistence): if persistence < 0: persistence = 0 if persistence > 255: persistence = 255 kiss_command = bytes([KISS.FEND])+bytes([KISS.CMD_P])+bytes([persistence])+bytes([KISS.FEND]) written = self.serial.write(kiss_command) if written != len(kiss_command): raise OSError(f"Could not configure KISS interface persistence to {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 = bytes([KISS.FEND])+bytes([KISS.CMD_SLOTTIME])+bytes([slottime])+bytes([KISS.FEND]) written = self.serial.write(kiss_command) if written != len(kiss_command): raise OSError(f"Could not configure KISS interface slot time to {slottime_ms} (command value {slottime})") def setFlowControl(self, flow_control): kiss_command = bytes([KISS.FEND])+bytes([KISS.CMD_READY])+bytes([0x01])+bytes([KISS.FEND]) written = self.serial.write(kiss_command) if written != len(kiss_command): if (flow_control): raise OSError("Could not enable KISS interface flow control") else: raise OSError("Could not enable KISS interface flow control") def processIncoming(self, data): self.rxb += len(data) def af(): self.owner.inbound(data, self) threading.Thread(target=af, daemon=True).start() def processOutgoing(self,data): datalen = len(data) if self.online: if self.interface_ready: if self.flow_control: self.interface_ready = False self.flow_control_locked = time.time() data = data.replace(bytes([0xdb]), bytes([0xdb])+bytes([0xdd])) data = data.replace(bytes([0xc0]), bytes([0xdb])+bytes([0xdc])) frame = bytes([KISS.FEND])+bytes([0x00])+data+bytes([KISS.FEND]) written = self.serial.write(frame) self.txb += datalen if data == self.beacon_d: self.first_tx = None else: if self.first_tx == None: self.first_tx = time.time() if written != len(frame): raise OSError(f"Serial interface only wrote {written} bytes of {len(data)}") else: self.queue(data) def queue(self, data): self.packet_queue.append(data) def process_queue(self): if len(self.packet_queue) > 0: data = self.packet_queue.pop(0) self.interface_ready = True self.processOutgoing(data) elif len(self.packet_queue) == 0: self.interface_ready = True def readLoop(self): try: in_frame = False escape = False command = KISS.CMD_UNKNOWN data_buffer = b"" last_read_ms = int(time.time()*1000) while self.serial.is_open: serial_bytes = self.serial.read() got = len(serial_bytes) for byte in serial_bytes: 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 = b"" elif (in_frame and len(data_buffer) < self.HW_MTU): if (len(data_buffer) == 0 and command == KISS.CMD_UNKNOWN): # We only support one HDLC port for now, so # strip off the port nibble byte = 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 escape = False data_buffer = data_buffer+bytes([byte]) elif (command == KISS.CMD_READY): self.process_queue() if got == 0: time_since_last = int(time.time()*1000) - last_read_ms if len(data_buffer) > 0 and time_since_last > self.timeout: data_buffer = b"" in_frame = False command = KISS.CMD_UNKNOWN escape = False sleep(0.05) if self.flow_control: if not self.interface_ready: if time.time() > self.flow_control_locked + self.flow_control_timeout: RNS.log(f"Interface {self} is unlocking flow control due to time-out. This should not happen. Your hardware might have missed a flow-control READY command, or maybe it does not support flow-control.", RNS.LOG_WARNING) self.process_queue() if self.beacon_i != None and self.beacon_d != None: if self.first_tx != None: if time.time() > self.first_tx + self.beacon_i: RNS.log(f"Interface {self} is transmitting beacon data: {self.beacon_d.decode('utf-8')}", RNS.LOG_DEBUG) self.first_tx = None self.processOutgoing(self.beacon_d) except Exception as e: self.online = False RNS.log(f"A serial port error occurred, the contained exception was: {e}", RNS.LOG_ERROR) RNS.log(f"The interface {self} experienced an unrecoverable error and is now offline.", RNS.LOG_ERROR) if RNS.Reticulum.panic_on_interface_error: RNS.panic() RNS.log("Reticulum will attempt to reconnect the interface periodically.", RNS.LOG_ERROR) self.online = False self.serial.close() self.reconnect_port() def reconnect_port(self): while not self.online: try: time.sleep(5) RNS.log(f"Attempting to reconnect serial port {self.port} for {self}...", RNS.LOG_VERBOSE) self.open_port() if self.serial.is_open: self.configure_device() except Exception as e: RNS.log(f"Error while reconnecting port, the contained exception was: {e}", RNS.LOG_ERROR) RNS.log(f"Reconnected serial port for {self}") def should_ingress_limit(self): return False def __str__(self): return f"KISSInterface[{self.name}]"