RTUS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_RTUSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_rtus_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_RTUSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_rtus_char_index_t charIndex)
	Sends a request to a peer device to set characteristic value of the Reference Time Update service, which is identified by charIndex. More...

Function Documentation

Cy_BLE_RTUSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_RTUSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_rtus_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_RTUSS_WRITE_CHAR_CMD 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_INVALID_STATE	Connection with the server is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Cy_BLE_RTUSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_RTUSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_rtus_char_index_t	charIndex
	)

Sends a request to a peer device to set characteristic value of the Reference Time Update 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 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.

Events

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

• CY_BLE_EVT_RTUSC_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_rtus_char_value_t.

Otherwise (if the RTUS 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).