TI BLE5-Stack API Documentation  2.02.04.00
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
rtls_ctrl_api.h File Reference

Detailed Description

This file contains the RTLS Control API's.

Go to the source code of this file.

Data Structures

struct  rtlsConfiguration_t
 RTLS Configuration structure. More...
 
struct  rtlsCtrlReq_t
 RTLS Control request. More...
 
struct  rtlsEnableSync_t
 RTLS Enable Sync - This will tell the RTLS Application to start notifying RTLS Control about a specific connection. More...
 
struct  rtlsGetActiveConnInfo_t
 RTLS Get Active Connection Info - get the connection information for a specific handle. More...
 
struct  rtlsPacket_t
 RTLS Packet - Generic structure that will be translated to a specific command. More...
 
struct  rtlsTerminateLinkReq_t
 RTLS terminate link request. More...
 
struct  rtlsUpdateConnIntReq_t
 RTLS update connection interval request. More...
 

Macros

#define BADDR_PAGE_OFFSET   0xFD0
 
#define BDADDR_OFFSET   0x2E8
 
#define BDADDR_VALID(bdAddr)
 
#define CHIP_ID_SIZE   6
 Chip Identifier Size.
 
#define RTLS_CONNHANDLE_ALL   0xFFFD
 
#define RTLS_CONNHANDLE_INVALID   0xFFFF
 
#define RTLS_CTRL_ASSERT_CAUSE_INVALID_PARAM   0x02
 RTLS Assert Error code.
 
#define RTLS_CTRL_ASSERT_CAUSE_NULL_POINTER_EXCEPT   0x03
 RTLS Assert Error code.
 
#define RTLS_CTRL_ASSERT_CAUSE_OUT_OF_MEMORY   0x01
 RTLS Assert Error code.
 
#define RTLS_CTRL_REV   0x2
 
#define RTLS_FALSE   0
 FALSE.
 
#define RTLS_REQ_ADD_DEVICE_ADV_LIST   0x0E
 RTLS Application Command Opcode.
 
#define RTLS_REQ_AOA_ENABLE   0x07
 RTLS Application Command Opcode.
 
#define RTLS_REQ_BLE_LOG_STRINGS_MAX   0x9
 
#define RTLS_REQ_CL_AOA_ENABLE   0x12
 RTLS Application Command Opcode.
 
#define RTLS_REQ_CLEAR_ADV_LIST   0x11
 RTLS Application Command Opcode.
 
#define RTLS_REQ_CONN   0x02
 RTLS Application Command Opcode.
 
#define RTLS_REQ_CREATE_SYNC_CANCEL   0x0B
 RTLS Application Command Opcode.
 
#define RTLS_REQ_ENABLE_SYNC   0x01
 RTLS Application Command Opcode.
 
#define RTLS_REQ_GET_ACTIVE_CONN_INFO   0x09
 RTLS Application Command Opcode.
 
#define RTLS_REQ_PERIODIC_RECEIVE_ENABLE   0x0D
 RTLS Application Command Opcode.
 
#define RTLS_REQ_READ_ADV_LIST_SIZE   0x10
 RTLS Application Command Opcode.
 
#define RTLS_REQ_REMOVE_DEVICE_ADV_LIST   0x0F
 RTLS Application Command Opcode.
 
#define RTLS_REQ_SCAN   0x03
 RTLS Application Command Opcode.
 
#define RTLS_REQ_SEND_DATA   0x04
 RTLS Application Command Opcode.
 
#define RTLS_REQ_SET_AOA_PARAMS   0x06
 RTLS Application Command Opcode.
 
#define RTLS_REQ_SET_CREATE_SYNC_PARAMS   0x0A
 RTLS Application Command Opcode.
 
#define RTLS_REQ_TERMINATE_LINK   0x05
 RTLS Application Command Opcode.
 
#define RTLS_REQ_TERMINATE_SYNC   0x0C
 RTLS Application Command Opcode.
 
#define RTLS_REQ_UPDATE_CONN_INTERVAL   0x08
 RTLS Application Command Opcode.
 
#define RTLS_TRUE   1
 TRUE.
 

Typedefs

typedef void(* pfnRtlsAppCb) (uint8_t *cmd)
 Application callback function.
 

Enumerations

enum  rtlsCapabilities_e {
  RTLS_CAP_NOT_INITIALIZED = 0x00000000, RTLS_CAP_CM = 0x00000001, RTLS_CAP_AOA_TX = 0x00000002, RTLS_CAP_AOA_RX = 0x00000004,
  RTLS_CAP_RESERVED1 = 0x00000008, RTLS_CAP_CL_AOA = 0x00000010, RTLS_CAP_RESERVED3 = 0x00000020, RTLS_CAP_RTLS_RESPONDER = 0x00000040,
  RTLS_CAP_RTLS_COORDINATOR = 0x00000080, RTLS_CAP_RTLS_PASSIVE = 0x00000100, RTLS_CAP_RTLS_CONNECTION_MONITOR = 0x00000200
}
 Enumeration for RTLS Capabilities.
 
enum  rtlsStatus_e {
  RTLS_SUCCESS, RTLS_FAIL, RTLS_LINK_ESTAB_FAIL, RTLS_LINK_TERMINATED,
  RTLS_OUT_OF_MEMORY, RTLS_CONFIG_NOT_SUPPORTED, RTLS_ILLEGAL_CMD
}
 Enumeration for RTLS Status.
 

Functions

void AssertHandler (uint8 assertCause, uint8 assertSubcause)
 
void RTLSCtrl_connInfoEvt (uint8_t *connInfo, uint16_t connInfoLen)
 RTLSCtrl_connInfoEvt. More...
 
void RTLSCtrl_connResultEvt (uint16_t connHandle, uint8_t status)
 RTLSCtrl_connResultEvt. More...
 
void RTLSCtrl_dataSentEvt (uint16_t connHandle, uint8_t status)
 RTLSCtrl_dataSentEvt. More...
 
void RTLSCtrl_open (rtlsConfiguration_t *rtlsConfig)
 RTLSCtrl_open. More...
 
void RTLSCTRL_processPeriodicAdvReport (uint8_t opcode, uint16_t syncHandle, int8_t txPower, int8_t rssi, uint8_t cteType, uint8_t dataStatus, uint8_t dataLen, uint8_t *pData)
 
void RTLSCtrl_processSyncEstEvt (uint8_t opcode, uint8_t status, uint16_t syncHandle, uint8_t advSid, uint8_t advAddrType, uint8_t advAddress[6], uint8_t advPhy, uint16_t periodicAdvInt, uint8_t advClockAccuracy)
 RTLSCtrl_processSyncEstEvt. More...
 
void RTLSCtrl_processSyncLostEvt (uint8_t opcode, uint16_t syncHandle)
 
void RTLSCtrl_processTerminateSyncEvt (void)
 
void RTLSCtrl_rtlsPacketEvt (uint8_t *pPkt)
 RTLSCtrl_rtlsPacketEvt. More...
 
void RTLSCtrl_scanResultEvt (rtlsStatus_e status, uint8_t *scanResult, uint8_t size)
 RTLSCtrl_scanResultEvt. More...
 
void RTLSCtrl_sendDebugEvt (uint8_t *debug_string, uint32_t debug_value)
 RTLSCtrl_sendDebugEvt. More...
 
void RTLSCtrl_sendPeriodicListSize (uint8_t *pEvt)
 RTLSCtrl_sendPeriodicListSize. More...
 
void RTLSCtrl_syncNotifyEvt (uint16_t connHandle, rtlsStatus_e status, uint32_t timeToNextEvent, int8_t rssi, uint8_t channel)
 RTLSCtrl_syncNotifyEvt. More...
 

Variables

char * rtlsReq_BleLogStrings []
 
© Copyright 1995-2022, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale