bsI2C.py

Go to the documentation of this file.

# This file was automatically generated by SWIG (http://www.swig.org).
# Version 3.0.8
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.





from sys import version_info
if version_info >= (2, 6, 0):
    def swig_import_helper():
        from os.path import dirname
        import imp
        fp = None
        try:
            fp, pathname, description = imp.find_module('_bsI2C', [dirname(__file__)])
        except ImportError:
            import _bsI2C
            return _bsI2C
        if fp is not None:
            try:
                _mod = imp.load_module('_bsI2C', fp, pathname, description)
            finally:
                fp.close()
            return _mod
    _bsI2C = swig_import_helper()
    del swig_import_helper
else:
    import _bsI2C
del version_info
try:
    _swig_property = property
except NameError:
    pass  # Python < 2.2 doesn't have 'property'.


def _swig_setattr_nondynamic(self, class_type, name, value, static=1):
    if (name == "thisown"):
        return self.this.own(value)
    if (name == "this"):
        if type(value).__name__ == 'SwigPyObject':
            self.__dict__[name] = value
            return
    method = class_type.__swig_setmethods__.get(name, None)
    if method:
        return method(self, value)
    if (not static):
        if _newclass:
            object.__setattr__(self, name, value)
        else:
            self.__dict__[name] = value
    else:
        raise AttributeError("You cannot add attributes to %s" % self)


def _swig_setattr(self, class_type, name, value):
    return _swig_setattr_nondynamic(self, class_type, name, value, 0)


def _swig_getattr_nondynamic(self, class_type, name, static=1):
    if (name == "thisown"):
        return self.this.own()
    method = class_type.__swig_getmethods__.get(name, None)
    if method:
        return method(self)
    if (not static):
        return object.__getattr__(self, name)
    else:
        raise AttributeError(name)

def _swig_getattr(self, class_type, name):
    return _swig_getattr_nondynamic(self, class_type, name, 0)


def _swig_repr(self):
    try:
        strthis = "proxy of " + self.this.__repr__()
    except Exception:
        strthis = ""
    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)

try:
    _object = object
    _newclass = 1
except AttributeError:
    class _object:
        pass
    _newclass = 0



_bsI2C.BS_I2C_DEV_NAME_DFT_swigconstant(_bsI2C)
BS_I2C_DEV_NAME_DFT = _bsI2C.BS_I2C_DEV_NAME_DFT

_bsI2C.BS_I2C_SERVER_MOD_swigconstant(_bsI2C)
BS_I2C_SERVER_MOD = _bsI2C.BS_I2C_SERVER_MOD

_bsI2C.BS_I2C_CLIENT_LIB_swigconstant(_bsI2C)
BS_I2C_CLIENT_LIB = _bsI2C.BS_I2C_CLIENT_LIB

def bsI2CGetMsgName(pClient, hndVConn, uMsgId):
    return _bsI2C.bsI2CGetMsgName(pClient, hndVConn, uMsgId)
bsI2CGetMsgName = _bsI2C.bsI2CGetMsgName

def bsI2CReqOpen(pClient, sDevName, bInitTrace):
    return _bsI2C.bsI2CReqOpen(pClient, sDevName, bInitTrace)
bsI2CReqOpen = _bsI2C.bsI2CReqOpen

def bsI2CReqClose(pClient, hndVConn):
    return _bsI2C.bsI2CReqClose(pClient, hndVConn)
bsI2CReqClose = _bsI2C.bsI2CReqClose

def bsI2CReqRead(pClient, hndVConn, i2cAddr, uReadLen, rbuf):
    return _bsI2C.bsI2CReqRead(pClient, hndVConn, i2cAddr, uReadLen, rbuf)
bsI2CReqRead = _bsI2C.bsI2CReqRead

def bsI2CReqWrite(pClient, hndVConn, i2cAddr, wbuf, uWriteLen):
    return _bsI2C.bsI2CReqWrite(pClient, hndVConn, i2cAddr, wbuf, uWriteLen)
bsI2CReqWrite = _bsI2C.bsI2CReqWrite

def bsI2CReqTrans(pClient, hndVConn, i2cAddr, wbuf, uWriteLen, uReadLen, rbuf):
    return _bsI2C.bsI2CReqTrans(pClient, hndVConn, i2cAddr, wbuf, uWriteLen, uReadLen, rbuf)
bsI2CReqTrans = _bsI2C.bsI2CReqTrans

def bsI2CReqScan(pClient, hndVConn, bufScan, sizeScanBuf):
    return _bsI2C.bsI2CReqScan(pClient, hndVConn, bufScan, sizeScanBuf)
bsI2CReqScan = _bsI2C.bsI2CReqScan

def new_i2cAddrArray(nelements):
    return _bsI2C.new_i2cAddrArray(nelements)
new_i2cAddrArray = _bsI2C.new_i2cAddrArray

def delete_i2cAddrArray(ary):
    return _bsI2C.delete_i2cAddrArray(ary)
delete_i2cAddrArray = _bsI2C.delete_i2cAddrArray

def i2cAddrArray_getitem(ary, index):
    return _bsI2C.i2cAddrArray_getitem(ary, index)
i2cAddrArray_getitem = _bsI2C.i2cAddrArray_getitem

def i2cAddrArray_setitem(ary, index, value):
    return _bsI2C.i2cAddrArray_setitem(ary, index, value)
i2cAddrArray_setitem = _bsI2C.i2cAddrArray_setitem


#
# BotSense I2C Python Wrappers
#

"""
BotSense I2C Python Inline Extensions and Wrappers.
"""

## \file 
## \package BotSense.bsI2C
##
## \brief BotSense Swigged I2C Python Interface Module.
##
## \author Robin Knight (robin.knight@roadnarrows.com)
##  
## \par Copyright:
##   (C) 2010.  RoadNarrows LLC.\n
##   (http://www.roadnarrows.com)\n
##   All Rights Reserved
##

import BotSenseCore  as bsCore
import BotSenseError as bsError
import BotSenseTypes as bsTypes

# maximum number of scanned I2C attached device addresses
I2CMaxNumOfScannedAddrs = 256

def I2CGetMsgName(client, hndVConn, msgId):
  """ Get the I2C message name.

      For each (virtual connection, message id) 2-tuple, there can be a known
      name string (provided the id is valid and an application provides the
      information).

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle (ignored).
        msgId     - I2C message id.

      Return:
        Returns message name string if it can be determined.
        Otherwise returns 'unknown'.
  """
  bsTypes.BsClient.ChkClient(client)
  return bsI2CGetMsgName(client.pClient, hndVConn, msgId)

def I2CReqOpen(client, devName, trace=False):
  """ Proxy server request to establish a virtual connection to an 
      I2C bus device.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        devName   - Proxied I2C device name (e.g. /dev/i2c-0).
        trace     - Initial message tracing enable(true)/disable(false) state.

      Return
        New virtual connection handle.
  """
  bsTypes.BsClient.ChkClient(client)
  hndVConn = bsI2CReqOpen(client.pClient, devName, trace)
  bsError.ChkReturnIsNonNeg(hndVConn,
      "Client %s: I2C Open request failed." % (client.AttrGetName()))
  return hndVConn

def I2CReqClose(client, hndVConn):
  """ Proxy server request to close client's proxied I2C bus device virtual
      connection.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
  """
  bsTypes.BsClient.ChkClient(client)
  rc = bsI2CReqClose(client.pClient, hndVConn)
  bsError.ChkReturnIsOk(rc,
      "Client %s: I2C Close request failed." % (client.AttrGetName()))

def I2CReqRead(client, hndVConn, i2cAddr, readLen):
  """ I2C request to read from a device attached to a proxied I2C bus.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
        i2cAddr   - Address of attached device on the I2C bus.
        readLen   - Number of bytes to read.

      Return:
        Buffer list of read bytes.
  """
  bsTypes.BsClient.ChkClient(client)
  rbytebuf = bsTypes.ByteBuf(readLen)
  n = bsI2CReqRead(client.pClient, hndVConn, i2cAddr, readLen,
                  rbytebuf.getSwigObj())
  bsError.ChkReturnIsNonNeg(n,
      "Client %s: I2C Read request failed." % (client.AttrGetName()))
  rbytebuf.copyFromSwigObj(n)
  return rbytebuf.buf

def I2CReqWrite(client, hndVConn, i2cAddr, wbuf):
  """ I2C request to write to a device attached to a proxied I2C bus.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
        i2cAddr   - Address of attached device on the I2C bus.
        wbuf      - Write buffer.

      Return:
        Number of bytes written.
  """
  bsTypes.BsClient.ChkClient(client)
  wbytebuf = bsTypes.ByteBuf.Clone(wbuf)
  wbytebuf.copyToSwigObj(len(wbytebuf))
  n = bsI2CReqWrite(client.pClient, hndVConn, i2cAddr, wbytebuf.getSwigObj(),
                        len(wbytebuf))
  bsError.ChkReturnIsNonNeg(n,
      "Client %s: I2C Write request failed." % (client.AttrGetName()))
  return n

def I2CReqTrans(client, hndVConn, i2cAddr, wbuf, readLen):
  """ I2C request to execute a write-read transaction to a device
      attached to a proxied I2C bus.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
        i2cAddr   - Address of attached device on the I2C bus.
        wbuf      - Write buffer.
        readLen   - Number of bytes to read.

      Return:
        Buffer list of read bytes.
  """
  bsTypes.BsClient.ChkClient(client)
  wbytebuf = bsTypes.ByteBuf.Clone(wbuf)
  wbytebuf.copyToSwigObj(len(wbytebuf))
  rbytebuf = bsTypes.ByteBuf(readLen)
  n = bsI2CReqTrans(client.pClient, hndVConn, i2cAddr,
                                wbytebuf.getSwigObj(), len(wbytebuf),
                                readLen, rbytebuf.getSwigObj())
  bsError.ChkReturnIsNonNeg(n,
      "Client %s: I2C Transaction request failed." % (client.AttrGetName()))
  rbytebuf.copyFromSwigObj(n)
  return rbytebuf.buf

def I2CReqScan(client, hndVConn):
  """ I2C request to scan a proxied I2C bus for attached devices.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.

      Return:
        List of I2C address of discovered attached devices.
  """
  bsTypes.BsClient.ChkClient(client)
  swigObj = new_i2cAddrArray(I2CMaxNumOfScannedAddrs)
  n = bsI2CReqScan(client.pClient, hndVConn, swigObj, I2CMaxNumOfScannedAddrs)
  bsError.ChkReturnIsNonNeg(n,
      "Client %s: I2C Read request failed." % (client.AttrGetName()))
  addrs = []
  for i in xrange(n):
    addrs += [ i2cAddrArray_getitem(swigObj, i) ]
  return addrs


# This file is compatible with both classic and new-style classes.