DIS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_DISC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_dis_char_index_t charIndex)
	This function is used to read the characteristic Value from a server which is identified by charIndex. More...

Function Documentation

Cy_BLE_DISC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_DISC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_dis_char_index_t	charIndex
	)

This function is used to read the characteristic Value from a server which is identified by charIndex.

The Read Response returns the characteristic value in the Attribute Value parameter. The Read Response only contains the characteristic value that is less than or equal to (MTU - 1) octets in length. If the characteristic value is greater than (MTU - 1) octets in length, a Read Long Characteristic Value procedure may be used if the rest of the characteristic value is required.

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

• CY_BLE_EVT_DISC_READ_CHAR_RESPONSE
• CY_BLE_EVT_GATTC_ERROR_RSP

Parameters

connHandle	The connection handle.
charIndex	The index of a service characteristic of type cy_en_ble_dis_char_index_t.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The Read 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 the DIS service-specific callback is registered (with Cy_BLE_DIS_RegisterAttrCallback):

• CY_BLE_EVT_DISC_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_dis_char_value_t.

Otherwise (if a DIS 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.