Add emulator support

- Add Emulator object that emulates bpod hardware behavior and reference
  it in the BpodBase class
- Modify bpod classes to accommodate emulator functionality

Author: ckaraneen

pybpodapi/bpod/bpod_base.py

@@ -30,16 +30,16 @@ class BpodCOMProtocol(BpodBase):
 
     """
 
-    def __init__(self, serial_port=None, sync_channel=None, sync_mode=None):
-        super(BpodCOMProtocol, self).__init__(serial_port, sync_channel, sync_mode)
+    def __init__(self, serial_port=None, sync_channel=None, sync_mode=None, emulator_mode=False):
+        super(BpodCOMProtocol, self).__init__(serial_port, sync_channel, sync_mode, emulator_mode=emulator_mode)
 
         self._arcom = None  # type: ArCOM
         self.bpod_com_ready = False
 
         # used to keep the list of msg ids sent using the load_serial_message function
         self.msg_id_list = [False for i in range(255)]
 
-        if self.serial_port:
+        if self.serial_port and not emulator_mode:
             self.open()
 
     def open(self):
@@ -52,39 +52,6 @@ def close(self):
             self._arcom.close()
             self.bpod_com_ready = False
 
-    def manual_override(self, channel_type, channel_name, channel_number, value):
-        """
-        Manually override a Bpod channel
-
-        :param ChannelType channel_type: channel type input or output
-        :param ChannelName channel_name: channel name like PWM, Valve, etc.
-        :param channel_number:
-        :param int value: value to write on channel
-        """
-        if channel_type == ChannelType.INPUT:
-            input_channel_name = channel_name + str(channel_number)
-            channel_number = self.hardware.channels.input_channel_names.index(input_channel_name)
-            try:
-                self._bpodcom_override_input_state(channel_number, value)
-            except:
-                raise BpodErrorException(
-                    'Error using manual_override: {name} is not a valid channel name.'.format(name=channel_name))
-
-        elif channel_type == ChannelType.OUTPUT:
-            if channel_name == 'Serial':
-                self._bpodcom_send_byte_to_hardware_serial(channel_number, value)
-
-            else:
-                try:
-                    output_channel_name = channel_name + str(channel_number)
-                    channel_number = self.hardware.channels.output_channel_names.index(output_channel_name)
-                    self._bpodcom_override_digital_hardware_state(channel_number, value)
-                except:
-                    raise BpodErrorException('Error using manual_override: {name} is not a valid channel name.'.format(
-                        name=output_channel_name))
-        else:
-            raise BpodErrorException('Error using manualOverride: first argument must be "Input" or "Output".')
-
     def _bpodcom_connect(self, serial_port, baudrate=115200, timeout=1):
         """
         Connect to Bpod using serial connection
@@ -250,18 +217,7 @@ def _bpodcom_enable_ports(self, hardware):
         :rtype: bool
         """
 
-        ###### set inputs enabled or disabled #######################################################
-        hardware.inputs_enabled = [0] * len(hardware.inputs)
-
-        for j, i in enumerate(hardware.bnc_inputports_indexes):
-            hardware.inputs_enabled[i] = settings.BPOD_BNC_PORTS_ENABLED[j]
-
-        for j, i in enumerate(hardware.wired_inputports_indexes):
-            hardware.inputs_enabled[i] = settings.BPOD_WIRED_PORTS_ENABLED[j]
-
-        for j, i in enumerate(hardware.behavior_inputports_indexes):
-            hardware.inputs_enabled[i] = settings.BPOD_BEHAVIOR_PORTS_ENABLED[j]
-        #############################################################################################
+        hardware.configure_inputs()
 
         logger.debug("Requesting ports enabling (%s)", SendMessageHeader.ENABLE_PORTS)
         logger.debug("Inputs enabled (%s): %s", len(hardware.inputs_enabled), hardware.inputs_enabled)

pybpodapi/bpod/bpod_com_protocol.py

@@ -20,11 +20,10 @@ class BpodIO(BpodCOMProtocolModules):
     """
     Bpod I/O logic.
     """
-    def __init__(self, serial_port=None, workspace_path=None, session_name=None, sync_channel=None, sync_mode=None):
+    def __init__(self, serial_port=None, workspace_path=None, session_name=None, sync_channel=None, sync_mode=None, emulator_mode=False):
         self.workspace_path = workspace_path if workspace_path is not None else settings.PYBPOD_SESSION_PATH
         self.session_name = session_name if session_name is not None else settings.PYBPOD_SESSION
-
-        super(BpodIO, self).__init__(serial_port, sync_channel, sync_mode)
+        super(BpodIO, self).__init__(serial_port, sync_channel, sync_mode, emulator_mode)
 
         self.session += SessionInfo("This is a PYBPOD file. Find more info at http://pybpod.readthedocs.io")
         self.session += SessionInfo(Session.INFO_BPODAPI_VERSION, pybpodapi.__version__)

pybpodapi/bpod/bpod_io.py

@@ -0,0 +1 @@
+from .emulator import Emulator

pybpodapi/bpod/emulator/__init__.py

@@ -0,0 +1,97 @@
+"""
+The following values must be set according to Bpod firmware specification:
+https://github.com/sanworks/Bpod_StateMachine_Firmware/blob/v22/Dev/StateMachineFirmware/StateMachineFirmware.ino
+
+0 = USB (default), 1 = Ethernet (w/ Bpod Ethernet Module)
+IMPORTANT: PC via Ethernet requires State Machine v2.0 or newer.
+"""
+__author__ = "Chris Karageorgiou Kaneen"
+
+from confapp import conf as settings
+
+#################
+# from settings #
+#################
+
+FIRMWARE_VERSION = int(settings.TARGET_BPOD_FIRMWARE_VERSION)
+MACHINE_TYPE = int(settings.TARGET_BPOD_MACHINE_TYPE)
+
+
+class MACHINE_TYPE_ENUM(object):
+    ONE = 1
+    TWO = 2
+    THREE = 3
+
+
+class SM_FEATURE_PROFILE_ENUM(object):
+    ZERO = 0
+    ONE = 1
+    TWO = 2
+    THREE = 3
+
+
+class ETHERNET_COM_ENUM(object):
+    ON = 1
+    OFF = 0
+
+
+ETHERNET_COM = ETHERNET_COM_ENUM.OFF
+LIVE_TIMESTAMPS = 0
+TIMER_PERIOD = 100
+SM_FEATURE_PROFILE = {
+    MACHINE_TYPE_ENUM.ONE: SM_FEATURE_PROFILE_ENUM.ZERO,
+    MACHINE_TYPE_ENUM.TWO: SM_FEATURE_PROFILE_ENUM.ZERO,
+    MACHINE_TYPE_ENUM.THREE: SM_FEATURE_PROFILE_ENUM.ONE,
+}
+INPUT_HW = {
+    MACHINE_TYPE_ENUM.ONE: 'UUXBBWWWWPPPPPPPP',
+    MACHINE_TYPE_ENUM.TWO: 'UUUXBBWWPPPPPPPP',
+    MACHINE_TYPE_ENUM.THREE: {
+        ETHERNET_COM_ENUM.OFF: 'UUUUUXBBPPPP',
+        ETHERNET_COM_ENUM.ON: 'UUUUXBBPPPP',
+    },
+}
+OUTPUT_HW = {
+    MACHINE_TYPE_ENUM.ONE: 'UUXBBWWWWPPPPPPPPVVVVVVVV',
+    MACHINE_TYPE_ENUM.TWO: 'UUUXBBWWWPPPPPPPPVVVVVVVV',
+    MACHINE_TYPE_ENUM.THREE: {
+        ETHERNET_COM_ENUM.OFF: 'UUUUUXBBPPPPVVVV',
+        ETHERNET_COM_ENUM.ON: 'UUUUXBBPPPPVVVV',
+    },
+}
+HARDWARE_DESCRIPTION = {
+    'MAX_STATES': {
+        MACHINE_TYPE_ENUM.ONE: 128,
+        MACHINE_TYPE_ENUM.TWO: 256,
+        MACHINE_TYPE_ENUM.THREE: 256,
+    },
+    'TIMER_PERIOD': TIMER_PERIOD,
+    'MAX_SERIAL_EVENTS': {
+        MACHINE_TYPE_ENUM.ONE: 30,
+        MACHINE_TYPE_ENUM.TWO: 60,
+        MACHINE_TYPE_ENUM.THREE: {
+            ETHERNET_COM_ENUM.OFF: 90,
+            ETHERNET_COM_ENUM.ON: 75,
+        },
+    },
+    'MAX_GLOBAL_TIMERS': {
+        SM_FEATURE_PROFILE_ENUM.ZERO: 5,
+        SM_FEATURE_PROFILE_ENUM.ONE: 16,
+        SM_FEATURE_PROFILE_ENUM.TWO: 8,
+        SM_FEATURE_PROFILE_ENUM.THREE: 20,
+    },
+    'MAX_GLOBAL_COUNTERS': {
+        SM_FEATURE_PROFILE_ENUM.ZERO: 5,
+        SM_FEATURE_PROFILE_ENUM.ONE: 8,
+        SM_FEATURE_PROFILE_ENUM.TWO: 2,
+        SM_FEATURE_PROFILE_ENUM.THREE: 2,
+    },
+    'MAX_CONDITIONS': {
+        SM_FEATURE_PROFILE_ENUM.ZERO: 5,
+        SM_FEATURE_PROFILE_ENUM.ONE: 16,
+        SM_FEATURE_PROFILE_ENUM.TWO: 8,
+        SM_FEATURE_PROFILE_ENUM.THREE: 20,
+    },
+    'INPUT_HW': INPUT_HW,
+    'OUTPUT_HW': OUTPUT_HW,
+}