Adding a system for linking aliased analog and digital pins.

Author: CreatingNull

CHANGES.rst

@@ -13,6 +13,8 @@ Version 0.4.0
   complexity.
 * Correcting a mistake in the arduino_nano device definition.
   This had 9x pins defined where only 8x exist on this device.
+* Redesigning the analog and digital pins to define aliases where
+  they physically are the same pin.
 
 Version 0.3.0
 -------------

tests/test_devices.py

@@ -7,11 +7,7 @@
 
 
 def test_get_compatible_pins(uos_device: UOSDevice):
-    """Checks the device function for returning lists of compatible pins.
-
-    :param uos_device:
-    :return:
-    """
+    """Checks the device function for returning lists of compatible pins."""
     # Check lookup of digital / analog pins works.
     for function in (
         UOSFunctions.set_gpio_output,
@@ -35,3 +31,20 @@ 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,6 +240,7 @@ class Pin:
     comp: dict = field(default_factory=dict)
     spi: dict = field(default_factory=dict)
     i2c: dict = field(default_factory=dict)
+    alias: int | None = None
 
 
 @dataclass(frozen=True)
@@ -250,7 +251,7 @@ class Device:
     interfaces: list
     functions_enabled: dict
     digital_pins: dict = field(default_factory=dict)
-    analogue_pins: dict = field(default_factory=dict)
+    analog_pins: dict = field(default_factory=dict)
     aux_params: dict = field(default_factory=dict)
 
     def get_compatible_pins(self, function: UOSFunction) -> dict:
@@ -267,7 +268,7 @@ def get_compatible_pins(self, function: UOSFunction) -> dict:
         requirements = function.pin_requirements
         if requirements is None:  # pins are not relevant to this function
             return {}
-        pin_dict = self.analogue_pins if "adc_in" in requirements else self.digital_pins
+        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()

uoshardware/devices/_arduino.py

@@ -74,32 +74,34 @@
             pc_int=True,
             i2c={"type": "sck", "bus": 0},
         ),
-        14: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True),  # analog pin 0
-        15: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True),  # analog pin 1
-        16: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True),  # analog pin 2
-        17: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True),  # analog pin 3
+        14: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True, alias=0),
+        15: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True, alias=1),
+        16: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True, alias=2),
+        17: Pin(gpio_out=True, gpio_in=True, pull_up=True, pc_int=True, alias=3),
         18: Pin(
             gpio_out=True,
             gpio_in=True,
             pull_up=True,
             pc_int=True,
             i2c={"type": "sda", "bus": 0},
-        ),  # analog pin 4
+            alias=4,
+        ),
         19: Pin(
             gpio_out=True,
             gpio_in=True,
             pull_up=True,
             pc_int=True,
             i2c={"type": "scl", "bus": 0},
-        ),  # analog pin 5
+            alias=5,
+        ),
     },
-    analogue_pins={
-        0: Pin(adc_in=True),
-        1: Pin(adc_in=True),
-        2: Pin(adc_in=True),
-        3: Pin(adc_in=True),
-        4: Pin(adc_in=True),
-        5: Pin(adc_in=True),
+    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),
     },