Merged master into this branch

Author: IsabellaRey

README.md

@@ -24,6 +24,7 @@ This section serves as an introduction for developers who are interested in main
 * [Data Matrix Reading](docs/datamatrix-reader.md)
 * [Unipuck Geometry Calculation](docs/unipuck.md)
 * [Camera Scanning](docs/scanning.md)
+* [Icons Tips](docs/icons_tips.md)
 
 Release Notes
 -------------

build.bat

@@ -3,7 +3,7 @@ mkdir bin
 
 cd dls_barcode
 
-pyinstaller --onefile --windowed main.py
+pyinstaller --onefile --windowed --icon=..\resources\icons\qr_code.ico --clean main.py
 
 move dist\main.exe ..\bin\barcode.exe
 rd /S /Q build

dls_barcode/data_store/store.py

@@ -125,6 +125,6 @@ def _merge_holder_image_into_pins_image(self, holder_img, pins_img):
         merged_img.paste(small_holder_img, 0, 0)
         return merged_img
 
-    def is_new_holder_barcode(self, holder_barcode):
-        known_holder_barcodes = [r.holder_barcode for r in self.records]
-        return not holder_barcode in known_holder_barcodes
+    def is_latest_holder_barcode(self, holder_barcode):
+        latest_record = self.get_record(0)
+        return latest_record is not None and holder_barcode == latest_record.holder_barcode

dls_barcode/gui/main_window.py

@@ -32,7 +32,6 @@ def __init__(self, config_file, version):
         # UI elements
         self._record_table = None
         self._barcode_table = None
-        self.sideBarcodeWindow = None
         self._image_frame = None
 
         # Scan elements
@@ -61,14 +60,16 @@ def __init__(self, config_file, version):
         self._message_timer.timeout.connect(self._read_message_queue)
         self._message_timer.start(MESSAGE_TIMER_PERIOD)
 
-        self._camera_switch.restart_live_capture_from_side()
+        self._restart_live_capture_from_side()
 
     def _init_ui(self):
         """ Create the basic elements of the user interface.
         """
+        self._init_icons()
+
         self.setGeometry(100, 100, 1020, 650)
         self.setWindowTitle('Diamond Puck Barcode Scanner')
-        self.setWindowIcon(QtGui.QIcon('web.png'))
+        self.setWindowIcon(self._window_icon)
 
         self.init_menu_bar()
 
@@ -109,30 +110,37 @@ def _init_ui(self):
 
         self.show()
 
+    def _init_icons(self):
+        self._window_icon = QtGui.QIcon("..\\resources\\icons\\qr_code_32.png")
+        self._start_capture_icon = self.style().standardIcon(QtGui.QStyle.SP_MediaPlay)
+        self._exit_icon = self.style().standardIcon(QtGui.QStyle.SP_DialogCloseButton)
+        self._config_icon = self.style().standardIcon(QtGui.QStyle.SP_FileDialogDetailedView)
+        self._about_icon = self.style().standardIcon(QtGui.QStyle.SP_FileDialogInfoView)
+
     def init_menu_bar(self):
         """Create and populate the menu bar.
         """
         # Continuous scanner mode
-        live_action = QtGui.QAction(QtGui.QIcon('open.png'), '&Camera Capture', self)
+        live_action = QtGui.QAction(self._start_capture_icon, '&Camera Capture', self)
         live_action.setShortcut('Ctrl+W')
         live_action.setStatusTip('Capture continuously from camera')
         live_action.triggered.connect(self._on_scan_action_clicked)
 
         # Exit Application
-        exit_action = QtGui.QAction(QtGui.QIcon('exit.png'), '&Exit', self)
+        exit_action = QtGui.QAction(self._exit_icon, '&Exit', self)
         exit_action.setShortcut('Ctrl+Q')
         exit_action.setStatusTip('Exit application')
         exit_action.triggered.connect(self._cleanup)
         exit_action.triggered.connect(QtGui.qApp.quit)
 
         # Open options dialog
-        options_action = QtGui.QAction(QtGui.QIcon('exit.png'), '&Options', self)
+        options_action = QtGui.QAction(self._config_icon, '&Config', self)
         options_action.setShortcut('Ctrl+O')
         options_action.setStatusTip('Open Options Dialog')
         options_action.triggered.connect(self._on_options_action_clicked)
 
         # Show version number
-        about_action = QtGui.QAction("About", self)
+        about_action = QtGui.QAction(self._about_icon, "About", self)
         about_action.triggered.connect(self._on_about_action_clicked)
 
         # Create menu bar
@@ -143,7 +151,7 @@ def init_menu_bar(self):
         scan_menu = menu_bar.addMenu('&Scan')
         scan_menu.addAction(live_action)
 
-        option_menu = menu_bar.addMenu('&Option')
+        option_menu = menu_bar.addMenu('&Options')
         option_menu.addAction(options_action)
 
         help_menu = menu_bar.addMenu('?')
@@ -157,7 +165,7 @@ def _on_scan_action_clicked(self):
         if not self._camera_capture_alive():
             self._initialise_scanner()
 
-        self._camera_switch.restart_live_capture_from_side()
+        self._restart_live_capture_from_side()
 
     def _on_options_action_clicked(self):
         result_ok = self._open_options_dialog()
@@ -166,10 +174,11 @@ def _on_options_action_clicked(self):
 
         self._cleanup()
         self._initialise_scanner()
-        self._camera_switch.restart_live_capture_from_side()
+        self._restart_live_capture_from_side()
 
     def _open_options_dialog(self):
-        dialog = BarcodeConfigDialog(self._config, self._before_test_camera) # pass the object here and trigger when the button is pressed
+        dialog = BarcodeConfigDialog(self._config, self._before_test_camera)
+        dialog.setWindowIcon(self._config_icon)
         result_ok = dialog.exec_()
         return result_ok
 
@@ -227,22 +236,23 @@ def _read_message_queue(self):
                 # 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():
-                self._message_box.display(MessageFactory.duplicate_barcode_message())
+                self._message_box.display(MessageFactory.latest_barcode_message())
         else:
             self._reset_msg_timer()
             self._message_box.display(MessageFactory.from_scanner_message(scanner_msg))
 
     def _reset_msg_timer(self):
-        self._duplicate_msg_timer = None
+        self._duplicate_record_msg_timer = None
 
     def _start_msg_timer(self):
-        self._duplicate_msg_timer = time.time()
+        self._duplicate_record_msg_timer = time.time()
 
     def _msg_timer_is_running(self):
-        return self._duplicate_msg_timer is not None
+        return self._duplicate_record_msg_timer is not None
 
     def _has_msg_timer_timeout(self):
-        return self._msg_timer_is_running() and time.time() - self._duplicate_msg_timer > 2 * RESULT_TIMER_PERIOD / 1000
+        timeout = 2 * RESULT_TIMER_PERIOD / 1000
+        return self._msg_timer_is_running() and time.time() - self._duplicate_record_msg_timer > timeout
 
     def _read_result_queue(self):
         """ Called every second; read any new results from the scan results queue, store them and display them.
@@ -268,33 +278,40 @@ def _read_side_scan(self):
         Beeper.beep()
         print("MAIN: puck barcode recorded")
         holder_barcode = plate.barcodes()[0]
-        if self._record_table.is_new_holder_barcode (holder_barcode):
-            self._current_holder_barcode = holder_barcode
+        if not self._record_table.is_latest_holder_barcode(holder_barcode):
+            self._latest_holder_barcode = holder_barcode
             self._latest_holder_image = holder_image
             self._message_box.display(MessageFactory.puck_recorded_message())
-            self._camera_switch.restart_live_capture_from_top()
+            self._restart_live_capture_from_top()
         else:
-            self._message_box.display(MessageFactory.duplicate_barcode_message())
+            self._message_box.display(MessageFactory.latest_barcode_message())
 
     def _read_top_scan(self):
         if self._result_queue.empty():
             if self._camera_switch.is_top_scan_timeout():
                 self._message_box.display(MessageFactory.scan_timeout_message())
                 print("\n*** Scan timeout ***")
-                self._camera_switch.restart_live_capture_from_side()
+                self._restart_live_capture_from_side()
             return
 
         # Get the result
         plate, pins_image = self._result_queue.get(False)
 
-        # Add new record to the table - side is the _current_holder_barcode read first, top is the plate
-        self._record_table.add_record_frame(self._current_holder_barcode, plate, self._latest_holder_image, pins_image)
+        # Add new record to the table - side is the _latest_holder_barcode read first, top is the plate
+        self._record_table.add_record_frame(self._latest_holder_barcode, plate, self._latest_holder_image, pins_image)
         if not plate.is_full_valid():
             return
 
         # Barcodes successfully read
         Beeper.beep()
         print("Scan Completed")
         self._message_box.display(MessageFactory.scan_completed_message())
+        self._restart_live_capture_from_side()
+
+    def _restart_live_capture_from_top(self):
+        self._camera_switch.restart_live_capture_from_top()
+
+    def _restart_live_capture_from_side(self):
+        self._reset_msg_timer()
         self._camera_switch.restart_live_capture_from_side()
 

dls_barcode/gui/message_factory.py

@@ -3,8 +3,8 @@
 
 class MessageFactory:
     @staticmethod
-    def duplicate_barcode_message():
-        return Message(MessageType.WARNING, "Puck barcode already in database", lifetime=3)
+    def latest_barcode_message():
+        return Message(MessageType.WARNING, "Puck barcode already in latest record", lifetime=3)
 
     @staticmethod
     def from_scanner_message(scanner_msg):

dls_barcode/gui/record_table.py

@@ -137,7 +137,7 @@ def _delete_selected_records(self):
             self._store.delete_records(records_to_delete)
             self._load_store_records()
 
-    def is_new_holder_barcode(self, holder_barcode):
-        return self._store.is_new_holder_barcode(holder_barcode)
+    def is_latest_holder_barcode(self, holder_barcode):
+        return self._store.is_latest_holder_barcode(holder_barcode)
 
 

docs/icons_tips.md

@@ -0,0 +1,115 @@
+Icons Tips
+==========
+
+The icons used in the application are mostly standard system icons. They can be found under `QtGui.QStyle`, e.g. `QtGui.QStyle.SP_MediaPlay`.
+A list of icons is available [here](https://deptinfo-ensip.univ-poitiers.fr/ENS/pyside-docs/PySide/QtGui/QStyle.html?highlight=qstyle#PySide.QtGui.PySide.QtGui.QStyle.StandardPixmap).
+
+To view them quickly, you can run the following code (taken from [here](https://joekuan.wordpress.com/2015/09/23/list-of-qt-icons/)):
+```
+import sys
+from PyQt4.QtCore import *
+from PyQt4.QtGui import *
+# from PyQt4.QtWidgets import *
+
+
+class Widget(QWidget):
+    def __init__(self, parent=None):
+        super(Widget, self).__init__()
+
+        icons = [
+            'SP_ArrowBack',
+            'SP_ArrowDown',
+            'SP_ArrowForward',
+            'SP_ArrowLeft',
+            'SP_ArrowRight',
+            'SP_ArrowUp',
+            'SP_BrowserReload',
+            'SP_BrowserStop',
+            'SP_CommandLink',
+            'SP_ComputerIcon',
+            'SP_CustomBase',
+            'SP_DesktopIcon',
+            'SP_DialogApplyButton',
+            'SP_DialogCancelButton',
+            'SP_DialogCloseButton',
+            'SP_DialogDiscardButton',
+            'SP_DialogHelpButton',
+            'SP_DialogNoButton',
+            'SP_DialogOkButton',
+            'SP_DialogOpenButton',
+            'SP_DialogResetButton',
+            'SP_DialogSaveButton',
+            'SP_DialogYesButton',
+            'SP_DirClosedIcon',
+            'SP_DirHomeIcon',
+            'SP_DirIcon',
+            'SP_DirLinkIcon',
+            'SP_DirOpenIcon',
+            'SP_DockWidgetCloseButton',
+            'SP_DriveCDIcon',
+            'SP_DriveDVDIcon',
+            'SP_DriveFDIcon',
+            'SP_DriveHDIcon',
+            'SP_DriveNetIcon',
+            'SP_FileDialogBack',
+            'SP_FileDialogContentsView',
+            'SP_FileDialogDetailedView',
+            'SP_FileDialogEnd',
+            'SP_FileDialogInfoView',
+            'SP_FileDialogListView',
+            'SP_FileDialogNewFolder',
+            'SP_FileDialogStart',
+            'SP_FileDialogToParent',
+            'SP_FileIcon',
+            'SP_FileLinkIcon',
+            'SP_MediaPause',
+            'SP_MediaPlay',
+            'SP_MediaSeekBackward',
+            'SP_MediaSeekForward',
+            'SP_MediaSkipBackward',
+            'SP_MediaSkipForward',
+            'SP_MediaStop',
+            'SP_MediaVolume',
+            'SP_MediaVolumeMuted',
+            'SP_MessageBoxCritical',
+            'SP_MessageBoxInformation',
+            'SP_MessageBoxQuestion',
+            'SP_MessageBoxWarning',
+            'SP_TitleBarCloseButton',
+            'SP_TitleBarContextHelpButton',
+            'SP_TitleBarMaxButton',
+            'SP_TitleBarMenuButton',
+            'SP_TitleBarMinButton',
+            'SP_TitleBarNormalButton',
+            'SP_TitleBarShadeButton',
+            'SP_TitleBarUnshadeButton',
+            'SP_ToolBarHorizontalExtensionButton',
+            'SP_ToolBarVerticalExtensionButton',
+            'SP_TrashIcon',
+            'SP_VistaShield'
+        ]
+
+        colSize = 4
+
+        layout = QGridLayout()
+
+        count = 0
+        for i in icons:
+            btn = QPushButton(i)
+            btn.setIcon(self.style().standardIcon(getattr(QStyle, i)))
+
+            layout.addWidget(btn, count / colSize, count % colSize)
+            count += 1
+
+        self.setLayout(layout)
+
+
+if __name__ == '__main__':
+    app = QApplication(sys.argv)
+
+    dialog = Widget()
+    dialog.show()
+
+    app.exec_()
+```
+

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

@@ -6,6 +6,8 @@ Changes merged into master
 | Jira Task | GitHub Issue | Type | Description |
 |-----------|--------------|------|-------------|
 | I04_1-167 | [#44](https://github.com/DiamondLightSource/PuckBarcodeReader/issues/44) | Minor | Added version number display |
+| I04_1-152 | [#48](https://github.com/DiamondLightSource/PuckBarcodeReader/issues/48) | Patch | Fixed missing icons |
+| I04_1-177 | [#46](https://github.com/DiamondLightSource/PuckBarcodeReader/issues/46) | Minor | Allow records for duplicate holder barcodes |
 
 
 Change Types: