rflib
Data Fields
rfc_ble5ScannerPerPar_s Struct Reference

#include <rf_ble_cmd.h>

Collaboration diagram for rfc_ble5ScannerPerPar_s:
Collaboration graph
[legend]

Data Fields

dataQueue_tpRxQ
 Pointer to receive queue. More...
 
struct {
   uint8_t   bAutoFlushIgnored:1
 If 1, automatically remove ignored packets from Rx queue. More...
 
   uint8_t   bAutoFlushCrcErr:1
 If 1, automatically remove packets with CRC error from Rx queue. More...
 
   uint8_t   bAutoFlushEmpty:1
 If 1, automatically remove empty packets from Rx queue. More...
 
   uint8_t   bIncludeLenByte:1
 If 1, include the received 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   bAppendStatus:1
 If 1, append a status word 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...
 
rxConfig
 Configuration bits for the receive queue entries. More...
 
struct {
   uint8_t   __pad0__:2
 
   uint8_t   deviceAddrType:1
 The type of the device address – public (0) or random (1) More...
 
   uint8_t   __pad1__:1
 
   uint8_t   bStrictLenFilter:1
 0: Accept any packet with a valid advertising packet length
1: Discard messages with illegal length for the given packet type More...
 
scanConfig
 
uint16_t __dummy0
 
uint32_t __dummy1
 
uint32_t __dummy2
 
uint16_t * pDeviceAddress
 Pointer (with least significant bit set to 0) to device address used for this device. If least significant bit is 1, the address type given by scanConfig.deviceAddrType is inverted. More...
 
uint32_t accessAddress
 Access address used on the periodic advertisement. More...
 
uint8_t crcInit0
 CRC initialization value used on the periodic advertisement – least significant byte. More...
 
uint8_t crcInit1
 CRC initialization value used on the periodic advertisement – middle byte. More...
 
uint8_t crcInit2
 CRC initialization value used on the periodic advertisement – most significant byte. More...
 
uint8_t __dummy3
 
uint16_t maxWaitTimeForAuxCh
 Maximum wait time for switching to secondary scanning withing the command. If the time to the start of the event is greater than this, the command will end with BLE_DONE_AUX. If it is smaller, the radio will automatically switch to the correct channel and PHY. 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...
 
timeoutTrigger
 Trigger that causes the device to stop receiving as soon as allowed. 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 that causes the device to stop receiving as soon as allowed. More...
 
ratmr_t timeoutTime
 Time used together with timeoutTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_RXTIMEOUT. More...
 
ratmr_t endTime
 Time used together with endTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_ENDED. More...
 
ratmr_t rxStartTime
 The time needed to start RX in order to receive the packet. More...
 
uint16_t rxListenTime
 The time needed to listen in order to receive the packet. 0: No AUX packet. More...
 
uint8_t channelNo
 The channel index used for secondary advertising. More...
 
uint8_t phyMode
 PHY to use on secondary channel:
0: 1 Mbps
1: 2 Mbps
2: Coded
Others: Reserved More...
 

Field Documentation

§ pRxQ

dataQueue_t* rfc_ble5ScannerPerPar_s::pRxQ

Pointer to receive queue.

§ bAutoFlushIgnored

uint8_t rfc_ble5ScannerPerPar_s::bAutoFlushIgnored

If 1, automatically remove ignored packets from Rx queue.

§ bAutoFlushCrcErr

uint8_t rfc_ble5ScannerPerPar_s::bAutoFlushCrcErr

If 1, automatically remove packets with CRC error from Rx queue.

§ bAutoFlushEmpty

uint8_t rfc_ble5ScannerPerPar_s::bAutoFlushEmpty

If 1, automatically remove empty packets from Rx queue.

§ bIncludeLenByte

uint8_t rfc_ble5ScannerPerPar_s::bIncludeLenByte

If 1, include the received length byte in the stored packet; otherwise discard it.

§ bIncludeCrc

uint8_t rfc_ble5ScannerPerPar_s::bIncludeCrc

If 1, include the received CRC field in the stored packet; otherwise discard it.

§ bAppendRssi

uint8_t rfc_ble5ScannerPerPar_s::bAppendRssi

If 1, append an RSSI byte to the packet in the Rx queue.

§ bAppendStatus

uint8_t rfc_ble5ScannerPerPar_s::bAppendStatus

If 1, append a status word to the packet in the Rx queue.

§ bAppendTimestamp

uint8_t rfc_ble5ScannerPerPar_s::bAppendTimestamp

If 1, append a timestamp to the packet in the Rx queue.

§ rxConfig

struct { ... } rfc_ble5ScannerPerPar_s::rxConfig

Configuration bits for the receive queue entries.

§ __pad0__

uint8_t rfc_ble5ScannerPerPar_s::__pad0__

§ deviceAddrType

uint8_t rfc_ble5ScannerPerPar_s::deviceAddrType

The type of the device address – public (0) or random (1)

§ __pad1__

uint8_t rfc_ble5ScannerPerPar_s::__pad1__

§ bStrictLenFilter

uint8_t rfc_ble5ScannerPerPar_s::bStrictLenFilter

0: Accept any packet with a valid advertising packet length
1: Discard messages with illegal length for the given packet type

§ scanConfig

struct { ... } rfc_ble5ScannerPerPar_s::scanConfig

§ __dummy0

uint16_t rfc_ble5ScannerPerPar_s::__dummy0

§ __dummy1

uint32_t rfc_ble5ScannerPerPar_s::__dummy1

§ __dummy2

uint32_t rfc_ble5ScannerPerPar_s::__dummy2

§ pDeviceAddress

uint16_t* rfc_ble5ScannerPerPar_s::pDeviceAddress

Pointer (with least significant bit set to 0) to device address used for this device. If least significant bit is 1, the address type given by scanConfig.deviceAddrType is inverted.

§ accessAddress

uint32_t rfc_ble5ScannerPerPar_s::accessAddress

Access address used on the periodic advertisement.

§ crcInit0

uint8_t rfc_ble5ScannerPerPar_s::crcInit0

CRC initialization value used on the periodic advertisement – least significant byte.

§ crcInit1

uint8_t rfc_ble5ScannerPerPar_s::crcInit1

CRC initialization value used on the periodic advertisement – middle byte.

§ crcInit2

uint8_t rfc_ble5ScannerPerPar_s::crcInit2

CRC initialization value used on the periodic advertisement – most significant byte.

§ __dummy3

uint8_t rfc_ble5ScannerPerPar_s::__dummy3

§ maxWaitTimeForAuxCh

uint16_t rfc_ble5ScannerPerPar_s::maxWaitTimeForAuxCh

Maximum wait time for switching to secondary scanning withing the command. If the time to the start of the event is greater than this, the command will end with BLE_DONE_AUX. If it is smaller, the radio will automatically switch to the correct channel and PHY.

§ triggerType

uint8_t rfc_ble5ScannerPerPar_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_ble5ScannerPerPar_s::bEnaCmd

0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger

§ triggerNo

uint8_t rfc_ble5ScannerPerPar_s::triggerNo

The trigger number of the CMD_TRIGGER command that triggers this action.

§ pastTrig

uint8_t rfc_ble5ScannerPerPar_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

§ timeoutTrigger

struct { ... } rfc_ble5ScannerPerPar_s::timeoutTrigger

Trigger that causes the device to stop receiving as soon as allowed.

§ endTrigger

struct { ... } rfc_ble5ScannerPerPar_s::endTrigger

Trigger that causes the device to stop receiving as soon as allowed.

§ timeoutTime

ratmr_t rfc_ble5ScannerPerPar_s::timeoutTime

Time used together with timeoutTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_RXTIMEOUT.

§ endTime

ratmr_t rfc_ble5ScannerPerPar_s::endTime

Time used together with endTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_ENDED.

§ rxStartTime

ratmr_t rfc_ble5ScannerPerPar_s::rxStartTime

The time needed to start RX in order to receive the packet.

§ rxListenTime

uint16_t rfc_ble5ScannerPerPar_s::rxListenTime

The time needed to listen in order to receive the packet. 0: No AUX packet.

§ channelNo

uint8_t rfc_ble5ScannerPerPar_s::channelNo

The channel index used for secondary advertising.

§ phyMode

uint8_t rfc_ble5ScannerPerPar_s::phyMode

PHY to use on secondary channel:
0: 1 Mbps
1: 2 Mbps
2: Coded
Others: Reserved


The documentation for this struct was generated from the following file:
© Copyright 1995-2022, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale