rflib
Data Fields
rfc_bleAdvPar_s Struct Reference

#include <rf_ble_cmd.h>

Collaboration diagram for rfc_bleAdvPar_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   advFilterPolicy:2
 Advertiser filter policy
0: Process scan and connect requests from all devices
1: Process connect requests from all devices and only scan requests from devices that are in the white list
2: Process scan requests from all devices and only connect requests from devices that are in the white list
3: Process scan and connect requests only from devices in the white list. More...
 
   uint8_t   deviceAddrType:1
 The type of the device address – public (0) or random (1) More...
 
   uint8_t   peerAddrType:1
 Directed advertiser: The type of the peer address – public (0) or random (1) More...
 
   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...
 
   uint8_t   chSel:1
 0: Do not report support of Channel Selection Algorithm #2
1: Report support of Channel Selection Algorithm #2 More...
 
   uint8_t   privIgnMode:1
 0: Filter on bPrivIgn only when white list is used 1: Filter on bPrivIgn always More...
 
   uint8_t   rpaMode:1
 Resolvable private address mode
0: Normal operation
1: Use white list for a received RPA regardless of filter policy. More...
 
advConfig
 
uint8_t advLen
 Size of advertiser data. More...
 
uint8_t scanRspLen
 Size of scan response data. More...
 
uint8_t * pAdvData
 Pointer to buffer containing ADV*_IND data. More...
 
uint8_t * pScanRspData
 Pointer to buffer containing SCAN_RSP data. More...
 
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 advConfig.deviceAddrType is inverted. More...
 
rfc_bleWhiteListEntry_tpWhiteList
 Pointer (with least significant bit set to 0) to white list or peer address (directed advertiser). If least significant bit is 1, the address type given by advConfig.peerAddrType is inverted. More...
 
struct {
   uint8_t   scanRspEndType:1
 Command status at end if SCAN_RSP was sent:
0: End with BLE_DONE_OK and result True
1: End with BLE_DONE_SCAN_RSP and result False. More...
 
behConfig
 
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 that causes the device to end the advertiser event as soon as allowed. More...
 
ratmr_t endTime
 Time used together with endTrigger that causes the device to end the advertiser event as soon as allowed. More...
 

Field Documentation

§ pRxQ

dataQueue_t* rfc_bleAdvPar_s::pRxQ

Pointer to receive queue.

§ bAutoFlushIgnored

uint8_t rfc_bleAdvPar_s::bAutoFlushIgnored

If 1, automatically remove ignored packets from Rx queue.

§ bAutoFlushCrcErr

uint8_t rfc_bleAdvPar_s::bAutoFlushCrcErr

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

§ bAutoFlushEmpty

uint8_t rfc_bleAdvPar_s::bAutoFlushEmpty

If 1, automatically remove empty packets from Rx queue.

§ bIncludeLenByte

uint8_t rfc_bleAdvPar_s::bIncludeLenByte

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

§ bIncludeCrc

uint8_t rfc_bleAdvPar_s::bIncludeCrc

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

§ bAppendRssi

uint8_t rfc_bleAdvPar_s::bAppendRssi

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

§ bAppendStatus

uint8_t rfc_bleAdvPar_s::bAppendStatus

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

§ bAppendTimestamp

uint8_t rfc_bleAdvPar_s::bAppendTimestamp

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

§ rxConfig

struct { ... } rfc_bleAdvPar_s::rxConfig

Configuration bits for the receive queue entries.

§ advFilterPolicy

uint8_t rfc_bleAdvPar_s::advFilterPolicy

Advertiser filter policy
0: Process scan and connect requests from all devices
1: Process connect requests from all devices and only scan requests from devices that are in the white list
2: Process scan requests from all devices and only connect requests from devices that are in the white list
3: Process scan and connect requests only from devices in the white list.

§ deviceAddrType

uint8_t rfc_bleAdvPar_s::deviceAddrType

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

§ peerAddrType

uint8_t rfc_bleAdvPar_s::peerAddrType

Directed advertiser: The type of the peer address – public (0) or random (1)

§ bStrictLenFilter

uint8_t rfc_bleAdvPar_s::bStrictLenFilter

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

§ chSel

uint8_t rfc_bleAdvPar_s::chSel

0: Do not report support of Channel Selection Algorithm #2
1: Report support of Channel Selection Algorithm #2

§ privIgnMode

uint8_t rfc_bleAdvPar_s::privIgnMode

0: Filter on bPrivIgn only when white list is used 1: Filter on bPrivIgn always

§ rpaMode

uint8_t rfc_bleAdvPar_s::rpaMode

Resolvable private address mode
0: Normal operation
1: Use white list for a received RPA regardless of filter policy.

§ advConfig

struct { ... } rfc_bleAdvPar_s::advConfig

§ advLen

uint8_t rfc_bleAdvPar_s::advLen

Size of advertiser data.

§ scanRspLen

uint8_t rfc_bleAdvPar_s::scanRspLen

Size of scan response data.

§ pAdvData

uint8_t* rfc_bleAdvPar_s::pAdvData

Pointer to buffer containing ADV*_IND data.

§ pScanRspData

uint8_t* rfc_bleAdvPar_s::pScanRspData

Pointer to buffer containing SCAN_RSP data.

§ pDeviceAddress

uint16_t* rfc_bleAdvPar_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 advConfig.deviceAddrType is inverted.

§ pWhiteList

rfc_bleWhiteListEntry_t* rfc_bleAdvPar_s::pWhiteList

Pointer (with least significant bit set to 0) to white list or peer address (directed advertiser). If least significant bit is 1, the address type given by advConfig.peerAddrType is inverted.

§ scanRspEndType

uint8_t rfc_bleAdvPar_s::scanRspEndType

Command status at end if SCAN_RSP was sent:
0: End with BLE_DONE_OK and result True
1: End with BLE_DONE_SCAN_RSP and result False.

§ behConfig

struct { ... } rfc_bleAdvPar_s::behConfig

§ __dummy0

uint8_t rfc_bleAdvPar_s::__dummy0

§ __dummy1

uint8_t rfc_bleAdvPar_s::__dummy1

§ triggerType

uint8_t rfc_bleAdvPar_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_bleAdvPar_s::bEnaCmd

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

§ triggerNo

uint8_t rfc_bleAdvPar_s::triggerNo

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

§ pastTrig

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

§ endTrigger

struct { ... } rfc_bleAdvPar_s::endTrigger

Trigger that causes the device to end the advertiser event as soon as allowed.

§ endTime

ratmr_t rfc_bleAdvPar_s::endTime

Time used together with endTrigger that causes the device to end the advertiser event as soon as allowed.


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