|
|
|
rflib
|
HID Transmit Command with Auto Retransmission. More...
#include <rf_hid_cmd.h>
Data Fields | |
| uint16_t | commandNo |
| The command ID number 0x5801. 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 bAutoRetransmit:1 | |
| 0: Do not listen for ACK 1: Listen for ACK and retransmit if missing More... | |
| uint8_t bVarLen:1 | |
| 0: Fixed length mode 1: Variable length mode More... | |
| uint8_t hdrMode:1 | |
| 0: 9-bit header 1: 10-bit header More... | |
| uint8_t bIncludeAddr:1 | |
| 0: Do not include address byte after sync word 1: 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... | |
| uint8_t bFixedTxLen:1 | |
| 0: Use actual length in header when sending packet 1: Use fixed word in length field of header when sending packet (only for peer without variable length packets) 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 | syncWord |
| Sync word to send. More... | |
| uint8_t | address |
| Address byte. More... | |
| uint8_t | seqNo |
| Sequence number to use for next packet. More... | |
| uint8_t | maxAckLen |
| Maximum length of ACKs. More... | |
| uint8_t | pktLen |
| Length of transmitted packet. More... | |
| uint8_t | maxRetrans |
| Maximum number of retransmissions. More... | |
| struct { | |
| uint8_t noAckVal:2 | |
| 0: Set automatic NO_ACK value to inverse of bAutoRetransmit 1: Set automatic NO_ACK value to bAutoRetransmit 2: Set automatic NO_ACK value to 0 3: Set automatic NO_ACK value to 1 More... | |
| uint8_t bAlwaysAutoRetransmit:1 | |
| 0: Disable auto retransmit if transmitted NO_ACK was 1 1: Never disable auto retransmit More... | |
| } | noAckMode |
| uint16_t | retransDelay |
| Number of RAT ticks from start of transmission of a packet to retransmission. More... | |
| uint8_t * | pPkt |
| Pointer to transmit queue for packets. More... | |
| dataQueue_t * | pRxQueue |
| Pointer to receive queue for ACKs. More... | |
| rfc_hidRxTxOutput_t * | pOutput |
| Pointer to output structure. More... | |
HID Transmit Command with Auto Retransmission.
| uint16_t rfc_CMD_HID_TX_s::commandNo |
The command ID number 0x5801.
| uint16_t rfc_CMD_HID_TX_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_TX_s::pNextOp |
Pointer to the next operation to run after this operation is done.
| ratmr_t rfc_CMD_HID_TX_s::startTime |
Absolute or relative start time (depending on the value of startTrigger)
| uint8_t rfc_CMD_HID_TX_s::triggerType |
The type of trigger.
| uint8_t rfc_CMD_HID_TX_s::bEnaCmd |
0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger
| uint8_t rfc_CMD_HID_TX_s::triggerNo |
The trigger number of the CMD_TRIGGER command that triggers this action.
| uint8_t rfc_CMD_HID_TX_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_TX_s::startTrigger |
Identification of the trigger that starts the operation.
| uint8_t rfc_CMD_HID_TX_s::rule |
Condition for running next command: Rule for how to proceed.
| uint8_t rfc_CMD_HID_TX_s::nSkip |
Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...
| struct { ... } rfc_CMD_HID_TX_s::condition |
| uint8_t rfc_CMD_HID_TX_s::bFsOff |
0: Keep frequency synth on after command
1: Turn frequency synth off after command
| uint8_t rfc_CMD_HID_TX_s::bAutoRetransmit |
0: Do not listen for ACK
1: Listen for ACK and retransmit if missing
| uint8_t rfc_CMD_HID_TX_s::bVarLen |
0: Fixed length mode
1: Variable length mode
| uint8_t rfc_CMD_HID_TX_s::hdrMode |
0: 9-bit header
1: 10-bit header
| uint8_t rfc_CMD_HID_TX_s::bIncludeAddr |
0: Do not include address byte after sync word
1: Include address byte after sync word
If 1, the received address byte is included in the Rx queue.
| uint8_t rfc_CMD_HID_TX_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
| uint8_t rfc_CMD_HID_TX_s::bFixedTxLen |
0: Use actual length in header when sending packet
1: Use fixed word in length field of header when sending packet (only for peer without variable length packets)
| struct { ... } rfc_CMD_HID_TX_s::pktConf |
| uint8_t rfc_CMD_HID_TX_s::bAutoFlushIgnored |
If 1, automatically remove ignored packets (RX) or empty ACKs (TX) from RX queue.
| uint8_t rfc_CMD_HID_TX_s::bAutoFlushCrcErr |
If 1, automatically remove packets with CRC error from Rx queue.
| uint8_t rfc_CMD_HID_TX_s::bIncludeHdr |
If 1, the received header is included in the Rx queue.
| uint8_t rfc_CMD_HID_TX_s::bIncludeCrc |
If 1, include the received CRC field in the stored packet; otherwise discard it.
| uint8_t rfc_CMD_HID_TX_s::bAppendRssi |
If 1, append an RSSI byte to the packet in the Rx queue.
| uint8_t rfc_CMD_HID_TX_s::bAppendStatus |
If 1, append a status byte to the packet in the Rx queue.
| uint8_t rfc_CMD_HID_TX_s::bAppendTimestamp |
If 1, append a timestamp to the packet in the Rx queue.
| struct { ... } rfc_CMD_HID_TX_s::rxConf |
Receive entry configuration.
| uint32_t rfc_CMD_HID_TX_s::syncWord |
Sync word to send.
| uint8_t rfc_CMD_HID_TX_s::address |
Address byte.
| uint8_t rfc_CMD_HID_TX_s::seqNo |
Sequence number to use for next packet.
| uint8_t rfc_CMD_HID_TX_s::maxAckLen |
Maximum length of ACKs.
| uint8_t rfc_CMD_HID_TX_s::pktLen |
Length of transmitted packet.
| uint8_t rfc_CMD_HID_TX_s::maxRetrans |
Maximum number of retransmissions.
| uint8_t rfc_CMD_HID_TX_s::noAckVal |
0: Set automatic NO_ACK value to inverse of bAutoRetransmit
1: Set automatic NO_ACK value to bAutoRetransmit
2: Set automatic NO_ACK value to 0
3: Set automatic NO_ACK value to 1
| uint8_t rfc_CMD_HID_TX_s::bAlwaysAutoRetransmit |
0: Disable auto retransmit if transmitted NO_ACK was 1
1: Never disable auto retransmit
| struct { ... } rfc_CMD_HID_TX_s::noAckMode |
| uint16_t rfc_CMD_HID_TX_s::retransDelay |
Number of RAT ticks from start of transmission of a packet to retransmission.
| uint8_t* rfc_CMD_HID_TX_s::pPkt |
Pointer to transmit queue for packets.
| dataQueue_t* rfc_CMD_HID_TX_s::pRxQueue |
Pointer to receive queue for ACKs.
| rfc_hidRxTxOutput_t* rfc_CMD_HID_TX_s::pOutput |
Pointer to output structure.