XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs
BleAlertNotification_Service.h File Reference
#include "bleTypes.h"
+ Include dependency graph for BleAlertNotification_Service.h:

Data Structures

struct  BleAlertNotificationServiceCommandRequest
 
struct  BleAlertNotificationServiceNewAlert
 
struct  BleAlertNotificationServiceUnreadAlertStatus
 

Macros

#define BLE_SUPPORT_ALERTNOTIFICATION_SERVICE   0
 
#define BLEALERTNOTIFICATION_SERVER_SUPPORT_TEXTSTRINGINFO   0
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORY_NONE   0x0000
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_ALLCATEGORIESWILDCARD   0xFF
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_CALL   3
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_EMAIL   1
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_HIGHPRIORITIZEDALERT   8
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_INSTANTMESSAGE   9
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_MISSEDCALL   4
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_NEWS   2
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_SCHEDULE   7
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_SIMPLEALERT   0
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_SMSMMS   5
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_VOICEMAIL   6
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_CALL   0x0008
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_EMAIL   0x0002
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_HIGHPRIORITIZEDALERT   0x0100
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_INSTANTMESSAGE   0x0200
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_MISSEDCALL   0x0010
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_NEWS   0x0004
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_SCHEDULE   0x0080
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_SIMPLEALERT   0x0001
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_SMSMMS   0x0020
 
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_VOICEMAIL   0x0040
 
#define BLEALERTNOTIFICATIONSERVICE_DISABLE_NEW_ALERT_NOTIFICATION   2
 
#define BLEALERTNOTIFICATIONSERVICE_DISABLE_UNREAD_ALERT_STATUS_NOTIFICATION   3
 
#define BLEALERTNOTIFICATIONSERVICE_ENABLE_NEW_ALERT_NOTIFICATION   0
 
#define BLEALERTNOTIFICATIONSERVICE_ENABLE_UNREAD_ALERT_STATUS_NOTIFICATION   1
 
#define BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDDISABLERECEIVED   0xA9
 
#define BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDENABLERECEIVED   0xA8
 
#define BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDNOTIFYRECEIVED   0xAA
 
#define BLEALERTNOTIFICATIONSERVICE_NOTIFY_NEW_ALERT_IMMEDIATELY   4
 
#define BLEALERTNOTIFICATIONSERVICE_NOTIFY_UNREAD_ALERT_STATUS_IMMEDIATELY   5
 
#define BLEINFOTYPE_NEWALERT_CLIENTCONFIG   0x9A
 
#define BLEINFOTYPE_UNREADALERTSTATUS_CLIENTCONFIG   0x9B
 

Typedefs

typedef U16 BleAlertNotificationServiceAlertCategoryBitmask
 
typedef U8 BleAlertNotificationServiceAlertCategoryId
 
typedef void(* BleAlertNotificationServiceCallBack )(BleAlertNotificationServiceEvent event, BleStatus status, void *parms)
 
typedef U8 BleAlertNotificationServiceCommandId
 
typedef U8 BleAlertNotificationServiceEvent
 

Macro Definition Documentation

#define BLE_SUPPORT_ALERTNOTIFICATION_SERVICE   0

BLE_SUPPORT_ALERTNOTIFICATION_SERVICE Defines if the BLE local device enables access to the local ALERT NOTIFICATION service and characteristic.

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

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

#define BLEALERTNOTIFICATION_SERVER_SUPPORT_TEXTSTRINGINFO   0

BLEALERTNOTIFICATION_SERVER_SUPPORT_TEXTSTRINGINFO Defines if the BLE local device enables access to the local text string information of the characteristic New Alert

If enabled ( set to 1 ) it enables Profiles to get access to the text string information

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

#define BLEALERTNOTIFICATIONSERVICE_CATEGORY_NONE   0x0000
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_ALLCATEGORIESWILDCARD   0xFF
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_CALL   3
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_EMAIL   1
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_HIGHPRIORITIZEDALERT   8
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_INSTANTMESSAGE   9
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_MISSEDCALL   4
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_NEWS   2
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_SCHEDULE   7
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_SIMPLEALERT   0
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_SMSMMS   5
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYID_VOICEMAIL   6
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_CALL   0x0008
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_EMAIL   0x0002
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_HIGHPRIORITIZEDALERT   0x0100
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_INSTANTMESSAGE   0x0200
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_MISSEDCALL   0x0010
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_NEWS   0x0004
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_SCHEDULE   0x0080
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_SIMPLEALERT   0x0001
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_SMSMMS   0x0020
#define BLEALERTNOTIFICATIONSERVICE_CATEGORYIDBITMASK_VOICEMAIL   0x0040
#define BLEALERTNOTIFICATIONSERVICE_DISABLE_NEW_ALERT_NOTIFICATION   2
#define BLEALERTNOTIFICATIONSERVICE_DISABLE_UNREAD_ALERT_STATUS_NOTIFICATION   3
#define BLEALERTNOTIFICATIONSERVICE_ENABLE_NEW_ALERT_NOTIFICATION   0
#define BLEALERTNOTIFICATIONSERVICE_ENABLE_UNREAD_ALERT_STATUS_NOTIFICATION   1
#define BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDDISABLERECEIVED   0xA9

BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDDISABLERECEIVED Event received when a remote CLIENT requests the SERVER to disable category for alert notification The status field is always BLESTATUS_SUCCESS The parms field is a BleAlertNotificationServiceCommandRequest structure, it indicates for which connection handle representing the CLIENT the requests come, and the requested state. The requested commandID can be either:

–DISABLE NEW ALERT CATEGORY– A remote CLIENT requests control point to disable New Alert category for new alert.

–DISABLE UNREAD ALERT STATUS CATEGORY– A remote CLIENT requests control point to disable Unread Alert category for unread alert.

#define BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDENABLERECEIVED   0xA8

BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDENABLERECEIVED Event received when a remote CLIENT requests the SERVER to enable category for alert notification The status field is always BLESTATUS_SUCCESS The parms field is a BleAlertNotificationServiceCommandRequest structure, it indicates for which connection handle representing the CLIENT the requests come, and the requested state. The requested commandID can be either:

–ENABLE NEW ALERT CATEGORY– A remote CLIENT requests control point to enable New Alert category for new alert.

–ENABLE UNREAD ALERT STATUS CATEGORY– A remote CLIENT requests control point to enable Unread Alert category for unread alert.

#define BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDNOTIFYRECEIVED   0xAA

BLEALERTNOTIFICATIONSERVICE_EVENT_COMMANDNOTIFYRECEIVED Event received when a remote CLIENT requests the SERVER to control the alert notification The status field is always BLESTATUS_SUCCESS The parms field is a BleAlertNotificationServiceCommandRequest structure, it indicates for which connection handle representing the CLIENT the requests come, and the requested state. The requested commandID can be either:

–NOTIFY NEW ALERT IMMEDIATELY– A remote CLIENT requests control point to Notify the New Alert characteristic immediately for the category specified if that category is enabled

–NOTIFY UNREAD ALERT STATUS IMMEDIATELY– A remote CLIENT requests control point to Notify the New Alert characteristic immediately for the category specified if that category is enabled

#define BLEALERTNOTIFICATIONSERVICE_NOTIFY_NEW_ALERT_IMMEDIATELY   4
#define BLEALERTNOTIFICATIONSERVICE_NOTIFY_UNREAD_ALERT_STATUS_IMMEDIATELY   5
#define BLEINFOTYPE_NEWALERT_CLIENTCONFIG   0x9A

BLEINFOTYPE_NEWALERT_CLIENTCONFIG BLEINFOTYPE_UNREADALERTSTATUS_CLIENTCONFIG BLEINFOTYPE_CONTROLPOINT_NEWALERTBITFIELD BLEINFOTYPE_CONTROLPOINT_UNREADALERTSTATUSBITFIELD Unique descriptors ID for information to save in persistent memory representing the client config for a given remote bonded device and configured new and unread alert. It is the Unique identifier passed in the infotype fields when the PROFILE call the system APIs SYSTEM_SetPersistentInformation(BD_ADDR addr, U8 infoType, U8* infoValue,U8 InfoLen) and SYSTEM_GetPersistentInformation(BD_ADDR addr, U8 infoType, U8 **infoValue, U8 *InfoLen).

#define BLEINFOTYPE_UNREADALERTSTATUS_CLIENTCONFIG   0x9B

Typedef Documentation

BleAlertNotificationServiceAlertCategoryBitmask type Define the different kind of Supported new alert category that could be received by the BleAlertNotificationServiceCallBack The categories supported for new alert and unread alert status are simple alert, email, call, missed call, sms/mms, schedule, high prioritized alert and instant message It is a bitfield indicating which categories are enabled or supported Set to 0 by default (the remote device will be able to enable the categories thanks to the control point). If the bit is set then the category is considered to enabled or supported.

BleAlertNotificationServiceAlertCategoryId type Define the different category which are notified by BLEALERTNOTIFICATIONSERVICE_SetNewAlert() or BLEALERTNOTIFICATIONSERVICE_SetUnreadAlertStatus() APIs. It defines the category which will be notified. It is not a bitfield, it represents a single category.

typedef void(* BleAlertNotificationServiceCallBack)(BleAlertNotificationServiceEvent event, BleStatus status, void *parms)

BleAlertNotificationServiceCallBack This callback receives the ALERT NOTIFICATION 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.

BleAlertNotificationServiceCommandId type Define the different kind of command that a remote MONITOR can request to be set by the local SERVER It can be one of the following values:

BleAlertNotificationServiceEvent type Define the different kind of events that could be received by the BleAlertNotificationServiceCallBack


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