release of new GPIO modules

Author: JensBlack

experiments/base/stimulation.py

@@ -19,18 +19,35 @@ def __init__(self):
         self._name = 'BaseStimulation'
         self._parameter_dict = dict(TYPE='str',
                                     PORT='str',
+                                    IP = 'str',
                                     STIM_TIME='float')
         self._settings_dict = get_stimulation_settings(self._name, self._parameter_dict)
         self._running = False
-        self._stim_device = self._setup_device(self._settings_dict['TYPE'], self._settings_dict['PORT'])
+        self._stim_device = self._setup_device(self._settings_dict['TYPE'], self._settings_dict['PORT'], self._settings_dict['IP'])
 
     @staticmethod
-    def _setup_device(type, port):
+    def _setup_device(type, port, ip):
         device = None
         if type == 'NI':
             from experiments.utils.DAQ_output import DigitalModDevice
             device = DigitalModDevice(port)
 
+        if type == 'RASPBERRY':
+            from experiments.utils.gpio_control import DigitalPiDevice
+            device = DigitalPiDevice(port)
+
+        if type == 'RASP_NETWORK':
+            from experiments.utils.gpio_control import DigitalPiDevice
+            if ip is not None:
+                device = DigitalPiDevice(port, ip)
+            else:
+                raise ValueError('IP required for remote GPIO control.')
+
+        if type == 'ARDUINO':
+            from experiments.utils.gpio_control import DigitalArduinoDevice
+            device = DigitalArduinoDevice(port)
+
+
         return device
 
     def stimulate(self):
@@ -72,23 +89,38 @@ class RewardDispenser(BaseStimulation):
     def __init__(self):
         self._name = 'RewardDispenser'
         self._parameter_dict = dict(TYPE = 'str',
+                                    IP = 'str',
                                     STIM_PORT= 'str',
                                     REMOVAL_PORT = 'str',
                                     STIM_TIME = 'float',
                                     REMOVAL_TIME = 'float')
         self._settings_dict = get_stimulation_settings(self._name, self._parameter_dict)
         self._running = False
-        self._stim_device = self._setup_device(self._settings_dict['TYPE'], self._settings_dict['STIM_PORT'])
-        self._removal_device = self._setup_device(self._settings_dict['TYPE'], self._settings_dict['REMOVAL_PORT'])
+        self._stim_device = self._setup_device(self._settings_dict['TYPE'], self._settings_dict['STIM_PORT'],
+                                               self._settings_dict['IP'])
+        self._removal_device = self._setup_device(self._settings_dict['TYPE'], self._settings_dict['REMOVAL_PORT'],
+                                                  self._settings_dict['IP'])
 
 
     @staticmethod
-    def _setup_device(type, port):
+    def _setup_device(type, port, ip):
         device = None
         if type == 'NI':
             from experiments.utils.DAQ_output import DigitalModDevice
             device = DigitalModDevice(port)
 
+        if type == 'RASPBERRY':
+            from experiments.utils.gpio_control import DigitialPiBoardDevice
+            device = DigitialPiBoardDevice(port)
+
+        if type == 'RASP_NETWORK':
+            from experiments.utils.gpio_control import DigitialPiBoardDevice
+            if ip is not None:
+                device = DigitialPiBoardDevice(port, ip)
+            else:
+                raise ValueError('IP required for remote GPIO control.')
+
+
         return device
 
     def stimulate(self):

experiments/configs/default_config.ini

@@ -98,12 +98,20 @@ STIMULATION = BaseStimulation
 ;[STIMULATION]
 
 [BaseStimulation]
+; can be NI, RASPBERRY or RASP_NETWORK
 TYPE = NI
+;only used in RASP_NETWORK
+IP = None
+;PORT parameter is used for all (Port from DAQ, PIN from Raspberry, or serial port from Arduino)
 PORT = Dev1/PFI6
 STIM_TIME = 3.5
 
 [RewardDispenser]
+; can be NI, RASPBERRY, RASP_NETWORK or ARDUINO
 TYPE = NI
+;only used in RASP_NETWORK
+IP = None
+;PORT parameter is used for all (Port from DAQ, PIN from Raspberry, or serial port from Arduino)
 STIM_PORT = Dev1/PFI6
 REMOVAL_PORT = Dev1/PFI5
 STIM_TIME = 3.5

experiments/utils/gpio_control.py

@@ -0,0 +1,66 @@
+from gpiozero import DigitalOutputDevice
+from gpiozero.pins.pigpio import PiGPIOFactory
+
+import serial
+
+
+
+class DigitalPiDevice:
+    """
+    Digital modulated devices in combination with Raspberry Pi GPIO
+    Setup: https://gpiozero.readthedocs.io/en/stable/remote_gpio.html
+    """
+
+    def __init__(self, PIN, BOARD_IP: str = None):
+
+        """
+        :param BOARD_IP:  IP adress of board connected to the Device
+        """
+        if BOARD_IP is not None:
+            self._factory = PiGPIOFactory(host = BOARD_IP)
+            self._device = DigitalOutputDevice(PIN, pin_factory = self._factory)
+        else:
+            self._factory = None
+            self._device = DigitalOutputDevice(PIN)
+        self._running = False
+
+    def turn_on(self):
+        self._device.on()
+        self._running = True
+
+    def turn_off(self):
+        self._device.off()
+        self._running = False
+
+    def toggle(self):
+        self._device.toggle()
+        self._running = self._device.is_active
+
+
+class DigitalArduinoDevice:
+    """
+    Digital modulated devices in combination with Arduino boards connected via USB
+        setup: https://pythonforundergradengineers.com/python-arduino-LED.html
+
+    """
+
+    def __init__(self, PORT):
+        """
+        :param PORT:  USB PORT of the arduino board
+        """
+        self._device = serial.Serial(PORT, baudrate=9600)
+        self._running = False
+
+    def turn_on(self):
+        self._device.write(b'H')
+        self._running = True
+
+    def turn_off(self):
+        self._device.write(b'L')
+        self._running = False
+
+    def toggle(self):
+        if self._running:
+            self.turn_off()
+        else:
+            self.turn_on()

experiments/utils/readme.md

@@ -1,8 +1,11 @@
+gpiozero
+pigpio
+pyserial
 nidaqmx>=0.5.7
 click>=7.0
 opencv-python>=3.4.5.20
 numpy>=1.14.5
 pandas>=0.21.0
 matplotlib>=3.0.3
 scikit-image>=0.14.2
-scipy>=1.1.0
+scipy>=1.1.0