TPS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_TPSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_tps_char_index_t charIndex)
	Gets the characteristic value of the Tx Power service, which is identified by charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_TPSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_tps_char_index_t charIndex, cy_en_ble_tps_char_descriptors_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets a characteristic descriptor value of the Tx Power service. More...
cy_en_ble_api_result_t	Cy_BLE_TPSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_tps_char_index_t charIndex, cy_en_ble_tps_char_descriptors_t descrIndex)
	Gets a characteristic descriptor of the Tx Power service. More...

Function Documentation

Cy_BLE_TPSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_TPSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_tps_char_index_t	charIndex
	)

Gets the characteristic value of the Tx Power service, which is identified by charIndex.

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

• CY_BLE_EVT_TPSC_READ_CHAR_RESPONSE
• CY_BLE_EVT_GATTC_ERROR_RSP

Parameters

connHandle	The connection handle.
charIndex	The index of the characteristic.

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 TPS service-specific callback is registered (with Cy_BLE_TPS_RegisterAttrCallback):

• CY_BLE_EVT_TPSC_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_tps_char_value_t.

Otherwise (if a TPS 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_TPSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_TPSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_tps_char_index_t	charIndex,
		cy_en_ble_tps_char_descriptors_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets a characteristic descriptor value of the Tx Power service.

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_TPSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_TPSS_NOTIFICATION_DISABLED

Parameters

connHandle	The connection handle.
charIndex	The index of the Characteristic
descrIndex	The index of the TX Power service characteristic descriptor.
attrSize	The size of the characteristic descriptor 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 TPS service-specific callback is registered with Cy_BLE_TPS_RegisterAttrCallback():

• CY_BLE_EVT_TPSC_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_tps_descr_value_t.

Otherwise (if a TPS 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_TPSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_TPSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_tps_char_index_t	charIndex,
		cy_en_ble_tps_char_descriptors_t	descrIndex
	)

Gets a characteristic descriptor of the Tx Power service.

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

• CY_BLE_EVT_TPSC_READ_DESCR_RESPONSE
• CY_BLE_EVT_GATTC_ERROR_RSP

Parameters

connHandle	The connection handle.
charIndex	The index of the characteristic.
descrIndex	The index of the 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 TPS service-specific callback is registered (with Cy_BLE_TPS_RegisterAttrCallback):

• CY_BLE_EVT_TPSC_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_tps_descr_value_t.

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