HTS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_HTSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	This function is used to write the characteristic (which is identified by charIndex) value attribute in the server. More...
cy_en_ble_api_result_t	Cy_BLE_HTSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex)
	This function is used to read a characteristic value, which is a value identified by charIndex, from the server. More...
cy_en_ble_api_result_t	Cy_BLE_HTSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex, cy_en_ble_hts_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	This function is used to write the characteristic descriptor to the server, which is identified by charIndex and descrIndex. More...
cy_en_ble_api_result_t	Cy_BLE_HTSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex, cy_en_ble_hts_descr_index_t descrIndex)
	Gets the characteristic descriptor of the specified characteristic of the service. More...

Function Documentation

Cy_BLE_HTSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_HTSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

This function is used to write the characteristic (which is identified by charIndex) value attribute in the server.

As a result a Write Request is sent to the GATT Server and on successful execution of the request on the server side, the CY_BLE_EVT_HTSS_WRITE_CHAR event is generated. On successful request execution on the server side, the Write Response is sent to the client.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic.
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the characteristic 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	Connection with the server is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Events

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

• CY_BLE_EVT_HTSC_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_hts_descr_value_t.

Otherwise (if a HTS 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 an event parameter structure cy_stc_ble_gatt_err_param_t.

Cy_BLE_HTSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_HTSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex
	)

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

Parameters

connHandle	The connection handle.
charIndex	The index of a service characteristic of type cy_en_ble_hts_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 HTS service-specific callback is registered (with Cy_BLE_HTS_RegisterAttrCallback):

• CY_BLE_EVT_HTSC_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_hts_char_value_t.

Otherwise (if a HTS 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_HTSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_HTSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex,
		cy_en_ble_hts_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

This function is used to write the characteristic descriptor to the server, which is identified by charIndex and descrIndex.

Internally, 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_HTSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_HTSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_HTSS_INDICATION_ENABLED
• CY_BLE_EVT_HTSS_INDICATION_DISABLED

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic.
descrIndex	The index of the service characteristic descriptor.
attrSize	The size of the characteristic 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	Connection with the server is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Events

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

• CY_BLE_EVT_HTSC_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_hts_descr_value_t.

Otherwise (if a HTS 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 an event parameter structure cy_stc_ble_gatt_err_param_t.

Cy_BLE_HTSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_HTSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex,
		cy_en_ble_hts_descr_index_t	descrIndex
	)

Gets the characteristic descriptor of the specified characteristic of the service.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic.
descrIndex	The index of the service characteristic descriptor.

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.

Events

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

• CY_BLE_EVT_HTSC_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_hts_descr_value_t.

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