Server/Client Dynamixel NetMsgs XML Definitions. More...

#include "rnr/rnrconfig.h"
#include "rnr/netmsgs.h"
#include "botsense/BotSense.h"
#include "Dynamixel/Dynamixel.h"

Classes
struct	BsDynaWriteTuple_T

struct	BsDynaReqOpenArgs_T

struct	BsDynaReqSetBaudRate_T

struct	BsDynaReqRead8_T

struct	BsDynaRspRead8_T

struct	BsDynaReqRead16_T

struct	BsDynaRspRead16_T

struct	BsDynaReqWrite8_T

struct	BsDynaRspWrite8_T

struct	BsDynaReqWrite16_T

struct	BsDynaRspWrite16_T

struct	BsDynaReqSyncWrite_T

struct	BsDynaReqPing_T

struct	BsDynaRspPing_T

struct	BsDynaReqReset_T

struct	BsDynaReqSetHalfDuplexCtl_T

Enumerations
enum	BsDynaMsgId_T { BsDynaMsgIdNone = 0, BsDynaMsgIdReqOpenArgs = 1, BsDynaMsgIdReqSetBaudRate = 2, BsDynaMsgIdReqRead8 = 3, BsDynaMsgIdRspRead8 = 4, BsDynaMsgIdReqRead16 = 5, BsDynaMsgIdRspRead16 = 6, BsDynaMsgIdReqWrite8 = 7, BsDynaMsgIdRspWrite8 = 8, BsDynaMsgIdReqWrite16 = 9, BsDynaMsgIdRspWrite16 = 10, BsDynaMsgIdReqSyncWrite = 11, BsDynaMsgIdReqPing = 12, BsDynaMsgIdRspPing = 13, BsDynaMsgIdReqReset = 14, BsDynaMsgIdReqSetHalfDuplexCtl = 15, BsDynaMsgIdNumOf = 16 }

Functions
const NMMsgDef_T *	BsDynaLookupMsgDef (BsDynaMsgId_T eMsgId)
	Look up the message definition associated with the message id. More...

size_t	BsDynaLookupMsgMaxLen (BsDynaMsgId_T eMsgId)
	Look up the message maximum length associated with the message id. More...

int	BsDynaPackMsg (BsDynaMsgId_T eMsgId, void *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a ITV message in big-endian byte order. More...

int	BsDynaUnpackMsg (BsDynaMsgId_T eMsgId, byte_t buf[], size_t uMsgLen, void *pStruct, bool_t bTrace)
	Unpack a ITV message in big-endian byte order. More...

INLINE_IN_H int	BsDynaPackReqOpenArgs (BsDynaReqOpenArgs_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqOpenArgs ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqOpenArgs (byte_t buf[], size_t uMsgLen, BsDynaReqOpenArgs_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqOpenArgs ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqSetBaudRate (BsDynaReqSetBaudRate_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqSetBaudRate ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqSetBaudRate (byte_t buf[], size_t uMsgLen, BsDynaReqSetBaudRate_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqSetBaudRate ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqRead8 (BsDynaReqRead8_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqRead8 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqRead8 (byte_t buf[], size_t uMsgLen, BsDynaReqRead8_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqRead8 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackRspRead8 (BsDynaRspRead8_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaRspRead8 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackRspRead8 (byte_t buf[], size_t uMsgLen, BsDynaRspRead8_T *pStruct, bool_t bTrace)
	Unpack a BsDynaRspRead8 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqRead16 (BsDynaReqRead16_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqRead16 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqRead16 (byte_t buf[], size_t uMsgLen, BsDynaReqRead16_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqRead16 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackRspRead16 (BsDynaRspRead16_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaRspRead16 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackRspRead16 (byte_t buf[], size_t uMsgLen, BsDynaRspRead16_T *pStruct, bool_t bTrace)
	Unpack a BsDynaRspRead16 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqWrite8 (BsDynaReqWrite8_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqWrite8 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqWrite8 (byte_t buf[], size_t uMsgLen, BsDynaReqWrite8_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqWrite8 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackRspWrite8 (BsDynaRspWrite8_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaRspWrite8 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackRspWrite8 (byte_t buf[], size_t uMsgLen, BsDynaRspWrite8_T *pStruct, bool_t bTrace)
	Unpack a BsDynaRspWrite8 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqWrite16 (BsDynaReqWrite16_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqWrite16 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqWrite16 (byte_t buf[], size_t uMsgLen, BsDynaReqWrite16_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqWrite16 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackRspWrite16 (BsDynaRspWrite16_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaRspWrite16 ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackRspWrite16 (byte_t buf[], size_t uMsgLen, BsDynaRspWrite16_T *pStruct, bool_t bTrace)
	Unpack a BsDynaRspWrite16 ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqSyncWrite (BsDynaReqSyncWrite_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqSyncWrite ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqSyncWrite (byte_t buf[], size_t uMsgLen, BsDynaReqSyncWrite_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqSyncWrite ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqPing (BsDynaReqPing_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqPing ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqPing (byte_t buf[], size_t uMsgLen, BsDynaReqPing_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqPing ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackRspPing (BsDynaRspPing_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaRspPing ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackRspPing (byte_t buf[], size_t uMsgLen, BsDynaRspPing_T *pStruct, bool_t bTrace)
	Unpack a BsDynaRspPing ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqReset (BsDynaReqReset_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqReset ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqReset (byte_t buf[], size_t uMsgLen, BsDynaReqReset_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqReset ITV message in big-endian byte order from the input buffer. More...

INLINE_IN_H int	BsDynaPackReqSetHalfDuplexCtl (BsDynaReqSetHalfDuplexCtl_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
	Pack a BsDynaReqSetHalfDuplexCtl ITV message in big-endian byte order into the output buffer. More...

INLINE_IN_H int	BsDynaUnpackReqSetHalfDuplexCtl (byte_t buf[], size_t uMsgLen, BsDynaReqSetHalfDuplexCtl_T *pStruct, bool_t bTrace)
	Unpack a BsDynaReqSetHalfDuplexCtl ITV message in big-endian byte order from the input buffer. More...

Variables
const NMMsgDef_T *	BsDynaMsgDefLookupTbl []

size_t	BsDynaMsgMaxLenLookupTbl []

Detailed Description

Server/Client Dynamixel NetMsgs XML Definitions.

Warning: This file was auto-generated on 2018.08.10 13:55:04 from the NetMsgs XML specification bsDynaMsgs.xml.

Copyright:: (C) 2018. RoadNarrows LLC (http://www.roadnarrows.com) All Rights Reserved

Definition in file bsDynaMsgs.h.

Enumeration Type Documentation

enum BsDynaMsgId_T

BsDyna Message Id Enumeration

Enumerator
BsDynaMsgIdNone	no message
BsDynaMsgIdReqOpenArgs	ReqOpenArgs.
BsDynaMsgIdReqSetBaudRate	ReqSetBaudRate.
BsDynaMsgIdReqRead8	ReqRead8.
BsDynaMsgIdRspRead8	RspRead8.
BsDynaMsgIdReqRead16	ReqRead16.
BsDynaMsgIdRspRead16	RspRead16.
BsDynaMsgIdReqWrite8	ReqWrite8.
BsDynaMsgIdRspWrite8	RspWrite8.
BsDynaMsgIdReqWrite16	ReqWrite16.
BsDynaMsgIdRspWrite16	RspWrite16.
BsDynaMsgIdReqSyncWrite	ReqSyncWrite.
BsDynaMsgIdReqPing	ReqPing.
BsDynaMsgIdRspPing	RspPing.
BsDynaMsgIdReqReset	ReqReset.
BsDynaMsgIdReqSetHalfDuplexCtl	ReqSetHalfDuplexCtl.
BsDynaMsgIdNumOf	number of message ids

Definition at line 36 of file bsDynaMsgs.h.

 {
   BsDynaMsgIdNone                       = 0,    ///< no message
   BsDynaMsgIdReqOpenArgs                = 1,    ///< ReqOpenArgs
   BsDynaMsgIdReqSetBaudRate             = 2,    ///< ReqSetBaudRate
   BsDynaMsgIdReqRead8                   = 3,    ///< ReqRead8
   BsDynaMsgIdRspRead8                   = 4,    ///< RspRead8
   BsDynaMsgIdReqRead16                  = 5,    ///< ReqRead16
   BsDynaMsgIdRspRead16                  = 6,    ///< RspRead16
   BsDynaMsgIdReqWrite8                  = 7,    ///< ReqWrite8
   BsDynaMsgIdRspWrite8                  = 8,    ///< RspWrite8
   BsDynaMsgIdReqWrite16                 = 9,    ///< ReqWrite16
   BsDynaMsgIdRspWrite16                 = 10,   ///< RspWrite16
   BsDynaMsgIdReqSyncWrite               = 11,   ///< ReqSyncWrite
   BsDynaMsgIdReqPing                    = 12,   ///< ReqPing
   BsDynaMsgIdRspPing                    = 13,   ///< RspPing
   BsDynaMsgIdReqReset                   = 14,   ///< ReqReset
   BsDynaMsgIdReqSetHalfDuplexCtl        = 15,   ///< ReqSetHalfDuplexCtl
   BsDynaMsgIdNumOf                      = 16    ///< number of message ids
 } BsDynaMsgId_T;

Function Documentation

const NMMsgDef_T* BsDynaLookupMsgDef ( BsDynaMsgId_T eMsgId )

Look up the message definition associated with the message id.

Parameters

eMsgId Message Id.

Returns: On success, returns the pointer to the NMMsgDef_T. On error, NULL is returned.

Definition at line 943 of file bsDynaMsgs.c.

References BsDynaMsgDefLookupTbl, and BsDynaMsgIdNumOf.

Referenced by bsDynaGetMsgName(), BsDynaPackMsg(), and BsDynaUnpackMsg().

 {
   if( (uint_t)eMsgId >= (uint_t)BsDynaMsgIdNumOf )
   {
     return NULL;
   }
   else
   {
     return BsDynaMsgDefLookupTbl[(uint_t)eMsgId];
   }
 }

size_t BsDynaLookupMsgMaxLen ( BsDynaMsgId_T eMsgId )

Look up the message maximum length associated with the message id.

The maximum length is the total number of packed bytes possible for the given message. The message may be much shorter.

Parameters

eMsgId Message Id.

Returns: On success, returns the number of bytes. On error, 0 is returned.

Definition at line 967 of file bsDynaMsgs.c.

References BsDynaMsgIdNumOf, and BsDynaMsgMaxLenLookupTbl.

 {
   if( (uint_t)eMsgId >= (uint_t)BsDynaMsgIdNumOf )
   {
     return (size_t)0;
   }
   else
   {
     return BsDynaMsgMaxLenLookupTbl[(uint_t)eMsgId];
   }
 }

int BsDynaPackMsg	(	BsDynaMsgId_T	eMsgId,
		void *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a ITV message in big-endian byte order.

Parameters

	eMsgId	Message Id.
[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 993 of file bsDynaMsgs.c.

References BsDynaLookupMsgDef().

Referenced by BsDynaPackReqOpenArgs(), BsDynaPackReqPing(), BsDynaPackReqRead16(), BsDynaPackReqRead8(), BsDynaPackReqReset(), BsDynaPackReqSetBaudRate(), BsDynaPackReqSetHalfDuplexCtl(), BsDynaPackReqSyncWrite(), BsDynaPackReqWrite16(), BsDynaPackReqWrite8(), BsDynaPackRspPing(), BsDynaPackRspRead16(), BsDynaPackRspRead8(), BsDynaPackRspWrite16(), and BsDynaPackRspWrite8().

 {
   const  NMMsgDef_T  *pMsgDef;
   
   if( (pMsgDef = BsDynaLookupMsgDef(eMsgId)) == NULL )
   {
     LOGERROR("%s(ecode=%d): msgid=%u.", 
               nmStrError(NM_ECODE_MSGID), NM_ECODE_MSGID, eMsgId);
     return -NM_ECODE_MSGID;
   }
   
   if( bTrace )
   {
     return nmPackITVMsgDebug(pMsgDef, pStruct, buf, bufSize, NMEndianBig);
   }
   else
   {
     return nmPackITVMsg(pMsgDef, pStruct, buf, bufSize, NMEndianBig);
   }
 }

INLINE_IN_H int BsDynaPackReqOpenArgs	(	BsDynaReqOpenArgs_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqOpenArgs ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 347 of file bsDynaMsgs.h.

References BsDynaMsgIdReqOpenArgs, and BsDynaPackMsg().

Referenced by bsDynaOpen().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqOpenArgs, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqPing	(	BsDynaReqPing_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqPing ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 820 of file bsDynaMsgs.h.

References BsDynaMsgIdReqPing, and BsDynaPackMsg().

Referenced by bsDynaPing().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqPing, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqRead16	(	BsDynaReqRead16_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqRead16 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 519 of file bsDynaMsgs.h.

References BsDynaMsgIdReqRead16, and BsDynaPackMsg().

Referenced by bsDynaRead16().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqRead16, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqRead8	(	BsDynaReqRead8_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqRead8 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 433 of file bsDynaMsgs.h.

References BsDynaMsgIdReqRead8, and BsDynaPackMsg().

Referenced by bsDynaRead8().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqRead8, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqReset	(	BsDynaReqReset_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqReset ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 906 of file bsDynaMsgs.h.

References BsDynaMsgIdReqReset, and BsDynaPackMsg().

Referenced by bsDynaReset().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqReset, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqSetBaudRate	(	BsDynaReqSetBaudRate_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqSetBaudRate ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 390 of file bsDynaMsgs.h.

References BsDynaMsgIdReqSetBaudRate, and BsDynaPackMsg().

Referenced by bsDynaSetBaudRate().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqSetBaudRate, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqSetHalfDuplexCtl	(	BsDynaReqSetHalfDuplexCtl_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqSetHalfDuplexCtl ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 949 of file bsDynaMsgs.h.

References BsDynaMsgIdReqSetHalfDuplexCtl, and BsDynaPackMsg().

Referenced by bsDynaSetHalfDuplexCtl().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqSetHalfDuplexCtl, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqSyncWrite	(	BsDynaReqSyncWrite_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqSyncWrite ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 777 of file bsDynaMsgs.h.

References BsDynaMsgIdReqSyncWrite, and BsDynaPackMsg().

Referenced by bsDynaSyncWrite().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqSyncWrite, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqWrite16	(	BsDynaReqWrite16_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqWrite16 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 691 of file bsDynaMsgs.h.

References BsDynaMsgIdReqWrite16, and BsDynaPackMsg().

Referenced by bsDynaWrite16().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqWrite16, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackReqWrite8	(	BsDynaReqWrite8_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaReqWrite8 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 605 of file bsDynaMsgs.h.

References BsDynaMsgIdReqWrite8, and BsDynaPackMsg().

Referenced by bsDynaWrite8().

 {
   return BsDynaPackMsg(BsDynaMsgIdReqWrite8, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackRspPing	(	BsDynaRspPing_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaRspPing ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 863 of file bsDynaMsgs.h.

References BsDynaMsgIdRspPing, and BsDynaPackMsg().

 {
   return BsDynaPackMsg(BsDynaMsgIdRspPing, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackRspRead16	(	BsDynaRspRead16_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaRspRead16 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 562 of file bsDynaMsgs.h.

References BsDynaMsgIdRspRead16, and BsDynaPackMsg().

 {
   return BsDynaPackMsg(BsDynaMsgIdRspRead16, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackRspRead8	(	BsDynaRspRead8_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaRspRead8 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 476 of file bsDynaMsgs.h.

References BsDynaMsgIdRspRead8, and BsDynaPackMsg().

 {
   return BsDynaPackMsg(BsDynaMsgIdRspRead8, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackRspWrite16	(	BsDynaRspWrite16_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaRspWrite16 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 734 of file bsDynaMsgs.h.

References BsDynaMsgIdRspWrite16, and BsDynaPackMsg().

 {
   return BsDynaPackMsg(BsDynaMsgIdRspWrite16, pStruct, buf, bufSize, bTrace);
 }

INLINE_IN_H int BsDynaPackRspWrite8	(	BsDynaRspWrite8_T *	pStruct,
		byte_t	buf[],
		size_t	bufSize,
		bool_t	bTrace
	)

Pack a BsDynaRspWrite8 ITV message in big-endian byte order into the output buffer.

Parameters

[in]	pStruct	Pointer to the associated, populated message structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes packed. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 648 of file bsDynaMsgs.h.

References BsDynaMsgIdRspWrite8, and BsDynaPackMsg().

 {
   return BsDynaPackMsg(BsDynaMsgIdRspWrite8, pStruct, buf, bufSize, bTrace);
 }

int BsDynaUnpackMsg	(	BsDynaMsgId_T	eMsgId,
		byte_t	buf[],
		size_t	uMsgLen,
		void *	pStruct,
		bool_t	bTrace
	)

Unpack a ITV message in big-endian byte order.

Parameters

	eMsgId	Message Id.
[in]	buf	Input message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 1031 of file bsDynaMsgs.c.

References BsDynaLookupMsgDef().

Referenced by BsDynaUnpackReqOpenArgs(), BsDynaUnpackReqPing(), BsDynaUnpackReqRead16(), BsDynaUnpackReqRead8(), BsDynaUnpackReqReset(), BsDynaUnpackReqSetBaudRate(), BsDynaUnpackReqSetHalfDuplexCtl(), BsDynaUnpackReqSyncWrite(), BsDynaUnpackReqWrite16(), BsDynaUnpackReqWrite8(), BsDynaUnpackRspPing(), BsDynaUnpackRspRead16(), BsDynaUnpackRspRead8(), BsDynaUnpackRspWrite16(), and BsDynaUnpackRspWrite8().

 {
   const  NMMsgDef_T  *pMsgDef;
   
   if( (pMsgDef = BsDynaLookupMsgDef(eMsgId)) == NULL )
   {
     LOGERROR("%s(ecode=%d): msgid=%u.", 
               nmStrError(NM_ECODE_MSGID), NM_ECODE_MSGID, eMsgId);
     return -NM_ECODE_MSGID;
   }
   
   if( bTrace )
   {
     return nmUnpackITVMsgDebug(pMsgDef, buf, uMsgLen, pStruct, NMEndianBig);
   }
   else
   {
     return nmUnpackITVMsg(pMsgDef, buf, uMsgLen, pStruct, NMEndianBig);
   }
 }

INLINE_IN_H int BsDynaUnpackReqOpenArgs	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqOpenArgs_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqOpenArgs ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 368 of file bsDynaMsgs.h.

References BsDynaMsgIdReqOpenArgs, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqOpenArgs, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqPing	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqPing_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqPing ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 841 of file bsDynaMsgs.h.

References BsDynaMsgIdReqPing, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqPing, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqRead16	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqRead16_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqRead16 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 540 of file bsDynaMsgs.h.

References BsDynaMsgIdReqRead16, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqRead16, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqRead8	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqRead8_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqRead8 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 454 of file bsDynaMsgs.h.

References BsDynaMsgIdReqRead8, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqRead8, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqReset	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqReset_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqReset ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 927 of file bsDynaMsgs.h.

References BsDynaMsgIdReqReset, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqReset, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqSetBaudRate	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqSetBaudRate_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqSetBaudRate ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 411 of file bsDynaMsgs.h.

References BsDynaMsgIdReqSetBaudRate, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqSetBaudRate, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqSetHalfDuplexCtl	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqSetHalfDuplexCtl_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqSetHalfDuplexCtl ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 970 of file bsDynaMsgs.h.

References BsDynaMsgIdReqSetHalfDuplexCtl, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqSetHalfDuplexCtl, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqSyncWrite	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqSyncWrite_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqSyncWrite ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 798 of file bsDynaMsgs.h.

References BsDynaMsgIdReqSyncWrite, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqSyncWrite, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqWrite16	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqWrite16_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqWrite16 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 712 of file bsDynaMsgs.h.

References BsDynaMsgIdReqWrite16, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqWrite16, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackReqWrite8	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaReqWrite8_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaReqWrite8 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 626 of file bsDynaMsgs.h.

References BsDynaMsgIdReqWrite8, and BsDynaUnpackMsg().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdReqWrite8, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackRspPing	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaRspPing_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaRspPing ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 884 of file bsDynaMsgs.h.

References BsDynaMsgIdRspPing, and BsDynaUnpackMsg().

Referenced by bsDynaPing().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdRspPing, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackRspRead16	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaRspRead16_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaRspRead16 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 583 of file bsDynaMsgs.h.

References BsDynaMsgIdRspRead16, and BsDynaUnpackMsg().

Referenced by bsDynaRead16().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdRspRead16, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackRspRead8	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaRspRead8_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaRspRead8 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 497 of file bsDynaMsgs.h.

References BsDynaMsgIdRspRead8, and BsDynaUnpackMsg().

Referenced by bsDynaRead8().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdRspRead8, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackRspWrite16	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaRspWrite16_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaRspWrite16 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 755 of file bsDynaMsgs.h.

References BsDynaMsgIdRspWrite16, and BsDynaUnpackMsg().

Referenced by bsDynaWrite16().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdRspWrite16, buf, uMsgLen, pStruct, bTrace);
 }

INLINE_IN_H int BsDynaUnpackRspWrite8	(	byte_t	buf[],
		size_t	uMsgLen,
		BsDynaRspWrite8_T *	pStruct,
		bool_t	bTrace
	)

Unpack a BsDynaRspWrite8 ITV message in big-endian byte order from the input buffer.

Parameters

[in]	buf	Output message buffer.
	uMsgLen	Length of message (bytes) in input buffer.
[out]	pStruct	Pointer to the associated message structure.
	bTrace	Do [not] trace packing.

Returns: On success, returns the number of bytes unpacked. On error, returns the appropriate < 0 negated NM_ECODE.

Definition at line 669 of file bsDynaMsgs.h.

References BsDynaMsgIdRspWrite8, and BsDynaUnpackMsg().

Referenced by bsDynaWrite8().

 {
   return BsDynaUnpackMsg(BsDynaMsgIdRspWrite8, buf, uMsgLen, pStruct, bTrace);
 }

Variable Documentation

const NMMsgDef_T* BsDynaMsgDefLookupTbl[]

BsDyna Message Definition Look-Up Table. Indexed by BsDynaMsgId_T enum.

Definition at line 883 of file bsDynaMsgs.c.

Referenced by BsDynaLookupMsgDef().

size_t BsDynaMsgMaxLenLookupTbl[]

BsDyna Message Maximum Size Look-Up Table. Indexed by BsDynaMsgId_T enum.

Definition at line 907 of file bsDynaMsgs.c.

Referenced by BsDynaLookupMsgMaxLen().

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation