bsI2CMsgs.py

Go to the documentation of this file.

##############################################################################
#
# File: bsI2CMsgs.py
#

"""
bsI2CMsgs.py
"""

## \file
##
## \brief BotSense bsProxy server - client raw I2C NetMsgs XML Definition
##
## \warning This file was auto-generated on 2018.08.10 13:54:23 from the NetMsgs
## XML specification bsI2CMsgs.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


# -----------------------------------------------------------------------------
# BsI2C Message Id Enumeration
# -----------------------------------------------------------------------------

class BsI2CMsgId:
  """ BsI2C Message Id Enumeration class. """
  NoId                            = 0     # no message id
  ReqRead                         = 1     # ReqRead
  ReqTrans                        = 2     # ReqTrans
  RspRead                         = 3     # RspRead
  ReqWrite                        = 4     # ReqWrite
  RspWrite                        = 5     # RspWrite
  ReqScan                         = 6     # ReqScan
  RspScan                         = 7     # RspScan
  NumOf                           = 8     # number of message ids
##


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

## ReqRead Message Definition 
BsI2CMsgDefReqRead = {
  'fielddef': [
    {'fid':1, 'ftype':'H', 'max_count':1, 'name':'addr', },
    {
      'fid': 2,
      'ftype': 'B',
      'max': NMFVAL_LEN_MAX_VECTOR,
      'max_count': 1,
      'min': 1,
      'name': 'readlen',
    },
  ],
  'ftype': '{',
  'max_count': 2,
  'msgid': BsI2CMsgId.ReqRead,
  'name': 'ReqRead',
}
##

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

## RspRead Message Definition 
BsI2CMsgDefRspRead = {
  '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': BsI2CMsgId.RspRead,
  'name': 'RspRead',
}
##

## ReqWrite Message Definition 
BsI2CMsgDefReqWrite = {
  'fielddef': [
    {'fid':1, 'ftype':'H', 'max_count':1, 'name':'addr', },
    {
      'fid': 2,
      'ftype': '[',
      'max_count': nmBase.NMVectorMaxCount,
      'name': 'writebuf',
      'vdef': {
        'fid': nmBase.NMFIdNone,
        'ftype': 'B',
        'max_count': 1,
        'name': 'writebuf_item',
      },
    },
  ],
  'ftype': '{',
  'max_count': 2,
  'msgid': BsI2CMsgId.ReqWrite,
  'name': 'ReqWrite',
}
##

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

## ReqScan Message Definition 
BsI2CMsgDefReqScan = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsI2CMsgId.ReqScan,
  'name': 'ReqScan',
}
##

## RspScan Message Definition 
BsI2CMsgDefRspScan = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': nmBase.NMVectorMaxCount,
      'name': 'scan',
      'vdef': {
        'fid': nmBase.NMFIdNone,
        'ftype': 'H',
        'max_count': 1,
        'name': 'scan_item',
      },
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsI2CMsgId.RspScan,
  'name': 'RspScan',
}
##

## BsI2C Message Definition Set Dictionary
BsI2CSetMsgDef = {
  BsI2CMsgId.ReqRead: BsI2CMsgDefReqRead,
  BsI2CMsgId.ReqScan: BsI2CMsgDefReqScan,
  BsI2CMsgId.ReqTrans: BsI2CMsgDefReqTrans,
  BsI2CMsgId.ReqWrite: BsI2CMsgDefReqWrite,
  BsI2CMsgId.RspRead: BsI2CMsgDefRspRead,
  BsI2CMsgId.RspScan: BsI2CMsgDefRspScan,
  BsI2CMsgId.RspWrite: BsI2CMsgDefRspWrite,
}
##


# -----------------------------------------------------------------------------
# CLASS: BsI2CNetMsgs
# -----------------------------------------------------------------------------

class BsI2CNetMsgs(NetMsgsITV):
  """ BsI2C NetMsgs Class. """

  #--
  def __init__(self, **kwargs):
    """ BsI2C NetMsgs initialization. """
    kwargs['msgsetname'] = 'BsI2CMsgSet'
    NetMsgsITV.__init__(self, BsI2CSetMsgDef, **kwargs)
  ##
##