SF BLE On-Board Profile Framework Interface

RTOS-integrated SF BLE On-Board Profile Framework Interface. More...

Data Structures
struct	sf_ble_onboard_profile_cccd_changed_t
struct	sf_ble_attr_info_t
struct	sf_ble_long_attr_info_t
struct	sf_ble_onboard_profile_cfg_t
struct	sf_ble_onboard_profile_ctrl_t
struct	sf_ble_onboard_profile_api_t
struct	sf_ble_onboard_profile_instance_t

Macros
#define	SF_BLE_ONBOARD_PROFILE_API_VERSION_MAJOR   (2U)
#define	SF_BLE_ONBOARD_PROFILE_API_VERSION_MINOR   (0U)
#define	SF_BLE_ATTM_MAX_VALUE   (0x18)

Typedefs
typedef void(*	sf_ble_profile_callback_t) (sf_ble_event_info_t *ev)

Enumerations
enum	sf_onbp_t {   SF_ONBP_ANS_SERVER, SF_ONBP_ANS_CLIENT, SF_ONBP_BAS_SERVER, SF_ONBP_BPS_SERVER,   SF_ONBP_BPS_CLIENT, SF_ONBP_CTS_SERVER, SF_ONBP_DIS_SERVER, SF_ONBP_FMP_SERVER,   SF_ONBP_FMP_CLIENT, SF_ONBP_HTP_SERVER, SF_ONBP_HTP_CLIENT, SF_ONBP_HRS_SERVER,   SF_ONBP_HRS_CLIENT, SF_ONBP_HID_SERVER, SF_ONBP_HID_BHOST_CLIENT, SF_ONBP_HID_RHOST_CLIENT,   SF_ONBP_IMA_SERVER, SF_ONBP_LLS_SERVER, SF_ONBP_LLS_CLIENT, SF_ONBP_NDCS_SERVER,   SF_ONBP_PAPS_SERVER, SF_ONBP_PAPS_CLIENT, SF_ONBP_PXP_SERVER, SF_ONBP_PXP_CLIENT,   SF_ONBP_RTUS_SERVER, SF_ONBP_SCPS_SERVER, SF_ONBP_SCPS_CLIENT, SF_ONBP_TIP_SERVER,   SF_ONBP_TIP_CLIENT, SF_ONBP_TXP_SERVER }
enum	sf_ble_prf_sec_t {   SF_BLE_PRF_SEC_NONE = 0x01, SF_BLE_PRF_SEC_UNAUTH = 0x02, SF_BLE_PRF_SEC_AUTH = 0x04, SF_BLE_PRF_SEC_AUTZ = 0x08,   SF_BLE_PRF_SEC_ENC = 0x10 }
enum	sf_ble_onbp_char_t {   SF_BLE_ONBP_CHAR_HRP_HRCP, SF_BLE_ONBP_CHAR_HRP_CCCD_NTF_HRMEAS, SF_BLE_ONBP_CHAR_HRP_BSL, SF_BLE_ONBP_CHAR_ANP_SUP_NEW_ALERT,   SF_BLE_ONBP_CHAR_ANP_CCCD_NTF_NEW_ALERT, SF_BLE_ONBP_CHAR_ANP_SUP_UNREAD_ALERT, SF_BLE_ONBP_CHAR_ANP_CCCD_NTF_UNREAD_ALERT_STATUS, SF_BLE_ONBP_CHAR_ANP_ALERT_NOTIFICATION_CTRL_POINT,   SF_BLE_ONBP_CHAR_DIS_MANUF, SF_BLE_ONBP_CHAR_DIS_MODEL, SF_BLE_ONBP_CHAR_DIS_SERNB, SF_BLE_ONBP_CHAR_DIS_HWREV,   SF_BLE_ONBP_CHAR_DIS_FWREV, SF_BLE_ONBP_CHAR_DIS_SWREV, SF_BLE_ONBP_CHAR_DIS_SYSID, SF_BLE_ONBP_CHAR_DIS_IEEE,   SF_BLE_ONBP_CHAR_DIS_PNPID, SF_BLE_ONBP_CHAR_IAS_ALERT_LEVEL, SF_BLE_ONBP_CHAR_SCPS_CCCD_NTF_SCAN_REFRESH, SF_BLE_ONBP_CHAR_SCPS_SCAN_INTERVAL_WINDOW,   SF_BLE_ONBP_CHAR_CTS_CCCD_NTF_CURRENT_TIME, SF_BLE_ONBP_CHAR_CTS_CCCD_NTF_CURRENT_TIME_VALUE, SF_BLE_ONBP_CHAR_CTS_LOCAL_TIME_INFORMATION, SF_BLE_ONBP_CHAR_CTS_REFERENCE_TIME_INFORMATION,   SF_BLE_ONBP_CHAR_NDCS_TIME_WITH_DST, SF_BLE_ONBP_CHAR_TIME_UPDATE_CONTROL_POINT, SF_BLE_ONBP_CHAR_TIME_UPDATE_STATE, SF_BLE_ONBP_CHAR_CCCD_NTF_CURRENT_TIME,   SF_BLE_ONBP_CHAR_CCCD_NTF_BATTERY_LEVEL, SF_BLE_ONBP_CHAR_PXPM_SET_ALERT, SF_BLE_ONBP_CHAR_PXPM_GET_ALERT_LVL, SF_BLE_ONBP_CHAR_PXPM_GET_TX_POWER_LVL,   SF_BLE_ONBP_CHAR_HTP_TEMP_MEAS_IND, SF_BLE_ONBP_CHAR_HTP_INTERM_TEMP_NTF, SF_BLE_ONBP_CHAR_HTP_MEAS_INTV_IND, SF_BLE_ONBP_CHAR_HTP_TEMP_TYPE,   SF_BLE_ONBP_CHAR_HTP_MEAS_INTV, SF_BLE_ONBP_CHAR_HTP_MEAS_INTV_RANGE, SF_BLE_ONBP_CHAR_CCCD_NTF_REPORT_INPUT, SF_BLE_ONBP_CHAR_CCCD_NTF_KB_INPUT_REPORT,   SF_BLE_ONBP_CHAR_CCCD_NTF_KB_INPUT_REPORT_VALUE, SF_BLE_ONBP_CHAR_CCCD_NTF_KB_OUTPUT_REPORT_VALUE, SF_BLE_ONBP_CHAR_CCCD_NTF_MOUSE_INPUT_REPORT, SF_BLE_ONBP_CHAR_CCCD_NTF_MOUSE_INPUT_REPORT_VALUE,   SF_BLE_ONBP_CHAR_PROTOCOL_MODE, SF_BLE_ONBP_CHAR_CONTROL_POINT, SF_BLE_ONBP_CHAR_BLP_CCCD_NTF_INTERM_CUFPRS, SF_BLE_ONBP_CHAR_BLP_CCCD_IND_BLDPRS_MEAS,   SF_BLE_ONBP_CHAR_BLP_RD_BLS_BF, SF_BLE_ONBP_CHAR_CCCD_NTF_ALERT_STATUS, SF_BLE_ONBP_CHAR_CCCD_NTF_ALERT_STATUS_VALUE, SF_BLE_ONBP_CHAR_CCCD_NTF_RINGER_SETTING,   SF_BLE_ONBP_CHAR_CCCD_NTF_RINGER_SETTING_VALUE, SF_BLE_ONBP_CHAR_RINGER_CONTROL_POINT }
enum	sf_ble_cccd_val_t { SF_BLE_CCCD_VAL_STOP_NTFIND, SF_BLE_CCCD_VAL_START_NTF, SF_BLE_CCCD_VAL_START_IND }

Detailed Description

RTOS-integrated SF BLE On-Board Profile Framework Interface.

Summary

This SSP Interface provides access to the ThreadX-aware SF BLE On-Board Profile Framework.

Macro Definition Documentation

SF_BLE_ATTM_MAX_VALUE

#define SF_BLE_ATTM_MAX_VALUE   (0x18)

GATT Attribute Length

SF_BLE_ONBOARD_PROFILE_API_VERSION_MAJOR

#define SF_BLE_ONBOARD_PROFILE_API_VERSION_MAJOR   (2U)

SSP BSP Include files Framework Include files Major Version of the API defined in this file

SF_BLE_ONBOARD_PROFILE_API_VERSION_MINOR

#define SF_BLE_ONBOARD_PROFILE_API_VERSION_MINOR   (0U)

Minor Version of the API defined in this file

Typedef Documentation

sf_ble_profile_callback_t

typedef void(* sf_ble_profile_callback_t) (sf_ble_event_info_t *ev)

User callback type for profile

Enumeration Type Documentation

sf_ble_cccd_val_t

enum sf_ble_cccd_val_t

Value for BLE CCCD Configuration

Enumerator
SF_BLE_CCCD_VAL_STOP_NTFIND	Stop Notification Indication.
SF_BLE_CCCD_VAL_START_NTF	Start Notification.
SF_BLE_CCCD_VAL_START_IND	Start Indication.

sf_ble_onbp_char_t

enum sf_ble_onbp_char_t

On-Board Profile GATT Characteristics Code

Enumerator
SF_BLE_ONBP_CHAR_HRP_HRCP	Heart Rate Control Point Characteristics (Property: Write), Refer sf_ble_prf_hrp_api_hrcp_t. Heart Rate Profile
SF_BLE_ONBP_CHAR_HRP_CCCD_NTF_HRMEAS	Heart Rate Measurement CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_hrp_api_hrmeas_t.
SF_BLE_ONBP_CHAR_HRP_BSL	Heart Rate Body Sensor Location Characteristics (Property: Read)
SF_BLE_ONBP_CHAR_ANP_SUP_NEW_ALERT	Supported New Alert Category Characteristics (Property: Read) Alert Notification Profile
SF_BLE_ONBP_CHAR_ANP_CCCD_NTF_NEW_ALERT	New Alert CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_anp_api_new_alert_ntf_t.
SF_BLE_ONBP_CHAR_ANP_SUP_UNREAD_ALERT	Supported Unread Alert Category Characteristics (Property: Read)
SF_BLE_ONBP_CHAR_ANP_CCCD_NTF_UNREAD_ALERT_STATUS	Unread Alert Status CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_anp_api_unread_alert_ntf_t.
SF_BLE_ONBP_CHAR_ANP_ALERT_NOTIFICATION_CTRL_POINT	Alert Notification Control Point (Property: Write), Refer sf_ble_anp_ancp_t.
SF_BLE_ONBP_CHAR_DIS_MANUF	Device Information Service Manufacturer Name String (Property: Read) Device Information Service Profile
SF_BLE_ONBP_CHAR_DIS_MODEL	Device Information Service Model Number String (Property: Read)
SF_BLE_ONBP_CHAR_DIS_SERNB	Device Information Service Serial number String (Property: Read)
SF_BLE_ONBP_CHAR_DIS_HWREV	Device Information Service HW Revision String (Property: Read)
SF_BLE_ONBP_CHAR_DIS_FWREV	Device Information Service Fw Revision String (Property: Read)
SF_BLE_ONBP_CHAR_DIS_SWREV	Device Information Service SW Revision String (Property: Read)
SF_BLE_ONBP_CHAR_DIS_SYSID	Device Information Service system ID (Property: Read)
SF_BLE_ONBP_CHAR_DIS_IEEE	Device Information Service IEEE Certification (Property: Read)
SF_BLE_ONBP_CHAR_DIS_PNPID	Device Information PNPID, Used in services like HOGP (Property: Read)
SF_BLE_ONBP_CHAR_IAS_ALERT_LEVEL	Alert Level (Property: Write), Refer sf_ble_prf_ias_alert_type_t. Immediate Alert Service Profile
SF_BLE_ONBP_CHAR_SCPS_CCCD_NTF_SCAN_REFRESH	Scan Refresh CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_prf_scps_scan_refresh_t. Scan Parameters Service Profile
SF_BLE_ONBP_CHAR_SCPS_SCAN_INTERVAL_WINDOW	Scan Interval Window (Property: Write), Refer sf_ble_prf_scps_scan_intv_t.
SF_BLE_ONBP_CHAR_CTS_CCCD_NTF_CURRENT_TIME	Current Time CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_cts_curr_time_ntf_t. Current Time Service Profile
SF_BLE_ONBP_CHAR_CTS_CCCD_NTF_CURRENT_TIME_VALUE	Used to read data for current time through read characteristics.
SF_BLE_ONBP_CHAR_CTS_LOCAL_TIME_INFORMATION	Local Time Information (Property: Read)
SF_BLE_ONBP_CHAR_CTS_REFERENCE_TIME_INFORMATION	Reference Time Information (Property: Read)
SF_BLE_ONBP_CHAR_NDCS_TIME_WITH_DST	Time with DST (Property: Read) Next DST Change Service Profile
SF_BLE_ONBP_CHAR_TIME_UPDATE_CONTROL_POINT	Time Update Control Point (Property: Write), Refer sf_ble_prf_rtus_time_updt_state_t. Reference Time Update Service Profile
SF_BLE_ONBP_CHAR_TIME_UPDATE_STATE	Time Update State (Property: Read)
SF_BLE_ONBP_CHAR_CCCD_NTF_CURRENT_TIME	Current Time CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_bas_battery_lvl_ntf_t. Time Information Service Profile
SF_BLE_ONBP_CHAR_CCCD_NTF_BATTERY_LEVEL	Battery Level (Property: NTF, Read, Write), Refer sf_ble_prf_bas_battery_lvl_t. Battery Service Profile
SF_BLE_ONBP_CHAR_PXPM_SET_ALERT	PXP Alert char. Alert Level Service Profile
SF_BLE_ONBP_CHAR_PXPM_GET_ALERT_LVL	PXP Get Alert Level.
SF_BLE_ONBP_CHAR_PXPM_GET_TX_POWER_LVL	PXP Get TX Power Level.
SF_BLE_ONBP_CHAR_HTP_TEMP_MEAS_IND	HTPC temp. measurement indication CCCD Characteristics (Property: IND, Read, Write), Refer. Health Thermometer Profile
SF_BLE_ONBP_CHAR_HTP_INTERM_TEMP_NTF	HTPC intermediate temp. notification CCCD Characteristics (Property: NTF, Read, Write), Refer.
SF_BLE_ONBP_CHAR_HTP_MEAS_INTV_IND	HTPC temp. measurement interval indication CCCD Characteristics (Property: IND, Read, Write), Refer.
SF_BLE_ONBP_CHAR_HTP_TEMP_TYPE	HTPC temp. temperature type(Property: Read)
SF_BLE_ONBP_CHAR_HTP_MEAS_INTV	HTPC temp. measurement interval.
SF_BLE_ONBP_CHAR_HTP_MEAS_INTV_RANGE	HTPC temp. measurement interval valid range.
SF_BLE_ONBP_CHAR_CCCD_NTF_REPORT_INPUT	Report Input CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_prf_hid_report_desc_t. HID Over GATT Service Profile
SF_BLE_ONBP_CHAR_CCCD_NTF_KB_INPUT_REPORT	Keyboard Input Report CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_prf_hid_report_desc_t.
SF_BLE_ONBP_CHAR_CCCD_NTF_KB_INPUT_REPORT_VALUE	Used to read Keyboard Input record value through read characteristics.
SF_BLE_ONBP_CHAR_CCCD_NTF_KB_OUTPUT_REPORT_VALUE	Used to read Keyboard Output record value through read characteristics.
SF_BLE_ONBP_CHAR_CCCD_NTF_MOUSE_INPUT_REPORT	Mouse Input Report CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_prf_hid_report_desc_t.
SF_BLE_ONBP_CHAR_CCCD_NTF_MOUSE_INPUT_REPORT_VALUE	Used to read Mouse Input record value through read characteristics.
SF_BLE_ONBP_CHAR_PROTOCOL_MODE	HID boot host protocol mode (Property: Read, Write), Refer sf_ble_prf_hid_protocol_mode_t.
SF_BLE_ONBP_CHAR_CONTROL_POINT	HID report host write control point (Property: Read, Write), Refer sf_ble_prf_hid_ctrl_point_val_t.
SF_BLE_ONBP_CHAR_BLP_CCCD_NTF_INTERM_CUFPRS	Read Cuff Pressure measurement CCCD Characteristics (Property: NTF, Read, Write), Refer sf_ble_blp_meas_info_t. Blood Pressure profile
SF_BLE_ONBP_CHAR_BLP_CCCD_IND_BLDPRS_MEAS	Blood Pressure Measurement CCCD Characteristics (Property: IND, Read, Write), Refer sf_ble_blp_meas_info_t.
SF_BLE_ONBP_CHAR_BLP_RD_BLS_BF	Read Blood Pressure Feature.
SF_BLE_ONBP_CHAR_CCCD_NTF_ALERT_STATUS	Alert Status (Property: NTF, Read, Write), Refer sf_ble_prf_alert_status. Phone Alert Status Service Profile
SF_BLE_ONBP_CHAR_CCCD_NTF_ALERT_STATUS_VALUE	Used to read Alert Status value through read characteristics.
SF_BLE_ONBP_CHAR_CCCD_NTF_RINGER_SETTING	Ringer Settings (Property: NTF, Read, Write), Refer sf_ble_prf_ringer_setting_t.
SF_BLE_ONBP_CHAR_CCCD_NTF_RINGER_SETTING_VALUE	Used to read Ringer Settings value through read characteristics.
SF_BLE_ONBP_CHAR_RINGER_CONTROL_POINT	PAPS Ringer control point write characteristics.

sf_ble_prf_sec_t

enum sf_ble_prf_sec_t

BLE Profile Security type

Enumerator
SF_BLE_PRF_SEC_NONE	No Security.
SF_BLE_PRF_SEC_UNAUTH	Unauthenticated Pairing.
SF_BLE_PRF_SEC_AUTH	Authenticated pairing.
SF_BLE_PRF_SEC_AUTZ	Requires Authorized.
SF_BLE_PRF_SEC_ENC	Encrypted communication.

sf_onbp_t

enum sf_onbp_t

BLE On-Board Profile types

Enumerator
SF_ONBP_ANS_SERVER	Alert Notification Service Server.
SF_ONBP_ANS_CLIENT	Alert Notification Service Client.
SF_ONBP_BAS_SERVER	Battery Service Server.
SF_ONBP_BPS_SERVER	Blood Pressure Service Server.
SF_ONBP_BPS_CLIENT	Blood Pressure Service Client.
SF_ONBP_CTS_SERVER	Current Time Service Server.
SF_ONBP_DIS_SERVER	Device Information Service Server.
SF_ONBP_FMP_SERVER	Find Me Service Server.
SF_ONBP_FMP_CLIENT	Find Me Service Client.
SF_ONBP_HTP_SERVER	Health Thermometer Service Server.
SF_ONBP_HTP_CLIENT	Health Thermometer Service Client.
SF_ONBP_HRS_SERVER	Heart Rate Service Server.
SF_ONBP_HRS_CLIENT	Heart Rate Service Client.
SF_ONBP_HID_SERVER	HID Over GATT Service Server.
SF_ONBP_HID_BHOST_CLIENT	HID Over GATT Boot Host Service Client.
SF_ONBP_HID_RHOST_CLIENT	HID Over GATT Report Host Service Client.
SF_ONBP_IMA_SERVER	Immediate Alert Service Server.
SF_ONBP_LLS_SERVER	Link Loss Service Server.
SF_ONBP_LLS_CLIENT	Link Loss Service Client.
SF_ONBP_NDCS_SERVER	Next Daylight Savings Change Service Server.
SF_ONBP_PAPS_SERVER	Phone Alert Service Server.
SF_ONBP_PAPS_CLIENT	Phone Alert Service Client.
SF_ONBP_PXP_SERVER	Proximity Service Server.
SF_ONBP_PXP_CLIENT	Proximity Service Client.
SF_ONBP_RTUS_SERVER	Reference Time Update Service Server.
SF_ONBP_SCPS_SERVER	Scan Parameter Service Server.
SF_ONBP_SCPS_CLIENT	Scan Parameter Service Client.
SF_ONBP_TIP_SERVER	Time Information Service Server.
SF_ONBP_TIP_CLIENT	Time Information Service Client.
SF_ONBP_TXP_SERVER	Transmit Power Service Server.