Auto_ACK_Plugin

Detailed Description

Auto acknowledge plugin, see Plugin System Layer for detailed documentation.

.

Data Structures

struct  EZRADIODRV_AutoAckHandle
 EzRadio auto acknowledge plug-in instance initialization and handler structure.
 

Macros

#define EZRADIODRV_AUTO_ACK_PLUGIN_INIT_DEFAULT
 Configuration data for EzRadio auto acknowledge plug-in.
 

Typedefs

typedef struct EZRADIODRV_AutoAckHandle EZRADIODRV_AutoAckHandle_t
 EzRadio auto acknowledge plug-in instance initialization and handler structure.
 
typedef enum EZRADIODRV_AutoAckMode EZRADIODRV_AutoAckMode_t
 EzRadio auto acknowledge mode.
 
typedef enum EZRADIODRV_AutoAckPacketMode EZRADIODRV_AutoAckPacketMode_t
 EzRadio packet mode for auto acknowledge plug-in.
 

Enumerations

enum  EZRADIODRV_AutoAckMode {
  ezradiodrvAutoAckDisabled = 0,
  ezradiodrvAutoAckImmediate = 1,
  ezradiodrvAutoAckSkipOne = 2
}
 EzRadio auto acknowledge mode.
 
enum  EZRADIODRV_AutoAckPacketMode {
  ezradiodrvAutoAckPktDefault = 0,
  ezradiodrvAutoAckPktCustom = 1
}
 EzRadio packet mode for auto acknowledge plug-in.
 

Functions

void ezradioDisableAutoAck (EZRADIODRV_AutoAckHandle_t *autoAckHandle)
 Disables auto acknowledge sending feature.
 
void ezradioEnableAutoAck (EZRADIODRV_AutoAckHandle_t *autoAckHandle)
 Enables auto acknowledge sending feature.
 
void ezradioSkipAutoAck (EZRADIODRV_AutoAckHandle_t *autoAckHandle)
 Configures auto acknowledge sending feature so that there will be no acknowledge transmitted to the next received packet. This is usefull is both nodes of a link uses auto acknowledgement.
 

Macro Definition Documentation

#define EZRADIODRV_AUTO_ACK_PLUGIN_INIT_DEFAULT
Value:
{ /* Auto acknowledge */ \
NULL, /* CallBack */ \
ezradiodrvAutoAckDisabled, /* Ack mode */ \
ezradiodrvAutoAckPktDefault, /* Ack packet mode */ \
{ /* Packet length config */ \
ezradiodrvTransmitLenghtDefault, /* Default length mode */ \
0, /* Packet length */ \
RADIO_CONFIG_DATA_FIELD_LENGTH, /* Field lengths */ \
}, \
NULL, /* Packet buffer */ \
0, /* Packet ID */ \
},

Configuration data for EzRadio auto acknowledge plug-in.

Definition at line 90 of file ezradio_auto_ack_plugin.h.

Enumeration Type Documentation

EzRadio auto acknowledge mode.

Enumerator
ezradiodrvAutoAckDisabled 

Auto acknowledge transmission disabled.

ezradiodrvAutoAckImmediate 

Immediate acknowledge transmission.

ezradiodrvAutoAckSkipOne 

Acknowledge transmission is skipped for one cycle, eg. not to transmit ACK if ACK is received.

Definition at line 63 of file ezradio_auto_ack_plugin.h.

EzRadio packet mode for auto acknowledge plug-in.

Enumerator
ezradiodrvAutoAckPktDefault 

Auto acknowledge uses the same transmission configuration as the actual configuration.

ezradiodrvAutoAckPktCustom 

Auto acknowledge uses custom packet configuration.

Definition at line 70 of file ezradio_auto_ack_plugin.h.

Function Documentation

void ezradioDisableAutoAck ( EZRADIODRV_AutoAckHandle_t autoAckHandle)

Disables auto acknowledge sending feature.

Parameters
autoAckHandleAuto acknowledge plug-in handler.
Returns
ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 65 of file ezradio_auto_ack_plugin.c.

References EZRADIODRV_AutoAckHandle::ackMode, and ezradiodrvAutoAckDisabled.

void ezradioEnableAutoAck ( EZRADIODRV_AutoAckHandle_t autoAckHandle)

Enables auto acknowledge sending feature.

Parameters
autoAckHandleAuto acknowledge plug-in handler.
Returns
ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 51 of file ezradio_auto_ack_plugin.c.

References EZRADIODRV_AutoAckHandle::ackMode, and ezradiodrvAutoAckImmediate.

void ezradioSkipAutoAck ( EZRADIODRV_AutoAckHandle_t autoAckHandle)

Configures auto acknowledge sending feature so that there will be no acknowledge transmitted to the next received packet. This is usefull is both nodes of a link uses auto acknowledgement.

Parameters
autoAckHandleAuto acknowledge plug-in handler.
Returns
ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 81 of file ezradio_auto_ack_plugin.c.

References EZRADIODRV_AutoAckHandle::ackMode, and ezradiodrvAutoAckSkipOne.