Cleaning devices API to reduce visibility of low-level objects.

These objects are not required or useful for library usage.

Author: CreatingNull

CHANGES.rst

@@ -8,6 +8,9 @@ Version 0.4.0
   this is for hash-ability. This change was required for 3.11
   support due to the
   `dataclass changes <https://github.com/python/cpython/issues/88840>`_.
+* Device definitions are shifted into private modules within a
+  devices packages. The intended API avoids having to be aware of this
+  complexity.
 
 Version 0.3.0
 -------------

uoshardware/abstractions.py

@@ -247,7 +247,6 @@ class Device:
     """Define an implemented UOS device dictionary."""
 
     name: str
-    versions: dict
     interfaces: list
     functions_enabled: dict
     digital_pins: dict = field(default_factory=dict)

uoshardware/devices/__init__.py

@@ -0,0 +1,20 @@
+"""Packages used to define Devices supported by the library."""
+from dataclasses import dataclass
+
+from uoshardware.abstractions import Device
+from uoshardware.devices._arduino import _ARDUINO_NANO_3
+
+
+@dataclass(init=False, repr=False, frozen=True)
+class Devices:
+    """Names for supported hardware linking to the Device object used.
+
+    :cvar hwid_0: device: _ARDUINO_NANO_3
+    :cvar arduino_nano: device: _ARDUINO_NANO_3
+    :cvar arduino_uno: device: _ARDUINO_NANO_3
+    """
+
+    # Lookup constants linking devices to importable names
+    hwid_0: Device = _ARDUINO_NANO_3
+    arduino_nano: Device = _ARDUINO_NANO_3
+    arduino_uno: Device = _ARDUINO_NANO_3

uoshardware/devices.py uoshardware/devices/_arduino.pyuoshardware/devices.py renamed to uoshardware/devices/_arduino.py

@@ -1,13 +1,10 @@
-"""Module defining supported hardware definitions."""
-from dataclasses import dataclass
-
+"""Module contains definitions for arduino devices."""
 from uoshardware import Persistence
 from uoshardware.abstractions import Device, Pin, UOSFunctions
 from uoshardware.interface import Interface
 
 _ARDUINO_NANO_3 = Device(
     name="Arduino Nano 3",
-    versions={},
     interfaces=[Interface.STUB, Interface.SERIAL],
     functions_enabled={
         UOSFunctions.set_gpio_output.name: [Persistence.NONE],
@@ -109,18 +106,3 @@
     },
     aux_params={"default_baudrate": 115200},
 )
-
-
-@dataclass(init=False, repr=False, frozen=True)
-class Devices:
-    """Names for supported hardware linking to the Device object used.
-
-    :cvar hwid_0: device: _ARDUINO_NANO_3
-    :cvar arduino_nano: device: _ARDUINO_NANO_3
-    :cvar arduino_uno: device: _ARDUINO_NANO_3
-    """
-
-    # Lookup constants linking devices to importable names
-    hwid_0: Device = _ARDUINO_NANO_3
-    arduino_nano: Device = _ARDUINO_NANO_3
-    arduino_uno: Device = _ARDUINO_NANO_3