ezradio_transmit_plugin.h File Reference

EzRadio transmit plug-in managed by the plug-in manager if enabled.

Version
5.4.0

License

(C) Copyright 2015 Silicon Labs, www.silabs.com

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
  2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.

DISCLAIMER OF WARRANTY/LIMITATION OF REMEDIES: Silicon Labs has no obligation to support this Software. Silicon Labs is providing the Software "AS IS", with no express or implied warranties of any kind, including, but not limited to, any implied warranties of merchantability or fitness for any particular purpose or warranties against infringement of any proprietary rights of a third party.

Silicon Labs will not be liable for any consequential, incidental, or special damages, or any other relief, or for any claim by any third party, arising from your use of this Software.

Definition in file ezradio_transmit_plugin.h .

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.