MT2523 API Reference  LinkIt SDK v4

This section defines the structures for the Bluetooth notification service. More...

Overview

This section defines the structures for the Bluetooth notification service.

Data Structures

struct  bt_notify_event_data_t
 Define the structure of the event BT_NOTIFY_EVENT_DATA_RECEIVED. More...
 
struct  page_struct
 Define the page structure of the notification received from a remote device. More...
 
struct  bt_notify_action_content_t
 Define the action content of the notification received from a remote device. More...
 
struct  bt_notify_notification_t
 Define the notification content received from a remote device. More...
 
struct  bt_notify_sms_t
 Define the SMS content received from a remote device. More...
 
struct  bt_notify_missed_call_t
 Define the missed call content received from the remote device. More...
 
struct  bt_notify_callback_data_t
 Define the structure for the callback content. More...
 

Typedefs

typedef void(* bt_notify_callback_t) (void *data)
 Defines the callback function type. More...
 
typedef struct page_struct bt_notify_page_content_list_t
 Define the page structure of the notification received from a remote device.
 

Enumerations

enum  bt_notify_event_t {
  BT_NOTIFY_EVENT_NONE = 1,
  BT_NOTIFY_EVENT_CONNECTION,
  BT_NOTIFY_EVENT_DISCONNECTION,
  BT_NOTIFY_EVENT_SEND_IND,
  BT_NOTIFY_EVENT_DATA_RECEIVED,
  BT_NOTIFY_EVENT_NOTIFICATION,
  BT_NOTIFY_EVENT_MISSED_CALL,
  BT_NOTIFY_EVENT_SMS,
  BT_NOTIFY_EVENT_END
}
 The structure defines the Bluetooth notification service indication event. More...
 
enum  bt_notify_remote_system_type_t {
  BT_NOTIFY_REMOTE_SYSTEM_NONE,
  BT_NOTIFY_REMOTE_SYSTEM_ANDROID,
  BT_NOTIFY_REMOTE_SYSTEM_IOS
}
 Define the remote device system type. More...
 
enum  bt_notify_action_type_t {
  BT_NOTIFY_ACTION_TYPE_NEW,
  BT_NOTIFY_ACTION_TYPE_DELETE
}
 Define the action type of the notification received from a remote device. More...
 
enum  bt_notify_result_t {
  BT_NOTIFY_RESULT_NOT_SUPPORTED = -9,
  BT_NOTIFY_RESULT_INVALID_PARAMETER,
  BT_NOTIFY_RESULT_PARSING_ERROR,
  BT_NOTIFY_RESULT_CHANNAL_UNAVAILABLE,
  BT_NOTIFY_RESULT_FAILED,
  BT_NOTIFY_RESULT_REGISTER_INVALID_PARAMETER,
  BT_NOTIFY_RESULT_REGISTER_SYSTEM_ALREADY_REGISTERED,
  BT_NOTIFY_RESULT_REGISTER_REPEATED_REGISTRATION,
  BT_NOTIFY_RESULT_REGISTER_NOT_IMPLEMENTED,
  BT_NOTIFY_RESULT_REGISTER_OK,
  BT_NOTIFY_RESULT_NO_ERROR = BT_NOTIFY_RESULT_REGISTER_OK
}
 This structure defines the Bluetooth notification service results. More...
 
enum  bt_notify_data_source_t {
  BT_NOTIFY_DATA_SOURCE_INVALID = 0x00,
  BT_NOTIFY_DATA_SOURCE_SPP = 0x01,
  BT_NOTIFY_DATA_SOURCE_DOGP = 0x02
}
 This structure defines the data transfer mode, SPP or DOGP mode. More...
 

Typedef Documentation

typedef void(* bt_notify_callback_t) (void *data)

Defines the callback function type.

The callback function type.

Enumeration Type Documentation

Define the action type of the notification received from a remote device.

Enumerator
BT_NOTIFY_ACTION_TYPE_NEW 

The action type to add a new notification.

BT_NOTIFY_ACTION_TYPE_DELETE 

The action type to delete a notification.

This structure defines the data transfer mode, SPP or DOGP mode.

Enumerator
BT_NOTIFY_DATA_SOURCE_INVALID 

Invalid value.

BT_NOTIFY_DATA_SOURCE_SPP 

Data transfer in the SPP mode.

BT_NOTIFY_DATA_SOURCE_DOGP 

Data transfer in the DOGP mode.

The structure defines the Bluetooth notification service indication event.

Enumerator
BT_NOTIFY_EVENT_NONE 

Invalid event.

BT_NOTIFY_EVENT_CONNECTION 

Connection indication event.

BT_NOTIFY_EVENT_DISCONNECTION 

Disconnection indication event.

BT_NOTIFY_EVENT_SEND_IND 

The event indicating that the data could be sent.

BT_NOTIFY_EVENT_DATA_RECEIVED 

Data received event.

BT_NOTIFY_EVENT_NOTIFICATION 

Generic notification.

BT_NOTIFY_EVENT_MISSED_CALL 

Missed call notification event.

BT_NOTIFY_EVENT_SMS 

SMS notification event.

BT_NOTIFY_EVENT_END 

The end of event definition.

Define the remote device system type.

Enumerator
BT_NOTIFY_REMOTE_SYSTEM_NONE 

Invalid value.

BT_NOTIFY_REMOTE_SYSTEM_ANDROID 

The remote device is an Android device.

BT_NOTIFY_REMOTE_SYSTEM_IOS 

The remote device is an iOS device.

This structure defines the Bluetooth notification service results.

Enumerator
BT_NOTIFY_RESULT_NOT_SUPPORTED 

Not supported.

BT_NOTIFY_RESULT_INVALID_PARAMETER 

Invalid parameter.

BT_NOTIFY_RESULT_PARSING_ERROR 

Notification parsing error.

BT_NOTIFY_RESULT_CHANNAL_UNAVAILABLE 

No available channel.

BT_NOTIFY_RESULT_FAILED 

Failed.

BT_NOTIFY_RESULT_REGISTER_INVALID_PARAMETER 

Invalid parameter is given during the registration.

BT_NOTIFY_RESULT_REGISTER_SYSTEM_ALREADY_REGISTERED 

The command type (DATA, SYNC, ACKY, ACKN, VERN) have already registered in the service,.

BT_NOTIFY_RESULT_REGISTER_REPEATED_REGISTRATION 

Repeated registration from the same sender with the same customized command.

BT_NOTIFY_RESULT_REGISTER_NOT_IMPLEMENTED 

Not implemented yet.

BT_NOTIFY_RESULT_REGISTER_OK 

Registration is successful.

BT_NOTIFY_RESULT_NO_ERROR 

Success.