#include <sf_ble_onboard_profile_api.h>

Data Fields
ssp_err_t(*	open )(sf_ble_onboard_profile_ctrl_t const p_ctrl, const sf_ble_onboard_profile_cfg_t p_cfg)
	Initializes the interface for data transfers. More...

ssp_err_t(*	close )(sf_ble_onboard_profile_ctrl_t *const p_ctrl)
	De-initialize the interface and may put it in low power mode or power it off. Close the driver, disable the driver link, disable interrupt. More...

ssp_err_t(*	onbpEnable )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile, sf_ble_profile_callback_t p_prf_cb, sf_ble_prf_sec_t sec)
	Enable On-Board Profile Enables On-Board profile on given connection handle with specified security type. Registers user callback for the profile. More...

ssp_err_t(*	onbpDisable )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile)
	Disable On-Board Profile Disables On-Board profile on given connection handle and unregisters user callback. More...

ssp_err_t(*	onbpServerWriteData )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)
	Update Server Local Database Update Local GATT database of Profile Server. More...

ssp_err_t(*	onbpServerSendNotification )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)
	Send notification from Server Sends Notification which will be data specific to On-Board Profile to Client. More...

ssp_err_t(*	onbpServerSendIndication )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)
	Send Indication from Server Sends Indication which contains profile specific data to client. More...

ssp_err_t(*	onbpClientWriteCCCD )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile, sf_ble_onbp_char_t cccd_char, sf_ble_cccd_val_t cccd_val)
	Writes CCCD configuration in Server This API writes CCCD configuration of Server and which enables or disables notification or indication from server. More...

ssp_err_t(*	onbpClientWriteChar )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)
	Writes GATT characteristics with data passed Writes the GATT characteristics in the Server with the data passed. More...

ssp_err_t(*	onbpClientReadChar )(sf_ble_onboard_profile_ctrl_t const p_ctrl, sf_ble_conn_handle_t p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics)
	Reads GATT characteristics from Server Reads GATT characteristics from the Server for the profile specified. More...

ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Gets version and stores it in provided pointer p_version. More...

Detailed Description

BLE Configuration, Control and API structures Framework API structure. Implementations will use the following API.

Field Documentation

◆ close

ssp_err_t(* sf_ble_onboard_profile_api_t::close) (sf_ble_onboard_profile_ctrl_t *const p_ctrl)

De-initialize the interface and may put it in low power mode or power it off. Close the driver, disable the driver link, disable interrupt.

Parameters

[in] p_ctrl Pointer to the control block for the BLE module.

◆ onbpClientReadChar

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpClientReadChar) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics)

Reads GATT characteristics from Server Reads GATT characteristics from the Server for the profile specified.

Parameters

[in]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Profile type
[in]	characteristics	Profile characteristics

◆ onbpClientWriteCCCD

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpClientWriteCCCD) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile, sf_ble_onbp_char_t cccd_char, sf_ble_cccd_val_t cccd_val)

Writes CCCD configuration in Server This API writes CCCD configuration of Server and which enables or disables notification or indication from server.

Parameters

[in]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Parameter_Description
[in]	cccd_char	CCCD Code
[in]	cccd_val	Configuration data of CCCD

◆ onbpClientWriteChar

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpClientWriteChar) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)

Writes GATT characteristics with data passed Writes the GATT characteristics in the Server with the data passed.

Parameters

[in]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Profile type
[in]	characteristics	GATT characteristics code
[in]	p_data	Pointer to data

◆ onbpDisable

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpDisable) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile)

Disable On-Board Profile Disables On-Board profile on given connection handle and unregisters user callback.

Parameters

[in]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Profile type to disable

◆ onbpEnable

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpEnable) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile, sf_ble_profile_callback_t p_prf_cb, sf_ble_prf_sec_t sec)

Enable On-Board Profile Enables On-Board profile on given connection handle with specified security type. Registers user callback for the profile.

Parameters

[in,out]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Profile type to enable
[in]	p_prf_cb	User callback for Profile
[in]	sec	Security type for profile

◆ onbpServerSendIndication

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpServerSendIndication) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)

Send Indication from Server Sends Indication which contains profile specific data to client.

Parameters

[in]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Profile type
[in]	characteristics	Profile characteristics
[in]	p_data	Pointer to data

◆ onbpServerSendNotification

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpServerSendNotification) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)

Send notification from Server Sends Notification which will be data specific to On-Board Profile to Client.

Parameters

[in]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Profile type
[in]	characteristics	Profile characteristics
[in]	p_data	Pointer to data

◆ onbpServerWriteData

ssp_err_t(* sf_ble_onboard_profile_api_t::onbpServerWriteData) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, sf_ble_conn_handle_t *p_handle, sf_onbp_t profile, sf_ble_onbp_char_t characteristics, const void *p_data)

Update Server Local Database Update Local GATT database of Profile Server.

Parameters

[in]	p_ctrl	Pointer to control structure for BLE
[in]	p_handle	Pointer to connection handle
[in]	profile	Profile type
[in]	characteristics	Profile characteristics
[in]	p_data	Pointer to data

◆ open

ssp_err_t(* sf_ble_onboard_profile_api_t::open) (sf_ble_onboard_profile_ctrl_t *const p_ctrl, const sf_ble_onboard_profile_cfg_t *p_cfg)

Initializes the interface for data transfers.

Initial driver configuration, enable the driver link, enable interrupts and make device ready for data transfer.

Parameters

[in,out]	p_ctrl	Pointer to user-provided storage for the control block.
[in]	p_cfg	Pointer to BLE configuration structure.

◆ versionGet

ssp_err_t(* sf_ble_onboard_profile_api_t::versionGet) (ssp_version_t *const p_version)

Gets version and stores it in provided pointer p_version.

Parameters

[out] p_version pointer to memory location to return version number

The documentation for this struct was generated from the following file:

sf_ble_onboard_profile_api.h

Data Fields

Detailed Description

Field Documentation

◆ close

◆ onbpClientReadChar

◆ onbpClientWriteCCCD

◆ onbpClientWriteChar

◆ onbpDisable

◆ onbpEnable

◆ onbpServerSendIndication

◆ onbpServerSendNotification

◆ onbpServerWriteData

◆ open

◆ versionGet