Module isotope.port.temp_input

Contains TempInputPort and TempInput classes, used to handle the communication with the TEMP ports on the Isotope board.

TempInputPort class inherits from the IsotopePort class as the actual implementation of the communicaiton protocol while the TempInput class inherits from the IsotopePortContainer class as a list-like container that holds TempInputPort instances for all available TEMP 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 TEMP ports and get their values
for i, temp in enumerate(isot.temps):
    print(f"TEMP port {i} value: {temp.get_value()}")

# Close the connection
isot.disconnect()

See Also

isotope.isotope

Classes

class TempInput (comms: Isotope_comms_protocol)

The TempInput class is a list-like container for TempInputPort objects representing all the Temperature input 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 TempInput(IsotopePortContainer[TempInputPort]):
    """The TempInput class is a list-like container for TempInputPort objects representing all the Temperature input 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 = [TempInputPort(comms, i) for i in range(self._max_port_count)]

Ancestors

class TempInputPort (comms: Isotope_comms_protocol, port_id: int)

The TempInputPort class is used to read inputs from the temperature ports, i.e. TEMP 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 temperature 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 TempInputPort(IsotopePort):
    """The TempInputPort class is used to read inputs from the temperature ports, i.e. TEMP 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 temperature 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 temperature input value from the temperature port.

        Returns:
            int | None: The temperature input value of the temperature port, or None if the read failed.
        """
        self._logger.debug(f"Reading value from temperature port {self._id}...")
        value, msg = self._comms.send_cmd(icl.CMD_TYPE_GET, icl.SEC_TEMP_SENSOR, 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 temperature input value from the temperature port.

Returns

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