|
|
|
rflib
|
HID Recieve Command with Auto Ack. More...
#include <rf_hid_cmd.h>
Data Fields | |
| uint16_t | commandNo |
| The command ID number 0x5802. 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 hdrMode:1 | |
| 0: 9-bit header 1: 10-bit header More... | |
| uint8_t bIncludeAddr:1 | |
| 0: Include address byte after sync word 1: Do not include address byte after sync word More... | |
| uint8_t hdrConf:2 | |
| 0: Automatically generate header (no header byte in buffer) 1: Insert NO_ACK field from TX buffer 2: Insert SEQ field from TX buffer 3: Insert SEQ and NO_ACK field from TX buffer More... | |
| } | pktConf |
| struct { | |
| uint8_t bAutoFlushIgnored:1 | |
| If 1, automatically remove ignored packets (RX) or empty ACKs (TX) from RX queue. More... | |
| uint8_t bAutoFlushCrcErr:1 | |
| If 1, automatically remove packets with CRC error from Rx queue. More... | |
| uint8_t bIncludeAddr:1 | |
| If 1, the received address byte is included in the Rx queue. More... | |
| uint8_t bIncludeHdr:1 | |
| If 1, the received header is included in the Rx queue. 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 bAppendStatus:1 | |
| If 1, append a status 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... | |
| } | rxConf |
| Receive entry configuration. More... | |
| uint32_t | syncWord0 |
| Sync word to listen for. More... | |
| uint32_t | syncWord1 |
| Alternative sync word if non-zero. More... | |
| uint8_t | numAddr |
| Number of address entries. More... | |
| uint8_t | __dummy0 |
| uint8_t | __dummy1 |
| 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... | |
| rfc_hidAddrEntry_t * | pAddrEntry |
| Pointer to array of address entries. More... | |
| dataQueue_t * | pRxQueue |
| Pointer to receive queue. More... | |
| rfc_hidRxTxOutput_t * | pOutput |
| Pointer to output structure. More... | |
HID Recieve Command with Auto Ack.
| uint16_t rfc_CMD_HID_RX_s::commandNo |
The command ID number 0x5802.
| uint16_t rfc_CMD_HID_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_HID_RX_s::pNextOp |
Pointer to the next operation to run after this operation is done.
| ratmr_t rfc_CMD_HID_RX_s::startTime |
Absolute or relative start time (depending on the value of startTrigger)
| uint8_t rfc_CMD_HID_RX_s::triggerType |
The type of trigger.
| uint8_t rfc_CMD_HID_RX_s::bEnaCmd |
0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger
| uint8_t rfc_CMD_HID_RX_s::triggerNo |
The trigger number of the CMD_TRIGGER command that triggers this action.
| uint8_t rfc_CMD_HID_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_HID_RX_s::startTrigger |
Identification of the trigger that starts the operation.
| uint8_t rfc_CMD_HID_RX_s::rule |
Condition for running next command: Rule for how to proceed.
| uint8_t rfc_CMD_HID_RX_s::nSkip |
Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...
| struct { ... } rfc_CMD_HID_RX_s::condition |
| uint8_t rfc_CMD_HID_RX_s::bFsOff |
0: Keep frequency synth on after command
1: Turn frequency synth off after command
| uint8_t rfc_CMD_HID_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_HID_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_HID_RX_s::hdrMode |
0: 9-bit header
1: 10-bit header
| uint8_t rfc_CMD_HID_RX_s::bIncludeAddr |
0: Include address byte after sync word
1: Do not include address byte after sync word
If 1, the received address byte is included in the Rx queue.
| uint8_t rfc_CMD_HID_RX_s::hdrConf |
0: Automatically generate header (no header byte in buffer) 1: Insert NO_ACK field from TX buffer 2: Insert SEQ field from TX buffer 3: Insert SEQ and NO_ACK field from TX buffer
| struct { ... } rfc_CMD_HID_RX_s::pktConf |
| uint8_t rfc_CMD_HID_RX_s::bAutoFlushIgnored |
If 1, automatically remove ignored packets (RX) or empty ACKs (TX) from RX queue.
| uint8_t rfc_CMD_HID_RX_s::bAutoFlushCrcErr |
If 1, automatically remove packets with CRC error from Rx queue.
| uint8_t rfc_CMD_HID_RX_s::bIncludeHdr |
If 1, the received header is included in the Rx queue.
| uint8_t rfc_CMD_HID_RX_s::bIncludeCrc |
If 1, include the received CRC field in the stored packet; otherwise discard it.
| uint8_t rfc_CMD_HID_RX_s::bAppendRssi |
If 1, append an RSSI byte to the packet in the Rx queue.
| uint8_t rfc_CMD_HID_RX_s::bAppendStatus |
If 1, append a status byte to the packet in the Rx queue.
| uint8_t rfc_CMD_HID_RX_s::bAppendTimestamp |
If 1, append a timestamp to the packet in the Rx queue.
| struct { ... } rfc_CMD_HID_RX_s::rxConf |
Receive entry configuration.
| uint32_t rfc_CMD_HID_RX_s::syncWord0 |
Sync word to listen for.
| uint32_t rfc_CMD_HID_RX_s::syncWord1 |
Alternative sync word if non-zero.
| uint8_t rfc_CMD_HID_RX_s::numAddr |
Number of address entries.
| uint8_t rfc_CMD_HID_RX_s::__dummy0 |
| uint8_t rfc_CMD_HID_RX_s::__dummy1 |
| struct { ... } rfc_CMD_HID_RX_s::endTrigger |
Trigger classifier for ending the operation.
| ratmr_t rfc_CMD_HID_RX_s::endTime |
Time used together with endTrigger for ending the operation.
| rfc_hidAddrEntry_t* rfc_CMD_HID_RX_s::pAddrEntry |
Pointer to array of address entries.
| dataQueue_t* rfc_CMD_HID_RX_s::pRxQueue |
Pointer to receive queue.
| rfc_hidRxTxOutput_t* rfc_CMD_HID_RX_s::pOutput |
Pointer to output structure.