Error handling improvements

* Added specific arduino protocol exception catchs and error report
* Now an arduino protocol error during evaluation doesn't break experiment and report to the user the problem
* The error text on arduino pin setup shows the human friendly name of the port (when possible)

Author: Marco-GG

MLC/GUI/Experiment/ArduinoConfigManager/ArduinoBoardManager.py

@@ -28,6 +28,7 @@
 from MLC.arduino import boards
 from MLC.arduino.connection.serialconnection import SerialConnection, SerialConnectionConfig
 from MLC.arduino.protocol import ProtocolConfig, BuildSerial
+from MLC.arduino.connection.base import ConnectionException, ConnectionTimeoutException
 
 from PyQt5.QtWidgets import QMessageBox
 from PyQt5.QtCore import QTimer
@@ -150,10 +151,12 @@ def conn_check(self):
             arduino_if = BuildSerial(config)
             version = arduino_if.get_version()
             self.__connection_status.set_ok()
-        except serial.SerialTimeoutException:
+        except ConnectionTimeoutException:
             self.__connection_status.set_error("Error: connection timeout")
-        except serial.SerialException:
+        except ConnectionException:
             self.__connection_status.set_error("Error: Board unreachable")
+        except ValueError, err:
+            self.__connection_status.set_error("Error: {0}".format(err))
 
     def board_changed(self, new_idx, old_idx):
         ret = QMessageBox.Yes
@@ -180,7 +183,7 @@ def board_changed(self, new_idx, old_idx):
     def start_bench(self):
         try:
             self.__setup = self.__setup._replace(connection=self.start_connection(), **self.__main_window.checkout_board_setup())
-        except serial.SerialException:
+        except SerialConnectionException:
             self.show_error(
                 "Error", "Connection failure", "Could not start connection to board", QMessageBox.Critical, QMessageBox.Ok)
             return

MLC/GUI/Experiment/ExperimentInProgress.py

@@ -32,6 +32,7 @@
 from MLC.Application import MLC_CALLBACKS
 from MLC.GUI.Autogenerated.autogenerated import Ui_ExperimentInProgressWindow
 from MLC.GUI.Experiment.QtCharts.QtChartWrapper import QtChartWrapper
+from MLC.arduino.protocol import ProtocolIOException, ProtocolSetupException
 from MLC.Log.log import get_gui_logger
 
 from PyQt5.QtCore import pyqtSignal
@@ -59,6 +60,7 @@ def __init__(self):
         self._condition = Condition()
         self._experiment_stopped = False
         self._experiment_cancelled = False
+        self._experiment_failure = False
 
     def stop_experiment(self):
         self._condition.acquire()
@@ -78,6 +80,12 @@ def cancel_experiment(self):
         self._condition.notify()
         self._condition.release()
 
+    def fail_experiment(self):
+        self._condition.acquire()
+        self._experiment_failure = True
+        self._condition.notify()
+        self._condition.release()
+
     def wait_if_experiment_stopped(self):
         had_to_wait = False
         self._condition.acquire()
@@ -94,11 +102,19 @@ def experiment_cancelled(self):
         self._condition.release()
         return cancelled
 
+    def experiment_failure(self):
+        self._condition.acquire()
+        failure = self._experiment_failure
+        self._condition.release()
+        return failure
+
 
 class ExperimentInProgressWindow(QMainWindow):
     indiv_evaluated = pyqtSignal([int, int, int, float])
     new_generation = pyqtSignal()
     simulation_finished = pyqtSignal()
+    board_setup_failure = pyqtSignal([str])
+    board_io_error = pyqtSignal([str])
 
     def __init__(self, parent, parent_signal, chart_params, from_gen, to_gen):
         QMainWindow.__init__(self, parent)
@@ -115,6 +131,8 @@ def __init__(self, parent, parent_signal, chart_params, from_gen, to_gen):
         self.indiv_evaluated.connect(self._update_dialog)
         self.simulation_finished.connect(self._simulation_finished)
         self.new_generation.connect(self._create_new_chart)
+        self.board_setup_failure.connect(self._board_setup_failure)
+        self.board_io_error.connect(self._board_io_error)
 
         # Signal to be emited when the experiment finished
         self._parent_signal = parent_signal
@@ -172,7 +190,8 @@ def _update_dialog(self, indivs_per_gen_counter, total_indivs_counter, gen_count
 
     def _simulation_finished(self):
         logger.debug('{0} [SIM_FINISHED] - Executing _simulation_finished function'.format(self._log_prefix))
-        self._parent_signal.emit(self._experiment_condition.experiment_cancelled())
+        self._parent_signal.emit(self._experiment_condition.experiment_cancelled(),
+                                 self._experiment_condition.experiment_failure())
 
     def _update_current_gen_experiment(self, indiv_index, cost):
         if cost > self._chart_params["max_cost"]:
@@ -227,6 +246,21 @@ def _create_new_chart(self):
         picture_layout.addWidget(indiv_canvas)
         self._indiv_chart = indiv_chart
 
+    def _board_setup_failure(self, error):
+        logger.debug('{0} [SIM_FINISHED] - Board setup failure: {1}'.format(self._log_prefix, error))
+        selection = QMessageBox.critical(self, "Board Setup error",
+                                            error,
+                                            QMessageBox.Ok)
+        self._experiment_condition.cancel_experiment()
+        self._simulation_finished()
+
+    def _board_io_error(self, error):
+        logger.debug('{0} [SIM_FINISHED] - Board IO error: {1}'.format(self._log_prefix, error))
+        selection = QMessageBox.critical(self, "Board IO error",
+                                            error,
+                                            QMessageBox.Ok)
+        self._experiment_condition.cancel_experiment()
+        self._simulation_finished()
 
 class ExperimentInProgress(Thread):
 
@@ -283,6 +317,16 @@ def run(self):
             logger.info('{0} [RUN] - Thread was cancelled by the user'
                         .format(self._log_prefix))
             self._dialog.simulation_finished.emit()
+        except ProtocolSetupException, err:
+            logger.info('{0} [RUN] - Error in arduino configuration'
+                        .format(self._log_prefix))
+            self._experiment_condition.fail_experiment()
+            self._dialog.board_setup_failure.emit(str(err))
+        except ProtocolIOException, err:
+            logger.info('{0} [RUN] - I/O error in arduino connection'
+                        .format(self._log_prefix))
+            self._experiment_condition.fail_experiment()
+            self._dialog.board_io_error.emit(srt(err))
         except Exception:
             logger.info('{0} [RUN] - Unknown Exception catch. Aborting experiment'
                         .format(self._log_prefix))

MLC/GUI/Experiment/ExperimentWindow.py

@@ -55,16 +55,16 @@
 from PyQt5.QtWidgets import QMessageBox
 from PyQt5.QtWidgets import QInputDialog
 
-from MLC.arduino.protocol import ProtocolConfig
+from MLC.arduino.protocol import ProtocolConfig, ProtocolSetupException, ProtocolIOException
 from MLC.arduino.protocol import ArduinoInterfaceSingleton
-from MLC.arduino.connection.serialconnection import SerialConnectionConfig, SerialConnection
+from MLC.arduino.connection.serialconnection import SerialConnectionConfig, SerialConnection, ConnectionException
 from MLC.arduino.connection.base import BaseConnection
 
 logger = get_gui_logger()
 
 
 class ExperimentWindow(QMainWindow):
-    experiment_finished = pyqtSignal([bool])
+    experiment_finished = pyqtSignal([bool, bool])
 
     MAX_GENERATIONS = 30
 
@@ -145,13 +145,13 @@ def on_start_button_clicked(self):
             ArduinoInterfaceSingleton.get_instance(protocol_config=self._board_config,
                                                    conn_setup=self._serial_conn._asdict())
 
-        except Exception, err:
+        except (ProtocolSetupException, ConnectionException) as err:
             logger.debug('[EXPERIMENT {0}] [BOARD_CONFIG] - '
                          'Serial port could not be initialized. Error Msg: {1}'
                          .format(self._experiment_name, err))
             selection = QMessageBox.critical(self, "Connection failure",
                                              "The current connection arduino setup failed during initialization "
-                                             "(Error: {0}), This may generate an error in your experiment.\n"
+                                             "(Error: {0}), this may generate an error in your experiment.\n"
                                              "Do you want to continue?".format(err),
                                              QMessageBox.Yes | QMessageBox.No,
                                              QMessageBox.Yes)
@@ -161,6 +161,9 @@ def on_start_button_clicked(self):
                 QMessageBox.information(self, "Check setup", "Please, open the arduino board configurator in order to "
                                                              "analize and resolve the error.", QMessageBox.Ok)
                 return
+        except Exception as err:
+            self._report_arduino_unhandled_error(err)
+            return
 
         from_gen = int(self._autogenerated_object.from_gen_combo.currentText())
         to_gen = int(self._autogenerated_object.to_gen_combo.currentText())
@@ -859,12 +862,12 @@ def _ask_if_experiment_config_must_be_saved(self):
 
             self._autogenerated_object.save_config_button.setDisabled(True)
 
-    def _update_experiment(self, cancelled):
+    def _update_experiment(self, cancelled, failed):
         self._progress_dialog.close_window()
-        if not cancelled:
+        if not cancelled and not failed:
             QMessageBox.information(self, 'Experiment {0}'.format(self._experiment_name),
                                     'Experiment was succesfully executed.', QMessageBox.Ok)
-        else:
+        if cancelled and not failed:
             QMessageBox.information(self, 'Experiment {0}'.format(self._experiment_name),
                                     'Experiment was cancelled by the user.', QMessageBox.Ok)
 
@@ -893,7 +896,7 @@ def _store_board_configuration(self, board_config, serial_conn):
             # Update board configuration in the DB
             self._mlc_local.save_board_configuration(self._experiment_name, self._board_config, self._serial_conn)
 
-        except Exception, err:
+        except (ProtocolSetupException, ConnectionException) as err:
             logger.debug('[EXPERIMENT {0}] [BOARD_CONFIG] - '
                          'Serial port could not be initialized. Error Msg: {1}'
                          .format(self._experiment_name, err))
@@ -910,3 +913,13 @@ def _store_board_configuration(self, board_config, serial_conn):
                 self._mlc_local.save_board_configuration(self._experiment_name,
                                                          self._board_config,
                                                          self._serial_conn)
+
+        except Exception as err:
+            self._report_arduino_unhandled_error(err)
+            return
+
+    def _report_arduino_unhandled_error(self, error):
+        logger.debug('[EXPERIMENT {0}] [BOARD_CONFIG] - '
+                     'Unhandled error. Error Msg: {1}'
+                     .format(self._experiment_name, error))
+        QMessageBox.critical(self, "Critical error", "Error: {0}".format(error))

MLC/arduino/connection/serialconnection.py

@@ -25,7 +25,7 @@
 
 class SerialConnectionException(ConnectionException):
     def __init__(self, what):
-        ConnectionException.__init__("Error in connection initialization. {0}".format(what))
+        ConnectionException.__init__(self, "Error in connection initialization. {0}".format(what))
 
 class SerialConnection(BaseConnection):
 
@@ -58,7 +58,7 @@ def __init__(self, **args):
 
         try:
             self._connection = serial.Serial(**args)
-        except SerialException, err:
+        except serial.SerialException, err:
             raise SerialConnectionException(str(err))
 
     def send(self, data):

MLC/arduino/protocol.py

@@ -22,6 +22,7 @@
 import collections
 import boards
 from collections import namedtuple
+from connection.base import ConnectionException
 import MLC.Log.log as lg
 
 _PROTOCOL_CMDS = {"ANALOG_PRECISION": '\x01\x00\x00\x00\x01%s',
@@ -72,7 +73,7 @@ def get_instance(protocol_config=None, conn_setup=None):
             ArduinoInterfaceSingleton._instance = BuildSerial(protocol_config)
 
         if ArduinoInterfaceSingleton._instance is None:
-            raise ValueError("ArduinoInterface was not configured.")
+            raise ProtocolSetupException("The arduino interface cannot be used if it isn't configured.")
 
         return ArduinoInterfaceSingleton._instance
 
@@ -118,7 +119,7 @@ def get_version(self):
 
     def set_pwm(self, pin, duty_cicle):
         if port in self._anlg_inputs or port in self._digital_inputs:
-            raise ProtocolSetupException("Port %s is configured as input!" % port)
+            raise ProtocolSetupException("Port %s is configured as input!" % self.__get_arduino_pin(port))
 
         self._connection.send(_PROTOCOL_CMDS["ANALAOG_WRITE"] % (
             chr(pin), chr((duty_cicle & 0xFF00) >> 8), chr(duty_cicle & 0x00FF)))
@@ -153,7 +154,7 @@ def set_report_mode(self, mode, read_count=1, read_delay=0):
 
     def add_input(self, port):
         if port in self._anlg_outputs or port in self._digital_outputs:
-            raise ProtocolSetupException("Pin %s is configured as output!" % port)
+            raise ProtocolSetupException("Pin %s is configured as output!" % self.__get_arduino_pin(port))
 
         self.__validate_pin(port)
 
@@ -171,7 +172,7 @@ def add_input(self, port):
 
     def add_output(self, port):
         if port in self._anlg_inputs or port in self._digital_inputs:
-            raise ProtocolSetupException("Port %s is configured as input!" % port)
+            raise ProtocolSetupException("Pin %s is configured as input!" % self.__get_arduino_pin(port))
 
         self.__validate_pin(port)
 
@@ -191,6 +192,16 @@ def __validate_pin(self, pin):
             raise ValueError("Invalid pin %s for board %s" %
                             (pin, self._board["NAME"]))
 
+    def __get_arduino_pin_id(self, pin):
+        ret = pin
+        if pin in self._board["DIGITAL_PINS"]:
+            ret = "D{0}".format(pin)
+
+        if pin in self._board["ANALOG_PINS"]:
+            ret = "A{0}".format(pin - len(self._board["DIGITAL_PINS"]))
+
+        return ret
+
     def reset(self):
         self._connection.send(_PROTOCOL_CMDS["RESET"])
         self._anlg_outputs = []
@@ -210,7 +221,8 @@ def actuate(self, data):
         # Sets as payload every digital or analog port
         for i in data:
             if i[0] not in self._anlg_outputs and i[0] not in self._digital_outputs:
-                raise ProtocolSetupException("Port %s not configured as output!" % i[0])
+                pin = self.__get_arduino_pin_id(i[0])
+                raise ProtocolSetupException("Port %s not configured as output!" % pin)
             if i[0] in self._anlg_outputs:
                 payload = "".join(
                     [payload, chr(i[0]), chr((i[1] & 0xFF00) >> 8), chr(i[1] & 0x00FF)])