* Moving get_pin function to be defined at the UOSDevice level.

  This is a client-facing function and low level devices aren't client-facing.
  Also set ``pin_index`` argument to be ``pin`` so this is more consistent
  with the other API functions.
* ``Device._pins`` un-protected as this was purely to promote use of get_pin.
* ``Device.get_pins`` removed as this is not required if pins is not protected.

Author: CreatingNull

CHANGES.rst

@@ -1,3 +1,15 @@
+Version 0.6.0
+-------------
+
+:Date: TBC
+
+* Moving get_pin function to be defined at the UOSDevice level.
+  This is a client-facing function and low level devices aren't client-facing.
+  Also set ``pin_index`` argument to be ``pin`` so this is more consistent
+  with the other API functions.
+* ``Device._pins`` un-protected as this was purely to promote use of get_pin.
+* ``Device.get_pins`` removed as this is not required if pins is not protected.
+
 Version 0.5.0
 -------------
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uos-hardware"
-version = "0.5.0"
+version = "0.6.0"
 description = "A hardware abstraction layer for microcontrollers running UOS compliant firmware."
 authors = ["nulltek <steve.public@nulltek.xyz>"]
 license = "MIT"

tests/test_devices.py

@@ -18,7 +18,7 @@ def test_get_compatible_pins(uos_device: UOSDevice):
             pins_indices = uos_device.device.get_compatible_pins(function)
             assert len(pins_indices) > 0
             for pin_index in pins_indices:
-                pin = uos_device.device.get_pin(pin_index)
+                pin = uos_device.get_pin(pin_index)
                 assert isinstance(pin, Pin)
                 if function == UOSFunctions.get_adc_input:
                     assert pin.adc_in

uoshardware/abstractions.py

@@ -332,25 +332,9 @@ class Device:
     name: str
     interfaces: list
     functions_enabled: dict
-    _pins: dict[int, Pin] = field(default_factory=dict)
+    pins: dict[int, Pin] = field(default_factory=dict)
     aux_params: dict = field(default_factory=dict)
 
-    def get_pin(self, pin_index) -> Pin:
-        """Return a pin object corresponding to index.
-
-        :param pin_index: The index of the pin to return.
-        :return: Pin object for provided index.
-        """
-        if pin_index not in self._pins:
-            raise UOSRuntimeError(
-                f"Pin index {pin_index} doesn't exist for device {self.name}"
-            )
-        return self._pins[pin_index]
-
-    def get_pins(self) -> set:
-        """Return a set of pin indices known by this device."""
-        return set(self._pins.keys())
-
     def get_compatible_pins(self, function: UOSFunction) -> set:
         """Get pins suitable for use with a particular UOS Function.
 
@@ -366,7 +350,7 @@ def get_compatible_pins(self, function: UOSFunction) -> set:
             return set()
         return {
             pin_index
-            for pin_index, pin in self._pins.items()
+            for pin_index, pin in self.pins.items()
             if all(
                 getattr(pin, requirement) for requirement in function.pin_requirements
             )
@@ -386,11 +370,11 @@ def update_adc_samples(self, result: ComResult):
         sample_values = result.get_rx_payload(0)
         logger.debug("Device returned sampled adc values %s", sample_values)
         for sample_index, pin in enumerate(result.tx_packet.payload):
-            if pin not in self._pins:
+            if pin not in self.pins:
                 raise UOSRuntimeError(
                     f"Can't update ADC samples on pin {pin} as it's invalid for {self.name}."
                 )
-            self._pins[pin].adc_reading = ADCSample(
+            self.pins[pin].adc_reading = ADCSample(
                 sample_values[sample_index * 2 : sample_index * 2 + 2],
                 steps=pow(2, self.aux_params["adc_resolution"]),
                 reference=self.aux_params["adc_reference"],
@@ -399,7 +383,7 @@ def update_adc_samples(self, result: ComResult):
                 "Setting pin %s adc reading to %s",
                 pin,
                 # This is a false call as it can't be None here.
-                self._pins[pin].adc_reading.value,  # type: ignore
+                self.pins[pin].adc_reading.value,  # type: ignore
             )
 
     def update_gpio_samples(self, result: ComResult):
@@ -412,14 +396,14 @@ def update_gpio_samples(self, result: ComResult):
         logger.debug("Device returned sampled gpio values %s", sample_values)
         for sample_index, pin in enumerate(sample_values):
             pin = result.tx_packet.payload[2 * sample_index]
-            if pin not in self._pins:
+            if pin not in self.pins:
                 raise UOSRuntimeError(
                     f"Can't update GPIO samples on pin {pin} as it's invalid for {self.name}."
                 )
-            self._pins[pin].gpio_reading = DigitalSample(sample_values[sample_index])
+            self.pins[pin].gpio_reading = DigitalSample(sample_values[sample_index])
             logger.debug(
                 "Setting pin %s gpio reading to %s",
                 pin,
                 # This is a false call as it can't be None here.
-                self._pins[pin].gpio_reading.value,  # type: ignore
+                self.pins[pin].gpio_reading.value,  # type: ignore
             )

uoshardware/api.py

@@ -1,10 +1,17 @@
 """Provides the HAL layer for communicating with the hardware."""
-from uoshardware import Loading, Persistence, UOSUnsupportedError, logger
+from uoshardware import (
+    Loading,
+    Persistence,
+    UOSRuntimeError,
+    UOSUnsupportedError,
+    logger,
+)
 from uoshardware.abstractions import (
     ComResult,
     Device,
     InstructionArguments,
     NPCPacket,
+    Pin,
     UOSFunction,
     UOSFunctions,
     UOSInterface,
@@ -318,6 +325,19 @@ def is_active(self) -> bool:
         """
         return self.__device_interface.is_active()
 
+    # False positive as this is a client-facing function.
+    def get_pin(self, pin: int) -> Pin:  # dead: disable
+        """Return a pin object corresponding to index.
+
+        :param pin: The index of the pin to return.
+        :return: Pin object for provided index.
+        """
+        if pin not in self.device.pins:
+            raise UOSRuntimeError(
+                f"Pin index {pin} doesn't exist for device {self.device.name}"
+            )
+        return self.device.pins[pin]
+
     def __repr__(self):
         """Representation of the UOS device.
 

uoshardware/devices/_arduino.py

@@ -14,7 +14,7 @@
         UOSFunctions.hard_reset.name: [Persistence.NONE],
         UOSFunctions.get_system_info.name: [Persistence.NONE],
     },
-    _pins={
+    pins={
         2: Pin(gpio_out=True, gpio_in=True, pull_up=True),
         3: Pin(
             gpio_out=True,
@@ -94,9 +94,9 @@
     name="Arduino Uno 3",
     interfaces=_ARDUINO_NANO_3.interfaces,
     functions_enabled=_ARDUINO_NANO_3.functions_enabled,
-    _pins={  # Doesn't expose the additional mux'd ADCs.
-        pin_index: _ARDUINO_NANO_3.get_pin(pin_index)
-        for pin_index in _ARDUINO_NANO_3.get_pins()
+    pins={  # Doesn't expose the additional mux'd ADCs.
+        pin_index: pin
+        for pin_index, pin in _ARDUINO_NANO_3.pins.items()
         if pin_index not in {20, 21}
     },
     aux_params={"default_baudrate": 115200, "adc_reference": 5, "adc_resolution": 10},