Merge pull request #76 from DiamondLightSource/I04-413_scan_completed_test

I04 413 scan completed test

Author: UrszulaNeuman

dls_barcode/camera/__init__.py

@@ -1,3 +1,3 @@
 from .camera_switch import CameraSwitch
 from .camera_scanner import CameraScanner
-from .scanner_message import NoNewBarcodeMessage, ScanErrorMessage
+from .scanner_message import NoNewBarcodeMessage, ScanErrorMessage, NoNewPuckBarcodeMessage

dls_barcode/camera/scanner_message.py

@@ -2,6 +2,10 @@ class NoNewBarcodeMessage:
     pass
 
 
+class NoNewPuckBarcodeMessage:
+    pass
+
+
 class ScanErrorMessage:
     def __init__(self, content):
         self._content = content

dls_barcode/camera/scanner_worker.py

@@ -6,7 +6,7 @@
 from dls_barcode.datamatrix import DataMatrix
 from .camera_position import CameraPosition
 from .plate_overlay import PlateOverlay
-from .scanner_message import NoNewBarcodeMessage, ScanErrorMessage
+from .scanner_message import NoNewBarcodeMessage, ScanErrorMessage, NoNewPuckBarcodeMessage
 
 NO_PUCK_TIME = 2
 
@@ -67,7 +67,10 @@ def _process_frame(self, frame, config, overlay_queue, result_queue, message_que
         elif scan_result.any_valid_barcodes():
             # We have read valid barcodes but they are not new, so the scanner didn't even output a plate
             self._last_puck_time = time.time()
-            message_queue.put(NoNewBarcodeMessage()) #important used in the message logic
+            if scan_result.geometry() is not None:
+                message_queue.put(NoNewBarcodeMessage()) #important used in the message logic
+            else:
+                message_queue.put(NoNewPuckBarcodeMessage())
         elif scan_result.error() is not None and (time.time() - self._last_puck_time > NO_PUCK_TIME):
             #TODO use log
             message_queue.put(ScanErrorMessage(scan_result.error()))

dls_barcode/gui/main_window.py

@@ -1,6 +1,7 @@
 from PyQt5 import QtWidgets, QtGui
 
 from dls_barcode.config import BarcodeConfigDialog
+from dls_barcode.gui.progress_bar import ProgressBox
 from dls_barcode.gui.scan_button import ScanButton
 from .barcode_table import BarcodeTable
 from .countdown_box import CountdownBox
@@ -60,7 +61,8 @@ def _init_ui(self):
         self._message_box = MessageBox()
 
         # Count down display
-        self._countdown_box = CountdownBox()
+        #self._countdown_box = CountdownBox()
+        self._countdown_box = ProgressBox()
 
         # Create layout
 
@@ -135,6 +137,9 @@ def closeEvent(self, event):
     def displayScanCompleteMessage(self):
         self._message_box.display(MessageFactory.scan_completed_message())
 
+    def displayPuckScanCompleteMessage(self):
+        self._message_box.display(MessageFactory.puck_scan_completed_message())
+
     def displayScanErrorMessage(self, scanner_msg):
         self._message_box.display(MessageFactory.from_scanner_message(scanner_msg))
 
@@ -155,3 +160,6 @@ def startCountdown(self, count):
 
     def resetCountdown(self):
         self._countdown_box.reset_countdown()
+
+    def scanCompleted(self):
+        self._countdown_box.scan_completed()

dls_barcode/gui/message_factory.py

@@ -17,4 +17,8 @@ def scan_timeout_message():
 
     @staticmethod
     def scan_completed_message():
-        return Message(MessageType.INFO, "Scan completed")
+        return Message(MessageType.INFO, "Scan completed")
+
+    @staticmethod
+    def puck_scan_completed_message():
+        return Message(MessageType.INFO, "Scan completed!")

dls_barcode/gui/progress_bar.py

@@ -0,0 +1,51 @@
+from PyQt5 import QtCore
+from PyQt5.QtWidgets import QLabel, QGroupBox, QVBoxLayout, QProgressBar
+
+BLACK = "; color: black"
+BASIC_STYLE_SHEET = "font-size: 20pt"
+
+
+class ProgressBox(QGroupBox):
+    """GUI component. Displays countdown for the user."""
+
+    def __init__(self):
+        super(ProgressBox, self).__init__()
+
+        self.setTitle("Scan Completed")
+        self.setMaximumHeight(100)
+        self.setMaximumWidth(200)
+        self._timer = None
+        self._init_ui()
+        self.count = 0
+
+    def _init_ui(self):
+        self.pbar = QProgressBar(self)
+        self.pbar.setGeometry(30, 40, 200, 25)
+        vbox = QVBoxLayout()
+        vbox.addWidget(self.pbar)
+        vbox.addStretch()
+        self.setLayout(vbox)
+
+    def start_countdown(self, count):
+        self.count = 0
+        self.pbar.setValue(self.count)
+        self.max = count
+        self._timer = QtCore.QTimer()
+        self._timer.timeout.connect(self.display)
+        self._timer.start(1000)
+
+    def reset_countdown(self):
+            if self._timer is not None:
+                self._timer.stop()
+                self._timer = None
+            self.count = 0
+            self.pbar.setValue(self.count)
+
+    def display(self):
+        if self.count <= self.max:
+            self.count = self.count + 1
+            self.pbar.setValue(100 * (self.count / self.max))
+
+    def scan_completed(self):
+        self.count = 100
+        self.pbar.setValue(self.count)

dls_barcode/main_manager.py

@@ -5,7 +5,8 @@
 
 from PyQt5 import QtCore
 
-from dls_barcode.camera import CameraScanner, CameraSwitch, NoNewBarcodeMessage, ScanErrorMessage
+from dls_barcode.camera import CameraScanner, CameraSwitch, ScanErrorMessage, NoNewPuckBarcodeMessage
+
 from dls_util import Beeper
 
 RESULT_TIMER_PERIOD = 1000  # ms
@@ -23,6 +24,7 @@ def __init__(self, ui, config):
         # Scan elements
         self._camera_scanner = None
         self._camera_switch = None
+        self._scan_completed_message_flag = False
 
         # Queue that holds new results generated in continuous scanning mode
         self._result_queue = multiprocessing.Queue()
@@ -62,7 +64,6 @@ def initialise_scanner(self):
         self._camera_switch = CameraSwitch(self._camera_scanner, self._config.top_camera_timeout)
 
         self._restart_live_capture_from_side()
-        self._ui.resetCountdown()
 
     def _camera_capture_alive(self):
         return self._camera_scanner is not None and self._camera_switch is not None
@@ -78,7 +79,6 @@ def _restart_live_capture_from_side(self):
         log.debug("5) starting live capture form side")
         self._reset_msg_timer()
         self._camera_switch.restart_live_capture_from_side()
-        self._ui.resetCountdown()
 
     def _read_message_queue(self):
         if self._message_queue.empty():
@@ -93,11 +93,13 @@ def _read_message_queue(self):
             if not self._msg_timer_is_running():
                 # The result queue is read at a slower rate - use a timer to give it time to process a new barcode
                 self._start_msg_timer()
-            elif self._has_msg_timer_timeout() and isinstance(scanner_msg, NoNewBarcodeMessage):
-                self._ui.displayScanCompleteMessage()
+            elif self._has_msg_timer_timeout() and isinstance(scanner_msg, NoNewPuckBarcodeMessage):
+                self._ui.displayPuckScanCompleteMessage()
+                self._ui.scanCompleted()
             elif isinstance(scanner_msg, ScanErrorMessage):
                 self._ui.displayScanErrorMessage(scanner_msg)
                 self._reset_msg_timer()
+                self._ui.resetCountdown()
         else:
             self._reset_msg_timer()
 
@@ -137,6 +139,7 @@ def _read_result_queue(self):
             self._read_top_scan()
 
     def _read_side_scan(self):
+        self._scan_completed_message_flag = False
         if self._result_queue.empty():
             return
 
@@ -156,14 +159,21 @@ def _read_side_scan(self):
             self._restart_live_capture_from_top()
 
     def _read_top_scan(self):
-        if self._result_queue.empty():
-            if self._camera_switch.is_top_scan_timeout():
+        if self._camera_switch.is_top_scan_timeout():
+            log = logging.getLogger(".".join([__name__]))
+            extra = ({"timeout_value": 1})
+            log = logging.LoggerAdapter(log, extra)
+            log.info("scan timeout", extra)
+            if self._scan_completed_message_flag:
+                self._ui.displayScanCompleteMessage()
+                self._ui.scanCompleted()
+            else:
                 self._ui.displayScanTimeoutMessage()
-                log = logging.getLogger(".".join([__name__]))
-                extra = ({"timeout_value": 1})
-                log = logging.LoggerAdapter(log, extra)
-                log.info("scan timeout", extra)
-                self._restart_live_capture_from_side()
+                self._ui.resetCountdown()
+            self._restart_live_capture_from_side()
+            return
+
+        if self._result_queue.empty():
             return
 
         # Get the result
@@ -173,6 +183,7 @@ def _read_top_scan(self):
         self._ui.addRecordFrame(self._latest_holder_barcode, plate, self._latest_holder_image, pins_image)
 
         if not plate.is_full_valid():
+            self._scan_completed_message_flag = True
             return
 
         # Barcodes successfully read
@@ -181,4 +192,7 @@ def _read_top_scan(self):
         extra = ({"scan_time": self._camera_switch.get_scan_time(), "timeout_value": 0})
         log = logging.LoggerAdapter(log, extra)
         log.info("Scan Completed", extra)
+        self._ui.displayScanCompleteMessage()
+        self._ui.scanCompleted()
+        self._scan_completed_message_flag = True
         self._restart_live_capture_from_side()

docs/release-notes/release-notes-dev.md

@@ -5,7 +5,9 @@ Changes merged into master
 --------------------------
 | Jira Task | GitHub Issue | Type | Description |
 |-----------|--------------|------|-------------|
-|I04_1-I04_1-415||Patch|Puck scanner - record backup functionality change|
+|I04_1-415 | | Patch|Puck scanner - record backup functionality change|
+|I04_1-413 | |Patch|Puck scanner - 'Scan completed' delay|
+
 
 Change Types:
 * Major - Backward incompatible change