Proprietary Mode Advanced Receive Command with Sniff Mode. More...
#include <rf_prop_cmd.h>
Data Fields | |
uint16_t | commandNo |
Proprietary Mode Advanced Receive Command The command ID number 0x3809. 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_t * | pNextOp |
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 bCrcIncSw:1 | |
0: Do not include sync word in CRC calculation 1: Include sync word in CRC calculation More... | |
uint8_t bCrcIncHdr:1 | |
0: Do not include header in CRC calculation 1: Include header in CRC calculation 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 | syncWord0 |
Sync word to listen for. More... | |
uint32_t | syncWord1 |
Alternative sync word if non-zero. More... | |
uint16_t | maxPktLen |
Packet length for fixed length, maximum packet length for variable length 0: Unlimited or unknown length. More... | |
struct { | |
uint16_t numHdrBits:6 | |
Number of bits in header (0–32) More... | |
uint16_t lenPos:5 | |
Position of length field in header (0–31) More... | |
uint16_t numLenBits:5 | |
Number of bits in length field (0–16) More... | |
} | hdrConf |
struct { | |
uint16_t addrType:1 | |
0: Address after header 1: Address in header More... | |
uint16_t addrSize:5 | |
If addrType = 0: Address size in bytesIf addrType = 1: Address size in bits. More... | |
uint16_t addrPos:5 | |
If addrType = 1: Bit position of address in headerIf addrType = 0: Non-zero to extend address with sync word identifier. More... | |
uint16_t numAddr:5 | |
Number of addresses in address list. More... | |
} | addrConf |
int8_t | lenOffset |
Signed value to add to length field. 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... | |
uint8_t * | pAddr |
Pointer to address list. More... | |
dataQueue_t * | pQueue |
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... | |
Proprietary Mode Advanced Receive Command with Sniff Mode.
Definition at line 743 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::__pad0__ |
Definition at line 784 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::addrConf |
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::addrPos |
If addrType
= 1: Bit position of address in header
If addrType
= 0: Non-zero to extend address with sync word identifier.
Definition at line 805 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::addrSize |
If addrType
= 0: Address size in bytes
If addrType
= 1: Address size in bits.
Definition at line 803 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::addrType |
0: Address after header
1: Address in header
Definition at line 801 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bAppendRssi |
If 1, append an RSSI byte to the packet in the RX queue.
Definition at line 787 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bAppendStatus |
If 1, append a status byte to the packet in the RX queue.
Definition at line 789 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bAppendTimestamp |
If 1, append a timestamp to the packet in the RX queue.
Definition at line 788 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bAutoFlushCrcErr |
If 1, automatically discard packets with CRC error from RX queue.
Definition at line 783 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bAutoFlushIgnored |
If 1, automatically discard ignored packets from RX queue.
Definition at line 782 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bCrcIncHdr |
0: Do not include header in CRC calculation
1: Include header in CRC calculation
Definition at line 774 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bCrcIncSw |
0: Do not include sync word in CRC calculation
1: Include sync word in CRC calculation
Definition at line 772 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bEnaCmd |
0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger
Definition at line 753 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bEnaCorr |
If 1, enable correlation as a criterion.
Definition at line 824 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bEnaRssi |
If 1, enable RSSI as a criterion.
Definition at line 823 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bFsOff |
0: Keep frequency synth on after command
1: Turn frequency synth off after command
Definition at line 764 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bIncludeCrc |
If 1, include the received CRC field in the stored packet; otherwise discard it.
Definition at line 786 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bIncludeHdr |
If 1, include the received header or length byte in the stored packet; otherwise discard it.
Definition at line 785 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_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
Definition at line 768 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bRepeatOk |
0: End operation after receiving a packet correctly
1: Go back to sync search after receiving a packet correctly
Definition at line 766 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::bUseCrc |
0: Do not check CRC
1: Check CRC
Definition at line 770 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_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
Definition at line 827 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::commandNo |
Proprietary Mode Advanced Receive Command The command ID number 0x3809.
Definition at line 744 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::condition |
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::corrConfig |
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::corrPeriod |
Number of RAT ticks for a correlation observation periods.
Definition at line 840 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::csConf |
ratmr_t rfc_CMD_PROP_RX_ADV_SNIFF_s::csEndTime |
Time used together with csEndTrigger
for ending the operation.
Definition at line 855 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::csEndTrigger |
Trigger classifier for ending the carrier sense.
ratmr_t rfc_CMD_PROP_RX_ADV_SNIFF_s::endTime |
Time used together with endTrigger
for ending the operation.
Definition at line 818 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::endTrigger |
Trigger classifier for ending the operation.
uint8_t rfc_CMD_PROP_RX_ADV_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
Definition at line 776 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::filterOp |
0: Stop receiver and restart sync search on address mismatch
1: Receive packet and mark it as ignored on address mismatch
Definition at line 778 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::hdrConf |
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::idleOp |
0: Continue on channel Idle
1: End on channel Idle
Definition at line 830 of file rf_prop_cmd.h.
int8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::lenOffset |
Signed value to add to length field.
Definition at line 809 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::lenPos |
Position of length field in header (0–31)
Definition at line 797 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::maxPktLen |
Packet length for fixed length, maximum packet length for variable length
0: Unlimited or unknown length.
Definition at line 793 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::nSkip |
Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...
Definition at line 761 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::numAddr |
Number of addresses in address list.
Definition at line 807 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::numCorrBusy |
Number of subsequent correlation tops with maximum corrPeriod
RAT ticks between them needed to go from Invalid to Busy.
Definition at line 844 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::numCorrInv |
Number of subsequent correlation tops with maximum corrPeriod
RAT ticks between them needed to go from Idle to Invalid.
Definition at line 842 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::numHdrBits |
Number of bits in header (0–32)
Definition at line 796 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_SNIFF_s::numLenBits |
Number of bits in length field (0–16)
Definition at line 798 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::numRssiBusy |
Number of consecutive RSSI measurements above the threshold needed before the channel is declared Busy.
Definition at line 838 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::numRssiIdle |
Number of consecutive RSSI measurements below the threshold needed before the channel is declared Idle.
Definition at line 836 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::operation |
0: Busy if either RSSI or correlation indicates Busy
1: Busy if both RSSI and correlation indicates Busy
Definition at line 825 of file rf_prop_cmd.h.
uint8_t* rfc_CMD_PROP_RX_ADV_SNIFF_s::pAddr |
Pointer to address list.
Definition at line 819 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_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
Definition at line 756 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::pktConf |
rfc_radioOp_t* rfc_CMD_PROP_RX_ADV_SNIFF_s::pNextOp |
Pointer to the next operation to run after this operation is done.
Definition at line 749 of file rf_prop_cmd.h.
uint8_t* rfc_CMD_PROP_RX_ADV_SNIFF_s::pOutput |
Pointer to output structure.
Definition at line 821 of file rf_prop_cmd.h.
dataQueue_t* rfc_CMD_PROP_RX_ADV_SNIFF_s::pQueue |
Pointer to receive queue.
Definition at line 820 of file rf_prop_cmd.h.
int8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::rssiThr |
RSSI threshold.
Definition at line 835 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::rule |
Condition for running next command: Rule for how to proceed.
Definition at line 760 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::rxConf |
RX configuration.
ratmr_t rfc_CMD_PROP_RX_ADV_SNIFF_s::startTime |
Absolute or relative start time (depending on the value of startTrigger
)
Definition at line 750 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_SNIFF_s::startTrigger |
Identification of the trigger that starts the operation.
uint16_t rfc_CMD_PROP_RX_ADV_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.
Definition at line 746 of file rf_prop_cmd.h.
uint32_t rfc_CMD_PROP_RX_ADV_SNIFF_s::syncWord0 |
Sync word to listen for.
Definition at line 791 of file rf_prop_cmd.h.
uint32_t rfc_CMD_PROP_RX_ADV_SNIFF_s::syncWord1 |
Alternative sync word if non-zero.
Definition at line 792 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::timeoutRes |
0: Timeout with channel state Invalid treated as Busy
1: Timeout with channel state Invalid treated as Idle
Definition at line 832 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::triggerNo |
The trigger number of the CMD_TRIGGER command that triggers this action.
Definition at line 755 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_SNIFF_s::triggerType |
The type of trigger.
Definition at line 752 of file rf_prop_cmd.h.