bsSerial.h File Reference

BotSense bsProxy client library RS-232 serial interface. More...

#include "rnr/rnrconfig.h"
#include "botsense/BotSense.h"
#include "botsense/libBotSense.h"

Go to the source code of this file.

Macros
#define	BS_SER_DEV_NAME_DFT   "/dev/ttyS0"
	default serial device
#define	BS_SER_SERVER_MOD   "libbsserver_serial"
	server plugin dll module
#define	BS_SER_CLIENT_LIB   "libbsclient_serial"
	client app library

Functions
const char *	bsSerialGetMsgName (BsClient_P pClient, BsVConnHnd_T hndVConn, uint_t uMsgId)
	Get the serial message name. More...
int	bsSerialReqOpen (BsClient_P pClient, const char *sDevName, int nBaudRate, int nByteSize, int cParity, int nStopBits, bool_t bRtsCts, bool_t bXonXoff, bool_t bInitTrace)
	Request proxy server to establish a virtual connection to an RS-232 serial device. More...
int	bsSerialReqClose (BsClient_P pClient, BsVConnHnd_T hndVConn)
	Request proxy server to close client's proxied serial device vitual connection. More...
int	bsSerialReqRead (BsClient_P pClient, BsVConnHnd_T hndVConn, size_t uReadLen, byte_t rbuf[])
	Proxied request to read from an RS-232 serial device. More...
int	bsSerialReqWrite (BsClient_P pClient, BsVConnHnd_T hndVConn, byte_t wbuf[], size_t uWriteLen)
	Proxied request to write to a RS-232 serial device. More...
int	bsSerialReqTrans (BsClient_P pClient, BsVConnHnd_T hndVConn, byte_t wbuf[], size_t uWriteLen, size_t uReadLen, byte_t rbuf[])
	Proxied request to execute a write-read transaction on a RS-232 serial device. More...

Detailed Description

BotSense bsProxy client library RS-232 serial interface.

LastChangedDate

2010-08-20 11:36:38 -0600 (Fri, 20 Aug 2010)

Rev

568

Todo:

Add bsSerialReqFlushInput() function.

Add bsSerialReqIoctl() function.

Add bsSerialReqReadLine() function.

Add bsSerialReqWriteLine() function.

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2010-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Definition in file bsSerial.h.

Function Documentation

const char* bsSerialGetMsgName	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		uint_t	uMsgId
	)

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

pClient

Definition at line 102 of file bsSerialClient.c.

References BsSerialLookupMsgDef().

{
  const NMMsgDef_T  *pMsgDef;

  pMsgDef = BsSerialLookupMsgDef((BsSerialMsgId_T)uMsgId);

  return pMsgDef!=NULL? pMsgDef->m_sMsgName: "unknown";
}

int bsSerialReqClose	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn
	)

Request proxy server to close client's proxied serial device vitual connection.

Parameters

pClient

Definition at line 193 of file bsSerialClient.c.

{
  return bsServerReqCloseDev(pClient, hndVConn);
}

int bsSerialReqOpen	(	BsClient_P	pClient,
		const char *	sDevName,
		int	nBaudRate,
		int	nByteSize,
		int	cParity,
		int	nStopBits,
		bool_t	bRtsCts,
		bool_t	bXonXoff,
		bool_t	bInitTrace
	)

Request proxy server to establish a virtual connection to an RS-232 serial device.

Parameters

pClient

Definition at line 131 of file bsSerialClient.c.

References BS_SER_SERVER_MOD, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_NM_ECODE, BSPROXY_MSG_MAX_LEN, BSPROXY_VCONN_SERVER, BsSerialMsgIdReqOpenArgs, BsSerialPackReqOpenArgs(), BsSerialReqOpenArgs_T::m_baudrate, BsSerialReqOpenArgs_T::m_bytesize, BsSerialReqOpenArgs_T::m_parity, BsSerialReqOpenArgs_T::m_rtscts, BsSerialReqOpenArgs_T::m_stopbits, and BsSerialReqOpenArgs_T::m_xonxoff.

{
  static BsSerialMsgId_T  msgIdReq = BsSerialMsgIdReqOpenArgs;
  
  BsSerialReqOpenArgs_T   msgReq;                   // specific open args
  byte_t                  buf[BSPROXY_MSG_MAX_LEN]; // specific open args buffer
  bool_t                  bTrace;                   // do [not] trace messages
  int                     n;                        // num of bytes/return code

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, BSPROXY_VCONN_SERVER);
  
  //
  // Set specific open argument values.
  //
  msgReq.m_baudrate = (uint_t)nBaudRate;
  msgReq.m_bytesize = (byte_t)nByteSize;
  msgReq.m_parity   = (char)cParity;
  msgReq.m_stopbits = (byte_t)nStopBits;
  msgReq.m_rtscts   = bRtsCts;
  msgReq.m_xonxoff  = bXonXoff;

  //
  // Pack specific open arguments (returns bytes packed \h_ge 0 on success).
  //
  n = BsSerialPackReqOpenArgs(&msgReq, buf, sizeof(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);


  //
  // Execute server transaction (returns handle \h_ge 0 on success).
  //
  n = bsServerReqOpenDev(pClient, sDevName, BS_SER_SERVER_MOD, buf, (size_t)n,
                         &bsSerialAppInfo, bInitTrace);

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "bsServerReqOpenDev(dev='%s') failed.",
      sDevName);

  // return handle
  return n;
}

int bsSerialReqRead	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		size_t	uReadLen,
		byte_t	rbuf[]
	)

Proxied request to read from an RS-232 serial device.

Parameters

pClient

Definition at line 210 of file bsSerialClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BSSERIAL_RSPREAD_READBUF_LEN, BsSerialMsgIdReqRead, BsSerialMsgIdRspRead, BsSerialPackReqRead(), BsSerialUnpackRspRead(), BsSerialRspRead_T::m_count, BsSerialRspRead_T::m_readbuf, BsSerialReqRead_T::m_readlen, and BsSerialRspRead_T::u.

{
  static BsSerialMsgId_T  msgIdReq = BsSerialMsgIdReqRead;
  static BsSerialMsgId_T  msgIdRsp = BsSerialMsgIdRspRead;

  BsSerialReqRead_T     msgReq;                   // request message 
  BsSerialRspRead_T     msgRsp;                   // response message 
  byte_t                buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t                bTrace;                   // do [not] trace messages
  int                   n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  BSCLIENT_TRY_EXPR(pClient, (uReadLen <= (size_t)BSSERIAL_RSPREAD_READBUF_LEN),
      BS_ECODE_BAD_VAL, "read_len=%zu > max_len=%zu",
      uReadLen, (size_t)BSSERIAL_RSPREAD_READBUF_LEN);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Set request message values.
  //
  msgReq.m_readlen = (byte_t)uReadLen;

  //
  // Pack request.
  //
  n = BsSerialPackReqRead(&msgReq, BSPROXY_BUF_BODY(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);

  //
  // Execute request-response transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, buf, (size_t)n,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsSerialUnpackRspRead(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  if( uReadLen > msgRsp.m_readbuf.m_count )
  {
    uReadLen = msgRsp.m_readbuf.m_count;
  }
  memcpy(rbuf, msgRsp.m_readbuf.u.m_buf, uReadLen);

  return (int)uReadLen;
}

int bsSerialReqTrans	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		byte_t	wbuf[],
		size_t	uWriteLen,
		size_t	uReadLen,
		byte_t	rbuf[]
	)

Proxied request to execute a write-read transaction on a RS-232 serial device.

Parameters

pClient

Definition at line 373 of file bsSerialClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BSSERIAL_REQTRANS_WRITEBUF_LEN, BSSERIAL_RSPREAD_READBUF_LEN, BsSerialMsgIdReqTrans, BsSerialMsgIdRspRead, BsSerialPackReqTrans(), BsSerialUnpackRspRead(), BsSerialReqTrans_T::m_count, BsSerialRspRead_T::m_count, BsSerialRspRead_T::m_readbuf, BsSerialReqTrans_T::m_readlen, BsSerialReqTrans_T::m_writebuf, BsSerialReqTrans_T::u, and BsSerialRspRead_T::u.

{
  static BsSerialMsgId_T  msgIdReq = BsSerialMsgIdReqTrans;
  static BsSerialMsgId_T  msgIdRsp = BsSerialMsgIdRspRead;

  BsSerialReqTrans_T    msgReq;                   // request message 
  BsSerialRspRead_T     msgRsp;                   // response message 
  byte_t                buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t                bTrace;                   // do [not] trace messages
  int                   n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  BSCLIENT_TRY_EXPR(pClient,
      (uWriteLen <= (size_t)BSSERIAL_REQTRANS_WRITEBUF_LEN), BS_ECODE_BAD_VAL,
      "write_len=%zu > max_len=%zu",
      uWriteLen, (size_t)BSSERIAL_REQTRANS_WRITEBUF_LEN);

  BSCLIENT_TRY_EXPR(pClient, (uReadLen <= (size_t)BSSERIAL_RSPREAD_READBUF_LEN),
      BS_ECODE_BAD_VAL, "read_len=%zu > max_len=%zu",
      uReadLen, (size_t)BSSERIAL_RSPREAD_READBUF_LEN);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Set request message values.
  //
  memcpy(msgReq.m_writebuf.u.m_buf, wbuf, uWriteLen);
  msgReq.m_writebuf.m_count = uWriteLen;
  msgReq.m_readlen = (byte_t)uReadLen;

  //
  // Pack request.
  //
  n = BsSerialPackReqTrans(&msgReq, BSPROXY_BUF_BODY(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);

  //
  // Execute request-response server transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, buf, (size_t)n,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsSerialUnpackRspRead(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  if( uReadLen > msgRsp.m_readbuf.m_count )
  {
    uReadLen = msgRsp.m_readbuf.m_count;
  }
  memcpy(rbuf, msgRsp.m_readbuf.u.m_buf, uReadLen);

  return (int)uReadLen;
}

int bsSerialReqWrite	(	BsClient_P	pClient,
		BsVConnHnd_T	hndVConn,
		byte_t	wbuf[],
		size_t	uWriteLen
	)

Proxied request to write to a RS-232 serial device.

Parameters

pClient

Definition at line 292 of file bsSerialClient.c.

References BS_ECODE_BAD_VAL, BSCLIENT_HAS_VCONN, BSCLIENT_TRY_ECODE, BSCLIENT_TRY_EXPR, BSCLIENT_TRY_NM_ECODE, BSPROXY_BUF_BODY, BSPROXY_MSG_MAX_LEN, BSSERIAL_REQWRITE_WRITEBUF_LEN, BsSerialMsgIdReqWrite, BsSerialMsgIdRspWrite, BsSerialPackReqWrite(), BsSerialUnpackRspWrite(), BsSerialRspWrite_T::m_byteswritten, BsSerialReqWrite_T::m_count, BsSerialReqWrite_T::m_writebuf, and BsSerialReqWrite_T::u.

{
  static BsSerialMsgId_T  msgIdReq = BsSerialMsgIdReqWrite;
  static BsSerialMsgId_T  msgIdRsp = BsSerialMsgIdRspWrite;

  BsSerialReqWrite_T    msgReq;                   // request message 
  BsSerialRspWrite_T    msgRsp;                   // response message 
  byte_t                buf[BSPROXY_MSG_MAX_LEN]; // req/rsp buffer
  bool_t                bTrace;                   // do [not] trace messages
  int                   n;                        // number of bytes/return code

  //
  // Parameter checks.
  //
  BSCLIENT_TRY_EXPR(pClient, BSCLIENT_HAS_VCONN(pClient, hndVConn),
      BS_ECODE_BAD_VAL, "VConn=%d", hndVConn);

  BSCLIENT_TRY_EXPR(pClient,
      (uWriteLen <= (size_t)BSSERIAL_REQWRITE_WRITEBUF_LEN), BS_ECODE_BAD_VAL,
      "write_len=%zu > max_len=%zu",
      uWriteLen, (size_t)BSSERIAL_REQWRITE_WRITEBUF_LEN);

  // trace state
  bTrace = bsClientAttrGetTraceState(pClient, hndVConn);

  //
  // Set request message values.
  //
  memcpy(msgReq.m_writebuf.u.m_buf, wbuf, uWriteLen);
  msgReq.m_writebuf.m_count = uWriteLen;

  //
  // Pack request.
  //
  n = BsSerialPackReqWrite(&msgReq, BSPROXY_BUF_BODY(buf), bTrace);

  // check packing return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdReq);

  //
  // Execute request-response transaction.
  //
  n = bsClientTrans(pClient,  hndVConn,
                    msgIdReq, buf, (size_t)n,
                    msgIdRsp, buf, sizeof(buf));

  // check transaction return code
  BSCLIENT_TRY_ECODE(pClient, n, "MsgId=%u: Transaction failed.", msgIdReq);

  //
  // Unpack response.
  //
  n = BsSerialUnpackRspWrite(buf, (size_t)n, &msgRsp, bTrace);

  // check unpack return code
  BSCLIENT_TRY_NM_ECODE(pClient, n, "MsgId=%u", msgIdRsp);

  //
  // Set return values from response.
  //
  return (int)msgRsp.m_byteswritten;
}