Smeshlink / MxRadioRF2xx

Dependents:   xBedRadio MxSniffer

Embed: (wiki syntax)

« Back to documentation index

GrpRadio

Data Structures

union  radio_param_t
 Container for handover of radio parameter values. More...
struct  radio_status_t
 Structure for storage of radio parameters. More...

Typedefs

typedef uint8_t radio_state_t
 Radio state type.
typedef enum SHORTENUM radio_cca_t
 codes for CCA
typedef enum SHORTENUM radio_attribute_t
 Enumeration to identify radio attributes.
typedef union radio_param_t radio_param_t
 Container for handover of radio parameter values.
typedef enum SHORTENUM radio_error_t
 Error codes.

Enumerations

enum  radio_tx_done_t { TX_OK, TX_CCA_FAIL, TX_NO_ACK, TX_FAIL }
 

error codes for tx done event

More...
enum  SHORTENUM {
  RADIO_CCA_FREE = CCA_IDLE, RADIO_CCA_BUSY = CCA_BUSY, RADIO_CCA_FAIL = 255, RADIO_CCA_FREE = CCA_IDLE,
  RADIO_CCA_BUSY = CCA_BUSY, RADIO_CCA_FAIL = 255, phyCurrentChannel, phyChannelsSupported,
  phyTransmitPower, phyIdleState, phyCCAMode, phyPanId,
  phyShortAddr, phyLongAddr, phyDataRate, phyTxPa,
  phyRxLna, SUCCESS = 0, STATE_SET_FAILED = 1, SET_PARM_FAILED,
  GET_PARM_FAILED, GENERAL_ERROR
}
 

codes for CCA

More...
enum  SHORTENUM {
  RADIO_CCA_FREE = CCA_IDLE, RADIO_CCA_BUSY = CCA_BUSY, RADIO_CCA_FAIL = 255, RADIO_CCA_FREE = CCA_IDLE,
  RADIO_CCA_BUSY = CCA_BUSY, RADIO_CCA_FAIL = 255, phyCurrentChannel, phyChannelsSupported,
  phyTransmitPower, phyIdleState, phyCCAMode, phyPanId,
  phyShortAddr, phyLongAddr, phyDataRate, phyTxPa,
  phyRxLna, SUCCESS = 0, STATE_SET_FAILED = 1, SET_PARM_FAILED,
  GET_PARM_FAILED, GENERAL_ERROR
}
 

Enumeration to identify radio attributes.

More...
enum  SHORTENUM {
  RADIO_CCA_FREE = CCA_IDLE, RADIO_CCA_BUSY = CCA_BUSY, RADIO_CCA_FAIL = 255, RADIO_CCA_FREE = CCA_IDLE,
  RADIO_CCA_BUSY = CCA_BUSY, RADIO_CCA_FAIL = 255, phyCurrentChannel, phyChannelsSupported,
  phyTransmitPower, phyIdleState, phyCCAMode, phyPanId,
  phyShortAddr, phyLongAddr, phyDataRate, phyTxPa,
  phyRxLna, SUCCESS = 0, STATE_SET_FAILED = 1, SET_PARM_FAILED,
  GET_PARM_FAILED, GENERAL_ERROR
}
 

Error codes.

More...

Typedef Documentation

Enumeration to identify radio attributes.

typedef enum SHORTENUM radio_cca_t

codes for CCA

typedef enum SHORTENUM radio_error_t

Error codes.

Container for handover of radio parameter values.

Note:
The elements in this union should have max. a size of 2 byte, all other parameters should be configured with the void pointer.
typedef uint8_t radio_state_t

Radio state type.

Definition at line 71 of file radio.h.


Enumeration Type Documentation

error codes for tx done event

Enumerator:
TX_OK 

transmission completed successfully

TX_CCA_FAIL 

channel was busy (TX_AUTO only)

TX_NO_ACK 

no ACK received (TX_AUTO only)

TX_FAIL 

unexpected error

Definition at line 76 of file radio.h.

enum SHORTENUM

Error codes.

Enumerator:
RADIO_CCA_FREE 

The CCA measurement estimates, that the channel is free.

RADIO_CCA_BUSY 

The CCA measurement estimates, that the channel is busy.

RADIO_CCA_FAIL 

The CCA measurement was not finished.

RADIO_CCA_FREE 

The CCA measurement estimates, that the channel is free.

RADIO_CCA_BUSY 

The CCA measurement estimates, that the channel is busy.

RADIO_CCA_FAIL 

The CCA measurement was not finished.

phyCurrentChannel 

Set the current channel.

phyChannelsSupported 

Currently unused.

phyTransmitPower 

Set the Tx power.

phyIdleState 

Transceiver state to return to after transmission.

phyCCAMode 

CCA mode to use in CSMA-CA:

valueCCA mode
0 carrier sense OR energy above threshold
1 energy above threshold (default)
2 carrier sense
3 carrier sense AND energy above threshold
phyPanId 

PAN ID to use in STATE_RXAUTO frame filter.

phyShortAddr 

Short (16-bit) address to use in STATE_RXAUTO frame filter.

phyLongAddr 

Pointer to long (EUI-64) address to use in STATE_RXAUTO frame filter.

phyDataRate 

Datarate.

phyTxPa 

PA enable.

phyRxLna 

LNA enable.

SUCCESS 

OK Code.

STATE_SET_FAILED 

function radio_set_state failed

SET_PARM_FAILED 

function radio_set_param failed

GET_PARM_FAILED 

function radio_get_param failed

GENERAL_ERROR 

something unexpected happened

Definition at line 196 of file radio.h.

enum SHORTENUM

Enumeration to identify radio attributes.

Enumerator:
RADIO_CCA_FREE 

The CCA measurement estimates, that the channel is free.

RADIO_CCA_BUSY 

The CCA measurement estimates, that the channel is busy.

RADIO_CCA_FAIL 

The CCA measurement was not finished.

RADIO_CCA_FREE 

The CCA measurement estimates, that the channel is free.

RADIO_CCA_BUSY 

The CCA measurement estimates, that the channel is busy.

RADIO_CCA_FAIL 

The CCA measurement was not finished.

phyCurrentChannel 

Set the current channel.

phyChannelsSupported 

Currently unused.

phyTransmitPower 

Set the Tx power.

phyIdleState 

Transceiver state to return to after transmission.

phyCCAMode 

CCA mode to use in CSMA-CA:

valueCCA mode
0 carrier sense OR energy above threshold
1 energy above threshold (default)
2 carrier sense
3 carrier sense AND energy above threshold
phyPanId 

PAN ID to use in STATE_RXAUTO frame filter.

phyShortAddr 

Short (16-bit) address to use in STATE_RXAUTO frame filter.

phyLongAddr 

Pointer to long (EUI-64) address to use in STATE_RXAUTO frame filter.

phyDataRate 

Datarate.

phyTxPa 

PA enable.

phyRxLna 

LNA enable.

SUCCESS 

OK Code.

STATE_SET_FAILED 

function radio_set_state failed

SET_PARM_FAILED 

function radio_set_param failed

GET_PARM_FAILED 

function radio_get_param failed

GENERAL_ERROR 

something unexpected happened

Definition at line 112 of file radio.h.

enum SHORTENUM

codes for CCA

Enumerator:
RADIO_CCA_FREE 

The CCA measurement estimates, that the channel is free.

RADIO_CCA_BUSY 

The CCA measurement estimates, that the channel is busy.

RADIO_CCA_FAIL 

The CCA measurement was not finished.

RADIO_CCA_FREE 

The CCA measurement estimates, that the channel is free.

RADIO_CCA_BUSY 

The CCA measurement estimates, that the channel is busy.

RADIO_CCA_FAIL 

The CCA measurement was not finished.

phyCurrentChannel 

Set the current channel.

phyChannelsSupported 

Currently unused.

phyTransmitPower 

Set the Tx power.

phyIdleState 

Transceiver state to return to after transmission.

phyCCAMode 

CCA mode to use in CSMA-CA:

valueCCA mode
0 carrier sense OR energy above threshold
1 energy above threshold (default)
2 carrier sense
3 carrier sense AND energy above threshold
phyPanId 

PAN ID to use in STATE_RXAUTO frame filter.

phyShortAddr 

Short (16-bit) address to use in STATE_RXAUTO frame filter.

phyLongAddr 

Pointer to long (EUI-64) address to use in STATE_RXAUTO frame filter.

phyDataRate 

Datarate.

phyTxPa 

PA enable.

phyRxLna 

LNA enable.

SUCCESS 

OK Code.

STATE_SET_FAILED 

function radio_set_state failed

SET_PARM_FAILED 

function radio_set_param failed

GET_PARM_FAILED 

function radio_get_param failed

GENERAL_ERROR 

something unexpected happened

Definition at line 88 of file radio.h.