python serial interfaces to various devices by Runze Fluid and Aurora Pro Scientific.

Installation

To install this package from the Github in editable mode, from this directory invoke: pip install -e .

To install this package in editable mode and build the docs locally, invoke: pip install -e .[dev]

Supported Devices and Interfaces:

Device	Description	Runze Protocol	ASCII Protocol	OEM Protocol	Webpage
SY08	syringe pump	yes	in progress	no	SY08
Mini-SY04	syringe pump	yes	no	no	Mini-SY04
ZSB-SY01B	multichannel syringe pump	in progress	no	no	ZSB-SY01B

More devices to come!

Getting Started

from runze_control.syringe_pump import SY01B

If you know the baudrate of your device, you can create an instance with:

syringe_pump = SY01B("COM3", 115200) # Create a device instance with a known
                                     # baudrate and default address 0x00.

If you don't know the baudrate, you can create an instance with:

syringe_pump = SY01B("COM3") # Create a device instance with unknown
                             # baudrate and default address 0x00.

The above command will scan through all valid baudrates until it successfully connects to a device.

The factory default device address is set to 0x00. If the device's address has been set to a different address, you can specify it with:

syringe_pump = SY01B("COM3", bus_address=0x01) # Create a device instance with
                                               # an unknown baudrate and
                                               # address 0x01.

From here, various commands exist such as:

syringe_pump.set_port(1)  # Select valve port 1.
syringe_pump.withdraw(1000)  # Withdraw 1000[uL] from the current port.
syringe_pump.set_port(10)  # Select valve port 10
syringe_pump.dispense(1000)  # Dispense 1000[uL] to the current port.

A host of other commands exist to provision the syringe pump (and all other devices) with default power-up settings. For more details, see the documentation.

Logging

All hardware transactions are logged via an instance-level logger. No handlers are attached, but you can display them with this boilerplate code:

import logging

# Send log messages to stdout so we can see every outgoing/incoming msg.
# Only display messages from this package.
class LogFilter(logging.Filter):
    def filter(self, record):
        return record.name.split(".")[0].lower() in ['runze_control']

fmt = '%(asctime)s.%(msecs)03d %(levelname)s %(name)s: %(message)s'
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)
logger.addHandler(logging.StreamHandler())
logger.handlers[-1].setFormatter(logging.Formatter(fmt=fmt))
logger.handlers[-1].addFilter(LogFilter())

# Now, create a device instance as usual and issue some commands to it.