CC13xx Driver Library
rfc_CMD_RX_s Struct Reference

#include <rf_common_cmd.h>

Data Fields

uint16_t commandNo
 The command ID number 0x0805. More...
 
uint16_t status
 An integer telling the status of the command. This value is updated by the radio CPU during operation and may be read by the system CPU at any time. More...
 
rfc_radioOp_tpNextOp
 Pointer to the next operation to run after this operation is done. More...
 
ratmr_t startTime
 Absolute or relative start time (depending on the value of startTrigger) More...
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
startTrigger
 Identification of the trigger that starts the operation. More...
 
struct {
   uint8_t   rule:4
 Condition for running next command: Rule for how to proceed. More...
 
   uint8_t   nSkip:4
 Number of skips if the rule involves skipping. More...
 
condition
 
struct {
   uint16_t   endianness:1
 0: Least significant bit first
1: Most significant bit first More...
 
   uint16_t   numHdrBits:6
 Number of bits in the header. More...
 
   uint16_t   bFsOff:1
 0: Keep frequency synth on after command
1: Turn frequency synth off after command More...
 
   uint16_t   bUseCrc:1
 0: No CRC
1: The last bytes of the packet are a CRC More...
 
   uint16_t   bCrcIncSw:1
 0: Do not include sync word in CRC calculation
1: Include sync word in CRC calculation More...
 
   uint16_t   bCrcIncHdr:1
 0: Do not include header in CRC calculation
1: Include header in CRC calculation More...
 
   uint16_t   bReportCrc:1
 0: Do not write CRC to receive buffer
1: Write received CRC to receive buffer More...
 
   uint16_t   endType:1
 0: Packet is received to the end if end trigger happens after sync is obtained
1: Packet reception is stopped if end trigger happens More...
 
   uint16_t   bDualSw:1
 0: Single sync word
1: Dual sync word. More...
 
pktConfig
 
uint32_t syncWord
 Sync word to receive. More...
 
uint32_t syncWord2
 Secondary sync word to receive if pktConfig.bDualSw = 1. More...
 
struct {
   uint16_t   numLenBits:4
 Number of bits in the length field. More...
 
   uint16_t   lenFieldPos:5
 Bit position of the first bit in the length field. More...
 
   uint16_t   lenOffset:7
 Signed number to add to the received length field. More...
 
lenConfig
 
uint16_t maxLen
 Maximum number of bytes in the received packet (including header, excluding CRC) More...
 
uint8_t * pRecPkt
 Pointer to buffer for received packet. NULL: Do not store the contents. More...
 
ratmr_t endTime
 Time to end the operation. More...
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
endTrigger
 Trigger classifier for ending the operation. More...
 
int8_t rssi
 RSSI of received packet. More...
 
uint16_t recLen
 Number of bytes written to receive buffer. More...
 
ratmr_t timeStamp
 Time stamp of received packet. More...
 
uint16_t nRxOk
 Counter of number of received packets with CRC OK and first sync word. More...
 
uint16_t nRxNok
 Counter of number of received packets with CRC error and first sync word. More...
 
uint16_t nRx2Ok
 Counter of number of received packets with CRC OK and second sync word; may safely be omitted if pktConfig.bDualSw is 0. More...
 
uint16_t nRx2Nok
 Counter of number of received packets with CRC error and second sync word; may safely be omitted if pktConfig.bDualSw is 0. More...
 

Detailed Description

Definition at line 282 of file rf_common_cmd.h.

Field Documentation

uint16_t rfc_CMD_RX_s::bCrcIncHdr

0: Do not include header in CRC calculation
1: Include header in CRC calculation

Definition at line 311 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::bCrcIncSw

0: Do not include sync word in CRC calculation
1: Include sync word in CRC calculation

Definition at line 309 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::bDualSw

0: Single sync word
1: Dual sync word.

Definition at line 317 of file rf_common_cmd.h.

uint8_t rfc_CMD_RX_s::bEnaCmd

0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger

Definition at line 291 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::bFsOff

0: Keep frequency synth on after command
1: Turn frequency synth off after command

Definition at line 305 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::bReportCrc

0: Do not write CRC to receive buffer
1: Write received CRC to receive buffer

Definition at line 313 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::bUseCrc

0: No CRC
1: The last bytes of the packet are a CRC

Definition at line 307 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::commandNo

The command ID number 0x0805.

Definition at line 283 of file rf_common_cmd.h.

struct { ... } rfc_CMD_RX_s::condition
uint16_t rfc_CMD_RX_s::endianness

0: Least significant bit first
1: Most significant bit first

Definition at line 302 of file rf_common_cmd.h.

ratmr_t rfc_CMD_RX_s::endTime

Time to end the operation.

Definition at line 329 of file rf_common_cmd.h.

struct { ... } rfc_CMD_RX_s::endTrigger

Trigger classifier for ending the operation.

uint16_t rfc_CMD_RX_s::endType

0: Packet is received to the end if end trigger happens after sync is obtained
1: Packet reception is stopped if end trigger happens

Definition at line 315 of file rf_common_cmd.h.

struct { ... } rfc_CMD_RX_s::lenConfig
uint16_t rfc_CMD_RX_s::lenFieldPos

Bit position of the first bit in the length field.

Definition at line 324 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::lenOffset

Signed number to add to the received length field.

Definition at line 325 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::maxLen

Maximum number of bytes in the received packet (including header, excluding CRC)

Definition at line 327 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::nRx2Nok

Counter of number of received packets with CRC error and second sync word; may safely be omitted if pktConfig.bDualSw is 0.

Definition at line 345 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::nRx2Ok

Counter of number of received packets with CRC OK and second sync word; may safely be omitted if pktConfig.bDualSw is 0.

Definition at line 343 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::nRxNok

Counter of number of received packets with CRC error and first sync word.

Definition at line 342 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::nRxOk

Counter of number of received packets with CRC OK and first sync word.

Definition at line 341 of file rf_common_cmd.h.

uint8_t rfc_CMD_RX_s::nSkip

Number of skips if the rule involves skipping.

Definition at line 299 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::numHdrBits

Number of bits in the header.

Definition at line 304 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::numLenBits

Number of bits in the length field.

Definition at line 323 of file rf_common_cmd.h.

uint8_t rfc_CMD_RX_s::pastTrig

0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible

Definition at line 294 of file rf_common_cmd.h.

struct { ... } rfc_CMD_RX_s::pktConfig
rfc_radioOp_t* rfc_CMD_RX_s::pNextOp

Pointer to the next operation to run after this operation is done.

Definition at line 287 of file rf_common_cmd.h.

uint8_t* rfc_CMD_RX_s::pRecPkt

Pointer to buffer for received packet. NULL: Do not store the contents.

Definition at line 328 of file rf_common_cmd.h.

uint16_t rfc_CMD_RX_s::recLen

Number of bytes written to receive buffer.

Definition at line 339 of file rf_common_cmd.h.

int8_t rfc_CMD_RX_s::rssi

RSSI of received packet.

Definition at line 338 of file rf_common_cmd.h.

uint8_t rfc_CMD_RX_s::rule

Condition for running next command: Rule for how to proceed.

Definition at line 298 of file rf_common_cmd.h.

ratmr_t rfc_CMD_RX_s::startTime

Absolute or relative start time (depending on the value of startTrigger)

Definition at line 288 of file rf_common_cmd.h.

struct { ... } rfc_CMD_RX_s::startTrigger

Identification of the trigger that starts the operation.

uint16_t rfc_CMD_RX_s::status

An integer telling the status of the command. This value is updated by the radio CPU during operation and may be read by the system CPU at any time.

Definition at line 284 of file rf_common_cmd.h.

uint32_t rfc_CMD_RX_s::syncWord

Sync word to receive.

Definition at line 320 of file rf_common_cmd.h.

uint32_t rfc_CMD_RX_s::syncWord2

Secondary sync word to receive if pktConfig.bDualSw = 1.

Definition at line 321 of file rf_common_cmd.h.

ratmr_t rfc_CMD_RX_s::timeStamp

Time stamp of received packet.

Definition at line 340 of file rf_common_cmd.h.

uint8_t rfc_CMD_RX_s::triggerNo

The trigger number of the CMD_TRIGGER command that triggers this action.

Definition at line 293 of file rf_common_cmd.h.

uint8_t rfc_CMD_RX_s::triggerType

The type of trigger.

Definition at line 290 of file rf_common_cmd.h.