GPIODigitalOutputDriver: implement more protocol classes

Update the GPIODigitalOutputDriver to also implement the ResetProtocol,
PowerProtocol, and ButtonProtocol.

Update the GpioDigitalOutput agent to use the new invert( active-low) attribute

Signed-off-by: Perry Melange <[email protected]>

Author: pmelange

labgrid/driver/gpiodriver.py

@@ -1,8 +1,9 @@
 """All GPIO-related drivers"""
 import attr
+import time
 
 from ..factory import target_factory
-from ..protocol import DigitalOutputProtocol
+from ..protocol import DigitalOutputProtocol, ResetProtocol, PowerProtocol, ButtonProtocol
 from ..resource.remote import NetworkSysfsGPIO
 from ..step import step
 from .common import Driver
@@ -11,11 +12,12 @@
 
 @target_factory.reg_driver
 @attr.s(eq=False)
-class GpioDigitalOutputDriver(Driver, DigitalOutputProtocol):
+class GpioDigitalOutputDriver(Driver, DigitalOutputProtocol, ResetProtocol, PowerProtocol, ButtonProtocol):
 
     bindings = {
         "gpio": {"SysfsGPIO", "NetworkSysfsGPIO"},
     }
+    delay = attr.ib(default=1.0, validator=attr.validators.instance_of(float))
 
     def __attrs_post_init__(self):
         super().__attrs_post_init__()
@@ -37,9 +39,53 @@ def on_deactivate(self):
     @Driver.check_active
     @step(args=['status'])
     def set(self, status):
-        self.proxy.set(self.gpio.index, status)
+        self.proxy.set(self.gpio.index, self.gpio.invert, status)
 
     @Driver.check_active
     @step(result=True)
     def get(self):
-        return self.proxy.get(self.gpio.index)
+        return self.proxy.get(self.gpio.index, self.gpio.invert)
+
+    @Driver.check_active
+    @step(result=True)
+    def invert(self):
+        self.set(not self.get())
+
+    @Driver.check_active
+    @step(result=True)
+    def reset(self):
+        self.cycle()
+
+    @Driver.check_active
+    @step(result=True)
+    def on(self):
+        self.set(True)
+
+    @Driver.check_active
+    @step(result=True)
+    def off(self):
+        self.set(False)
+
+    @Driver.check_active
+    @step(result=True)
+    def cycle(self):
+        self.off()
+        time.sleep(self.delay)
+        self.on()
+
+    @Driver.check_active
+    @step(result=True)
+    def press(self):
+        self.set(True)
+
+    @Driver.check_active
+    @step(result=True)
+    def release(self):
+        self.set(False)
+
+    @Driver.check_active
+    @step(result=True)
+    def press_for(self):
+        self.press()
+        time.sleep(self.delay)
+        self.release()

labgrid/util/agents/sysfsgpio.py

@@ -2,6 +2,7 @@
 This module implements switching GPIOs via sysfs GPIO kernel interface.
 
 Takes an integer property 'index' which refers to the already exported GPIO device.
+Takes a boolean property 'invert' which inverts logical values if set to True (active-low)
 
 """
 import logging
@@ -23,7 +24,7 @@ def _assert_gpio_line_is_exported(index):
         if not os.path.exists(gpio_sysfs_path):
             raise ValueError("Device not found")
 
-    def __init__(self, index):
+    def __init__(self, index, invert):
         self._logger = logging.getLogger("Device: ")
         GpioDigitalOutput._assert_gpio_line_is_exported(index)
         gpio_sysfs_path = os.path.join(GpioDigitalOutput._gpio_sysfs_path_prefix,
@@ -40,6 +41,10 @@ def __init__(self, index):
         gpio_sysfs_value_path = os.path.join(gpio_sysfs_path, 'value')
         self.gpio_sysfs_value_fd = os.open(gpio_sysfs_value_path, flags=(os.O_RDWR | os.O_SYNC))
 
+        gpio_sysfs_active_low_path = os.path.join(gpio_sysfs_path, 'active_low')
+        with open(gpio_sysfs_active_low_path, 'w') as active_low_fd:
+            active_low_fd.write(str(int(invert)))
+
     def __del__(self):
         os.close(self.gpio_sysfs_value_fd)
         self.gpio_sysfs_value_fd = None
@@ -69,18 +74,18 @@ def set(self, status):
 
 _gpios = {}
 
-def _get_gpio_line(index):
+def _get_gpio_line(index, invert):
     if index not in _gpios:
-        _gpios[index] = GpioDigitalOutput(index=index)
+        _gpios[index] = GpioDigitalOutput(index=index, invert=invert)
     return _gpios[index]
 
-def handle_set(index, status):
-    gpio_line = _get_gpio_line(index)
+def handle_set(index, invert, status):
+    gpio_line = _get_gpio_line(index, invert)
     gpio_line.set(status)
 
 
-def handle_get(index):
-    gpio_line = _get_gpio_line(index)
+def handle_get(index, invert):
+    gpio_line = _get_gpio_line(index, invert)
     return gpio_line.get()