sbgEComCmdCommon.h

Go to the documentation of this file.

#ifndef __SBG_ECOM_CMD_COMMON_H__
#define __SBG_ECOM_CMD_COMMON_H__

#include "../sbgECom.h"

//----------------------------------------------------------------------//
//- Defintions                                                         -//
//----------------------------------------------------------------------//

#define SBG_ECOM_DEFAULT_CMD_TIME_OUT   (500)   
typedef enum _SbgEComRejectionMode
{
        SBG_ECOM_NEVER_ACCEPT_MODE              = 0,            
        SBG_ECOM_AUTOMATIC_MODE                 = 1,            
        SBG_ECOM_ALWAYS_ACCEPT_MODE             = 2                     
} SbgEComRejectionMode;

typedef enum _SbgEComAxisDirection
{
        SBG_ECOM_ALIGNMENT_FORWARD              = 0,            
        SBG_ECOM_ALIGNMENT_BACKWARD             = 1,            
        SBG_ECOM_ALIGNMENT_LEFT                 = 2,            
        SBG_ECOM_ALIGNMENT_RIGHT                = 3,            
        SBG_ECOM_ALIGNMENT_UP                   = 4,            
        SBG_ECOM_ALIGNMENT_DOWN                 = 5                     
} SbgEComAxisDirection;

typedef struct _SbgEComModelInfo
{
        uint32_t        id;                                                                     
        uint32_t        revision;                                                       
} SbgEComModelInfo;

//----------------------------------------------------------------------//
//- Common command reception operations                                -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComReceiveAnyCmd(SbgEComHandle *pHandle, uint8_t *pMsgClass, uint8_t *pMsg, void *pData, size_t *pSize, size_t maxSize, uint32_t timeOut);

SbgErrorCode sbgEComReceiveCmd(SbgEComHandle *pHandle, uint8_t msgClass, uint8_t msg, void *pData, size_t *pSize, size_t maxSize, uint32_t timeOut);

//----------------------------------------------------------------------//
//- ACK related commands  operations                                   -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComWaitForAck(SbgEComHandle *pHandle, uint8_t msgClass, uint8_t msg, uint32_t timeOut);

SbgErrorCode sbgEComSendAck(SbgEComHandle *pHandle, uint8_t msgClass, uint8_t msg, SbgErrorCode cmdError);

//----------------------------------------------------------------------//
//- Generic command definitions                                        -//
//----------------------------------------------------------------------//

SbgErrorCode sbgEComCmdGenericSetModelId(SbgEComHandle *pHandle, uint8_t msgClass, uint8_t msg, uint32_t modelId);

SbgErrorCode sbgEComCmdGenericGetModelId(SbgEComHandle *pHandle, uint8_t msgClass, uint8_t msg, uint32_t *pModelId);

SbgErrorCode sbgEComCmdGenericGetModelInfo(SbgEComHandle *pHandle, uint8_t msgClass, uint8_t msg, SbgEComModelInfo *pModelInfo);

#endif