XDK API  3.6.0
Documentation
Data Structures | Typedefs | Functions | Variables
BleDeviceInfoService.c File Reference
#include "BCDS_Basics.h"
#include "BCDS_Retcode.h"
#include "BleTypes.h"
#include "attserver.h"
#include "BleDeviceInfoService.h"
+ Include dependency graph for BleDeviceInfoService.c:

Data Structures

struct  DeviceInfoService_Characteristic_S
 structure to hold the Characteristic properties of the Device Information Service More...
 

Typedefs

typedef struct
DeviceInfoService_Characteristic_S 
DeviceInfoService_Characteristic_T
 Typedef to represent the Characteristic property of Model Number. More...
 

Functions

Retcode_T BleDeviceInformationService_Initialize (BleDeviceInformationService_CharacteristicValue_T characteristicValue)
 This is to configure the user characteristics value for the BLE standard Device Information Service . More...
 
Retcode_T BleDeviceInformationService_Register (void)
 This API registers the BLE standard Device Information Service & needs to be called in the BLE GAP event callback function registered using the BlePeripheral_Initialize() API for proper operation. More...
 
static void DeviceInformationServiceCallback (AttServerCallbackParms *serverCallbackParms)
 This function handles the Device Information service events. More...
 

Variables

static AttServiceAttribute DeviceInformationServiceAttribute
 This module contains Ble Device Information Service Register API along with the Characteristics. More...
 
static const uint8_t DeviceInformationUUID [2] = { 0x0A, 0x18 }
 
static
DeviceInfoService_Characteristic_T 
GetManufacturerCharacteristicProperties
 
static
DeviceInfoService_Characteristic_T 
GetModelNumberCharacteristicProperties
 
static
DeviceInfoService_Characteristic_T 
GetSoftwareRevisionCharacteristicProperties
 
static uint8_t ManufacturerCharacteristicValue [17U]
 
static const uint16_t ManufacturerUUID = 0x2A29
 
static uint8_t ModelNumberCharacteristicValue [6U]
 
static const uint16_t ModelNumberUUID = 0x2A24
 
static uint8_t SoftwareRevisionCharacteristicValue [14U]
 
static const uint16_t SoftwareRevisionUUID = 0x2A28
 

Typedef Documentation

Function Documentation

Retcode_T BleDeviceInformationService_Initialize ( BleDeviceInformationService_CharacteristicValue_T  characteristicValue)

Prerequisite: Failing to call this API before BleDeviceInformationService_Register() would result in unknown characteristics value for Device Information Service

Parameters
characteristicValuestructure to hold the characteristic value.
Return values
RETCODE_OKif success RETCODE_FAILURE for error case
Retcode_T BleDeviceInformationService_Register ( void  )
Return values
RETCODE_OKif BLE Service Registered successfully RETCODE_FAILURE Failed to Register the Ble Device Info Service

+ Here is the call graph for this function:

static void DeviceInformationServiceCallback ( AttServerCallbackParms *  serverCallbackParms)
static
Parameters
i]serverCallbackParms Parameters holding service event status

+ Here is the caller graph for this function:

Variable Documentation

AttServiceAttribute DeviceInformationServiceAttribute
static

Attribute handle for the Device Information service

const uint8_t DeviceInformationUUID[2] = { 0x0A, 0x18 }
static

Device Information Service UUID as per the BLE Specifications

DeviceInfoService_Characteristic_T GetManufacturerCharacteristicProperties
static
Initial value:
=
{
{ 0, { 0 } },
{ 0, 0, 0, { 0 }, { 0 }, 0, 0, 0, 0, { 0 } },
{ 0, 0, 0, { 0 }, { 0 }, 0, 0, 0, 0 }
}
DeviceInfoService_Characteristic_T GetModelNumberCharacteristicProperties
static
Initial value:
=
{
{ 0, { 0 } },
{ 0, 0, 0, { 0 }, { 0 }, 0, 0, 0, 0, { 0 } },
{ 0, 0, 0, { 0 }, { 0 }, 0, 0, 0, 0 }
}
DeviceInfoService_Characteristic_T GetSoftwareRevisionCharacteristicProperties
static
Initial value:
=
{
{ 0, { 0 } },
{ 0, 0, 0, { 0 }, { 0 }, 0, 0, 0, 0, { 0 } },
{ 0, 0, 0, { 0 }, { 0 }, 0, 0, 0, 0 }
}
uint8_t ManufacturerCharacteristicValue[17U]
static

Manufacturer information Format: {"Manufacturer"}

const uint16_t ManufacturerUUID = 0x2A29
static

Manufacturer String Characteristics as per the BLE Specifications

uint8_t ModelNumberCharacteristicValue[6U]
static

Model Number information Format: {"MODEL NUMBER"}

const uint16_t ModelNumberUUID = 0x2A24
static

Model Number String Characteristics as per the BLE Specifications

uint8_t SoftwareRevisionCharacteristicValue[14U]
static

Serial Number information Format: {"Serial Number"}

const uint16_t SoftwareRevisionUUID = 0x2A28
static

SoftwareRevision String Characteristics as per the BLE Specifications


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