How to Control your NE-1000 Syringe Pump with Python?

				
					'''
-----------------------------------------------------------------------
NE-1000 Syringe Pump Control Library Using RS232 Communication Protocol
-----------------------------------------------------------------------
'''

class NewEraSyringePump:

    # Open the serial port
    def __init__(self, port):
        self.ser = serial.Serial(port, 19200, parity=serial.PARITY_NONE, bytesize=8, stopbits=1, timeout=None, xonxoff=0, rtscts=0) # data format corresponding to the NE-1000
        time.sleep(0.075)  # time for the pump to initialize

    # Write a command to the syringe pump
    def send_command(self, command):
        self.ser.write(command.encode() + b'\r\n') # convert the command string into bytes, append a carriage return and line feed, and send the resulting byte sequence to the serial port
        time.sleep(0.075) # a brief delay to ensure that the pump has enough time to process the command before proceeding to the next operation
    
    # Start the pump
    def start_pump(self):
        self.send_command("RUN") # RUN to run the pump

    # Stop the pump
    def stop_pump(self):
        self.send_command("STP") # STP to stop the pump
        
    # Set the syringe diameter
    def set_diameter(self, diameter):
        command = f"DIA {diameter}" # DIA for syringe inside diameter (float)
        self.send_command(command) # set the syringe diameter using the "send_command" function 

#-----------------------------------------------------------------------------------------#  
# The three functions below (set_rate, set_volume and set_direction) are only defined to be used within the run_RATE_function defined afterwards
#-----------------------------------------------------------------------------------------#

    # Set the pumping rate
    def set_rate(self, rate, r_units):
        command = f"RAT {rate} {r_units}" # RAT for pumping rate 
        # Rate units: 'MH' for mL/hr - 'MM' for mL/min - 'UH' for µL/hr - 'UM' for µL/min
        self.send_command(command)

    # Set the volume
    def set_volume(self, volume, units):
        command = f"VOL {volume} {units}" # VOL for volume 
        # Volume units: 'ML' for mL - 'UL' for µL
        self.send_command(command)

    # Set the pumping direction
    def set_direction(self, direction):
        if direction == 0: 
            command = "DIR INF" # DIR for pumping direction - INF for infuse
        elif direction == 1: 
            command = "DIR WDR" # WDR for withdraw
        elif direction == 2:  
           command = "DIR REV" # REV for reverse direction
        self.send_command(command)

#-----------------------------------------------------------------------------------------# 

    # Define the "RATE" Function
    def run_RATE_function(self, rate, rate_units, volume, units, direction):
        self.set_rate(rate, rate_units) # Set the pumping rate
        self.set_volume(volume, units) # Set the pumping volume
        self.set_direction(direction) # Set the pumping direction
        self.start_pump() # Start the pumping rate function
        # Calculate pumping duration based on rate and volume units:
        if rate_units == "MH" and units == "ML":
            pumping_duration = volume * 3600 / rate # mL/hr and mL
        elif rate_units == "UH" and units == "UL":
            pumping_duration = volume * 3600 / rate # µL/hr and µL
        elif rate_units == "MH" and units == "UL":
            pumping_duration = volume * 3.6 / rate # mL/hr and µL
        elif rate_units == "UH" and units == "ML":
            pumping_duration = volume * 3.6 * 10**6 / rate # µL/hr and mL
        
        elif rate_units == "MM" and units == "ML":
            pumping_duration = volume * 60 / rate # mL/min and mL
        elif rate_units == "UM" and units == "UL":
            pumping_duration = volume * 60 / rate # µL/min and µL
        elif rate_units == "MM" and units == "UL":
            pumping_duration = volume * 0.06 / rate # mL/min and µL
        elif rate_units == "UM" and units == "ML":
            pumping_duration = volume * 6 * 10**4 / rate # µL/min and mL
        else:
            raise ValueError("Unsupported units combination: rate_units={}, units={}".format(rate_units, units))
    
        time.sleep(pumping_duration) # Delay to ensure the pump dispenses the required volume at the given pumping rate
    
        self.stop_pump() # Stop the pump
            
    # Reset the pump
    def reset_pump(self):
        self.send_command("RESET") # RESET to reset the pump
        
    # Pump beep
    def beep(self):
        self.send_command("BEP") # BEP for the pump beep

    # Delete the pump
    def __del__(self):
        self.ser.close() # close the serial communication port
        
##### BELOW are the commands that should be executed #####