Add Uploader GUI

Uploader_GUI/RTK_Firmware_Uploader_GUI.py

@@ -0,0 +1,346 @@
+"""
+This is a simple Python3 PyQt5 firmware upload GUI for the SparkFun RTK products - based on ESP32 esptool.exe
+
+Please make sure you are using Python3. You will see a bunch of errors with Python2.
+To install PyQt5:
+  pip install PyQt5
+or
+  pip3 install PyQt5
+or
+  sudo apt-get install python3-pyqt5
+You may also need:
+  sudo apt-get install python3-pyqt5.qtserialport
+
+Pyinstaller:
+Windows:
+pyinstaller --onefile --clean --noconsole --distpath=./Windows_exe --icon=RTK.ico --add-binary="esptool.exe;." --add-binary="RTK_Surveyor.ino.partitions.bin;." --add-binary="RTK_Surveyor.ino.bootloader.bin;." --add-binary="boot_app0.bin;." --add-binary="RTK.png;." RTK_Firmware_Uploader_GUI.py
+
+Pyinstaller needs:
+RTK_Firmware_Uploader_GUI.py (this file!)
+RTK.ico (icon file for the .exe)
+RTK.png (icon for the GUI widget)
+esptool.exe
+RTK_Surveyor.ino.partitions.bin
+RTK_Surveyor.ino.bootloader.bin
+boot_app0.bin
+
+
+MIT license
+
+Please see the LICENSE.md for more details
+
+"""
+
+from typing import Iterator, Tuple
+
+from PyQt5.QtCore import QSettings, QProcess, QTimer, Qt, QIODevice, pyqtSlot
+from PyQt5.QtWidgets import QWidget, QLabel, QComboBox, QGridLayout, \
+    QPushButton, QApplication, QLineEdit, QFileDialog, QPlainTextEdit, \
+    QAction, QActionGroup, QMenu, QMenuBar, QMainWindow, QMessageBox
+from PyQt5.QtGui import QCloseEvent, QTextCursor, QIcon, QFont
+from PyQt5.QtSerialPort import QSerialPortInfo, QSerialPortInfo
+import sys
+import os
+
+# Setting constants
+SETTING_PORT_NAME = 'port_name'
+SETTING_FILE_LOCATION = 'message'
+SETTING_BAUD_RATE = '921600' # Default to 921600 for upload
+
+guiVersion = 'v1.0'
+
+def gen_serial_ports() -> Iterator[Tuple[str, str, str]]:
+    """Return all available serial ports."""
+    ports = QSerialPortInfo.availablePorts()
+    return ((p.description(), p.portName(), p.systemLocation()) for p in ports)
+
+#https://stackoverflow.com/a/50914550
+def resource_path(relative_path):
+    """ Get absolute path to resource, works for dev and for PyInstaller """
+    base_path = getattr(sys, '_MEIPASS', os.path.dirname(os.path.abspath(__file__)))
+    return os.path.join(base_path, relative_path)
+
+# noinspection PyArgumentList
+
+class MainWidget(QWidget):
+    """Main Widget."""
+
+    def __init__(self, parent: QWidget = None) -> None:
+        super().__init__(parent)
+
+        self.p = None # This will be the esptool QProcess
+
+        # File location line edit
+        self.msg_label = QLabel(self.tr('Firmware File:'))
+        self.fileLocation_lineedit = QLineEdit()
+        self.msg_label.setBuddy(self.fileLocation_lineedit)
+        self.fileLocation_lineedit.setEnabled(False)
+        self.fileLocation_lineedit.returnPressed.connect(
+            self.on_browse_btn_pressed)
+
+        # Browse for new file button
+        self.browse_btn = QPushButton(self.tr('Browse'))
+        self.browse_btn.setEnabled(True)
+        self.browse_btn.pressed.connect(self.on_browse_btn_pressed)
+
+        # Port Combobox
+        self.port_label = QLabel(self.tr('COM Port:'))
+        self.port_combobox = QComboBox()
+        self.port_label.setBuddy(self.port_combobox)
+        self.update_com_ports()
+
+        # Refresh Button
+        self.refresh_btn = QPushButton(self.tr('Refresh'))
+        self.refresh_btn.clicked.connect(self.on_refresh_btn_pressed)
+
+        # Baudrate Combobox
+        self.baud_label = QLabel(self.tr('Baud Rate:'))
+        self.baud_combobox = QComboBox()
+        self.baud_label.setBuddy(self.baud_combobox)
+        self.update_baud_rates()
+
+        # Upload Button
+        myFont=QFont()
+        myFont.setBold(True)
+        self.upload_btn = QPushButton(self.tr('  Upload Firmware  '))
+        self.upload_btn.setFont(myFont)
+        self.upload_btn.clicked.connect(self.on_upload_btn_pressed)
+
+        # Messages Bar
+        self.messages_label = QLabel(self.tr('Status / Warnings:'))
+
+        # Messages Window
+        self.messages = QPlainTextEdit()
+
+        # Arrange Layout
+        layout = QGridLayout()
+
+        layout.addWidget(self.msg_label, 1, 0)
+        layout.addWidget(self.fileLocation_lineedit, 1, 1)
+        layout.addWidget(self.browse_btn, 1, 2)
+
+        layout.addWidget(self.port_label, 2, 0)
+        layout.addWidget(self.port_combobox, 2, 1)
+        layout.addWidget(self.refresh_btn, 2, 2)
+
+        layout.addWidget(self.baud_label, 3, 0)
+        layout.addWidget(self.baud_combobox, 3, 1)
+        layout.addWidget(self.upload_btn, 3, 2)
+
+        layout.addWidget(self.messages_label, 4, 0)
+        layout.addWidget(self.messages, 5, 0, 5, 3)
+
+        self.setLayout(layout)
+
+        #self._clean_settings() # This will delete all existing settings! Use with caution!
+
+        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:
+        """Add msg to the messages window, ensuring that it is visible"""
+        self.messages.moveCursor(QTextCursor.End)
+        self.messages.ensureCursorVisible()
+        self.messages.appendPlainText(msg)
+        self.messages.ensureCursorVisible()
+        self.repaint() # Update/refresh the message window
+
+    def insertMessageText(self, msg: str) -> None:
+        """Add msg to the messages window, ensuring that it is visible"""
+        self.messages.moveCursor(QTextCursor.End)
+        self.messages.ensureCursorVisible()
+        self.messages.insertPlainText(msg)
+        self.messages.ensureCursorVisible()
+        self.repaint() # Update/refresh the message window
+
+    def _load_settings(self) -> None:
+        """Load settings on startup."""
+        self.settings = QSettings()
+
+        port_name = self.settings.value(SETTING_PORT_NAME)
+        if port_name is not None:
+            index = self.port_combobox.findData(port_name)
+            if index > -1:
+                self.port_combobox.setCurrentIndex(index)
+
+        lastFile = self.settings.value(SETTING_FILE_LOCATION)
+        if lastFile is not None:
+            self.fileLocation_lineedit.setText(lastFile)
+
+        baud = self.settings.value(SETTING_BAUD_RATE)
+        if baud is not None:
+            index = self.baud_combobox.findData(baud)
+            if index > -1:
+                self.baud_combobox.setCurrentIndex(index)
+
+    def _save_settings(self) -> None:
+        """Save settings on shutdown."""
+        self.settings = QSettings()
+        self.settings.setValue(SETTING_PORT_NAME, self.port)
+        self.settings.setValue(SETTING_FILE_LOCATION, self.fileLocation_lineedit.text())
+        self.settings.setValue(SETTING_BAUD_RATE, self.baudRate)
+
+    def _clean_settings(self) -> None:
+        """Clean (remove) all existing settings."""
+        self.settings = QSettings()
+        self.settings.clear()
+
+    def show_error_message(self, msg: str) -> None:
+        """Show a Message Box with the error message."""
+        QMessageBox.critical(self, QApplication.applicationName(), str(msg))
+
+    def update_com_ports(self) -> None:
+        """Update COM Port list in GUI."""
+        previousPort = self.port # Record the previous port before we clear the combobox
+
+        self.port_combobox.clear()
+
+        index = 0
+        indexOfPrevious = -1
+        for desc, name, sys in gen_serial_ports():
+            longname = desc + " (" + name + ")"
+            self.port_combobox.addItem(longname, sys)
+            if(sys == previousPort): # Previous port still exists so record it
+                indexOfPrevious = index
+            index = index + 1
+
+        if indexOfPrevious > -1: # Restore the previous port if it still exists
+            self.port_combobox.setCurrentIndex(indexOfPrevious)
+
+    def update_baud_rates(self) -> None:
+        """Update baud rate list in GUI."""
+        # Highest speed first so code defaults to that
+        # if settings.value(SETTING_BAUD_RATE) is None
+        self.baud_combobox.clear()
+        self.baud_combobox.addItem("921600", 921600)
+        self.baud_combobox.addItem("460800", 460800)
+        self.baud_combobox.addItem("115200", 115200)
+
+    @property
+    def port(self) -> str:
+        """Return the current serial port."""
+        return str(self.port_combobox.currentData())
+
+    @property
+    def baudRate(self) -> str:
+        """Return the current baud rate."""
+        return str(self.baud_combobox.currentData())
+
+    @property
+    def theFileName(self) -> str:
+        """Return the file name."""
+        return self.fileLocation_lineedit.text()
+
+    def closeEvent(self, event: QCloseEvent) -> None:
+        """Handle Close event of the Widget."""
+        try:
+            self._save_settings()
+        except:
+            pass
+
+        event.accept()
+
+    def on_refresh_btn_pressed(self) -> None:
+        self.update_com_ports()
+        self.addMessage("Ports Refreshed\n")
+
+    def on_browse_btn_pressed(self) -> None:
+        """Open dialog to select bin file."""
+        options = QFileDialog.Options()
+        fileName, _ = QFileDialog.getOpenFileName(
+            None,
+            "Select Firmware to Upload",
+            "",
+            "Firmware Files (*.bin);;All Files (*)",
+            options=options)
+        if fileName:
+            self.fileLocation_lineedit.setText(fileName)
+
+    def handle_stderr(self) -> None:
+        data = self.p.readAllStandardError()
+        stderr = bytes(data).decode("utf8")
+        self.insertMessageText(stderr)
+
+    def handle_stdout(self) -> None:
+        data = self.p.readAllStandardOutput()
+        stdout = bytes(data).decode("utf8")
+        self.insertMessageText(stdout)
+
+    def handle_state(self, state) -> None:
+        states = {
+            QProcess.NotRunning: 'Not running\n',
+            QProcess.Starting: 'Starting\n',
+            QProcess.Running: 'Running\n',
+        }
+        state_name = states[state]
+        self.addMessage(f"Upload state changed: {state_name}")
+
+    def process_finished(self) -> None:
+        self.addMessage("Upload finished\n")
+        self.p = None
+
+    def on_upload_btn_pressed(self) -> None:
+        """Upload the firmware"""
+        portAvailable = False
+        for desc, name, sys in gen_serial_ports():
+            if (sys == self.port):
+                portAvailable = True
+        if (portAvailable == False):
+            self.addMessage("Port No Longer Available")
+            return
+
+        fileExists = False
+        try:
+            f = open(self.fileLocation_lineedit.text())
+            fileExists = True
+        except IOError:
+            fileExists = False
+        finally:
+            if (fileExists == False):
+                self.addMessage("File Not Found")
+                return
+            f.close()
+
+        if self.p is None:
+            self.addMessage("Uploading firmware\n")
+
+            self.p = QProcess()
+            self.p.readyReadStandardOutput.connect(self.handle_stdout)
+            self.p.readyReadStandardError.connect(self.handle_stderr)
+            self.p.stateChanged.connect(self.handle_state)
+            self.p.finished.connect(self.process_finished)
+
+            command = []
+            command.append("--chip")
+            command.append("esp32")
+            command.append("--port")
+            command.append(self.port)
+            command.append("--baud")
+            command.append(self.baudRate)
+            command.extend(["--before","default_reset","--after","hard_reset","write_flash","-z","--flash_mode","dio","--flash_freq","80m","--flash_size","detect"])
+            command.extend(["0x1000",resource_path("RTK_Surveyor.ino.bootloader.bin")])
+            command.extend(["0x8000",resource_path("RTK_Surveyor.ino.partitions.bin")])
+            command.extend(["0xe000",resource_path("boot_app0.bin")])
+            command.append("0x10000")
+            command.append(self.theFileName)
+
+            self.addMessage("Command: esptool.py %s\n" % " ".join(command))
+
+            self.p.start(resource_path("esptool.exe"), command)
+
+        else:
+            self.addMessage("\nUploader is already running!\n")
+
+
+if __name__ == '__main__':
+    from sys import exit as sysExit
+    app = QApplication([])
+    app.setOrganizationName('SparkFun')
+    app.setApplicationName('SparkFun RTK Firmware Uploader ' + guiVersion)
+    app.setWindowIcon(QIcon(resource_path("RTK.png")))
+    w = MainWidget()
+    w.show()
+    sys.exit(app.exec_())