TI BLE5-Stack API Documentation  2.02.00.00
Data Structures | Macros | Typedefs | Functions | Variables
rtls_srv_api.h File Reference

Detailed Description

RTLS Services.

Go to the source code of this file.

Data Structures

struct  rtlsSrv_antennaInfo_t
 LE CTE Antenna Information Event RTLSSRV_ANTENNA_INFORMATION_EVT. More...
 
struct  rtlsSrv_ClAoAEnableEvt_t
 CL AoA Enable command complete event. More...
 
struct  rtlsSrv_ClCmdCompleteEvt_t
 CL AoA command complete event. More...
 
struct  rtlsSrv_clIQReport_t
 CTE Connectionless IQ Report Event RTLSSRV_CL_CTE_IQ_REPORT_EVT. More...
 
struct  rtlsSrv_connectionIQReport_t
 CTE Connection IQ Report Event RTLSSRV_CONNECTION_CTE_IQ_REPORT_EVT. More...
 
struct  rtlsSrv_cteReqFailed_t
 LE CTE Request Failed Event RTLSSRV_CTE_REQUEST_FAILED_EVT. More...
 
struct  rtlsSrv_errorEvt_t
 RTLS Services error structure RTLSSRV_ERROR_EVT. More...
 
struct  rtlsSrv_evt_t
 RTLS Services passes messages in this format. More...
 
struct  rtlsSrv_PeriodicAdvRpt_t
 Periodic adverting report event. More...
 
struct  rtlsSrv_SyncEstEvt_t
 Periodic advertising sync establish event structure. More...
 
struct  rtlsSrv_SyncLostEvt_t
 Periodic advertising sync lost event. More...
 

Macros

#define RTLSSRV_ANTENNA_INFORMATION_EVT   2
 
#define RTLSSRV_BAD_PARAMETER   0x12
 Invalid parameter.
 
#define RTLSSRV_CL_AOA_ENABLE_EVT   12
 
#define RTLSSRV_CL_CTE_ANTENNA_LIST_MAX_LENGTH   LL_CTE_ANTENNA_LIST_MAX_LENGTH
 CTE antenna maximum switch length.
 
#define RTLSSRV_CL_CTE_ANTENNA_LIST_MIN_LENGTH   LL_CTE_ANTENNA_LIST_MIN_LENGTH
 CTE antenna minimum switch length.
 
#define RTLSSRV_CL_CTE_EVT   5
 
#define RTLSSRV_CL_CTE_IQ_REPORT_EVT   10
 
#define RTLSSRV_CL_CTE_MAX_COUNT   LL_CTE_COUNT_MAX
 CTE count - maximum value.
 
#define RTLSSRV_CL_CTE_MAX_LEN   LL_CTE_MAX_LEN
 CTE maximum length.
 
#define RTLSSRV_CL_CTE_MIN_COUNT   LL_CTE_COUNT_MIN
 CTE count - minimum value.
 
#define RTLSSRV_CL_CTE_MIN_LEN   LL_CTE_MIN_LEN
 CTE minimun length.
 
#define RTLSSRV_COMMAND_DISALLOWED   0x0C
 Disallowed Command.
 
#define RTLSSRV_CONN_HANDLE_INVALID   0x02
 Invalid Handle.
 
#define RTLSSRV_CONNECTION_CTE_IQ_REPORT_EVT   1
 
#define RTLSSRV_CTE_REQUEST_FAILED_EVT   3
 
#define RTLSSRV_CTE_SAMPLE_CONTROL_RF_DEFAULT_FILTERING   CTE_SAMPLING_CONTROL_DEFAULT_FILTERING
 CTE Sample Control.
 
#define RTLSSRV_CTE_SAMPLE_CONTROL_RF_RAW_NO_FILTERING   CTE_SAMPLING_CONTROL_RF_RAW_NO_FILTERING
 
#define RTLSSRV_CTE_SAMPLE_RATE_1MHZ   CTE_SAMPLING_CONFIG_1MHZ
 CTE Sample Rates. More...
 
#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOA_RX   LL_CTE_SAMPLE_RATE_1US_AOA_RX
 Angle of Arrival RX.
 
#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOD_RX   LL_CTE_SAMPLE_RATE_1US_AOD_RX
 Angle of Departure RX.
 
#define RTLSSRV_CTE_SAMPLE_RATE_1US_AOD_TX   LL_CTE_SAMPLE_RATE_1US_AOD_TX
 CTE supported modes, only AoA at this point. More...
 
#define RTLSSRV_CTE_SAMPLE_RATE_2MHZ   CTE_SAMPLING_CONFIG_2MHZ
 2 MHz
 
#define RTLSSRV_CTE_SAMPLE_RATE_3MHZ   CTE_SAMPLING_CONFIG_3MHZ
 3 MHz
 
#define RTLSSRV_CTE_SAMPLE_RATE_4MHZ   CTE_SAMPLING_CONFIG_4MHZ
 4 MHz
 
#define RTLSSRV_CTE_SAMPLE_SIZE_16BITS   LL_CTE_SAMPLE_SIZE_16BITS
 16 bit
 
#define RTLSSRV_CTE_SAMPLE_SIZE_8BITS   LL_CTE_SAMPLE_SIZE_8BITS
 CTE Sample Size. More...
 
#define RTLSSRV_CTE_SAMPLE_SLOT_1US   LL_CTE_SAMPLE_SLOT_1US
 CTE sample slot type. More...
 
#define RTLSSRV_CTE_SAMPLE_SLOT_2US   LL_CTE_SAMPLE_SLOT_2US
 2 μsec
 
#define RTLSSRV_CTE_SAMPLING_DISABLE   LL_CTE_SAMPLING_DISABLE
 Disabled.
 
#define RTLSSRV_CTE_SAMPLING_ENABLE   LL_CTE_SAMPLING_ENABLE
 Enabled.
 
#define RTLSSRV_CTE_SAMPLING_NOT_INIT   LL_CTE_SAMPLING_NOT_INIT
 CTE Sampling state. More...
 
#define RTLSSRV_CTE_TYPE_AOA   LL_CTE_TYPE_AOA
 CTE types. More...
 
#define RTLSSRV_ERROR_DUE_TO_LIMITED_RESOURCES   0x0D
 Limited Resources.
 
#define RTLSSRV_ERROR_EVT   4
 
#define RTLSSRV_FEATURE_NOT_SUPPORTED   0x11
 Unsupported Feature.
 
#define RTLSSRV_OUT_OF_MEMORY   0x07
 Out of Memory.
 
#define RTLSSRV_PERIODIC_ADV_RPT   9
 
#define RTLSSRV_PERIODIC_ADV_TERMINATE_SYNC   11
 
#define RTLSSRV_READ_PERIODIC_LIST_SIZE_EVT   6
 
#define RTLSSRV_REMOTE_FEATURE_NOT_SUPPORTED   0x1A
 Unsupported Remote Feature.
 
#define RTLSSRV_REVERSE_SYNC_HANDLE   0x0FFF
 Reverse sync handle mask.
 
#define RTLSSRV_SET_CL_CTE_TRANSMIT_ENABLE   0x2052
 CL CTE transmit Enable cmd complete event.
 
#define RTLSSRV_SET_CL_CTE_TRANSMIT_PARAMS   0x2051
 CL CTE transmit params cmd complete event.
 
#define RTLSSRV_SET_CL_IQ_SAMPLING_ENABLE   0x2053
 CL CTE iq sampling enable.
 
#define RTLSSRV_SET_CONNECTION_CTE_RECEIVE_PARAMS   0x2054
 Receive Parameters.
 
#define RTLSSRV_SET_CONNECTION_CTE_REQUEST_ENABLE   0x2056
 Enable Request.
 
#define RTLSSRV_SET_CONNECTION_CTE_RESPONSE_ENABLE   0x2057
 Enable Response.
 
#define RTLSSRV_SET_CONNECTION_CTE_TRANSMIT_PARAMS   0x2055
 Transmit Parameters.
 
#define RTLSSRV_SYNC_EST_EVT   7
 
#define RTLSSRV_SYNC_HANDLE_MASK   0x1000
 Sync handle mask.
 
#define RTLSSRV_SYNC_LOST_EVT   8
 
#define RTLSSRV_UNKNOWN_ADVERTISING_IDENTIFIER   0x42
 Unknown Advertising Identifier.
 

Typedefs

typedef void(* pfnAppEventHandlerCB_t) (rtlsSrv_evt_t *pEvt)
 

Functions

bStatus_t RTLSSrv_CLCteTransmitEnable (uint8 advHandle, uint8 enable)
 
bStatus_t RTLSSrv_init (uint8_t numOfRTLSConns)
 
PIN_Handle RTLSSrv_initAntArray (uint8_t mainAntenna)
 
bStatus_t RTLSSrv_processHciEvent (uint16_t hciEvt, uint16_t hciEvtSz, uint8_t *pEvtData)
 
bStatus_t RTLSSrv_readAntennaInformationCmd (void)
 
bStatus_t RTLSSrv_register (pfnAppEventHandlerCB_t pCB)
 
bStatus_t RTLSSrv_setCLCteSamplingEnableCmd (uint16_t syncHandle, uint8_t enable, uint8_t slotDuration, uint8_t maxSampleCte, uint8_t numAnt, uint8_t pAntPattern[])
 
bStatus_t RTLSSrv_SetCLCteTransmitParams (uint8 advHandle, uint8 cteLength, uint8 cteType, uint8 cteCount, uint8 switchLen, uint8 *pAntenna)
 
bStatus_t RTLSSrv_setConnCteReceiveParams (uint16_t connHandle, uint8_t samplingEnable, uint8_t slotDurations, uint8_t numAnt, uint8_t antArray[])
 
bStatus_t RTLSSrv_setConnCteRequestEnableCmd (uint16_t connHandle, uint8_t enable, uint16_t interval, uint8_t length, uint8_t type)
 
bStatus_t RTLSSrv_setConnCteResponseEnableCmd (uint16_t connHandle, uint8_t enable)
 
bStatus_t RTLSSrv_setConnCteTransmitParams (uint16_t connHandle, uint8_t types, uint8_t length, uint8_t antArray[])
 
bStatus_t RTLSSrv_setCteSampleAccuracy (uint16_t handle, uint8_t sampleRate1M, uint8_t sampleSize1M, uint8_t sampleRate2M, uint8_t sampleSize2M, uint8_t sampleCtrl)
 

Variables

uint8_t maxNumClCteBufs
 Maximum number of buffers for CL AoA.
 
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale