pygpibtoolkit/prologix.py

"""
prologix
========

Module defining a communication object to talk to Prologix USB-GPIB controler.

"""
import serial
import time

from pygpibtoolkit import pygpib
from pygpibtoolkit.pygpib import ConnectionError

GPIB_CONTROLLER = 1
GPIB_DEVICE = 0

class GPIB(object):
    _retries = 15
    def __init__(self, device="/dev/ttyUSB0", baudrate=115200, timeout=0.1,
                    address=0, mode=1):        
        """
        Create a new GPIB controller for the Prologix USB-GPIB device
        located on serial device 'device'.        
        """
        self._cnx = serial.Serial(port=device, baudrate=baudrate, timeout=timeout)
        self._timeout = timeout

        try:
            res = self._cnx.readlines()
            if res: # empty evetual read buffer
                print "there where pending stuffs in buffer", repr(res)
            self.set_mode(mode)
            self.set_address(address)
            self._set_cmd('auto', 0)
        except Exception, e:
            print "Humm, something went wrong", e
            
    def set_address(self, address, check=True):
        """
        Set the address of the GPIB device:
        
        - if the device is the Controller In Charge, this is the
          address of the device commands are sent to,

        - if the device is in GPIB_DEVICE mode, this is its address.
        """
        self._set_cmd('addr', address, check)
        self._address = address
        #self._set_cmd('auto', 0)
        
    def set_mode(self, mode):
        """
        Set GPIB device mode to 'mode':
        
        - GPIB_CONTROLLER: set the device as the Controller In Charge
          on the GPIB bus

        - GPIB_DEVICE: set the device as a standard GPIB device on the
          bus.
        """
        self._set_cmd('mode', mode)
        self._mode = mode
        if self._mode:
            self._cnx.write('++ifc\r')

    def set_controller(self):
        """
        Set GPIB device the Controller In Charge on the GPIB bus.
        """
        self.set_mode(1)

    def set_device(self):
        """
        Set the GPIB device as a simple device on the GPIB bus.        
        """
        self.set_mode(0)

    def send_command(self, cmd, address=None):
        """
        Send the specified GPIB command on the bus (must be the CIC),
        and read the answer.
        Eventually, set the addressed device first.
        """
        assert self._mode == 1
        if address is not None:
            self.set_address(address)
        self._cnx.write(cmd+';\r')
        time.sleep(self._timeout) # required?
        return self.read_eoi()
        
    def read_eoi(self, address=None):
        """
        Read the HPIB buffer from device, till EOI is performed, or timeout.
        """
        if address is not None:
            self.set_address(address)
        self._cnx.write('++read eoi\r') # idem
        ret = ""
        i = 0
        while not ret.endswith('\r\n') and i<3:
            ret += ''.join(self._cnx.readlines())
            time.sleep(self._timeout) # required?
            i += 1
        return ''.join(ret)
            
    def check_srq(self):
        """
        Check the SRQ line
        """
        assert self._mode == 1, "must be the Controller In Charge"
        self._cnx.write('++srq\r')
        ret = self._cnx.readline().strip()
        if ret:
            return bool(int(ret))
        return None

    def poll(self, addresses=None):
        """
        Poll every address, and return a dictionnary
         {add: status, ...}        
        """        
        assert self._mode == 1, "must be the Controller In Charge"        
        only_one = False
        if addresses is None:
            addresses = range(31)
        if not isinstance(addresses, (list, tuple)):
            addresses = [addresses]
            only_one = True
        if len(addresses)==0:
            return None
        
        dico = {}
        for add in addresses:
            self._cnx.write('++spoll %d\r'%add)
            ret = self._cnx.readline().strip()
            if ret:
                dico[add] = int(ret)
            time.sleep(0.3) # need to wait at least 150ms (not enough on prologix)
        self.set_address(self._address)
        if only_one:
            return dico.values()[0]
        return dico
    
    def _read(self):
        for i in range(self._retries):
            rdata = self._cnx.readline()
            if rdata.strip() != "":
                break
            time.sleep(self._timeout)
        return rdata

    def _set_cmd(self, cmd, value, check=True):
        self._cnx.write('++%s %d\r'%(cmd, value))
        if check:
            self._cnx.write('++%s\r'%(cmd))
            rval = self._read().strip()
            if not rval.isdigit() or int(rval) != value:
                raise ConnectionError("Can't set GPIB %s to %s [ret=%s]"%(cmd, value, repr(rval)))

    def reset(self):
        """
        Perform a reset of the USB device
        
        """
        print "Resetting GPIB controller"
        self._cnx.write('++rst\r')
        print "Must wait for 5 seconds"
        time.sleep(5)