XDK API  3.6.0
Documentation
Files | Typedefs | Functions

The Sensor Services is a set of custom services, that provides a raw byte array payload communication as well as several sensor data services. More...

+ Collaboration diagram for Sensor Services:

Files

file  BCDS_SensorServices.h
 

Typedefs

typedef
SensorServices_SensorAxisType_T 
BLE_SensorAxisType_T
 Typedef to represent the sensor axis type for accelerometer and gyro services. More...
 
typedef
SensorServices_SensorControlNode_T 
BLE_SensorControlNode_T
 Typedef to control the node. More...
 
typedef
SensorServices_EnvironmentalType_T 
BLE_SensorEnvironmentalType_T
 Typedef to represent the environmental service characteristic. More...
 
typedef
SensorServices_HighDataRateType_T 
BLE_SensorHighDataRateType_T
 Typedef to represent the high data rate service characteristic. More...
 
typedef
SensorServices_MagnetometerType_T 
BLE_SensorMagnetometerType_T
 typedef to represent the magnetometer service characteristic More...
 
typedef SensorServices_Info_T Ble_SensorServicesInfo_T
 Typedef to represent the node sensor service information. More...
 
typedef SensorService_Type_T BLE_SensorServiceType_T
 Typedef to represent the sensor service type. More...
 
typedef void(* SensorServices_DataReceivedCallBack )(uint8_t *rxBuffer, uint8_t rxDataLength, Ble_SensorServicesInfo_T *sensorServicesInfo)
 Typedef to notify the application about any incoming data for any of the registered sensor services. More...
 
typedef void(* SensorServices_SendEventCallback )(Retcode_T sendStatus)
 Typedef to send status notification. More...
 

Functions

Retcode_T SensorServices_Init (SensorServices_DataReceivedCallBack readCallback, SensorServices_SendEventCallback sendCallback)
 Initialize application callback to intimate for events from sensor services. More...
 
Retcode_T SensorServices_SendData (uint8_t *dataToSend, uint8_t dataToSendLen, Ble_SensorServicesInfo_T *param)
 This function sends data to the client. More...
 

Detailed Description

The Sensor Services is a set of custom services, that provides a raw byte array payload communication as well as several sensor data services, see #BLE_SensorServiceType_E.

Typedef Documentation

typedef void(* SensorServices_DataReceivedCallBack)(uint8_t *rxBuffer, uint8_t rxDataLength, Ble_SensorServicesInfo_T *sensorServicesInfo)
Parameters
[in]rxBufferpointer to the received data buffer
[in]rxDataLengthLength of the received data
[in]sensorServicesInfoConsists of the necessary service information of the received characteristic.
typedef void(* SensorServices_SendEventCallback)(Retcode_T sendStatus)
Parameters
[in]sendStatusStatus of the send operation
Note
For every single SensorServices_SendData, this must be synchronized before triggering a new send. If the interface user wants to have a queuing mechanism for sending data where the user need not worry about this notification and shall load the send API per need, it is excepted to be implemented as a wrapper at the application end on top of this.

Function Documentation

Retcode_T SensorServices_Init ( SensorServices_DataReceivedCallBack  readCallback,
SensorServices_SendEventCallback  sendCallback 
)
Parameters
[in]readCallbackApplication Callback that will be called on data reception for any sensor services characteristics
[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
SensorServices_SendData

Initialize application callback to intimate for events from sensor services

Parameters
[in]readCallbackApplication Callback that will be called on data reception for any sensor services characteristics
[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
SensorServices_SendData
Retcode_T SensorServices_SendData ( uint8_t *  dataToSend,
uint8_t  dataToSendLen,
Ble_SensorServicesInfo_T param 
)
Parameters
[in]dataToSendThe payload to be sent
[in]dataToSendLenThe length of the payload to be sent
[in]paramProvides the service characteristics information
Returns
RETCODE_OK on success, or an error code otherwise. Refer Retcode_General_E and Ble_Retcode_E for other values.
Note
Sensor Services must have been successfully initialized and registered prior. SensorServices_SendEventCallback will be triggered to provide the status of every individual send's.
See also
SensorServices_SendEventCallback

This function sends data to the client

Parameters
[in]dataToSendThe payload to be sent
[in]dataToSendLenThe length of the payload to be sent
[in]paramProvides the service characteristics information
Returns
RETCODE_OK on success, or an error code otherwise. Refer Retcode_General_E and Ble_Retcode_E for other values.
Note
Sensor Services must have been successfully initialized and registered prior. SensorServices_SendEventCallback will be triggered to provide the status of every individual send's.
See also
SensorServices_SendEventCallback

+ 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:51 by doxygen 1.8.8