sqnsupgrade: Make it compatible with UART upgrade on a PC.

Author: Daniel Campora

lib/sqnsupgrade/sqnsupgrade.py

@@ -4,9 +4,14 @@
 import stp
 import time
 import os
-from machine import UART
-from machine import SD
 
+sysname = os.uname().sysname
+
+if 'FiPy' in sysname or 'GPy' in sysname:
+    from machine import UART
+    from machine import SD
+else:   # this is a computer
+    import serial
 
 FFF_FMT = "<4sIIIIIIIHHIHHIHHHH"
 FFF_SLIM_FMT = "<4sIIIIIIIHHHH"
@@ -26,9 +31,14 @@ def read_rsp(s, size=None, timeout=-1):
         timeout = 20000
     elif timeout is None:
         timeout = 0
-    while not s.any() and timeout > 0:
-        time.sleep_ms(1)
-        timeout -= 1
+    if 'FiPy' in sysname or 'GPy' in sysname:
+        while not s.any() and timeout > 0:
+            time.sleep_ms(1)
+            timeout -= 1
+    else:
+        while s.in_waiting <= 0 and timeout > 0:
+            time.sleep(0.001)
+            timeout -= 1
 
     if size is not None:
         rsp = s.read(size)
@@ -47,62 +57,77 @@ def print_pretty_response(rsp):
 
 
 def wait_for_modem(s, send=True, expected=b'OK'):
+    rsp = b''
     while True:
         if send:
-            s.write("AT\r\n")
-        rsp = read_rsp(s, timeout=50)
+            s.write(b"AT\r\n")
+        r = read_rsp(s, size=(len(expected) + 4), timeout=50)
+        if r:
+            rsp += r
         if expected in rsp:
             print()
             break
         else:
             print('.', end='', flush=True)
             time.sleep(0.5)
 
-def run(file_path, baudrate):
+def run(file_path, baudrate, port=None):
+    global sysname
+
     abort = False
+    s = None
 
     print('<<< Welcome to the SQN3330 firmware updater >>>')
 
-    if '/sd' in file_path:
-        sd = SD()
-        time.sleep(0.5)
-        os.mount(sd, '/sd')
-        time.sleep(0.5)
+    if 'FiPy' in sysname or 'GPy' in sysname:
+        if '/sd' in file_path and not 'sd' in os.listdir('/'):
+            sd = SD()
+            time.sleep(0.5)
+            os.mount(sd, '/sd')
+            time.sleep(0.5)
 
-    blobsize = os.stat(file_path)[6]
-    blob = open(file_path, "rb")
+        if 'GPy' in sysname:
+            pins = ('P5', 'P98', 'P7', 'P99')
+        else:
+            pins = ('P20', 'P18', 'P19', 'P17')
 
-    if 'FiPy' in os.uname().sysname:
-        pins = ('P20', 'P18', 'P19', 'P17')
+        s = UART(1, baudrate=baudrate, pins=pins, timeout_chars=100)
+        s.read()
     else:
-        pins = ('P5', 'P98', 'P7', 'P99')
+        if port is None:
+            raise ValueError('serial port not specified')
+        s = serial.Serial(port, baudrate=921600, bytesize=serial.EIGHTBITS, timeout=0.1)
+        s.reset_input_buffer()
+        s.reset_output_buffer()
 
-    s = UART(1, baudrate=baudrate, pins=pins, timeout_chars=100)
-    s.read()
+    blobsize = os.stat(file_path)[6]
+    blob = open(file_path, "rb")
 
     # disable echo
-    s.write("ATE0\r\n")
-    response = read_rsp(s)
+    s.write(b"ATE0\r\n")
+    response = read_rsp(s, size=6)
 
+    s.read(100)
     print('Entering recovery mode')
-    s.write("AT+SMSWBOOT=3,0\r\n")
-    response = read_rsp(s)
+    s.write(b"AT+SMSWBOOT=3,0\r\n")
+    response = read_rsp(s, size=6)
     if b'OK' in response:
         print('Resetting.', end='', flush=True)
-        s.write('AT^RESET\r\n')
+        s.write(b'AT^RESET\r\n')
         wait_for_modem(s, send=False, expected=b'+SHUTDOWN')
         time.sleep(2)
         wait_for_modem(s)
-        s.write("AT\r\n")
-        s.write("AT\r\n")
+        s.write(b"AT\r\n")
+        s.write(b"AT\r\n")
     else:
         raise OSError('AT+SMSWBOOT=3,0 failed!')
 
     time.sleep(1)
     s.read()
 
     print('Starting STP (DO NOT DISCONNECT POWER!!!)')
-    s.write('AT+SMSTPU=\"ON_THE_FLY\"\r\n')
+    s.read(100)
+    s.write(b'AT+SMSTPU=\"ON_THE_FLY\"\r\n')
     response = read_rsp(s, size=4)
     if response != b'OK\r\n' and response != b'\r\nOK' and response != b'\nOK':
         raise OSError("Invalid answer '%s' from the device" % response)
@@ -118,36 +143,36 @@ def run(file_path, baudrate):
 
     time.sleep(1.5)
     s.read()
-    s.write("AT+SMSWBOOT=1,0\r\n")
-    response = read_rsp(s)
+    s.write(b"AT+SMSWBOOT=1,0\r\n")
+    response = read_rsp(s, size=6)
 
     print('Resetting (DO NOT DISCONNECT POWER!!!).', end='', flush=True)
     time.sleep(1.5)
-    s.write("AT^RESET\r\n")
+    s.write(b"AT^RESET\r\n")
     wait_for_modem(s, send=False, expected=b'+SHUTDOWN')
     time.sleep(2)
     wait_for_modem(s, send=False, expected=b'+SYSSTART')
 
     if not abort:
         time.sleep(0.5)
         print('Deploying the upgrade (DO NOT DISCONNECT POWER!!!)...')
-        s.write("AT+SMUPGRADE\r\n")
-        response = read_rsp(s, timeout=120000)
+        s.write(b"AT+SMUPGRADE\r\n")
+        response = read_rsp(s, size=6, timeout=120000)
 
         print('Resetting (DO NOT DISCONNECT POWER!!!).', end='', flush=True)
         time.sleep(1.5)
-        s.write("AT^RESET\r\n")
+        s.write(b"AT^RESET\r\n")
         wait_for_modem(s, send=False, expected=b'+SHUTDOWN')
         time.sleep(2)
         wait_for_modem(s, send=False, expected=b'+SYSSTART')
-        s.write("AT\r\n")
-        s.write("AT\r\n")
+        s.write(b"AT\r\n")
+        s.write(b"AT\r\n")
         time.sleep(0.5)
         s.read()
         print('Upgrade completed!')
         print("Here's the current firmware version:")
         time.sleep(0.5)
         s.read()
-        s.write("ATI1\r\n")
-        response = read_rsp(s)
+        s.write(b"ATI1\r\n")
+        response = read_rsp(s, size=100)
         print_pretty_response(response)

lib/sqnsupgrade/stp.py

@@ -3,8 +3,8 @@
 import struct
 import time
 import os
-from machine import UART
 
+sysname = os.uname().sysname
 
 # CRC-16(CCIT)
 def crc16(s):
@@ -69,18 +69,12 @@ def __str__(self):
         return self.s
 
 class SerialDev(object):
-    def __init__(self, serial, baud, timeout=None):
+    def __init__(self, serial, baud, timeout=90000):    # 90 seconds timeout
         self.serial = serial
-
-        if 'FiPy' in os.uname().sysname:
-            pins = ('P20', 'P18', 'P19', 'P17')
-        else:
-            pins = ('P5', 'P98', 'P7', 'P99')
-
-        self.serial.init(baudrate=baud, pins=pins, timeout_chars=100)
-        self.timeout = 90000    # 90 seconds
+        self.timeout = timeout
 
     def read(self, n):
+        global sysname
         _n = n
         t = self.timeout
         r = b''
@@ -91,8 +85,11 @@ def read(self, n):
                 if len(r) == n:
                     break
                 _n -= len(c)
-            time.sleep_ms(5)
-            t -= 5
+            if 'FiPy' in sysname or 'GPy' in sysname:
+                time.sleep_ms(2)
+            else:
+                time.sleep(0.002)
+            t -= 2
         return r
 
     def write(self, s):
@@ -250,6 +247,8 @@ def open_session(self):
 
 
     def send_data(self, blobfile, filesize, trials=4):
+        global sysname
+
         class Trial:
             def __init__(self, trials):
                 self.trials = trials
@@ -267,7 +266,10 @@ def need_retry(self, c, *a, **k):
         downloaded = 0
 
         while True:
-            data = blobfile.read(1536)
+            if 'FiPy' in sysname or 'GPy' in sysname:
+                data = blobfile.read(1536)
+            else:
+                data = blobfile.read(512)
             size = len(data)
             if size:
                 while size:
@@ -365,10 +367,10 @@ def start(elf, elfsize, serial, baud=3686400, retry=None, debug=None, AT=True):
         flush_data = dev.read(256)
         dev.serial.timeout = 1
 
-        ok_msg = "OK\r\n"
+        ok_msg = b"OK\r\n"
         print("Starting AT negociation")
 
-        dev.write("AT\n")
+        dev.write(b"AT\n")
         data = dev.read(len(ok_msg))
         if data != ok_msg:
             print("Remote didn't answered to AT command")
@@ -377,7 +379,7 @@ def start(elf, elfsize, serial, baud=3686400, retry=None, debug=None, AT=True):
             return
 
         print("Setting baudrate %d"%baud)
-        dev.write("AT+IPR=%d\n"%baud)
+        dev.write(b"AT+IPR=%d\n"%baud)
         data = dev.read(len(ok_msg))
         if data != ok_msg:
             print("Remote failed to set baudrate")
@@ -388,7 +390,7 @@ def start(elf, elfsize, serial, baud=3686400, retry=None, debug=None, AT=True):
 
         time.sleep(0.1)
         print("Starting STP")
-        dev.write("AT+STP\n")
+        dev.write(b"AT+STP\n")
         data = dev.read(len(ok_msg))
         if data != ok_msg:
             print("Remote failed to start STP")

lib/sqnsupgrade/uartmirror.py

@@ -0,0 +1,19 @@
+from machine import UART
+import time
+import os
+
+os.dupterm(None)
+
+repl_u = UART(0, baudrate=921600, timeout_chars=10)
+
+if 'FiPy' in os.uname().sysname:
+    lte_u = UART(1, baudrate=921600, pins=('P20', 'P18', 'P19', 'P17'), timeout_chars=10)
+else:
+    lte_u = UART(1, baudrate=921600, pins=('P5', 'P98', 'P7', 'P99'), timeout_chars=10)
+
+while True:
+    if repl_u.any():
+        lte_u.write(repl_u.read())
+    if lte_u.any():
+        repl_u.write(lte_u.read())
+    time.sleep_ms(2)