Working v1.0

Author: Nathan Seidle

README.md

@@ -0,0 +1,42 @@
+SparkFun Artemis Firmware Uploader GUI
+========================================
+
+![Artemis Firmware Uploader GUI](https://cdn.sparkfun.com/assets/home_page_posts/3/2/4/5/Artemis_Firmware_Uploader_GUI.jpg)
+
+The Artemis Firmware Uploader (AFU) is a simple to use Windows GUI for updating firmware and the bootloader on Artemis based products.
+
+To use:
+
+* Download the repo ZIP
+* Run artemis_firmware_uploader_gui.exe
+* Select the firmware file you'd like to upload (should end in *.bin*)
+* Attach the Artemis target board over USB
+* Select the COM port (hit Refresh to refresh the list of USB devices)
+* Press Upload
+
+Be sure you are loading firmware for your board or product. While it's unlikely to damage Artemis by loading incorrect firmware it will erase the pre-existing firmware and may lead to the peripherals being controlled incorrectly.
+
+A *Blink.bin* firmware file is included. This will cause pin 5 to blink at 1Hz.
+
+Pressing the 'Update Bootloader' button will erase all firmware on the Artemis and load the latest bootloader firmware. This is handy when SparkFun releases updates to the [SVL](https://github.com/sparkfun/SparkFun_Apollo3_AmbiqSuite_BSPs/blob/master/common/examples/artemis_svl/src/main.c).
+
+SparkFun labored with love to create this code. Feel like supporting open source hardware? 
+Buy a [breakout board](https://www.sparkfun.com/products/15444) from SparkFun!
+
+Repository Contents
+-------------------
+
+* **/tools** - The python source files and executables
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+If you have any questions or concerns on licensing, please contact [email protected].
+
+Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release any derivative under the same license.
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.

Together/AFU.exe

@@ -10,24 +10,24 @@
 TODO:
 
 Push user to upgrade bootloader as needed
+Bootloader from CLI:
+ambiq_bin2board.exe --bin "artemis_svl.bin" --load-address-blob 0x20000 --magic-num 0xCB --version 0x0 --load-address-wired 0xC000 -i 6 --options 0x1 -b 115200 -port "COM3" -r 2 -v
+
+ambiq_bin2board.exe --bin "artemis_svl.bin" --load-address-blob 0x20000 --magic-num 0xCB --version 0x0 --load-address-wired 0xC000 -i 6 --options 0x1 -b 115200 -port "COM3" -r 2 -v
 
 """
 from typing import Iterator, Tuple
 from serial.tools.list_ports import comports
-from PyQt5.QtCore import QSettings, QProcess
+from PyQt5.QtCore import QSettings, QProcess, QTimer
 from PyQt5.QtWidgets import QWidget, QLabel, QComboBox, QGridLayout, \
-    QPushButton, QApplication, QLineEdit, QFileDialog
-from PyQt5.QtGui import QCloseEvent
-
-# import artemis_svl
+    QPushButton, QApplication, QLineEdit, QFileDialog, QPlainTextEdit
+from PyQt5.QtGui import QCloseEvent, QTextCursor
 
 # Setting constants
 SETTING_PORT_NAME = 'port_name'
 SETTING_FILE_LOCATION = 'message'
 SETTING_BAUD_RATE = '921600'
 
-progressCount = 1
-
 guiVersion = 'v1.0'
 
 
@@ -69,7 +69,7 @@ def __init__(self, parent: QWidget = None) -> None:
         self.refresh_btn.pressed.connect(self.on_refresh_btn_pressed)
 
         # Baudrate Combobox
-        self.baud_label = QLabel(self.tr('Baud:'))
+        self.baud_label = QLabel(self.tr('Baud Rate:'))
         self.baud_combobox = QComboBox()
         self.baud_label.setBuddy(self.baud_combobox)
         self.update_baud_rates()
@@ -78,10 +78,24 @@ def __init__(self, parent: QWidget = None) -> None:
         self.upload_btn = QPushButton(self.tr('Upload'))
         self.upload_btn.pressed.connect(self.on_upload_btn_pressed)
 
+        # Upload Button
+        self.updateBootloader_btn = QPushButton(self.tr('Update Bootloader'))
+        self.updateBootloader_btn.pressed.connect(
+            self.on_update_bootloader_btn_pressed)
+
         # Status bar
         self.status_label = QLabel(self.tr('Status:'))
         self.status = QLabel(self.tr(' '))
 
+        # Messages Bar
+        self.messages_label = QLabel(self.tr('Status / Warnings:'))
+
+        # Messages Window
+        self.messages = QPlainTextEdit()
+        # Attempting to reduce window size
+        #self.messages.setMinimumSize(1, 2)
+        #self.messages.resize(1, 2)
+
         # Arrange Layout
         layout = QGridLayout()
         layout.addWidget(self.msg_label, 0, 0)
@@ -94,14 +108,30 @@ def __init__(self, parent: QWidget = None) -> None:
 
         layout.addWidget(self.baud_label, 2, 0)
         layout.addWidget(self.baud_combobox, 2, 1)
-        layout.addWidget(self.upload_btn, 3, 2)
 
-        layout.addWidget(self.status_label, 3, 0)
-        layout.addWidget(self.status, 3, 1)
+        #layout.addWidget(self.status_label, 3, 0)
+        #layout.addWidget(self.status, 3, 1)
+
+        layout.addWidget(self.messages_label, 3, 0)
+        layout.addWidget(self.messages, 4, 0, 4, 3)
+
+        layout.addWidget(self.upload_btn, 15, 2)
+        layout.addWidget(self.updateBootloader_btn, 15, 1)
+
         self.setLayout(layout)
 
         self._load_settings()
 
+        # Make the text edit window read-only
+        self.messages.setReadOnly(True)
+        self.messages.clear()  # Clear the message window
+
+    def addMessage(self, msg: str) -> None:
+        self.messages.moveCursor(QTextCursor.End)
+        self.messages.ensureCursorVisible()
+        self.messages.appendPlainText(msg)
+        self.messages.ensureCursorVisible()
+
     def _load_settings(self) -> None:
         """Load settings on startup."""
         settings = QSettings()
@@ -139,11 +169,26 @@ def show_error_message(self, msg: str) -> None:
     def update_com_ports(self) -> None:
         """Update COM Port list in GUI."""
         self.port_combobox.clear()
+
+        index = 0
+        indexOfCH340 = -1
         for name, device in gen_serial_ports():
             self.port_combobox.addItem(name, device)
+            if("CH340" in name):
+                if(indexOfCH340 == -1):  # Select the first available
+                    indexOfCH340 = index
+                    #print("CH340 found at index " + str(indexOfCH340))
+            index = index + 1
+
+        # If we have no previous settings, and CH340 is in the list, auto-select it
+        if indexOfCH340 > -1:
+            settings = QSettings()
+            port_name = settings.value(SETTING_PORT_NAME)
+            if port_name is not None:
+                self.port_combobox.setCurrentIndex(indexOfCH340)
 
     def update_baud_rates(self) -> None:
-        """Update COM Port list in GUI."""
+        """Update baud rate list in GUI."""
         self.baud_combobox.addItem("921600", 921600)
         self.baud_combobox.addItem("460800", 460800)
         self.baud_combobox.addItem("115200", 115200)
@@ -167,6 +212,7 @@ def closeEvent(self, event: QCloseEvent) -> None:
 
     def on_refresh_btn_pressed(self) -> None:
         self.update_com_ports()
+        self.addMessage("Ports Refreshed")
 
     def on_upload_btn_pressed(self) -> None:
         """Check if port is available"""
@@ -176,7 +222,7 @@ def on_upload_btn_pressed(self) -> None:
             if (p.device == self.port):
                 portAvailable = True
         if (portAvailable == False):
-            self.status.setText("Port No Longer Available")
+            self.addMessage("Port No Longer Available")
             return
 
         """Check if file exists"""
@@ -188,46 +234,62 @@ def on_upload_btn_pressed(self) -> None:
             fileExists = False
         finally:
             if (fileExists == False):
-                self.status.setText("File Not Found")
+                self.addMessage("File Not Found")
                 return
             f.close()
 
-        global progressCount
-        progressCount = 0
+        self.addMessage("Uploading")
+
+        self.process = QProcess()
+        self.process.readyReadStandardError.connect(
+            self.onReadyReadStandardError)
+        self.process.readyReadStandardOutput.connect(
+            self.onReadyReadStandardOutput)
+
+        commandString = "tools/artemis_svl.exe " + \
+            str(self.port) + " -f\"" + self.fileLocation_lineedit.text() + \
+            "\"" + " -b" + str(self.baudRate)
+        print(commandString)
+        self.process.start(commandString)
+
+    def on_update_bootloader_btn_pressed(self) -> None:
+        """Check if port is available"""
+        portAvailable = False
+        ports = comports()
+        for p in ports:
+            if (p.device == self.port):
+                portAvailable = True
+        if (portAvailable == False):
+            self.addMessage("Port No Longer Available")
+            return
 
-        self.status.setText("Uploading ")
+        self.addMessage("Updating bootloader")
 
         self.process = QProcess()
         self.process.readyReadStandardError.connect(
             self.onReadyReadStandardError)
         self.process.readyReadStandardOutput.connect(
             self.onReadyReadStandardOutput)
 
-        self.process.start("artemis_svl.exe " + str(self.port) +
-                           " -f\"" + self.fileLocation_lineedit.text() + "\"" + " -b" + str(self.baudRate))
+        self.process.start("tools/ambiq_bin2board.exe --bin tools/artemis_svl.bin --load-address-blob 0x20000 --magic-num 0xCB --version 0x0 --load-address-wired 0xC000 -i 6 --options 0x1 -b 115200 -port " + str(self.port) +
+                           " -r 2 -v")
 
     def onReadyReadStandardError(self):
         error = self.process.readAllStandardError().data().decode()
         # print(error)
-        self.status.setText(error)
+        self.addMessage(error)
 
     def onReadyReadStandardOutput(self):
         """Parse the output from the process. Update our status as we go."""
         result = self.process.readAllStandardOutput().data().decode()
         # print(result)
+        self.addMessage(result)
         if ("complete" in result):
-            self.status.setText("Complete")
+            self.addMessage("Complete")
         elif ("failed" in result):
-            self.status.setText("Upload Failed")
+            self.addMessage("Upload Failed")
         elif ("open" in result):
-            self.status.setText("Port In Use / Please Close")
-        else:  # The '#' is displayed 50 times until completion
-            global progressCount
-            progressCount = progressCount + result.count("#")
-            # print(progressCount)
-            for i in range(int(progressCount / 3)):
-                current = self.status.text() + "."
-                self.status.setText(current)
+            self.addMessage("Port In Use / Please Close")
 
     def on_browse_btn_pressed(self) -> None:
         """Open dialog to select bin file."""
@@ -246,7 +308,7 @@ def on_browse_btn_pressed(self) -> None:
     import sys
     app = QApplication([])
     app.setOrganizationName('SparkFun')
-    app.setApplicationName('Artemis Firmware Uploader')
+    app.setApplicationName('Artemis Firmware Uploader ' + guiVersion)
     w = RemoteWidget()
     w.show()
     sys.exit(app.exec_())