NDCS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_NDCSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ndcs_char_index_t charIndex)
	Sends a request to peer device to set characteristic value of the Next DST Change service, which is identified by charIndex. More...

Function Documentation

Cy_BLE_NDCSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_NDCSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ndcs_char_index_t	charIndex
	)

Sends a request to peer device to set characteristic value of the Next DST Change service, which is identified by charIndex.

Parameters

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

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_STATE	connection with the client is not established.
CY_BLE_ERROR_INVALID_PARAMETER	validation of the input parameters failed.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_INVALID_OPERATION	Operation is invalid for this characteristic.

Events

In case of successful execution (return value = CY_BLE_SUCCESS) the following events can appear:
If the NDCS service-specific callback is registered (with Cy_BLE_NDCS_RegisterAttrCallback):

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

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

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