Proprietary Mode Advanced Receive Command. More...
#include <rf_prop_cmd.h>
Data Fields | |
uint16_t | commandNo |
The command ID number 0x3804. 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... | |
Proprietary Mode Advanced Receive Command.
Definition at line 295 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::__pad0__ |
Definition at line 335 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_s::addrConf |
uint16_t rfc_CMD_PROP_RX_ADV_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 356 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::addrSize |
If addrType
= 0: Address size in bytes
If addrType
= 1: Address size in bits.
Definition at line 354 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::addrType |
0: Address after header
1: Address in header
Definition at line 352 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bAppendRssi |
If 1, append an RSSI byte to the packet in the RX queue.
Definition at line 338 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bAppendStatus |
If 1, append a status byte to the packet in the RX queue.
Definition at line 340 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bAppendTimestamp |
If 1, append a timestamp to the packet in the RX queue.
Definition at line 339 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bAutoFlushCrcErr |
If 1, automatically discard packets with CRC error from RX queue.
Definition at line 334 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bAutoFlushIgnored |
If 1, automatically discard ignored packets from RX queue.
Definition at line 333 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bCrcIncHdr |
0: Do not include header in CRC calculation
1: Include header in CRC calculation
Definition at line 325 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bCrcIncSw |
0: Do not include sync word in CRC calculation
1: Include sync word in CRC calculation
Definition at line 323 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bEnaCmd |
0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger
Definition at line 304 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bFsOff |
0: Keep frequency synth on after command
1: Turn frequency synth off after command
Definition at line 315 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bIncludeCrc |
If 1, include the received CRC field in the stored packet; otherwise discard it.
Definition at line 337 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bIncludeHdr |
If 1, include the received header or length byte in the stored packet; otherwise discard it.
Definition at line 336 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_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 319 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bRepeatOk |
0: End operation after receiving a packet correctly
1: Go back to sync search after receiving a packet correctly
Definition at line 317 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::bUseCrc |
0: Do not check CRC
1: Check CRC
Definition at line 321 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::commandNo |
The command ID number 0x3804.
Definition at line 296 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_s::condition |
ratmr_t rfc_CMD_PROP_RX_ADV_s::endTime |
Time used together with endTrigger
for ending the operation.
Definition at line 369 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_s::endTrigger |
Trigger classifier for ending the operation.
uint8_t rfc_CMD_PROP_RX_ADV_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 327 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_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 329 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_s::hdrConf |
int8_t rfc_CMD_PROP_RX_ADV_s::lenOffset |
Signed value to add to length field.
Definition at line 360 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::lenPos |
Position of length field in header (0–31)
Definition at line 348 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::maxPktLen |
Packet length for fixed length, maximum packet length for variable length
0: Unlimited or unknown length.
Definition at line 344 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::nSkip |
Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...
Definition at line 312 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::numAddr |
Number of addresses in address list.
Definition at line 358 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::numHdrBits |
Number of bits in header (0–32)
Definition at line 347 of file rf_prop_cmd.h.
uint16_t rfc_CMD_PROP_RX_ADV_s::numLenBits |
Number of bits in length field (0–16)
Definition at line 349 of file rf_prop_cmd.h.
uint8_t* rfc_CMD_PROP_RX_ADV_s::pAddr |
Pointer to address list.
Definition at line 370 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_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 307 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_s::pktConf |
rfc_radioOp_t* rfc_CMD_PROP_RX_ADV_s::pNextOp |
Pointer to the next operation to run after this operation is done.
Definition at line 300 of file rf_prop_cmd.h.
uint8_t* rfc_CMD_PROP_RX_ADV_s::pOutput |
Pointer to output structure.
Definition at line 372 of file rf_prop_cmd.h.
dataQueue_t* rfc_CMD_PROP_RX_ADV_s::pQueue |
Pointer to receive queue.
Definition at line 371 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::rule |
Condition for running next command: Rule for how to proceed.
Definition at line 311 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_s::rxConf |
RX configuration.
ratmr_t rfc_CMD_PROP_RX_ADV_s::startTime |
Absolute or relative start time (depending on the value of startTrigger
)
Definition at line 301 of file rf_prop_cmd.h.
struct { ... } rfc_CMD_PROP_RX_ADV_s::startTrigger |
Identification of the trigger that starts the operation.
uint16_t rfc_CMD_PROP_RX_ADV_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 297 of file rf_prop_cmd.h.
uint32_t rfc_CMD_PROP_RX_ADV_s::syncWord0 |
Sync word to listen for.
Definition at line 342 of file rf_prop_cmd.h.
uint32_t rfc_CMD_PROP_RX_ADV_s::syncWord1 |
Alternative sync word if non-zero.
Definition at line 343 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::triggerNo |
The trigger number of the CMD_TRIGGER command that triggers this action.
Definition at line 306 of file rf_prop_cmd.h.
uint8_t rfc_CMD_PROP_RX_ADV_s::triggerType |
The type of trigger.
Definition at line 303 of file rf_prop_cmd.h.