science_jubilee.tools.PneumaticSampleLoader
===========================================

.. py:module:: science_jubilee.tools.PneumaticSampleLoader


Classes
-------

.. autoapisummary::

   science_jubilee.tools.PneumaticSampleLoader.PneumaticSampleLoader


Module Contents
---------------

.. py:class:: PneumaticSampleLoader(url, port, name, cell_location, safe_position, username, password)

   Bases: :py:obj:`science_jubilee.tools.Tool.Tool`


   Interfaces the AFL sample loader tool with Jubilee deck


   .. py:attribute:: name


   .. py:attribute:: url


   .. py:attribute:: port


   .. py:attribute:: safe_position


   .. py:attribute:: cell_location


   .. py:attribute:: username


   .. py:attribute:: password


   .. py:attribute:: arm_down_delay
      :value: 10



   .. py:attribute:: index
      :value: None



   .. py:method:: login()


   .. py:method:: from_config(fp)
      :classmethod:



   .. py:method:: load_sample(tool, sample_location: str, volume) -> bool

      Load a sample into the sample cell using pneumatic pressure.
      First moves to the specified position, then performs the loading operation.

      :param tool: pipette-like tool (ie OT P300, HTTP syringe)
      :param sample_location: location

      :returns: True if sample was loaded successfully, False otherwise.
      :rtype: bool



   .. py:method:: rinse_cell() -> bool

      Clean the sample cell using pressurized air or cleaning solution.

      :param pressure: The pressure (PSI) to use for cleaning.
                       If None, uses default_clean_pressure from config.
      :type pressure: float, optional
      :param cycles: Number of cleaning cycles to perform.
      :type cycles: int

      :returns: True if cleaning was successful, False otherwise.
      :rtype: bool



   .. py:method:: prepare_cell()

      Prepare the cell for loading - raise arm and make sure it is clean



   .. py:method:: _prepare_load()

      Raise the arm of the pneumatic sample loader.



   .. py:method:: _load_sample(volume)


   .. py:method:: _rinse_cell()


   .. py:method:: update_status() -> dict

      Get the current status of the sample loader.

      :returns:

                Status information including whether sample is loaded
                     and current pressure settings.
      :rtype: dict



   .. py:method:: get_cell_state() -> str

      Get the current state of the sample cell.

      :returns: The current state of the sample cell (e.g., 'LOADED', 'IDLE', etc.)
      :rtype: str



   .. py:method:: parse_state(status_list: str) -> tuple[str, str]

      Parse the state and arm state from a status string.

      :param status_str: Raw status string from the device
      :type status_str: str

      :returns:

                A tuple containing (cell_state, arm_state)
                                e.g., ('LOADED', 'DOWN')
      :rtype: tuple[str, str]



   .. py:method:: enqueue(task: dict)

      Enqueue a task to be executed by the pneumatic sample loader.

      returns task uuid



   .. py:method:: unpause_queue()


   .. py:method:: pause_queue()


   .. py:method:: _safe_position()

      Check if currentlu in safe postion, and if not, move to it



   .. py:method:: get_safety_state()

      Returns the safety state of the machine.