BLS Client Functions

General Description

API unique to BLS designs configured as a GATT Client role.

A letter 'c' is appended to the API name: Cy_BLE_BLSC_

Functions
cy_en_ble_api_result_t	Cy_BLE_BLSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bls_char_index_t charIndex)
	This function is used to read the characteristic value from the server identified by charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_BLSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bls_char_index_t charIndex, cy_en_ble_bls_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends a request to set the characteristic descriptor of the specified Blood Pressure service characteristic to the server device. More...
cy_en_ble_api_result_t	Cy_BLE_BLSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bls_char_index_t charIndex, cy_en_ble_bls_descr_index_t descrIndex)
	Sends a request to get the characteristic descriptor of the specified Blood Pressure service characteristic from the server device. More...

Function Documentation

Cy_BLE_BLSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_BLSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_bls_char_index_t	charIndex
	)

This function is used to read the characteristic value from the server identified by charIndex.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_bls_char_index_t. The valid values are, CY_BLE_BLS_BPM CY_BLE_BLS_ICP CY_BLE_BLS_BPF

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was sent successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_INVALID_OPERATION	Operation is invalid for this characteristic.
CY_BLE_ERROR_INVALID_STATE	Connection with the server is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.

Events

If execution is successful(return value = CY_BLE_SUCCESS) these events can appear:
If a BLS service-specific callback is registered (with Cy_BLE_BLS_RegisterAttrCallback):

• CY_BLE_EVT_BLSC_READ_CHAR_RESPONSE - if the requested attribute is successfully read on the peer device, the details (charIndex , value, etc.) are provided with an event parameter structure of type cy_stc_ble_bls_char_value_t.

Otherwise (if a BLS service-specific callback is not registered):

• CY_BLE_EVT_GATTC_READ_RSP - if the requested attribute is successfully read on the peer device, the details (handle, value, etc.) are provided with the event parameters structure cy_stc_ble_gattc_read_rsp_param_t.
• CY_BLE_EVT_GATTC_ERROR_RSP - If an error occurred with the requested attribute on the peer device, the details are provided with the event parameters structure cy_stc_ble_gatt_err_param_t.

Cy_BLE_BLSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_BLSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_bls_char_index_t	charIndex,
		cy_en_ble_bls_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends a request to set the characteristic descriptor of the specified Blood Pressure service characteristic to the server device.

Internally, a Write Request is sent to the GATT Server and on successful execution of the request on the server side, the following events can be generated:

• CY_BLE_EVT_BLSS_INDICATION_ENABLED
• CY_BLE_EVT_BLSS_INDICATION_DISABLED
• CY_BLE_EVT_BLSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_BLSS_NOTIFICATION_DISABLED

Parameters

connHandle	The BLE peer device connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_bls_char_index_t. The valid values are, CY_BLE_BLS_BPM CY_BLE_BLS_ICP CY_BLE_BLS_BPF
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_bls_descr_index_t. The valid value is, CY_BLE_BLS_CCCD
attrSize	The size of the characteristic descriptor value attribute.
attrValue	The pointer to the characteristic descriptor value data that should be sent to the server device.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was sent successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_INVALID_OPERATION	Operation is invalid for this characteristic.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
CY_BLE_ERROR_INVALID_STATE	The state is not valid.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Events

If execution is successful(return value = CY_BLE_SUCCESS), the following events can appear:
If a BLS service-specific callback is registered with Cy_BLE_BLS_RegisterAttrCallback():

• CY_BLE_EVT_BLSC_WRITE_DESCR_RESPONSE - if the requested attribute is successfully written on the peer device, the details (charIndex, descrIndex etc.) are provided with an event parameter structure of type cy_stc_ble_bls_descr_value_t.

Otherwise (if the BLS service-specific callback is not registered):

• CY_BLE_EVT_GATTC_WRITE_RSP - if the requested attribute is successfully written on the peer device.
• CY_BLE_EVT_GATTC_ERROR_RSP - If an error occurred with the requested attribute on the peer device, the details are provided with the event parameters structure cy_stc_ble_gatt_err_param_t.

Cy_BLE_BLSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_BLSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_bls_char_index_t	charIndex,
		cy_en_ble_bls_descr_index_t	descrIndex
	)

Sends a request to get the characteristic descriptor of the specified Blood Pressure service characteristic from the server device.

This function call can result in the generation of the following events based on the response from the server device:

• CY_BLE_EVT_BLSC_READ_DESCR_RESPONSE
• CY_BLE_EVT_GATTC_ERROR_RSP

Parameters

connHandle	The BLE peer device connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_bls_char_index_t. The valid values are, CY_BLE_BLS_BPM CY_BLE_BLS_ICP CY_BLE_BLS_BPF
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_bls_descr_index_t. The valid value is, CY_BLE_BLS_CCCD*

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was sent successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_INVALID_OPERATION	This operation is not permitted on the specified attribute.
CY_BLE_ERROR_INVALID_STATE	The state is not valid.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular descriptor.

Events

If execution is successful (return value = CY_BLE_SUCCESS), these events can appear:
If a BLS service-specific callback is registered with Cy_BLE_BLS_RegisterAttrCallback():

• CY_BLE_EVT_BLSC_READ_DESCR_RESPONSE - if the requested attribute is successfully read on the peer device, the details (charIndex, descrIndex, value, etc.) are provided with an event parameter structure of type cy_stc_ble_bls_descr_value_t.

Otherwise (if a BLS service-specific callback is not registered):

• CY_BLE_EVT_GATTC_READ_RSP - if the requested attribute is successfully read on the peer device, the details (handle, value, etc.) are provided with the event parameters structure cy_stc_ble_gattc_read_rsp_param_t.
• CY_BLE_EVT_GATTC_ERROR_RSP - If an error occurred with the requested attribute on the peer device, the details are provided with the event parameters structure cy_stc_ble_gatt_err_param_t.