Detailed Description

Transmit plugin, see Plugin System Layer for detailed documentation.

.

Data Structures
struct	EZRADIODRV_FieldLength

struct	EZRADIODRV_PacketLengthConfig
	EzRadio transmit packet length configuration structure.

struct	EZRADIODRV_PacketTxHandle
	EzRadio transmit plug-in instance initialization and handler structure.

Macros
#define	ECODE_EMDRV_EZRADIODRV_TRANSMIT_FAILED ( ECODE_EMDRV_EZRADIODRV_TRANSMIT_PLUGIN_BASE \| 0x00000001)
	Unable to start transmission.

#define	EZRADIODRV_TRANSMIT_PLUGIN_INIT_DEFAULT
	Configuration data for EzRadio transmit plug-in.

Typedefs
typedef struct EZRADIODRV_FieldLength	EZRADIODRV_FieldLength_t

typedef struct EZRADIODRV_PacketLengthConfig	EZRADIODRV_PacketLengthConfig_t
	EzRadio transmit packet length configuration structure.

typedef struct EZRADIODRV_PacketTxHandle	EZRADIODRV_PacketTxHandle_t
	EzRadio transmit plug-in instance initialization and handler structure.

typedef enum EZRADIODRV_TransmitLengthMode	EZRADIODRV_TransmitLengthMode_t
	EzRadio transmit packet length mode.

typedef enum EZRADIODRV_TransmitPacketType	EZRADIODRV_TransmitPacketType_t
	EzRadio transmit packet type.

Enumerations
enum	EZRADIODRV_TransmitLengthMode { ezradiodrvTransmitLenghtDefault = 0, ezradiodrvTransmitLenghtCustomPacketLen = 1, ezradiodrvTransmitLenghtCustomFieldLen = 2 }
	EzRadio transmit packet length mode.

enum	EZRADIODRV_TransmitPacketType { ezradiodrvPacketTypeNormal = 0, ezradiodrvPacketTypeAutoAck = 1 }
	EzRadio transmit packet type.

Functions
Ecode_t	ezradioStartTransmitBasic ( EZRADIODRV_Handle_t radioHandle, uint16_t packetLength, uint8_t *pioRadioPacket)
	Start basic transmission. Radio transmits with data only in the first field in this case.

Ecode_t	ezradioStartTransmitConfigured ( EZRADIODRV_Handle_t radioHandle, uint8_t *pioRadioPacket)
	Start transmission using the packet parameters from the generated configuration header file.

Ecode_t	ezradioStartTransmitCustom ( EZRADIODRV_Handle_t radioHandle, EZRADIODRV_PacketLengthConfig_t pktLengthConf, uint8_t *pioRadioPacket)
	Start transmission using the packet parameters from pktLengthConf.

Ecode_t	ezradioStartTransmitDefault ( EZRADIODRV_Handle_t radioHandle, uint8_t *pioRadioPacket)
	Start a default transmission using the packet information previously set to radioHandle. Depending on the information in the radioHandle parameter the function decides which transmission function has to be called.

Ecode_t	ezradioStartTransmitSmart ( EZRADIODRV_Handle_t radioHandle, EZRADIODRV_PacketLengthConfig_t pktLengthConf, uint8_t *pioRadioPacket)
	Start a smart transmission. Depending on the information in the pktLengthConf parameter the function decides which transmission function has to be called.

Macro Definition Documentation

#define EZRADIODRV_TRANSMIT_PLUGIN_INIT_DEFAULT

Value:

         {
         
          /* 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 */
         
         \
        
         },

Configuration data for EzRadio transmit plug-in.

Definition at line 116 of file ezradio_transmit_plugin.h .

Typedef Documentation

typedef struct EZRADIODRV_FieldLength EZRADIODRV_FieldLength_t

EzRadio transmit field length sturcture. Holds length information on all available fields. Data is got from the generated radio configuration header file.

Enumeration Type Documentation

enum EZRADIODRV_TransmitLengthMode

EzRadio transmit packet length mode.

Enumerator
ezradiodrvTransmitLenghtDefault	Transmit packet length is defined in the generated configuration.
ezradiodrvTransmitLenghtCustomPacketLen	Transmit packet length is defined by the application for field1 only.
ezradiodrvTransmitLenghtCustomFieldLen	Transmit packet length is defined by the application for multiple fields.

Definition at line 68 of file ezradio_transmit_plugin.h .

enum EZRADIODRV_TransmitPacketType

EzRadio transmit packet type.

Enumerator
ezradiodrvPacketTypeNormal	Normal packet type.
ezradiodrvPacketTypeAutoAck	Auto acknowledge packet type.

Definition at line 75 of file ezradio_transmit_plugin.h .

Function Documentation

Ecode_t ezradioStartTransmitBasic	(	EZRADIODRV_Handle_t	`radioHandle,`
		uint16_t	`packetLength,`
		uint8_t *	`pioRadioPacket`
	)

Start basic transmission. Radio transmits with data only in the first field in this case.

Parameters

`radioHandle`	Handler of the EzRadio driver instance where packet length and channel configurations are set.
`packetLength`	Length of the basic packet.
`pioRadioPacket`	Pointer to the packet buffer.

Returns: ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 70 of file ezradio_transmit_plugin.c .

References ECODE_EMDRV_EZRADIODRV_ILLEGAL_HANDLE , ECODE_EMDRV_EZRADIODRV_OK , ezradiodrvTransmitLenghtCustomPacketLen , EZRADIODRV_FieldLength::f1 , EZRADIODRV_FieldLength::f2 , EZRADIODRV_FieldLength::f3 , EZRADIODRV_FieldLength::f4 , EZRADIODRV_FieldLength::f5 , EZRADIODRV_PacketLengthConfig::fieldLen , EZRADIODRV_PacketTxHandle::lenConfig , EZRADIODRV_PacketLengthConfig::lenMode , EZRADIODRV_HandleData::packetTx , and EZRADIODRV_PacketLengthConfig::pktLen .

Referenced by ezradioStartTransmitSmart() .

Ecode_t ezradioStartTransmitConfigured	(	EZRADIODRV_Handle_t	`radioHandle,`
		uint8_t *	`pioRadioPacket`
	)

Start transmission using the packet parameters from the generated configuration header file.

Parameters

`radioHandle`	Handler of the EzRadio driver instance where packet length and channel configurations are set.
`pioRadioPacket`	Pointer to the packet buffer.

Returns: ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 111 of file ezradio_transmit_plugin.c .

References ECODE_EMDRV_EZRADIODRV_ILLEGAL_HANDLE , ECODE_EMDRV_EZRADIODRV_OK , ezradiodrvTransmitLenghtDefault , EZRADIODRV_FieldLength::f1 , EZRADIODRV_FieldLength::f2 , EZRADIODRV_FieldLength::f3 , EZRADIODRV_FieldLength::f4 , EZRADIODRV_FieldLength::f5 , EZRADIODRV_PacketLengthConfig::fieldLen , EZRADIODRV_PacketTxHandle::lenConfig , EZRADIODRV_PacketLengthConfig::lenMode , EZRADIODRV_HandleData::packetTx , and EZRADIODRV_PacketLengthConfig::pktLen .

Referenced by ezradioStartTransmitSmart() .

Ecode_t ezradioStartTransmitCustom	(	EZRADIODRV_Handle_t	`radioHandle,`
		EZRADIODRV_PacketLengthConfig_t	`pktLengthConf,`
		uint8_t *	`pioRadioPacket`
	)

Start transmission using the packet parameters from pktLengthConf.

Parameters

`radioHandle`	Handler of the EzRadio driver instance where packet length and channel configurations are set.
`pktLengthConf`	Packet length configuration structure configuration of the custom packet.
`pioRadioPacket`	Pointer to the packet buffer.

Returns: ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 152 of file ezradio_transmit_plugin.c .

References ECODE_EMDRV_EZRADIODRV_ILLEGAL_HANDLE , ECODE_EMDRV_EZRADIODRV_OK , ezradiodrvTransmitLenghtCustomPacketLen , EZRADIODRV_FieldLength::f1 , EZRADIODRV_FieldLength::f2 , EZRADIODRV_FieldLength::f3 , EZRADIODRV_FieldLength::f4 , EZRADIODRV_FieldLength::f5 , EZRADIODRV_PacketLengthConfig::fieldLen , EZRADIODRV_PacketTxHandle::lenConfig , EZRADIODRV_PacketLengthConfig::lenMode , EZRADIODRV_HandleData::packetTx , and EZRADIODRV_PacketLengthConfig::pktLen .

Referenced by ezradioStartTransmitSmart() .

Ecode_t ezradioStartTransmitDefault	(	EZRADIODRV_Handle_t	`radioHandle,`
		uint8_t *	`pioRadioPacket`
	)

Start a default transmission using the packet information previously set to radioHandle. Depending on the information in the radioHandle parameter the function decides which transmission function has to be called.

Parameters

`radioHandle`	Handler of the EzRadio driver instance where packet length and channel configurations are set.
`pioRadioPacket`	Pointer to the packet buffer.

Returns: ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 221 of file ezradio_transmit_plugin.c .

References ECODE_EMDRV_EZRADIODRV_ILLEGAL_HANDLE , ECODE_EMDRV_EZRADIODRV_OK , ezradioStartTransmitSmart() , EZRADIODRV_PacketTxHandle::lenConfig , and EZRADIODRV_HandleData::packetTx .

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

Start a smart transmission. Depending on the information in the pktLengthConf parameter the function decides which transmission function has to be called.

Parameters

`radioHandle`	Handler of the EzRadio driver instance where packet length and channel configurations are set.
`pktLengthConf`	Packet length configuration structure configuration of the custom packet.
`pioRadioPacket`	Pointer to the packet buffer.

Returns: ECODE_EMDRV_EZRADIODRV_OK on success. On failure an appropriate EZRADIODRV Ecode_t is returned.

Definition at line 191 of file ezradio_transmit_plugin.c .

References ECODE_EMDRV_EZRADIODRV_ILLEGAL_HANDLE , ECODE_EMDRV_EZRADIODRV_OK , ezradiodrvTransmitLenghtCustomFieldLen , ezradiodrvTransmitLenghtCustomPacketLen , ezradiodrvTransmitLenghtDefault , ezradioStartTransmitBasic() , ezradioStartTransmitConfigured() , ezradioStartTransmitCustom() , EZRADIODRV_PacketLengthConfig::lenMode , and EZRADIODRV_PacketLengthConfig::pktLen .

Referenced by ezradioStartTransmitDefault() .

Transmit_PluginEMDRV > EZRADIODRV > Plugin_System

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation