bsSerialMsgs.py

Go to the documentation of this file.

##############################################################################
#
# File: bsSerialMsgs.py
#

"""
bsSerialMsgs.py
"""

## \file
##
## \brief BotSense bsProxy server - client raw serial NetMsgs XML Definition
##
## \warning This file was auto-generated on 2018.08.10 13:54:23 from the NetMsgs
## XML specification bsSerialMsgs.xml.
##
## \par Copyright:
## (C) 2018. RoadNarrows LLC
## (http://www.roadnarrows.com)
## All Rights Reserved
##
##############################################################################


import NetMsgs.NetMsgsBase as nmBase
from NetMsgs.NetMsgsLibITV import NetMsgsITV

## maximum vector length
NMFVAL_LEN_MAX_VECTOR = nmBase.NMVectorMaxCount


# -----------------------------------------------------------------------------
# BsSerial Message Id Enumeration
# -----------------------------------------------------------------------------

class BsSerialMsgId:
  """ BsSerial Message Id Enumeration class. """
  NoId                            = 0     # no message id
  ReqOpenArgs                     = 1     # ReqOpenArgs
  ReqRead                         = 2     # ReqRead
  ReqTrans                        = 3     # ReqTrans
  RspRead                         = 4     # RspRead
  ReqWrite                        = 5     # ReqWrite
  RspWrite                        = 6     # RspWrite
  NumOf                           = 7     # number of message ids
##


# -----------------------------------------------------------------------------
# Message Definition Set
# -----------------------------------------------------------------------------

## ReqOpenArgs Message Definition 
BsSerialMsgDefReqOpenArgs = {
  'fielddef': [
    {'fid':1, 'ftype':'I', 'max_count':1, 'name':'baudrate', },
    {'fid':2, 'ftype':'B', 'max_count':1, 'name':'bytesize', },
    {'fid':3, 'ftype':'c', 'max_count':1, 'name':'parity', },
    {'fid':4, 'ftype':'B', 'max_count':1, 'name':'stopbits', },
    {'fid':5, 'ftype':'?', 'max_count':1, 'name':'rtscts', },
    {'fid':6, 'ftype':'?', 'max_count':1, 'name':'xonxoff', },
  ],
  'ftype': '{',
  'max_count': 6,
  'msgid': BsSerialMsgId.ReqOpenArgs,
  'name': 'ReqOpenArgs',
}
##

## ReqRead Message Definition 
BsSerialMsgDefReqRead = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': 'B',
      'max': NMFVAL_LEN_MAX_VECTOR,
      'max_count': 1,
      'min': 1,
      'name': 'readlen',
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsSerialMsgId.ReqRead,
  'name': 'ReqRead',
}
##

## ReqTrans Message Definition 
BsSerialMsgDefReqTrans = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': nmBase.NMVectorMaxCount,
      'name': 'writebuf',
      'vdef': {
        'fid': nmBase.NMFIdNone,
        'ftype': 'B',
        'max_count': 1,
        'name': 'writebuf_item',
      },
    },
    {
      'fid': 2,
      'ftype': 'B',
      'max': NMFVAL_LEN_MAX_VECTOR,
      'max_count': 1,
      'min': 1,
      'name': 'readlen',
    },
  ],
  'ftype': '{',
  'max_count': 2,
  'msgid': BsSerialMsgId.ReqTrans,
  'name': 'ReqTrans',
}
##

## RspRead Message Definition 
BsSerialMsgDefRspRead = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': nmBase.NMVectorMaxCount,
      'name': 'readbuf',
      'vdef': {
        'fid': nmBase.NMFIdNone,
        'ftype': 'B',
        'max_count': 1,
        'name': 'readbuf_item',
      },
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsSerialMsgId.RspRead,
  'name': 'RspRead',
}
##

## ReqWrite Message Definition 
BsSerialMsgDefReqWrite = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': nmBase.NMVectorMaxCount,
      'name': 'writebuf',
      'vdef': {
        'fid': nmBase.NMFIdNone,
        'ftype': 'B',
        'max_count': 1,
        'name': 'writebuf_item',
      },
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsSerialMsgId.ReqWrite,
  'name': 'ReqWrite',
}
##

## RspWrite Message Definition 
BsSerialMsgDefRspWrite = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'byteswritten', },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsSerialMsgId.RspWrite,
  'name': 'RspWrite',
}
##

## BsSerial Message Definition Set Dictionary
BsSerialSetMsgDef = {
  BsSerialMsgId.ReqOpenArgs: BsSerialMsgDefReqOpenArgs,
  BsSerialMsgId.ReqRead: BsSerialMsgDefReqRead,
  BsSerialMsgId.ReqTrans: BsSerialMsgDefReqTrans,
  BsSerialMsgId.ReqWrite: BsSerialMsgDefReqWrite,
  BsSerialMsgId.RspRead: BsSerialMsgDefRspRead,
  BsSerialMsgId.RspWrite: BsSerialMsgDefRspWrite,
}
##


# -----------------------------------------------------------------------------
# CLASS: BsSerialNetMsgs
# -----------------------------------------------------------------------------

class BsSerialNetMsgs(NetMsgsITV):
  """ BsSerial NetMsgs Class. """

  #--
  def __init__(self, **kwargs):
    """ BsSerial NetMsgs initialization. """
    kwargs['msgsetname'] = 'BsSerialMsgSet'
    NetMsgsITV.__init__(self, BsSerialSetMsgDef, **kwargs)
  ##
##