PyLabware documentation

Contents:

• Overview
  • Features
  • Minimal requirements
  • Platforms
  • Documentation
• Usage
  • Basic examples
    • Creating a device
    • Operating a device
    • Running sequential commands
    • Operating multiple devices
  • Advanced examples
    • Running concurrent tasks for devices
    • Simulation mode
    • Tweaking simulation mode
      • How simulation mode works
      • Using @in_simulation_device_returns decorator
      • Simulating dynamic return values
• Data model
  • Data flow
  • Timeouts
  • Device command structure
    • Value checking
      • Min/max check
      • Value in range check
    • Built-in reply parsers
    • Making custom parsers
  • Device reply structure
    • LabDeviceReply
  • Abstract classes hierarchy
    • AbstractLabDevice
      • AbstractLabDevice.check_errors()
      • AbstractLabDevice.clear_errors()
      • AbstractLabDevice.connect()
      • AbstractLabDevice.disconnect()
      • AbstractLabDevice.execute_when_ready()
      • AbstractLabDevice.get_status()
      • AbstractLabDevice.initialize_device()
      • AbstractLabDevice.is_connected()
      • AbstractLabDevice.is_idle()
      • AbstractLabDevice.simulation
      • AbstractLabDevice.start()
      • AbstractLabDevice.stop()
      • AbstractLabDevice.wait_until_ready()
    • AbstractTemperatureController
      • AbstractTemperatureController.get_temperature()
      • AbstractTemperatureController.get_temperature_setpoint()
      • AbstractTemperatureController.set_temperature()
      • AbstractTemperatureController.start()
      • AbstractTemperatureController.start_temperature_regulation()
      • AbstractTemperatureController.stop()
      • AbstractTemperatureController.stop_temperature_regulation()
    • AbstractPressureController
      • AbstractPressureController.get_pressure()
      • AbstractPressureController.get_pressure_setpoint()
      • AbstractPressureController.set_pressure()
      • AbstractPressureController.start()
      • AbstractPressureController.start_pressure_regulation()
      • AbstractPressureController.stop()
      • AbstractPressureController.stop_pressure_regulation()
      • AbstractPressureController.vent_off()
      • AbstractPressureController.vent_on()
    • AbstractStirringController
      • AbstractStirringController.get_speed()
      • AbstractStirringController.get_speed_setpoint()
      • AbstractStirringController.set_speed()
      • AbstractStirringController.start()
      • AbstractStirringController.start_stirring()
      • AbstractStirringController.stop()
      • AbstractStirringController.stop_stirring()
    • AbstractDispensingController
      • AbstractDispensingController.dispense()
      • AbstractDispensingController.get_speed()
      • AbstractDispensingController.set_speed()
      • AbstractDispensingController.withdraw()
    • AbstractHotplate
      • AbstractHotplate.start()
      • AbstractHotplate.stop()
    • AbstractSyringePump
      • AbstractSyringePump.get_plunger_position()
      • AbstractSyringePump.move_home()
      • AbstractSyringePump.move_plunger_absolute()
      • AbstractSyringePump.move_plunger_relative()
    • AbstractDistributionValve
      • AbstractDistributionValve.get_valve_position()
      • AbstractDistributionValve.move_home()
      • AbstractDistributionValve.set_valve_position()
    • AbstractRotavap
      • AbstractRotavap.lift_down()
      • AbstractRotavap.lift_up()
      • AbstractRotavap.start_bath()
      • AbstractRotavap.start_rotation()
      • AbstractRotavap.start_stirring()
      • AbstractRotavap.start_temperature_regulation()
      • AbstractRotavap.stop_bath()
      • AbstractRotavap.stop_rotation()
      • AbstractRotavap.stop_stirring()
      • AbstractRotavap.stop_temperature_regulation()
    • AbstractFlashChromatographySystem
• API Reference
  • Connections
    • AbstractConnection
      • AbstractConnection.DEFAULT_CONNECTION_PARAMETERS
      • AbstractConnection.close_connection()
      • AbstractConnection.is_connection_open()
      • AbstractConnection.open_connection()
      • AbstractConnection.receive()
      • AbstractConnection.transmit()
    • HTTPConnection
      • HTTPConnection.HTTP_DEFAULT_CONNECTION_PARAMETERS
      • HTTPConnection.close_connection()
      • HTTPConnection.is_connection_open()
      • HTTPConnection.open_connection()
      • HTTPConnection.receive()
      • HTTPConnection.transmit()
    • SerialConnection
      • SerialConnection.SERIAL_DEFAULT_CONNECTION_PARAMETERS
      • SerialConnection.close_connection()
      • SerialConnection.connection_listener()
      • SerialConnection.is_connection_open()
      • SerialConnection.open_connection()
      • SerialConnection.receive()
      • SerialConnection.transmit()
    • TCPIPConnection
      • TCPIPConnection.TCPIP_DEFAULT_CONNECTION_PARAMETERS
      • TCPIPConnection.close_connection()
      • TCPIPConnection.connection_listener()
      • TCPIPConnection.is_connection_open()
      • TCPIPConnection.open_connection()
      • TCPIPConnection.receive()
      • TCPIPConnection.transmit()
  • Controllers
    • in_simulation_device_returns()
    • LabDevice
      • LabDevice.cast_reply_type()
      • LabDevice.check_value()
      • LabDevice.connect()
      • LabDevice.disconnect()
      • LabDevice.execute_when_ready()
      • LabDevice.get_all_tasks()
      • LabDevice.parse_reply()
      • LabDevice.prepare_message()
      • LabDevice.send()
      • LabDevice.simulation
      • LabDevice.start_task()
      • LabDevice.stop_all_tasks()
      • LabDevice.stop_task()
      • LabDevice.wait_until_ready()
    • LabDeviceTask
      • LabDeviceTask.run()
      • LabDeviceTask.stop()
  • Exceptions
    • PLConnectionError
    • PLConnectionProtocolError
    • PLConnectionTimeoutError
    • PLDeviceCommandError
    • PLDeviceError
    • PLDeviceInternalError
    • PLDeviceReplyError
  • Parsers
    • researcher()
    • slicer()
    • splitter()
    • stripper()
  • Devices
    • Buchi C815
      • C815Commands
      • C815FlashChromatographySystem
    • Buchi R300
      • R300Rotovap
      • R300RotovapCommands
    • Heidolph HeiTorque 100 Precision
      • HeiTorque100PrecisionStirrer
      • HeiTorque100PrecisionStirrerCommands
    • Heidolph RZR 2052 Control
      • RZR2052ControlStirrer
      • RZR2052ControlStirrerCommands
    • Huber Petite Fleur
      • PetiteFleurChiller
      • PetiteFleurChillerCommands
    • IKA Microstar 75
      • Microstar75Stirrer
      • Microstar75StirrerCommands
    • IKA RCT Digital
      • RCTDigitalHotplate
      • RCTDigitalHotplateCommands
    • IKA RET Control Visc
      • RETControlViscHotplate
      • RETControlViscHotplateCommands
    • IKA RV10
      • RV10Rotovap
      • RV10RotovapCommands
    • IDEX mxII
      • IDEXMXIIValve
      • IDEXMXIIValveCommands
    • Kern KDP3000
      • KDP3000Balance
      • KDP3000BalanceCommands
    • Metrohm 781
      • Metrohm781pHMeter
      • Metrohm781pHMeterCommands
    • Mettler Toledo MS3002S
      • MS3002SBalance
      • MS3002SBalanceCommands
    • Julabo CF41
      • CF41Chiller
      • CF41ChillerCommands
    • TECAN Cavro XLP6000
      • XLP6000SyringePump
      • XLP6000SyringePumpCommands
    • Tricontinent C3000
      • C3000SyringePump
      • C3000SyringePumpCommands
    • Vacuubrand CVC3000
      • CVC3000VacuumPump
      • CVC3000VacuumPumpCommands
• Utils
  • OpenAPI parser
• Contributing
  • Reporting bugs
  • Feature requests
  • Adding new devices
  • Code style

Indices and tables

• Index

• Module Index

• Search Page