The wpi_al1000 module

Autogenerated API documentation for wpi_al1000

This module implements a driver for the AL1000 syringe pump from World Precision Instruments

class PyExpLabSys.drivers.wpi_al1000.AL1000(port='/dev/ttyUSB0', baudrate=19200)[source]

Bases: object

Driver for the AL1000 syringe pump

__init__(port='/dev/ttyUSB0', baudrate=19200)[source]

x.__init__(…) initializes x; see help(type(x)) for signature

get_firmware()[source]

Retrieves the firmware version

Returns:The firmware version
Return type:str
get_rate()[source]

Retrieves the pump rate

Returns:The pumping rate
set_rate(num, unit=False)[source]

Sets the pump rate.

Parameters:
  • num (float) – The flow rate (0 mL/min - 34.38 mL/min)
  • unit (str) – For valid values see below.

Valid units are: UM=microL/min MM=milliL/min UH=microL/hr MH=milliL/hour

Returns:Notihing. Printing the function yields space for success or error message
set_vol(num)[source]

Sets the pumped volume to the pump. The pump will pump until the given volume has been dispensed.

Parameters:num (float) – The volume to de dispensed (no limits)
Returns:Notihing. Printing the function yields space for success or error message
get_vol_disp()[source]

Retrieves the dispensed volume since last reset.

Returns:The dispensed volume
clear_vol_disp(direction='both')[source]

Clear pumped volume for one or more dircetions.

Parameters:direction (string) – The pumping direction. Valid directions are: INF=inflation, WDR=withdrawn, both=both directions. Default is both
Returns:Notihing. Printing the function yields space for success or error message
set_fun(phase)[source]

Sets the program function

Returns:Notihing. Printing the function yields space for success or error message
set_safe_mode(num)[source]

Enables or disables safe mode.

Parameters:num=0 --> Safe mode disables (If) – If num>0 –> Safe mode enables with the requirement that valid communication must be received every num seconds
Returns:Notihing. Printing the function yields space for success or error message
get_direction()[source]

Retrieves the curret pumping direction

set_direction(direction)[source]

Sets the pumping direction

Parameters:--> Pumping dirction set to infuse (directoin=INF) –
directoin=WDR –> Pumping dirction set to Withdraw
directoin=REV –> Pumping dirction set to the reverse current pumping direction
Returns:Notihing. Printing the function yields space for success or error message
retract_pump()[source]

Fully retracts the pump. REMEMBER TO STOP MANUALLY!

Returns:Notihing. Printing the function yields space for success or error message