CC13xx Driver Library
rfc_CMD_PROP_RX_SNIFF_s Struct Reference

Proprietary Mode Receive Command with Sniff Mode. More...

#include <rf_prop_cmd.h>

Data Fields

uint16_t commandNo
 The command ID number 0x3808. 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 + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ... More...
 
condition
 
struct {
   uint8_t   bFsOff:1
 0: Keep frequency synth on after command
1: Turn frequency synth off after command More...
 
   uint8_t   bRepeatOk:1
 0: End operation after receiving a packet correctly
1: Go back to sync search after receiving a packet correctly More...
 
   uint8_t   bRepeatNok:1
 0: End operation after receiving a packet with CRC error
1: Go back to sync search after receiving a packet with CRC error More...
 
   uint8_t   bUseCrc:1
 0: Do not check CRC
1: Check CRC More...
 
   uint8_t   bVarLen:1
 0: Fixed length
1: Receive length as first byte More...
 
   uint8_t   bChkAddress:1
 0: No address check
1: Check address More...
 
   uint8_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...
 
   uint8_t   filterOp:1
 0: Stop receiver and restart sync search on address mismatch
1: Receive packet and mark it as ignored on address mismatch More...
 
pktConf
 
struct {
   uint8_t   bAutoFlushIgnored:1
 If 1, automatically discard ignored packets from RX queue. More...
 
   uint8_t   bAutoFlushCrcErr:1
 If 1, automatically discard packets with CRC error from RX queue. More...
 
   uint8_t   __pad0__:1
 
   uint8_t   bIncludeHdr:1
 If 1, include the received header or length byte in the stored packet; otherwise discard it. More...
 
   uint8_t   bIncludeCrc:1
 If 1, include the received CRC field in the stored packet; otherwise discard it. More...
 
   uint8_t   bAppendRssi:1
 If 1, append an RSSI byte to the packet in the RX queue. More...
 
   uint8_t   bAppendTimestamp:1
 If 1, append a timestamp to the packet in the RX queue. More...
 
   uint8_t   bAppendStatus:1
 If 1, append a status byte to the packet in the RX queue. More...
 
rxConf
 RX configuration. More...
 
uint32_t syncWord
 Sync word to listen for. More...
 
uint8_t maxPktLen
 Packet length for fixed length, maximum packet length for variable length
0: Unlimited or unknown length. More...
 
uint8_t address0
 Address. More...
 
uint8_t address1
 Address (set equal to address0 to accept only one address. If 0xFF, accept 0x00 as well) 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...
 
ratmr_t endTime
 Time used together with endTrigger for ending the operation. More...
 
dataQueue_tpQueue
 Pointer to receive queue. More...
 
uint8_t * pOutput
 Pointer to output structure. More...
 
struct {
   uint8_t   bEnaRssi:1
 If 1, enable RSSI as a criterion. More...
 
   uint8_t   bEnaCorr:1
 If 1, enable correlation as a criterion. More...
 
   uint8_t   operation:1
 0: Busy if either RSSI or correlation indicates Busy
1: Busy if both RSSI and correlation indicates Busy More...
 
   uint8_t   busyOp:1
 0: Continue carrier sense on channel Busy
1: End carrier sense on channel Busy
For an RX command, the receiver will continue when carrier sense ends, but it will then not end if channel goes Idle More...
 
   uint8_t   idleOp:1
 0: Continue on channel Idle
1: End on channel Idle More...
 
   uint8_t   timeoutRes:1
 0: Timeout with channel state Invalid treated as Busy
1: Timeout with channel state Invalid treated as Idle More...
 
csConf
 
int8_t rssiThr
 RSSI threshold. More...
 
uint8_t numRssiIdle
 Number of consecutive RSSI measurements below the threshold needed before the channel is declared Idle. More...
 
uint8_t numRssiBusy
 Number of consecutive RSSI measurements above the threshold needed before the channel is declared Busy. More...
 
uint16_t corrPeriod
 Number of RAT ticks for a correlation observation periods. More...
 
struct {
   uint8_t   numCorrInv:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Idle to Invalid. More...
 
   uint8_t   numCorrBusy:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Invalid to Busy. More...
 
corrConfig
 
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...
 
csEndTrigger
 Trigger classifier for ending the carrier sense. More...
 
ratmr_t csEndTime
 Time used together with csEndTrigger for ending the operation. More...
 

Detailed Description

Proprietary Mode Receive Command with Sniff Mode.

Field Documentation

uint8_t rfc_CMD_PROP_RX_SNIFF_s::__pad0__
uint8_t rfc_CMD_PROP_RX_SNIFF_s::address0

Address.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::address1

Address (set equal to address0 to accept only one address. If 0xFF, accept 0x00 as well)

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bAppendRssi

If 1, append an RSSI byte to the packet in the RX queue.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bAppendStatus

If 1, append a status byte to the packet in the RX queue.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bAppendTimestamp

If 1, append a timestamp to the packet in the RX queue.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bAutoFlushCrcErr

If 1, automatically discard packets with CRC error from RX queue.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bAutoFlushIgnored

If 1, automatically discard ignored packets from RX queue.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bChkAddress

0: No address check
1: Check address

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bEnaCmd

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

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bEnaCorr

If 1, enable correlation as a criterion.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bEnaRssi

If 1, enable RSSI as a criterion.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bFsOff

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

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bIncludeCrc

If 1, include the received CRC field in the stored packet; otherwise discard it.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bIncludeHdr

If 1, include the received header or length byte in the stored packet; otherwise discard it.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bRepeatNok

0: End operation after receiving a packet with CRC error
1: Go back to sync search after receiving a packet with CRC error

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bRepeatOk

0: End operation after receiving a packet correctly
1: Go back to sync search after receiving a packet correctly

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bUseCrc

0: Do not check CRC
1: Check CRC

uint8_t rfc_CMD_PROP_RX_SNIFF_s::busyOp

0: Continue carrier sense on channel Busy
1: End carrier sense on channel Busy
For an RX command, the receiver will continue when carrier sense ends, but it will then not end if channel goes Idle

uint8_t rfc_CMD_PROP_RX_SNIFF_s::bVarLen

0: Fixed length
1: Receive length as first byte

uint16_t rfc_CMD_PROP_RX_SNIFF_s::commandNo

The command ID number 0x3808.

struct { ... } rfc_CMD_PROP_RX_SNIFF_s::condition
struct { ... } rfc_CMD_PROP_RX_SNIFF_s::corrConfig
uint16_t rfc_CMD_PROP_RX_SNIFF_s::corrPeriod

Number of RAT ticks for a correlation observation periods.

struct { ... } rfc_CMD_PROP_RX_SNIFF_s::csConf
ratmr_t rfc_CMD_PROP_RX_SNIFF_s::csEndTime

Time used together with csEndTrigger for ending the operation.

struct { ... } rfc_CMD_PROP_RX_SNIFF_s::csEndTrigger

Trigger classifier for ending the carrier sense.

ratmr_t rfc_CMD_PROP_RX_SNIFF_s::endTime

Time used together with endTrigger for ending the operation.

struct { ... } rfc_CMD_PROP_RX_SNIFF_s::endTrigger

Trigger classifier for ending the operation.

uint8_t rfc_CMD_PROP_RX_SNIFF_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

uint8_t rfc_CMD_PROP_RX_SNIFF_s::filterOp

0: Stop receiver and restart sync search on address mismatch
1: Receive packet and mark it as ignored on address mismatch

uint8_t rfc_CMD_PROP_RX_SNIFF_s::idleOp

0: Continue on channel Idle
1: End on channel Idle

uint8_t rfc_CMD_PROP_RX_SNIFF_s::maxPktLen

Packet length for fixed length, maximum packet length for variable length
0: Unlimited or unknown length.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::nSkip

Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...

uint8_t rfc_CMD_PROP_RX_SNIFF_s::numCorrBusy

Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Invalid to Busy.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::numCorrInv

Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Idle to Invalid.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::numRssiBusy

Number of consecutive RSSI measurements above the threshold needed before the channel is declared Busy.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::numRssiIdle

Number of consecutive RSSI measurements below the threshold needed before the channel is declared Idle.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::operation

0: Busy if either RSSI or correlation indicates Busy
1: Busy if both RSSI and correlation indicates Busy

uint8_t rfc_CMD_PROP_RX_SNIFF_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

struct { ... } rfc_CMD_PROP_RX_SNIFF_s::pktConf
rfc_radioOp_t* rfc_CMD_PROP_RX_SNIFF_s::pNextOp

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

uint8_t* rfc_CMD_PROP_RX_SNIFF_s::pOutput

Pointer to output structure.

dataQueue_t* rfc_CMD_PROP_RX_SNIFF_s::pQueue

Pointer to receive queue.

int8_t rfc_CMD_PROP_RX_SNIFF_s::rssiThr

RSSI threshold.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::rule

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

struct { ... } rfc_CMD_PROP_RX_SNIFF_s::rxConf

RX configuration.

ratmr_t rfc_CMD_PROP_RX_SNIFF_s::startTime

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

struct { ... } rfc_CMD_PROP_RX_SNIFF_s::startTrigger

Identification of the trigger that starts the operation.

uint16_t rfc_CMD_PROP_RX_SNIFF_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.

uint32_t rfc_CMD_PROP_RX_SNIFF_s::syncWord

Sync word to listen for.

uint8_t rfc_CMD_PROP_RX_SNIFF_s::timeoutRes

0: Timeout with channel state Invalid treated as Busy
1: Timeout with channel state Invalid treated as Idle

uint8_t rfc_CMD_PROP_RX_SNIFF_s::triggerNo

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

uint8_t rfc_CMD_PROP_RX_SNIFF_s::triggerType

The type of trigger.