XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs
BleImmediateAlert_Service.h File Reference
#include "bleTypes.h"
+ Include dependency graph for BleImmediateAlert_Service.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  BleImmediateAlertAlert
 

Macros

#define BLE_SUPPORT_IMMEDIATEALERT_SERVICE   0
 
#define BLEIMMEDIATEALERT_ALERT_HIGHALERT   2
 
#define BLEIMMEDIATEALERT_ALERT_MEDIUMALERT   1
 
#define BLEIMMEDIATEALERT_ALERT_NOALERT   0
 
#define BLEIMMEDIATEALERT_EVENT_ALERT   1
 

Typedefs

typedef U8 BleImmediateAlertAlertLevel
 
typedef void(* BleImmediateAlertCallBack )(BleImmediateAlertEvent event, BleStatus status, void *parms)
 
typedef U8 BleImmediateAlertEvent
 

Macro Definition Documentation

#define BLE_SUPPORT_IMMEDIATEALERT_SERVICE   0

BLE_SUPPORT_IMMEDIATEALERT_SERVICE Defines if the BLE local device enables access to the local immediate Alert service and characteristic.

If enabled ( set to 1 ) it enables Profiles to get access to the immediate Alert Service and characteristic

The default value for this option is disabled (0).

#define BLEIMMEDIATEALERT_ALERT_HIGHALERT   2

BLEIMMEDIATEALERT_ALERT_HIGHALERT The alert level is high Alert, the device shall alert in the strongest possible way.

#define BLEIMMEDIATEALERT_ALERT_MEDIUMALERT   1

BLEIMMEDIATEALERT_ALERT_MEDIUMALERT The Alert level is medium Alert, the device shall alert.

#define BLEIMMEDIATEALERT_ALERT_NOALERT   0

BLEIMMEDIATEALERT_ALERT_NOALERT The alert level is no alert; no alerting shall be done on this device.

#define BLEIMMEDIATEALERT_EVENT_ALERT   1

BLEIMMEDIATEALERT_EVENT_ALERT Event received when a new alerting state is raised. for example when the remote device will trig an immediate Alert, the BLEIMMEDIATEALERT_EVENT_ALERT event with the configurated alert level will be trigged. The parms field indicates the Alert information within the BleImmediateAlertAlert type.

Typedef Documentation

BleImmediateAlertAlertLevel type Define the different kind of Alert level that could be received by the BleImmediateAlertCallBack The specific action that occurs in the device for the mild and high alerts is implementation specific. For example, this could include flashing lights, making noises, moving, or other methods to alert the user.

typedef void(* BleImmediateAlertCallBack)(BleImmediateAlertEvent event, BleStatus status, void *parms)

BleImmediateAlertCallBack This callback receives the IMMEDIATE ALERT SERVICE events. Each events may be assiociated with specified parameters. The callback is executed during the stack context, be careful to not doing heavy process in this function.

BleImmediateAlertEvent type Define the different kind of events that could be received by the BleImmediateAlertCallBack


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