ezradio_transmit_plugin.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef EZRADIO_TRANSMIT_PLUGIN_H_
#define EZRADIO_TRANSMIT_PLUGIN_H_

#ifdef __cplusplus
extern "C" {
#endif

/***************************************************************************/
/***************************************************************************/
/***************************************************************************/
/***************************************************************************/
// Transmit plugin related error codes
#define ECODE_EMDRV_EZRADIODRV_TRANSMIT_FAILED          ( ECODE_EMDRV_EZRADIODRV_TRANSMIT_PLUGIN_BASE | 0x00000001 )   

#if defined(EZRADIO_PLUGIN_TRANSMIT)

typedef enum EZRADIODRV_TransmitLengthMode
{
  ezradiodrvTransmitLenghtDefault               = 0,    
  ezradiodrvTransmitLenghtCustomPacketLen       = 1,    
  ezradiodrvTransmitLenghtCustomFieldLen        = 2     
} EZRADIODRV_TransmitLengthMode_t;

typedef enum EZRADIODRV_TransmitPacketType
{
  ezradiodrvPacketTypeNormal                    = 0,    
#if defined(EZRADIO_PLUGIN_AUTO_ACK) && defined(EZRADIO_PLUGIN_RECEIVE)
  ezradiodrvPacketTypeAutoAck                   = 1,    
#endif
} EZRADIODRV_TransmitPacketType_t;

typedef struct EZRADIODRV_FieldLength
{
  uint8_t f1;       
  uint8_t f2;       
  uint8_t f3;       
  uint8_t f4;       
  uint8_t f5;       
} EZRADIODRV_FieldLength_t;

typedef struct EZRADIODRV_PacketLengthConfig
{
  EZRADIODRV_TransmitLengthMode_t lenMode;  
  uint16_t pktLen;                          
  EZRADIODRV_FieldLength_t fieldLen;        
} EZRADIODRV_PacketLengthConfig_t;

typedef struct EZRADIODRV_PacketTxHandle
{
  EZRADIODRV_Callback_t userCallback;           
  EZRADIODRV_PacketLengthConfig_t lenConfig;    
  uint8_t channel;                              
  EZRADIODRV_TransmitPacketType_t pktType;      
  uint16_t pktId;                               
} EZRADIODRV_PacketTxHandle_t;


Ecode_t ezradioStartTransmitBasic(EZRADIODRV_Handle_t radioHandle, uint16_t packetLength, uint8_t *pioRadioPacket);
Ecode_t ezradioStartTransmitConfigured(EZRADIODRV_Handle_t radioHandle, uint8_t *pioRadioPacket);
Ecode_t ezradioStartTransmitCustom(EZRADIODRV_Handle_t radioHandle, EZRADIODRV_PacketLengthConfig_t pktLengthConf, uint8_t *pioRadioPacket);

Ecode_t ezradioStartTransmitDefault(EZRADIODRV_Handle_t radioHandle, uint8_t *pioRadioPacket);
Ecode_t ezradioStartTransmitSmart(EZRADIODRV_Handle_t radioHandle, EZRADIODRV_PacketLengthConfig_t pktLengthConf, uint8_t *pioRadioPacket);

#define EZRADIODRV_TRANSMIT_PLUGIN_INIT_DEFAULT                                \
{                                           /* Packet TX                   */  \
  NULL,                                     /* CallBack                    */  \
  {                                         /* Packet length config        */  \
    ezradiodrvTransmitLenghtDefault,        /* Default length mode         */  \
    0,                                      /* Packet length               */  \
    {0,0,0,0,0}                             /* Field lengths               */  \
  },                                                                           \
  RADIO_CONFIGURATION_DATA_CHANNEL_NUMBER,  /* Channel                     */  \
  ezradiodrvPacketTypeNormal,               /* Packet type                 */  \
  0,                                        /* Packet ID                   */  \
},

#else //#if defined( EZRADIO_PLUGIN_TRANSMIT )
#define EZRADIODRV_TRANSMIT_PLUGIN_INIT_DEFAULT
#endif  //#if defined( EZRADIO_PLUGIN_TRANSMIT )

#ifdef __cplusplus
}
#endif

#endif /* EZRADIO_TRANSMIT_PLUGIN_H_ */