|
|
|
rflib
|
Proprietary Mode Receive Command. More...
#include <rf_prop_cmd.h>
Data Fields | |
| uint16_t | commandNo |
| The command ID number 0x3802. 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 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_t * | pQueue |
| Pointer to receive queue. More... | |
| uint8_t * | pOutput |
| Pointer to output structure. 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... | |
| 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... | |
| 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... | |
| 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... | |
Proprietary Mode Receive Command.
| uint16_t rfc_CMD_PROP_RX_s::commandNo |
The command ID number 0x3802.
| uint16_t rfc_CMD_PROP_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.
| rfc_radioOp_t * rfc_CMD_PROP_RX_s::pNextOp |
Pointer to the next operation to run after this operation is done.
| ratmr_t rfc_CMD_PROP_RX_s::startTime |
Absolute or relative start time (depending on the value of startTrigger)
| uint8_t rfc_CMD_PROP_RX_s::triggerType |
The type of trigger.
| uint8_t rfc_CMD_PROP_RX_s::bEnaCmd |
0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger
| uint8_t rfc_CMD_PROP_RX_s::triggerNo |
The trigger number of the CMD_TRIGGER command that triggers this action.
| uint8_t rfc_CMD_PROP_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
| struct { ... } rfc_CMD_PROP_RX_s::startTrigger |
Identification of the trigger that starts the operation.
| uint8_t rfc_CMD_PROP_RX_s::rule |
Condition for running next command: Rule for how to proceed.
| uint8_t rfc_CMD_PROP_RX_s::nSkip |
Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...
| struct { ... } rfc_CMD_PROP_RX_s::condition |
| uint8_t rfc_CMD_PROP_RX_s::bFsOff |
0: Keep frequency synth on after command
1: Turn frequency synth off after command
| uint8_t rfc_CMD_PROP_RX_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_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_s::bUseCrc |
0: Do not check CRC
1: Check CRC
| uint8_t rfc_CMD_PROP_RX_s::bVarLen |
0: Fixed length
1: Receive length as first byte
| uint8_t rfc_CMD_PROP_RX_s::bChkAddress |
0: No address check
1: Check address
| uint8_t rfc_CMD_PROP_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
| uint8_t rfc_CMD_PROP_RX_s::filterOp |
0: Stop receiver and restart sync search on address mismatch
1: Receive packet and mark it as ignored on address mismatch
| struct { ... } rfc_CMD_PROP_RX_s::pktConf |
| uint8_t rfc_CMD_PROP_RX_s::bAutoFlushIgnored |
If 1, automatically discard ignored packets from RX queue.
| uint8_t rfc_CMD_PROP_RX_s::bAutoFlushCrcErr |
If 1, automatically discard packets with CRC error from RX queue.
| uint8_t rfc_CMD_PROP_RX_s::__pad0__ |
| uint8_t rfc_CMD_PROP_RX_s::bIncludeHdr |
If 1, include the received header or length byte in the stored packet; otherwise discard it.
| uint8_t rfc_CMD_PROP_RX_s::bIncludeCrc |
If 1, include the received CRC field in the stored packet; otherwise discard it.
| uint8_t rfc_CMD_PROP_RX_s::bAppendRssi |
If 1, append an RSSI byte to the packet in the RX queue.
| uint8_t rfc_CMD_PROP_RX_s::bAppendTimestamp |
If 1, append a timestamp to the packet in the RX queue.
| uint8_t rfc_CMD_PROP_RX_s::bAppendStatus |
If 1, append a status byte to the packet in the RX queue.
| struct { ... } rfc_CMD_PROP_RX_s::rxConf |
RX configuration.
| uint32_t rfc_CMD_PROP_RX_s::syncWord |
Sync word to listen for.
| uint8_t rfc_CMD_PROP_RX_s::maxPktLen |
Packet length for fixed length, maximum packet length for variable length
0: Unlimited or unknown length.
| uint8_t rfc_CMD_PROP_RX_s::address0 |
Address.
| uint8_t rfc_CMD_PROP_RX_s::address1 |
Address (set equal to address0 to accept only one address. If 0xFF, accept 0x00 as well)
| struct { ... } rfc_CMD_PROP_RX_s::endTrigger |
Trigger classifier for ending the operation.
| ratmr_t rfc_CMD_PROP_RX_s::endTime |
Time used together with endTrigger for ending the operation.
| dataQueue_t * rfc_CMD_PROP_RX_s::pQueue |
Pointer to receive queue.
| uint8_t * rfc_CMD_PROP_RX_s::pOutput |
Pointer to output structure.
| struct { ... } rfc_CMD_PROP_RX_s::startTrigger |
Identification of the trigger that starts the operation.
| struct { ... } rfc_CMD_PROP_RX_s::condition |
| struct { ... } rfc_CMD_PROP_RX_s::pktConf |
| struct { ... } rfc_CMD_PROP_RX_s::rxConf |
RX configuration.
| struct { ... } rfc_CMD_PROP_RX_s::endTrigger |
Trigger classifier for ending the operation.
| struct { ... } rfc_CMD_PROP_RX_s::startTrigger |
Identification of the trigger that starts the operation.
| struct { ... } rfc_CMD_PROP_RX_s::condition |
| struct { ... } rfc_CMD_PROP_RX_s::pktConf |
| struct { ... } rfc_CMD_PROP_RX_s::rxConf |
RX configuration.
| struct { ... } rfc_CMD_PROP_RX_s::endTrigger |
Trigger classifier for ending the operation.