Adding the AIO/DIO functionality.

Author: CreatingNull

CHANGES.rst

@@ -15,6 +15,12 @@ Version 0.5.0
   reset details are obtained from.
 * Enabling volatile instructions on arduino devices as this is now
   available at the firmware level.
+* Removed volatility from get_adc_input as this doesn't apply to that
+  function.
+* Removing the concept of separate analog and digital pins.
+  If these are distinct then the analog should be aliased as virtual higher
+  index pins.
+* Fixed a bug where get compatible pins wasn't verifying requirements.
 
 Version 0.4.0
 -------------

tests/test_devices.py

@@ -31,20 +31,3 @@ def test_get_compatible_pins(uos_device: UOSDevice):
         uos_device.device.get_compatible_pins(
             UOSFunction(name="bad_function", address_lut={}, ack=False)
         )
-
-
-def test_pin_aliases(uos_device: UOSDevice):
-    """Makes sure all aliases are defined bidirectionally."""
-    # Check digital pins have valid analog aliases and vice-versa.
-    for pin_mapping in (
-        (uos_device.device.digital_pins, uos_device.device.analog_pins),
-        (uos_device.device.analog_pins, uos_device.device.digital_pins),
-    ):
-        for pin_number in pin_mapping[0]:
-            pin = pin_mapping[0][pin_number]
-            if pin.alias is not None:
-                assert isinstance(pin.alias, int)
-                assert pin.alias in pin_mapping[1]
-                alias = pin_mapping[1][pin.alias]
-                assert alias.alias is not None
-                assert alias.alias == pin_number

uoshardware/abstractions.py

@@ -240,7 +240,7 @@ class Pin:
     adc_in: bool = False
     pull_up: bool = False
     pull_down: bool = False
-    alias: int | None = None
+    aliases: list = field(default_factory=list)
 
 
 @dataclass(frozen=True)
@@ -250,8 +250,7 @@ class Device:
     name: str
     interfaces: list
     functions_enabled: dict
-    digital_pins: dict = field(default_factory=dict)
-    analog_pins: dict = field(default_factory=dict)
+    pins: dict = field(default_factory=dict)
     aux_params: dict = field(default_factory=dict)
 
     def get_compatible_pins(self, function: UOSFunction) -> dict:
@@ -265,12 +264,12 @@ def get_compatible_pins(self, function: UOSFunction) -> dict:
             or function not in UOSFunctions.enumerate_functions()
         ):
             raise UOSUnsupportedError(f"UOS function {function.name} doesn't exist.")
-        requirements = function.pin_requirements
-        if requirements is None:  # pins are not relevant to this function
+        if function.pin_requirements is None:  # pins are not relevant to this function
             return {}
-        pin_dict = self.analog_pins if "adc_in" in requirements else self.digital_pins
         return {
-            pin_name: pin
-            for pin_name, pin in pin_dict.items()
-            if all(hasattr(pin, requirement) for requirement in requirements)
+            pin_index: pin
+            for pin_index, pin in self.pins.items()
+            if all(
+                getattr(pin, requirement) for requirement in function.pin_requirements
+            )
         }

uoshardware/api.py

@@ -51,7 +51,7 @@ class UOSDevice:  # dead: disable
 
     :ivar device: Device definitions as parsed from a compatible ini.
     :ivar identity: The type of device, this is must have a valid device in the config.
-    :ivar connection: Compliant connection string for identifying the device and interface.
+    :ivar address: Compliant connection string for identifying the device and interface.
     :ivar __device_interface: Lower level communication protocol layer.
     :ivar __kwargs: Connection specific / optional parameters.
     """
@@ -165,21 +165,16 @@ def get_gpio_input(
     def get_adc_input(
         self,
         pin: int,
-        volatility: Persistence = Persistence.NONE,
     ) -> ComResult:
         """Read the current 10 bit ADC value.
 
         :param pin: The index of the analog pin to read
-        :param volatility: How volatile should the command be, use constants from uoshardware.
         :return: ComResult object containing the ADC readings.
         """
         return self.__execute_instruction(
             UOSFunctions.get_adc_input,
             InstructionArguments(
-                payload=tuple([pin]),
-                expected_rx_packets=2,
-                check_pin=pin,
-                volatility=volatility,
+                payload=tuple([pin]), expected_rx_packets=2, check_pin=pin
             ),
         )
 

uoshardware/devices/_arduino.py

@@ -15,7 +15,7 @@
         UOSFunctions.get_system_info.name: [Persistence.NONE],
         UOSFunctions.get_gpio_config.name: [Persistence.NONE],
     },
-    digital_pins={
+    pins={
         2: Pin(gpio_out=True, gpio_in=True, pull_up=True),
         3: Pin(
             gpio_out=True,
@@ -60,32 +60,32 @@
             gpio_in=True,
             pull_up=True,
         ),
-        14: Pin(gpio_out=True, gpio_in=True, pull_up=True, alias=0),
-        15: Pin(gpio_out=True, gpio_in=True, pull_up=True, alias=1),
-        16: Pin(gpio_out=True, gpio_in=True, pull_up=True, alias=2),
-        17: Pin(gpio_out=True, gpio_in=True, pull_up=True, alias=3),
+        14: Pin(gpio_out=True, gpio_in=True, pull_up=True, aliases=["A0"], adc_in=True),
+        15: Pin(gpio_out=True, gpio_in=True, pull_up=True, aliases=["A1"], adc_in=True),
+        16: Pin(gpio_out=True, gpio_in=True, pull_up=True, aliases=["A2"], adc_in=True),
+        17: Pin(gpio_out=True, gpio_in=True, pull_up=True, aliases=["A3"], adc_in=True),
         18: Pin(
             gpio_out=True,
             gpio_in=True,
             pull_up=True,
-            alias=4,
+            adc_in=True,
+            aliases=["A4"],
         ),
         19: Pin(
             gpio_out=True,
             gpio_in=True,
             pull_up=True,
-            alias=5,
+            adc_in=True,
+            aliases=["A5"],
+        ),
+        20: Pin(
+            adc_in=True,
+            aliases=["A6"],
+        ),
+        21: Pin(
+            adc_in=True,
+            aliases=["A7"],
         ),
-    },
-    analog_pins={
-        0: Pin(adc_in=True, alias=14),
-        1: Pin(adc_in=True, alias=15),
-        2: Pin(adc_in=True, alias=16),
-        3: Pin(adc_in=True, alias=17),
-        4: Pin(adc_in=True, alias=18),
-        5: Pin(adc_in=True, alias=19),
-        6: Pin(adc_in=True),
-        7: Pin(adc_in=True),
     },
     aux_params={"default_baudrate": 115200},
 )
@@ -95,15 +95,10 @@
     name="Arduino Uno 3",
     interfaces=_ARDUINO_NANO_3.interfaces,
     functions_enabled=_ARDUINO_NANO_3.functions_enabled,
-    digital_pins=_ARDUINO_NANO_3.digital_pins,
-    analog_pins={
-        0: Pin(adc_in=True, alias=14),
-        1: Pin(adc_in=True, alias=15),
-        2: Pin(adc_in=True, alias=16),
-        3: Pin(adc_in=True, alias=17),
-        4: Pin(adc_in=True, alias=18),
-        5: Pin(adc_in=True, alias=19),
-        # Uno has 2 less ADCs pins than the nano.
+    pins={  # Doesn't expose the addition mux'd ADCs.
+        pin_index: value
+        for pin_index, value in _ARDUINO_NANO_3.pins.items()
+        if pin_index not in {20, 21}
     },
     aux_params={"default_baudrate": 115200},
 )