TI BLE5-Stack API Documentation  2.02.00.00
Modules | Files | Macros | Functions
RTLS_CTRL_AOA

This module implements Real Time Localization System (RTLS) AoA post processing module. More...

Modules

 RTLS Control Structures
 

Files

file  rtls_ctrl.h
 RTLS Control module interface.
 

Macros

#define MAX_SAMPLES_SINGLE_CHUNK   32
 Max number of samples reported in a single chunk when using RAW mode.
 
#define REVERSE_SYNC_HANDLE   0x0FFF
 
#define SYNC_HANDLE_MASK   0x1000
 

Functions

rtlsStatus_e RTLSCtrl_clInitAoa (aoaResultMode_e resultMode, uint8_t sampleCtrl, uint8_t numAnt, uint8_t *pAntPattern, uint16_t syncHandle)
 
AoA_clSyncInfo_t * RTLSCtrl_getClRes (uint16_t syncHnadle)
 
void RTLSCtrl_initAntConfig (void)
 
rtlsStatus_e RTLSCtrl_initAoa (uint8_t maxConnections, uint8_t sampleCtrl, uint8_t numAnt, uint8_t *pAntPattern, aoaResultMode_e resultMode)
 
rtlsStatus_e RTLSCtrl_initClResNode (uint16_t syncHandle)
 
void RTLSCtrl_postProcessAoa (rtlsAoaIqEvt_t *pEvt)
 Called at the end of each connection event to extract I/Q samples. More...
 
void RTLSCtrl_removeClAoaNode (uint16_t syncHandle)
 
rtlsStatus_e RTLSCtrl_verifyAntPattern (uint8_t sampleCtrl, uint8_t numAnt, uint8_t *pAntPattern)
 

Detailed Description

This module implements Real Time Localization System (RTLS) AoA post processing module.

Function Documentation

§ RTLSCtrl_clInitAoa()

rtlsStatus_e RTLSCtrl_clInitAoa ( aoaResultMode_e  resultMode,
uint8_t  sampleCtrl,
uint8_t  numAnt,
uint8_t *  pAntPattern,
uint16_t  syncHandle 
)

RTLSCtrl_clInitAoa

Initialize connectionless AoA - has to be called before running AoA

Parameters
resultMode- AOA_MODE_ANGLE/AOA_MODE_PAIR_ANGLES/AOA_MODE_RAW
sampleCtrl- sample control configs: 0x01 = RAW RF, 0x00 = Filtered results (switching period omitted), bit 4,5 0x10 - ONLY_ANT_1, 0x20 - ONLY_ANT_2
numAnt- Number of items in Antenna array
pAntPattern- Pointer to Antenna array
syncHandle- Handle identifying the periodic advertising train
Returns
status - RTLS_AOA_CONFIG_NOT_SUPPORTED/RTLS_SUCCESS

§ RTLSCtrl_getClRes()

AoA_clSyncInfo_t* RTLSCtrl_getClRes ( uint16_t  syncHnadle)

RTLSCtrl_getClRes

Find the CL AoA result node matching the given syncHandle

Parameters
syncHandle- Handle identifying the periodic advertising train
Returns
pointer to AoA_clSyncInfo_t node if found. Else, NULL

§ RTLSCtrl_initAntConfig()

void RTLSCtrl_initAntConfig ( void  )

RTLSCtrl_initAntConfig

Initialize the anternna configuration in the AoA control block

Parameters
None
Returns
None

§ RTLSCtrl_initClResNode()

rtlsStatus_e RTLSCtrl_initClResNode ( uint16_t  syncHandle)

RTLSCtrl_initClResNode

Initialize new node for CL AoA angle mode and pair angle results

Parameters
syncHandle- Handle identifying the periodic advertising train
Returns
RTLS_FAIL, RTLS_OUT_OF_MEMORY, RTLS_SUCCESS

§ RTLSCtrl_postProcessAoa()

void RTLSCtrl_postProcessAoa ( rtlsAoaIqEvt_t *  pEvt)

Called at the end of each connection event to extract I/Q samples.

Parameters
pEvt- Pointer to IQ Event
Returns
none

§ RTLSCtrl_removeClAoaNode()

void RTLSCtrl_removeClAoaNode ( uint16_t  syncHandle)

RTLSCtrl_removeClAoaNode

Removes the node matching the given syncHandle

Parameters
syncHandle- Handle identifying the periodic advertising train
Returns
None

§ RTLSCtrl_verifyAntPattern()

rtlsStatus_e RTLSCtrl_verifyAntPattern ( uint8_t  sampleCtrl,
uint8_t  numAnt,
uint8_t *  pAntPattern 
)

RTLSCtrl_verifyAntPattern

Check that a correct configuration was provided for the antenna pattern

Parameters
sampleCtrl- sample control configs: 0x01 = RAW RF, 0x00 = Filtered results (switching period omitted), bit 4,5 0x10 - ONLY_ANT_1, 0x20 - ONLY_ANT_2
numAnt- Number of items in Antenna array
pAntPattern- Pointer to Antenna array
Returns
status - RTLS_CONFIG_NOT_SUPPORTED/RTLS_SUCCESS
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale