XDK API  3.6.0
Documentation
Typedefs | Functions
GridEyeService.h File Reference
#include "BCDS_Retcode.h"
+ Include dependency graph for GridEyeService.h:
+ This graph shows which files directly or indirectly include this file:

Typedefs

typedef void(* GridEyeService_DataReceivedCallBack )(uint8_t *rxBuffer, uint8_t rxDataLength, void *param)
 This is function template which is needs to be implemented by the application in order to receive data from the BLE central device. More...
 
typedef void(* GriEyeService_SendEventCallback )(Retcode_T sendStatus)
 This is the callback triggered after the successful sending of data over BLE, the semaphore is released here to synchronize the calling task to initiate next BLE data transfer. More...
 

Functions

Retcode_T GridEyeService_Init (GridEyeService_DataReceivedCallBack readCallback, GriEyeService_SendEventCallback sendCallback)
 Initializes the GridEye Service. More...
 
Retcode_T GridEyeService_Register (void)
 This contains the implementation to register the GridEye Service to the BLE stack. More...
 
Retcode_T GridEyeService_SendData (uint8_t *payload, uint8_t payloadLen)
 The function is used to transmit data to ble to the BLE GridEye Sensor Service. More...
 
void GridEyeService_UpdateConnectionStatus (bool connectionStatus)
 This function notifies the BLE connection status. More...
 

Detailed Description

This module handles the GridEye Service

Typedef Documentation

typedef void(* GridEyeService_DataReceivedCallBack)(uint8_t *rxBuffer, uint8_t rxDataLength, void *param)

Typedef to notify the application about any incoming data

Parameters
[in]rxBufferpointer to the received data buffer
[in]rxDataLengthLength of the received data
[in]paramUnused
Note
This is not used as of now for this application, But this is give as an example for the user, to configure some parameters of GridEye sensor
typedef void(* GriEyeService_SendEventCallback)(Retcode_T sendStatus)
Parameters
[in]sendStatusStatus of the send operation

Function Documentation

Retcode_T GridEyeService_Init ( GridEyeService_DataReceivedCallBack  readCallback,
GriEyeService_SendEventCallback  sendCallback 
)

Initializes the GridEye Service with a readCallback and a sendCallback to be implemented by the application.

Parameters
[in]readCallbackApplication Callback that will be called on data reception for any data reception
[in]sendCallbackApplication Callback that will be notified about the data send status.
Returns
RETCODE_OK on success, or an error code otherwise. Refer Retcode_General_E and Ble_Retcode_E for other values.
See also
GridEyeService_SendData
Retcode_T GridEyeService_Register ( void  )
Returns
RETCODE_OK on success, or an error code otherwise. Refer Retcode_General_E and Ble_Retcode_E for other values.
Note
GridEye Services must have been successfully initialized prior to this call.
Return values
RETCODE_OKif success error otherwise

+ Here is the call graph for this function:

Retcode_T GridEyeService_SendData ( uint8_t *  payload,
uint8_t  payloadLen 
)
Parameters
[in]payloadpointer holding the data to be transmitted over BLE
[in]payloadLenlength of the data to be transmitted
Return values
RETCODE_OKin the case of success or an error code otherwise.
Note
This function is non-blocking call and hence a signalling mechanism like semaphore needed for proper sending of data
void GridEyeService_UpdateConnectionStatus ( bool  connectionStatus)

This function notifies the BLE connection status

Parameters
[in]connectionStatusBLE connection status

+ Here is the call graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:40 by doxygen 1.8.8