Module isotope.port.adc_input

Contains ADCInputPort and ADCInput classes, used to handle the communication with the MOT ports on the Isotope board.

ADCInputPort class inherits from the IsotopePort class as the actual implementation of the communicaiton protocol while the ADCInput class inherits from the IsotopePortContainer class as a list-like container that holds ADCInputPort instances for all available ADC ports on the Isotope board.

Notes

Users are encouraged to use the isotope.Isotope class to access the ports instead of creating their own instances of these class directly.

Example

import isotope

usb_address = 'COM3'

# Start the communication
isot = isotope.Isotope(usb_address)
isot.connect()

# Enumerate through all the ADC ports and get their values
for i, adc in enumerate(isot.adcs):
    print(f"ADC port {i} value: {adc.get_value()}")

# Close the connection
isot.disconnect()

See Also

isotope.isotope

Classes

class ADCInput (comms: Isotope_comms_protocol)

The ADCInput class is a list-like container for ADCInputPort objects representing all the ADC ports on the Isotope board.

Args

comms : isotope_comms_lib.Isotope_comms_protocol
The instance of the Isotope_comms_protocol class that is used to communicate with the Isotope board.
Expand source code 
class ADCInput(IsotopePortContainer[ADCInputPort]):
    """The ADCInput class is a list-like container for ADCInputPort objects representing all the ADC ports on the Isotope board.
    """

    def __init__(self, comms: icl.Isotope_comms_protocol) -> None:
        """
        Args:
            comms (isotope_comms_lib.Isotope_comms_protocol): The instance of the Isotope_comms_protocol class 
                that is used to communicate with the Isotope board.
        """
        super().__init__(comms, 3)
        self._ports = [ADCInputPort(comms, i) for i in range(self._max_port_count)]

Ancestors

class ADCInputPort (comms: Isotope_comms_protocol, port_id: int)

The ADCInputPort class is used to read inputs from the ADC ports, i.e. ADC 0, 1 and 2, on the Isotope board.

Args

comms : isotope_comms_lib.Isotope_comms_protocol
The instance of the Isotope_comms_protocol class that is used to communicate with the Isotope board.
port_id : int
ID of the ADC port on the Isotope board. Valid values are 0, 1 and 2.

Raises

ValueError
Invalid port ID. Valid values are 0, 1 and 2.
Expand source code 
class ADCInputPort(IsotopePort):
    """The ADCInputPort class is used to read inputs from the ADC ports, i.e. ADC 0, 1 and 2, on the Isotope board.
    """

    def __init__(self, comms: icl.Isotope_comms_protocol, port_id: int) -> None:
        """
        Args:
            comms (isotope_comms_lib.Isotope_comms_protocol): The instance of the Isotope_comms_protocol class 
                that is used to communicate with the Isotope board.
            port_id (int): ID of the ADC port on the Isotope board. Valid values are 0, 1 and 2.

        Raises:
            ValueError: Invalid port ID. Valid values are 0, 1 and 2.
        """

        if port_id < 0 or port_id > 2:
            raise ValueError("Invalid port ID. Valid values are 0, 1 and 2.")

        super().__init__(comms, port_id)

    def get_value(self) -> int | None:
        """Get the input value of the ADC port.

        Returns:
            int | None: The input value of the ADC port, or None if the read failed.
        """
        self._logger.debug(f"Reading value from ADC port {self._id}...")
        value, msg = self._comms.send_cmd(icl.CMD_TYPE_GET, icl.SEC_ANALOG_INPUT, self._id, 0)
        return value if self._comms.is_resp_ok(msg) else None

Ancestors

Instance variables

prop id : int

Inherited from: IsotopePort.id

Get the ID of the port …

Methods

def get_value(self) ‑> int | None

Get the input value of the ADC port.

Returns

int | None
The input value of the ADC port, or None if the read failed.