bsSerial.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('_bsSerial', [dirname(__file__)])
        except ImportError:
            import _bsSerial
            return _bsSerial
        if fp is not None:
            try:
                _mod = imp.load_module('_bsSerial', fp, pathname, description)
            finally:
                fp.close()
            return _mod
    _bsSerial = swig_import_helper()
    del swig_import_helper
else:
    import _bsSerial
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



_bsSerial.BS_SER_DEV_NAME_DFT_swigconstant(_bsSerial)
BS_SER_DEV_NAME_DFT = _bsSerial.BS_SER_DEV_NAME_DFT

_bsSerial.BS_SER_SERVER_MOD_swigconstant(_bsSerial)
BS_SER_SERVER_MOD = _bsSerial.BS_SER_SERVER_MOD

_bsSerial.BS_SER_CLIENT_LIB_swigconstant(_bsSerial)
BS_SER_CLIENT_LIB = _bsSerial.BS_SER_CLIENT_LIB

def bsSerialGetMsgName(pClient, hndVConn, uMsgId):
    return _bsSerial.bsSerialGetMsgName(pClient, hndVConn, uMsgId)
bsSerialGetMsgName = _bsSerial.bsSerialGetMsgName

def bsSerialReqOpen(pClient, sDevName, nBaudRate, nByteSize, cParity, nStopBits, bRtsCts, bXonXoff, bInitTrace):
    return _bsSerial.bsSerialReqOpen(pClient, sDevName, nBaudRate, nByteSize, cParity, nStopBits, bRtsCts, bXonXoff, bInitTrace)
bsSerialReqOpen = _bsSerial.bsSerialReqOpen

def bsSerialReqClose(pClient, hndVConn):
    return _bsSerial.bsSerialReqClose(pClient, hndVConn)
bsSerialReqClose = _bsSerial.bsSerialReqClose

def bsSerialReqRead(pClient, hndVConn, uReadLen, rbuf):
    return _bsSerial.bsSerialReqRead(pClient, hndVConn, uReadLen, rbuf)
bsSerialReqRead = _bsSerial.bsSerialReqRead

def bsSerialReqWrite(pClient, hndVConn, wbuf, uWriteLen):
    return _bsSerial.bsSerialReqWrite(pClient, hndVConn, wbuf, uWriteLen)
bsSerialReqWrite = _bsSerial.bsSerialReqWrite

def bsSerialReqTrans(pClient, hndVConn, wbuf, uWriteLen, uReadLen, rbuf):
    return _bsSerial.bsSerialReqTrans(pClient, hndVConn, wbuf, uWriteLen, uReadLen, rbuf)
bsSerialReqTrans = _bsSerial.bsSerialReqTrans


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

## \file 
## \package BotSense.bsSerial
##
## \brief BotSense Swigged Serial 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

def SerialGetMsgName(client, hndVConn, msgId):
  """ Get the serial 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     - Serial message id.

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

def SerialReqOpen(client, devName, baudRate=9600, byteSize=8, parity='N',
                      stopBits=1, rtscts=False, xonxoff=False, trace=False):
  """ Proxy server request to establish a virtual connection to an RS-232
      serial device.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        devName   - Proxied serial device name (e.g. /dev/ttyS0).
        baudRate  -  Baud rate.
        byteSize  - Bytes size in bits 5...8.
        parity    - Parity. One of: 'N', 'E', 'O'
        stopBits  - Number of stop bits 1, 2
        rtscts    - Do [not] use hardware flow control.
        xonxoff   - Do [not] use software flow control.
        trace     - Initial message tracing enable(true)/disable(false) state.

      Return
        New virtual connection handle.
  """
  bsTypes.BsClient.ChkClient(client)
  hndVConn = bsSerialReqOpen(client.pClient, devName, baudRate, byteSize,
                        ord(parity), stopBits, rtscts, xonxoff, trace)
  bsError.ChkReturnIsNonNeg(hndVConn,
      "Client %s: Serial Open request failed." % (client.AttrGetName()))
  return hndVConn

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

      Raises a BotSenseError exception on failure.

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

def SerialReqRead(client, hndVConn, readLen):
  """ Serial request to read from a proxied RS-232 serial device.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
        readLen   - Number of bytes to read.

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

def SerialReqWrite(client, hndVConn, wbuf):
  """ Serial request to write to a proxied RS-232 serial device.

      Raises a BotSenseError exception on failure.

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

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

def SerialReqTrans(client, hndVConn, wbuf, readLen):
  """ Serial request to execute a write-read transaction to a proxied
      RS-232 serial device.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
        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 = bsSerialReqTrans(client.pClient, hndVConn,
                                wbytebuf.getSwigObj(), len(wbytebuf),
                                readLen, rbytebuf.getSwigObj())
  bsError.ChkReturnIsNonNeg(n,
      "Client %s: Serial Transaction request failed." % (client.AttrGetName()))
  rbytebuf.copyFromSwigObj(n)
  return rbytebuf.buf


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