Initial changes

Author: Wil Bennett

pitop/core/mixins/recreatable.py

@@ -8,7 +8,7 @@
 
 class Recreatable:
     """Represents an object that keeps track of a set of parameters that will
-    allow to be recreate it in the future.
+    allow it to be recreated in the future.
 
     The values for each key provided in the :param:`config_dict`
     parameter can be a constant value or a reference to a function,

pitop/pma/adc_base.py

@@ -6,6 +6,7 @@
 )
 from pitop.pma.plate_interface import PlateInterface
 from pitop.pma.common import get_pin_for_port
+from pitop.pma.common.utils import Port
 
 
 class ADCBase(Stateful, Recreatable):
@@ -22,6 +23,12 @@ class ADCBase(Stateful, Recreatable):
     """
 
     def __init__(self, port_name, pin_number=1, name="adcbase"):
+        if port_name not in Port.keys():
+            raise ValueError(f"{port_name} is not a valid port name. An example of a valid port name is A0")
+
+        if not port_name.startswith("A"):
+            raise ValueError(f"{port_name} is not a valid port type for an analog component. Try using an analog port, such as A0")
+
         self._pma_port = port_name
         self.name = name
 

pitop/pma/button.py

@@ -18,6 +18,12 @@ def __init__(self, port_name, name="button"):
         self._pma_port = port_name
         self.name = name
 
+        if port_name not in Port.keys():
+            raise ValueError(f"{port_name} is not a valid port name. An example of a valid port name is D0")
+
+        if not port_name.startswith("D"):
+            raise ValueError(f"{port_name} is not a valid port type for a button. Try using a digital port, such as D0")
+
         Stateful.__init__(self)
         Recreatable.__init__(self, {"port_name": port_name, "name": self.name})
         gpiozero_Button.__init__(self, get_pin_for_port(self._pma_port))

pitop/pma/buzzer.py

@@ -17,6 +17,12 @@ def __init__(self, port_name, name="buzzer"):
         self._pma_port = port_name
         self.name = name
 
+        if port_name not in Port.keys():
+            raise ValueError(f"{port_name} is not a valid port name. An example of a valid port name is D0")
+
+        if not port_name.startswith("D"):
+            raise ValueError(f"{port_name} is not a valid port type for a buzzer. Try using a digital port, such as D0")
+
         Stateful.__init__(self)
         Recreatable.__init__(self, {"port_name": port_name, "name": self.name})
         gpiozero_Buzzer.__init__(self, get_pin_for_port(self._pma_port))

pitop/pma/encoder_motor.py

@@ -26,7 +26,7 @@ class EncoderMotor(Stateful, Recreatable):
 
         The conversions between angle, rotations and RPM used by the motor to meters and meters/second are performed considering
         the :data:`wheel_diameter` parameter. This parameter defaults to the diameter of the wheel included with MMK.
-        If a wheel of different dimmensions is attached to the motor, you'll need to measure it's diameter, in order for these
+        If a wheel of different dimensions is attached to the motor, you'll need to measure it's diameter, in order for these
         methods to work properly.
 
     :type port_name: str

pitop/pma/led.py

@@ -18,6 +18,12 @@ def __init__(self, port_name, name="led"):
         self._pma_port = port_name
         self.name = name
 
+        if port_name not in Port.keys():
+            raise ValueError(f"{port_name} is not a valid port name. An example of a valid port name is D0")
+
+        if not port_name.startswith("D"):
+            raise ValueError(f"{port_name} is not a valid port type for an LED. Try using a digital port, such as D0")
+
         Stateful.__init__(self)
         Recreatable.__init__(self, {"port_name": port_name, "name": self.name})
         gpiozero_LED.__init__(self, get_pin_for_port(self._pma_port))

pitop/pma/ultrasonic_sensor.py

@@ -30,6 +30,13 @@ def __init__(
         self._pma_port = port_name
         self.name = name
 
+        if port_name not in Port.keys():
+            raise ValueError(f"{port_name} is not a valid port name. An example of a valid port name is D0")
+
+        # todo: what ports do we allow for ultrasonic? Is the MCU now capable of handling ultrasonic, and if so do we unconditionally allow all D or A ports to be used?
+        #if not port_name.startswith("D"):
+        #    raise ValueError(f"{port_name} is not a valid port type for an ultrasonic sensor. Try using a digital port, such as D0")
+
         SmoothedInputDevice.__init__(self,
                                      get_pin_for_port(self._pma_port),
                                      pull_up=False,