Source code for science_jubilee.tools.PeristalticPumps

import json
import logging
import os
from typing import Union

from science_jubilee.tools.Tool import Tool



[docs]
class PeristalticPumps(Tool):
    """
    class representation of peristaltic pumps. Due to duet-level axis definition requirements, currently requires an accompanying PumpDispenser tool to control pumps.

    :param n_pumps: Number of peristaltic pumps
    :type n_pumps: int
    :param steps_per_mL: stepper motor steps to turn pump to pump 1mL of liquid. calibrate gravimetrically. Can pass a float or int to apply same value to each pump or list to apply unique value to each pump.
    :type steps_per_mL: float, int, list
    :param tool_axis: Motion axis tool is defined to on duet. Default E
    :type tool_axis: str
    :param name: name of tool
    :type name: str
    """

    def __init__(
        self,
        n_pumps: int,
        steps_per_ml: Union[float, int, list],
        tool_axis: str = "E",
        name: str = "dispenser_pumps",
    ):

[docs]
        self.tool_axis = tool_axis


[docs]
        self.n_pumps = n_pumps


[docs]
        self.name = name


        if isinstance(steps_per_ml, float) or isinstance(steps_per_ml, int):
            self.steps_per_ml = [steps_per_ml] * n_pumps
        elif isinstance(steps_per_ml, list):
            assert (
                len(steps_per_ml) == n_pumps
            ), "steps per ml list length much equal number of pumps"
            self.steps_per_ml = steps_per_ml

    @classmethod

[docs]
    def from_config(
        cls,
        config_file: str,
        path: str = os.path.join(os.path.dirname(__file__), "configs"),
    ):
        """Initialize a PeristalticPumps object from a config file

        :param config_file: The name of the config file containign the pump parameters
        :type config_file: str
        :returns: A :class:`PeristalticPumps` object
        :rtype: :class:`PeristalticPumps`
        """
        config = os.path.join(path, config_file)
        with open(config) as f:
            kwargs = json.load(f)
        print(kwargs)
        return cls(**kwargs)



[docs]
    def post_load(self):
        """
        After tool load, set steps per mm on machine
        """
        # set steps per mL on machine
        steps_per_ml = self.steps_per_ml

        gcode = f"M92 {self.tool_axis}" + ":".join(
            [str(stpml) for stpml in steps_per_ml]
        )
        print(gcode)
        self._machine.gcode(gcode)

        return



[docs]
    def pump(self, volume: Union[int, float, list]):
        """transfer volume using pump

        :param volume: volume to pump. Specify a number (int/float) to pump same amount from all pumps simultaneously, or a list of numbers to pump unique amount from each pump.
        :type volume: int, float, list
        """
        # dispense given volume
        if isinstance(volume, list):
            assert isinstance(volume[0], float) or isinstance(
                volume[0], int
            ), "Volume list must be floats or ints"
            pass

        elif isinstance(volume, float) or isinstance(volume, int):
            volume = [volume] * self.n_pumps

        else:
            raise TypeError("Volume must be an int, float, or list of ints or floats")

        stringvol = ":".join([str(v) for v in volume])

        # sticking with a direct gcode to send here makes sense: no 3-motor on axis support in movement code, and no risk of crashing anything here
        self._machine.gcode(f"G1 {self.tool_axis}{stringvol}")