bsHekMsgs.py

Go to the documentation of this file.

##############################################################################
#
# File: bsHekMsgs.py
#

"""
bsHekMsgs.py
"""

## \file
##
## \brief \h_botsense Server/Client Hekateros NetMsgs XML Definitions.
##
## \warning This file was auto-generated on 2018.04.06 10:24:24 from the NetMsgs
## XML specification bsHekMsgs.xml.
##
## \par Copyright:
## (C) 2018. RoadNarrows LLC
## (http://www.roadnarrows.com)
## All Rights Reserved
##
##############################################################################


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


# -----------------------------------------------------------------------------
# BsHek Message Id Enumeration
# -----------------------------------------------------------------------------

class BsHekMsgId:
  """ BsHek Message Id Enumeration class. """
  NoId                            = 0     # no message id
  ReqOpenArgs                     = 1     # ReqOpenArgs
  ReqGetVersion                   = 2     # ReqGetVersion
  RspGetVersion                   = 3     # RspGetVersion
  ReqMoveAtSpeedTo                = 4     # ReqMoveAtSpeedTo
  ReqGetState                     = 5     # ReqGetState
  ReqFreeze                       = 6     # ReqFreeze
  ReqEStop                        = 7     # ReqEStop
  ReqCalibrate                    = 8     # ReqCalibrate
  RspState                        = 9     # RspState
  ReqGetHealth                    = 10    # ReqGetHealth
  RspGetHealth                    = 11    # RspGetHealth
  ReqClearAlarms                  = 12    # ReqClearAlarms
  NumOf                           = 13    # number of message ids
##


# -----------------------------------------------------------------------------
# Extended Field Types
# -----------------------------------------------------------------------------

## ServoState Extended Field Type 
BsHekExtFTypeServoState = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'servo_id', },
    {'fid':2, 'ftype':'h', 'max_count':1, 'name':'goal_speed', },
    {'fid':3, 'ftype':'h', 'max_count':1, 'name':'goal_pos', },
  ],
  'ftype': '{',
  'max_count': 3,
  'msgid': BsHekMsgId.NoId,
  'name': 'ServoState',
}
##

## ServoStateVec Extended Field Type 
BsHekExtFTypeServoStateVec = {
  'fid': nmBase.NMFIdNone,
  'ftype': '[',
  'max_count': DYNA_ID_NUMOF,
  'name': 'ServoStateVec',
  'vdef': {
    'fid': nmBase.NMFIdNone,
    'ftype': '{',
    'max_count': 1,
    'msgdef': BsHekExtFTypeServoState,
    'name': 'ServoStateVec_item',
  },
}
##

## ServoIdVec Extended Field Type 
BsHekExtFTypeServoIdVec = {
  'fid': nmBase.NMFIdNone,
  'ftype': '[',
  'max_count': DYNA_ID_NUMOF,
  'name': 'ServoIdVec',
  'vdef': {
    'fid': nmBase.NMFIdNone,
    'ftype': 'B',
    'max_count': 1,
    'name': 'ServoIdVec_item',
  },
}
##

## ServoHealth Extended Field Type 
BsHekExtFTypeServoHealth = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'servo_id', },
    {'fid':2, 'ftype':'B', 'max_count':1, 'name':'alarms', },
    {'fid':3, 'ftype':'h', 'max_count':1, 'name':'load', },
    {'fid':4, 'ftype':'H', 'max_count':1, 'name':'volts', },
    {'fid':5, 'ftype':'H', 'max_count':1, 'name':'temp', },
  ],
  'ftype': '{',
  'max_count': 5,
  'msgid': BsHekMsgId.NoId,
  'name': 'ServoHealth',
}
##

## ServoHealthVec Extended Field Type 
BsHekExtFTypeServoHealthVec = {
  'fid': nmBase.NMFIdNone,
  'ftype': '[',
  'max_count': DYNA_ID_NUMOF,
  'name': 'ServoHealthVec',
  'vdef': {
    'fid': nmBase.NMFIdNone,
    'ftype': '{',
    'max_count': 1,
    'msgdef': BsHekExtFTypeServoHealth,
    'name': 'ServoHealthVec_item',
  },
}
##

## BsHek Extended Field Type Dictionary
BsHekExtFieldTypes = {
  'ServoHealth': BsHekExtFTypeServoHealth,
  'ServoHealthVec': BsHekExtFTypeServoHealthVec,
  'ServoIdVec': BsHekExtFTypeServoIdVec,
  'ServoState': BsHekExtFTypeServoState,
  'ServoStateVec': BsHekExtFTypeServoStateVec,
}
##


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

## ReqOpenArgs Message Definition 
BsHekMsgDefReqOpenArgs = {
  'fielddef': [
    {'fid':1, 'ftype':'I', 'max_count':1, 'name':'baudrate', },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsHekMsgId.ReqOpenArgs,
  'name': 'ReqOpenArgs',
}
##

## ReqGetVersion Message Definition 
BsHekMsgDefReqGetVersion = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsHekMsgId.ReqGetVersion,
  'name': 'ReqGetVersion',
}
##

## RspGetVersion Message Definition 
BsHekMsgDefRspGetVersion = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'version',
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsHekMsgId.RspGetVersion,
  'name': 'RspGetVersion',
}
##

## ReqMoveAtSpeedTo Message Definition 
BsHekMsgDefReqMoveAtSpeedTo = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': DYNA_ID_NUMOF,
      'name': 'move',
      'vdef': BsHekExtFTypeServoStateVec['vdef'],
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsHekMsgId.ReqMoveAtSpeedTo,
  'name': 'ReqMoveAtSpeedTo',
}
##

## ReqGetState Message Definition 
BsHekMsgDefReqGetState = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsHekMsgId.ReqGetState,
  'name': 'ReqGetState',
}
##

## ReqFreeze Message Definition 
BsHekMsgDefReqFreeze = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsHekMsgId.ReqFreeze,
  'name': 'ReqFreeze',
}
##

## ReqEStop Message Definition 
BsHekMsgDefReqEStop = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsHekMsgId.ReqEStop,
  'name': 'ReqEStop',
}
##

## ReqCalibrate Message Definition 
BsHekMsgDefReqCalibrate = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsHekMsgId.ReqCalibrate,
  'name': 'ReqCalibrate',
}
##

## RspState Message Definition 
BsHekMsgDefRspState = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': DYNA_ID_NUMOF,
      'name': 'state',
      'vdef': BsHekExtFTypeServoStateVec['vdef'],
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsHekMsgId.RspState,
  'name': 'RspState',
}
##

## ReqGetHealth Message Definition 
BsHekMsgDefReqGetHealth = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': DYNA_ID_NUMOF,
      'name': 'servo_id',
      'vdef': BsHekExtFTypeServoIdVec['vdef'],
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsHekMsgId.ReqGetHealth,
  'name': 'ReqGetHealth',
}
##

## RspGetHealth Message Definition 
BsHekMsgDefRspGetHealth = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': DYNA_ID_NUMOF,
      'name': 'health',
      'vdef': BsHekExtFTypeServoHealthVec['vdef'],
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsHekMsgId.RspGetHealth,
  'name': 'RspGetHealth',
}
##

## ReqClearAlarms Message Definition 
BsHekMsgDefReqClearAlarms = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': DYNA_ID_NUMOF,
      'name': 'servo_id',
      'vdef': BsHekExtFTypeServoIdVec['vdef'],
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsHekMsgId.ReqClearAlarms,
  'name': 'ReqClearAlarms',
}
##

## BsHek Message Definition Set Dictionary
BsHekSetMsgDef = {
  BsHekMsgId.ReqCalibrate: BsHekMsgDefReqCalibrate,
  BsHekMsgId.ReqClearAlarms: BsHekMsgDefReqClearAlarms,
  BsHekMsgId.ReqEStop: BsHekMsgDefReqEStop,
  BsHekMsgId.ReqFreeze: BsHekMsgDefReqFreeze,
  BsHekMsgId.ReqGetHealth: BsHekMsgDefReqGetHealth,
  BsHekMsgId.ReqGetState: BsHekMsgDefReqGetState,
  BsHekMsgId.ReqGetVersion: BsHekMsgDefReqGetVersion,
  BsHekMsgId.ReqMoveAtSpeedTo: BsHekMsgDefReqMoveAtSpeedTo,
  BsHekMsgId.ReqOpenArgs: BsHekMsgDefReqOpenArgs,
  BsHekMsgId.RspGetHealth: BsHekMsgDefRspGetHealth,
  BsHekMsgId.RspGetVersion: BsHekMsgDefRspGetVersion,
  BsHekMsgId.RspState: BsHekMsgDefRspState,
}
##


# -----------------------------------------------------------------------------
# CLASS: BsHekNetMsgs
# -----------------------------------------------------------------------------

class BsHekNetMsgs(NetMsgsITV):
  """ BsHek NetMsgs Class. """

  #--
  def __init__(self, **kwargs):
    """ BsHek NetMsgs initialization. """
    kwargs['msgsetname'] = 'BsHekMsgSet'
    NetMsgsITV.__init__(self, BsHekSetMsgDef, **kwargs)
  ##
##