ble/html/rtls__host_8h_source.html

 /******************************************************************************

  @file  rtls_host.h

  @brief This file contains the host abstraction layer for a RTLS Host
  Group: WCS, BTS
  $Target Device: DEVICES $

  ******************************************************************************
  $License: BSD3 2018 $
  ******************************************************************************
  $Release Name: PACKAGE NAME $
  $Release Date: PACKAGE RELEASE DATE $
  *****************************************************************************/

 #ifndef RTLS_HOST_H_
 #define RTLS_HOST_H_

 #ifdef __cplusplus
 extern "C"
 {
 #endif

 /*********************************************************************
  * INCLUDES
  */

 /*********************************************************************
 *  EXTERNAL VARIABLES
 */

 /*********************************************************************
  * CONSTANTS
  */

 /*********************************************************************
  * MACROS
  */

 /*********************************************************************
  * TYPEDEFS
  */

 typedef enum
 {
   HOST_ASYNC_REQ,
   HOST_ASYNC_RSP,
   HOST_SYNC_REQ,
   HOST_SYNC_RSP
 } rtlsHostMsgType_e;

 // RTLS Host message structure
 typedef struct
 {
   uint16_t            cmdId;
   rtlsHostMsgType_e   cmdType;
   uint16_t            dataLen;
   uint8_t             *pData;
 } rtlsHostMsg_t;

 typedef void (*pfnRtlsCtrlProcessMsgCb)(rtlsHostMsg_t *pMsg);
 /*********************************************************************
  * API FUNCTIONS
  */

 void RTLSHost_openHostIf(pfnRtlsCtrlProcessMsgCb rtlsHostMsgCb);

 uint8_t RTLSHost_sendMsg(uint8_t cmdId, uint8_t cmdType, uint8_t *pData, uint16_t dataLen);

 /*********************************************************************
 *********************************************************************/

 #ifdef __cplusplus
 }
 #endif

 #endif /* RTLS_HOST_H_ */

rtlsHostMsgType_e
rtlsHostMsgType_e
Enumeration for Host Message types.
Definition: rtls_host.h:58

RTLSHost_sendMsg
uint8_t RTLSHost_sendMsg(uint8_t cmdId, uint8_t cmdType, uint8_t *pData, uint16_t dataLen)
This function is an abstraction of sending messages to a RTLS Host.

pfnRtlsCtrlProcessMsgCb
void(* pfnRtlsCtrlProcessMsgCb)(rtlsHostMsg_t *pMsg)
RTLS Host application callback.
Definition: rtls_host.h:76

RTLSHost_openHostIf
void RTLSHost_openHostIf(pfnRtlsCtrlProcessMsgCb rtlsHostMsgCb)
This function opens the host interface and registers the application callback.