Synergy Software Package User's Manual
SF BLE Phone Alert Status Profile Framework Interface

RTOS-integrated SF BLE Phone Alert Status Profile Framework Interface. More...

Data Structures

struct  sf_ble_prf_ringer_cp_change_t
 
struct  sf_ble_prf_ringer_setting_ntf_t
 
struct  sf_ble_prf_alert_status_ntf_t
 

Typedefs

typedef uint8_t sf_ble_prf_alert_status
 

Enumerations

enum  sf_ble_prf_papsc_event_t { SF_BLE_PRF_PAPSC_EVENT_NONE, SF_BLE_PRF_PAPSC_EVENT_READ_CHAR_RES, SF_BLE_PRF_PAPSC_EVENT_RINGER_SETTING_IND, SF_BLE_PRF_PAPSC_EVENT_ALERT_STATUS_RES }
 
enum  sf_ble_prf_papss_event_t { SF_BLE_PRF_PAPSS_EVENT_NONE, SF_BLE_PRF_PAPSS_EVENT_RINGER_CP_IND, SF_BLE_PRF_PAPSS_EVENT_CFG_NTF_IND }
 
enum  sf_ble_prf_ringer_cp_t { SF_BLE_PRF_RINGER_CP_SILENT_MODE = 0x01, SF_BLE_PRF_RINGER_CP_MUTE_ONCE, SF_BLE_PRF_RINGER_CP_CANCEL_SILENT_MODE }
 
enum  sf_ble_prf_ringer_setting_t { SF_BLE_PRF_RINGER_SETTING_SILENT, SF_BLE_PRF_RINGER_SETTING_NORMAL }
 
enum  sf_ble_prf_alert_setting_t { SF_BLE_PRF_ALERT_NONE, SF_BLE_PRF_ALERT_RINGER, SF_BLE_PRF_ALERT_VIBRATOR, SF_BLE_PRF_ALERT_DISPLAY }
 

Detailed Description

RTOS-integrated SF BLE Phone Alert Status Profile Framework Interface.

Summary

This SSP Interface provides access to the ThreadX-aware SF BLE Phone Alert Status Profile Framework.

Typedef Documentation

◆ sf_ble_prf_alert_status

typedef uint8_t sf_ble_prf_alert_status

PASP Alert Status

Enumeration Type Documentation

◆ sf_ble_prf_alert_setting_t

PASP Alert status

Enumerator
SF_BLE_PRF_ALERT_NONE 

No active alert.

SF_BLE_PRF_ALERT_RINGER 

Ringer State is active.

SF_BLE_PRF_ALERT_VIBRATOR 

Vibrate State is active.

SF_BLE_PRF_ALERT_DISPLAY 

Display Alert Status State is active.

◆ sf_ble_prf_papsc_event_t

Profile Client user events

Enumerator
SF_BLE_PRF_PAPSC_EVENT_NONE 

Event not supported.

SF_BLE_PRF_PAPSC_EVENT_READ_CHAR_RES 

BLE user event indicating PAPS target alert indication received from locator.

SF_BLE_PRF_PAPSC_EVENT_RINGER_SETTING_IND 

BLE user event indicating PAPS ringer setting indication, Refer sf_ble_prf_ringer_setting_ntf_t.

SF_BLE_PRF_PAPSC_EVENT_ALERT_STATUS_RES 

BLE user event indicating PAPS alert status response, Refer sf_ble_prf_alert_status_ntf_t.

◆ sf_ble_prf_papss_event_t

Profile Server user events

Enumerator
SF_BLE_PRF_PAPSS_EVENT_NONE 

Event not supported.

SF_BLE_PRF_PAPSS_EVENT_RINGER_CP_IND 

BLE user event indicating ringer control point indication, Refer sf_ble_prf_ringer_cp_change_t.

SF_BLE_PRF_PAPSS_EVENT_CFG_NTF_IND 

BLE user event indicating notification indication.

◆ sf_ble_prf_ringer_cp_t

Ringer Control Point value

Enumerator
SF_BLE_PRF_RINGER_CP_SILENT_MODE 

Silent Mode.

SF_BLE_PRF_RINGER_CP_MUTE_ONCE 

Mute Once.

SF_BLE_PRF_RINGER_CP_CANCEL_SILENT_MODE 

Cancel Silent Mode.

◆ sf_ble_prf_ringer_setting_t

Ringer Setting Value

Enumerator
SF_BLE_PRF_RINGER_SETTING_SILENT 

Ringer Silent.

SF_BLE_PRF_RINGER_SETTING_NORMAL 

Ringer Normal.