BT_Notify

The Bluetooth notification service is a Bluetooth service that parses the information from a remote device. More...

Overview

The Bluetooth notification service is a Bluetooth service that parses the information from a remote device.

The information could be a common notification, message, missed call or a customized content.

Terms and Acronyms

Terms	Details
SPP	Serial Port Profile. For more information, please refer to Wikipedia.
SDP	Service Discovery Protocol. For more information, please refer to Wikipedia.
DOGP	Data Over GATT Profile. It is a GATT based profile defined by MediaTek. It is used to transmit (send and receive) data through a GATT server.
EXCD	Extend Command. It is used to send and receive customized data.

How to use this module

• An example code to parse a common notification:
  • Step 1. Mandatory, implement bt_sdps_get_customized_record() to add SDP records for the SPP Server. For more information about the SDP record, please refer to SPP. Then call bt_notify_init() with the SDP ID to initialize the Bluetooth notification service.
    • Sample code:

      #define BT_SPP_UUID    0x00,0x00,0xFF,0x01,0x00,0x00,0x10,0x00,0x80,0x00,0x00,0x80,0x5F,0x9B,0x34,0xFF
      static const uint8_t bt_spp_service_class_id_pattern[] =
      {
          BT_SPP_SDP_ATTRIBUTE_UUID_LENGTH,
          BT_SPP_SDP_ATTRIBUTE_UUID(BT_SPP_STANDARD_UUID)
      };
      static const uint8_t bt_spp_protocol_descriptor_list_pattern[] =
      {
          BT_SPP_SDP_ATTRIBUTE_PROTOCOL_DESCRIPTOR(BT_SPP_SERVER_ID_START)
      };
      static const uint8_t bt_spp_browse_group_pattern[] =
      {
          BT_SPP_SDP_ATTRIBUTE_PUBLIC_BROWSE_GROUP
      };
      static const uint8_t bt_spp_language_pattern[] =
      {
          BT_SPP_SDP_ATTRIBUTE_LANGUAGE
      };
      static const uint8_t bt_spp_service_name_pattern[] =
      {
          BT_SPP_SDP_ATTRIBUTE_SIZE_OF_SERVICE_NAME(11),
          'S', 'e', 'r', 'i', 'a', 'l', ' ', 'P', 'o', 'r', 't'
      };
      static const bt_sdps_attribute_t bt_spp_sdp_attributes_pattern[] =
      {
          BT_SPP_SDP_ATTRIBUTE_SERVICE_CLASS_ID_LIST(bt_spp_service_class_id_pattern),
          BT_SPP_SDP_ATTRIBUTE_PROTOCOL_DESC_LIST(bt_spp_protocol_descriptor_list_pattern),
          BT_SPP_SDP_ATTRIBUTE_BROWSE_GROUP_LIST(bt_spp_browse_group_pattern),
          BT_SPP_SDP_ATTRIBUTE_LANGUAGE_BASE_LIST(bt_spp_language_pattern),
          BT_SPP_SDP_ATTRIBUTE_SERVICE_NAME(bt_spp_service_name_pattern)
      };
      static const bt_sdps_record_t bt_spp_sdp_record_pattern = 
      {
          .attribute_list_length = sizeof(bt_spp_sdp_attributes_pattern),
          .attribute_list = bt_spp_sdp_attributes_pattern,
      };
      static const bt_sdps_record_t *sdps_spp_record[]= {
          &bt_spp_sdp_record_pattern,
      };
      uint8_t bt_sdps_get_customized_record(const bt_sdps_record_t *** record_list)
      {
          *record_list = sdps_spp_record;
         return sizeof(sdps_spp_record)/sizeof(bt_sdps_record_t*);
      }
      // Initialize the Bluetooth notification service. Call this function in application initialization or in system initialization.
      bt_notify_init(BT_SPP_STANDARD_UUID);

  • Step 2. Mandatory, register a callback function for the service.
    • Sample code:

      if (BT_NOTIFY_RESULT_REGISTER_OK !=  bt_notify_register_callback(NULL, "app_test", my_bt_notify_callback)) {
           // Failed to register.
           return;
      }

  • Step 3. Mandatory, implement the callback function as registered in step 2, to handle the connection information, notifications, write indications, etc.
    • Sample code:

      void my_bt_notify_callback(void *data)
      {   
          bt_notify_callback_data_t *p_cb_data = (bt_notify_callback_data_t *)data;
          switch (p_cb_data->evt_id) {
              case BT_NOTIFY_EVENT_CONNECTION: {
                  // Handle connection event.
                  break;
              }
              case BT_NOTIFY_EVENT_DISCONNECTION: {
                  // Handle disconnection event.
                  break;
              }
              case BT_NOTIFY_EVENT_SEND_IND: {
                  // An indication to notify the application to send data.
                  break;
              }
              case BT_NOTIFY_EVENT_DATA_RECEIVED: {
                  // Notify the application that the EXCD data has been received from a remote device.
                   break;
              }
              case BT_NOTIFY_EVENT_NOTIFICATION: {
                  // Notify the application that a notification has been received from a remote device.
                   break;
              }
              case BT_NOTIFY_EVENT_MISSED_CALL: {
                  // Notify the application that a missed call notification has been received from a remote device.
                   break;
              }
              case BT_NOTIFY_EVENT_SMS: {
                  // Notify the application that an SMS notification has been received from a remote device.
                 break;
              }
              default: {
                   break;
              }
          }         
      }

Functions
bt_notify_result_t	bt_notify_register_callback (const bt_bd_addr_t *bt_addr, char *sender, bt_notify_callback_t cb_ptr)
	This function registers a callback function to the Bluetooth notification service. More...
bt_notify_result_t	bt_notify_deregister_callback (const bt_bd_addr_t *bt_addr, bt_notify_callback_t cb_ptr)
	This function unregisters the callback function that has already been registered. More...
int32_t	bt_notify_send_data (bt_bd_addr_t *bt_addr, const char *data, uint16_t data_len, bool is_new)
	Call this function to send data. More...
void	bt_notify_init (uint8_t sdp_id)
	This function initializes the Bluetooth notification service. More...
bt_notify_data_source_t	bt_notify_get_data_source (bt_bd_addr_t *bt_addr)
	Call this function to get the data transfer mode. More...

Modules
	Define
	This section defines the macros for the Bluetooth notification service.
	Struct
	This section defines the structures for the Bluetooth notification service.

Function Documentation

bt_notify_result_t bt_notify_deregister_callback	(	const bt_bd_addr_t *	bt_addr,
		bt_notify_callback_t	cb_ptr
	)

This function unregisters the callback function that has already been registered.

Parameters

[in]	bt_addr	is the Bluetooth address of a remote device. It cannot be NULL.
[in]	cb_ptr	is the callback function to unregister.

Returns

The result of the registration, as defined in bt_notify_result_t.

bt_notify_data_source_t bt_notify_get_data_source

(

bt_bd_addr_t *

bt_addr

)

Call this function to get the data transfer mode.

Parameters

[in]

bt_addr

is the Bluetooth address of a remote device. It cannot be NULL.

Returns

The data transfer mode, SPP or DOGP mode.

void bt_notify_init

(

uint8_t

sdp_id

)

This function initializes the Bluetooth notification service.

It should be called either in application initialization or in system initialization.

Parameters

[in]

sdp_id

is the record ID of the SDP.

bt_notify_result_t bt_notify_register_callback	(	const bt_bd_addr_t *	bt_addr,
		char *	sender,
		bt_notify_callback_t	cb_ptr
	)

This function registers a callback function to the Bluetooth notification service.

Parameters

[in]	bt_addr	is the Bluetooth address of a remote device. It can be NULL.
[in]	sender	is a character string to identify the entity the callback is registered for.
[in]	cb_ptr	is the callback function.

Returns

The result of the registration, as defined in bt_notify_result_t.

int32_t bt_notify_send_data	(	bt_bd_addr_t *	bt_addr,
		const char *	data,
		uint16_t	data_len,
		bool	is_new
	)

Call this function to send data.

Wait for the BT_NOTIFY_EVENT_SEND_IND event to send more data.

Parameters

[in]	bt_addr	is the Bluetooth address of the remote device to send data to. It cannot be NULL.
[in]	data	is the data to be sent.
[in]	data_len	is the data length.
[in]	is_new	is the flag indicating if the data is new.

Returns

The length of the send data.