v1.5.1 - auto port refresh when COM combo box is clicked

Author: PaulZC

README.md

@@ -13,16 +13,15 @@ If you need to install the application, see the [Installation Section](#installa
 ## Upload Firmware
 
 * Attach the RTK product over USB
-* Click ```Refresh```
+* Click the ```COM Port``` combo box and select the correct COM port from the dropdown menu
 
-![Select Firmware](images/RTK_Uploader_Windows_2.png)
+![Select COM Port](images/RTK_Uploader_Windows_2.png)
 
-* Select the correct COM port from the dropdown menu
 * Adjust the Baud Rate if desired
-* Click ```Browse``` and select the firmware file you'd like to upload (should end in *.bin*)
+* Click ```Browse``` and select the firmware file you'd like to upload (the filename should end in *.bin*)
   * You can find the firmware in the [SparkFun_RTK_Firmware_Binaries repo on GitHub](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries)
   * The older versions of the firmware are in a [separate folder](https://github.com/sparkfun/SparkFun_RTK_Firmware_Binaries/tree/main/PreviousVersions)
-  * If you have one of the earliest RTK Surveyors with 4MB flash, please select v1_12
+  * If you have one of the earliest RTK Surveyors with 4MB flash, please select **v1_12**
 
 ![Select Firmware](images/RTK_Uploader_Windows_4.png)
 
@@ -34,7 +33,7 @@ The selected firmware is then uploaded to the connected SparkFun RTK product. Up
 
 ## Reset ESP32
 
-Clicking the ```Reset ESP32``` button . This is helpful when the firmware update succeeds but does not reset the RTK correctly.
+Clicking the ```Reset ESP32``` button will reset the ESP32 processor. This is helpful when the firmware update succeeds but does not reset the RTK correctly.
 If your RTK 'freezes' after the update, pressing ```Reset ESP32``` will get it going again.
 
 ![Reset ESP32](images/RTK_Uploader_Windows_3.png)

RTK_Firmware_Uploader/RTK_Firmware_Uploader.py

@@ -51,6 +51,18 @@ def get_version(rel_path: str) -> str:
 
 _APP_VERSION = get_version("_version.py")
 
+# ----------------------------------------------------------------
+# hack to know when a combobox menu is being shown. Helpful if contents
+# of list are dynamic -- like serial ports.
+
+class AUxComboBox(QComboBox):
+
+    popupAboutToBeShown = pyqtSignal()
+
+    def showPopup(self):
+        self.popupAboutToBeShown.emit()
+        super().showPopup()
+
 #----------------------------------------------------------------
 # ux_is_darkmode()
 #
@@ -131,13 +143,14 @@ def __init__(self, parent: QWidget = None) -> None:
 
         # Port Combobox
         self.port_label = QLabel(self.tr('COM Port:'))
-        self.port_combobox = QComboBox()
+        self.port_combobox = AUxComboBox()
         self.port_label.setBuddy(self.port_combobox)
         self.update_com_ports()
+        self.port_combobox.popupAboutToBeShown.connect(self.on_port_combobox)
 
-        # Refresh Button
-        self.refresh_btn = QPushButton(self.tr('Refresh'))
-        self.refresh_btn.clicked.connect(self.on_refresh_btn_pressed)
+        # Reset Button
+        self.reset_btn = QPushButton(self.tr('Reset ESP32'))
+        self.reset_btn.clicked.connect(self.on_reset_btn_pressed)
 
         # Baudrate Combobox
         self.baud_label = QLabel(self.tr('Baud Rate:'))
@@ -152,10 +165,6 @@ def __init__(self, parent: QWidget = None) -> None:
         self.upload_btn.setFont(myFont)
         self.upload_btn.clicked.connect(self.on_upload_btn_pressed)
 
-        # Reset Button
-        self.reset_btn = QPushButton(self.tr('Reset ESP32'))
-        self.reset_btn.clicked.connect(self.on_reset_btn_pressed)
-
         # Messages Bar
         self.messages_label = QLabel(self.tr('Status / Warnings:'))
 
@@ -179,16 +188,14 @@ def __init__(self, parent: QWidget = None) -> None:
 
         layout.addWidget(self.port_label, 2, 0)
         layout.addWidget(self.port_combobox, 2, 1)
-        layout.addWidget(self.refresh_btn, 2, 2)
+        layout.addWidget(self.reset_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.reset_btn, 4, 2)
-
-        layout.addWidget(self.messages_label, 5, 0)
-        layout.addWidget(self.messageBox, 6, 0, 6, 3)
+        layout.addWidget(self.messages_label, 4, 0)
+        layout.addWidget(self.messageBox, 5, 0, 5, 3)
 
         self.setLayout(layout)
 
@@ -278,16 +285,30 @@ def on_finished(self, status, action_type, job_id) -> None:
 
         # If the flash detection is finished, trigger the upload
         if action_type == AUxEsptoolDetectFlash.ACTION_ID:
+            self.writeMessage("Flash detection complete. Uploading firmware...")
             self.do_upload()
 
         # If the upload is finished, trigger a reset
         elif action_type == AUxEsptoolUploadFirmware.ACTION_ID:
+            self.writeMessage("Firmware upload complete. Resetting ESP32...")
             self.on_reset_btn_pressed()
 
         # re-enable the UX
         else:
+            self.writeMessage("Reset complete...")
             self.disable_interface(False)
 
+    # --------------------------------------------------------------
+    # on_port_combobox()
+    #
+    # Called when the combobox pop-up menu is about to be shown
+    #
+    # Use this event to dynamically update the displayed ports
+    #
+    @pyqtSlot()
+    def on_port_combobox(self):
+        self.update_com_ports()
+
     def _load_settings(self) -> None:
         """Load settings on startup."""
         port_name = self.settings.value(SETTING_PORT_NAME)
@@ -386,10 +407,6 @@ def closeEvent(self, event: QCloseEvent) -> None:
 
         event.accept()
 
-    def on_refresh_btn_pressed(self) -> None:
-        self.update_com_ports()
-        self.writeMessage("Ports Refreshed\n")
-
     def on_browse_btn_pressed(self) -> None:
         """Open dialog to select bin file."""
         options = QFileDialog.Options()

RTK_Firmware_Uploader/resource/_version.py

@@ -1 +1 @@
-__version__ = "1.5.0"
+__version__ = "1.5.1"