ESS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_ESSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ess_char_index_t charIndex, uint8_t charInstance, 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_ESSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ess_char_index_t charIndex, uint8_t charInstance)
	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_ESSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ess_char_index_t charIndex, uint8_t charInstance, cy_en_ble_ess_descr_index_t descrIndex, 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_ESSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ess_char_index_t charIndex, uint8_t charInstance, cy_en_ble_ess_descr_index_t descrIndex)
	Sends a request to get the characteristic descriptor of the specified characteristic of the service. More...
cy_en_ble_api_result_t	Cy_BLE_ESSC_SetLongCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ess_char_index_t charIndex, uint8_t charInstance, cy_en_ble_ess_descr_index_t descrIndex, uint16_t attrSize, uint8_t *attrValue)
	This function is used to write a long characteristic descriptor to the server, which is identified by charIndex and descrIndex. More...
cy_en_ble_api_result_t	Cy_BLE_ESSC_GetLongCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ess_char_index_t charIndex, uint8_t charInstance, cy_en_ble_ess_descr_index_t descrIndex, uint16_t attrSize, uint8_t *attrValue)
	Sends a request to read long characteristic descriptor of the specified characteristic of the service. More...

Function Documentation

Cy_BLE_ESSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_ESSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ess_char_index_t	charIndex,
		uint8_t	charInstance,
		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_ESSS_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 of type cy_en_ble_ess_char_index_t.
charInstance	The instance number of the characteristic specified by "charIndex".
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.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.

Events

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

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

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

• CY_BLE_EVT_GATTC_WRITE_RSP - In case if the requested attribute is successfully written on the peer device.
• 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.

Cy_BLE_ESSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_ESSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ess_char_index_t	charIndex,
		uint8_t	charInstance
	)

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 the service characteristic of type cy_en_ble_ess_char_index_t.
charInstance	The instance number of the characteristic specified by "charIndex".

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_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic is absent.

Events

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

• CY_BLE_EVT_ESSC_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_ess_char_value_t.

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

Cy_BLE_ESSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_ESSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ess_char_index_t	charIndex,
		uint8_t	charInstance,
		cy_en_ble_ess_descr_index_t	descrIndex,
		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_ESSS_DESCR_WRITE event is generated. On successful request execution on the server side, the Write Response is sent to the client.

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_ESSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_ESSS_NOTIFICATION_DISABLED
• CY_BLE_EVT_ESSS_INDICATION_ENABLED
• CY_BLE_EVT_ESSS_INDICATION_DISABLED

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_ess_char_index_t.
charInstance	The instance number of the characteristic specified by "charIndex".
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_ess_descr_index_t.
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	The state is not valid.
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 ESS service-specific callback is registered with Cy_BLE_ESS_RegisterAttrCallback():

• CY_BLE_EVT_ESSC_WRITE_DESCR_RESPONSE - In case if the requested attribute is successfully written on the peer device, the details (charIndex, descr index etc.) are provided with event parameter structure of type cy_stc_ble_ess_descr_value_t.

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

• CY_BLE_EVT_GATTC_WRITE_RSP - In case if the requested attribute is successfully written on the peer device.
• 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.

Cy_BLE_ESSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_ESSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ess_char_index_t	charIndex,
		uint8_t	charInstance,
		cy_en_ble_ess_descr_index_t	descrIndex
	)

Sends a request to get the characteristic descriptor of the specified characteristic of the service.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_ess_char_index_t.
charInstance	The instance number of the characteristic specified by "charIndex".
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_ess_descr_index_t.

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	This operation is not permitted on the specified attribute.
CY_BLE_ERROR_INVALID_STATE	The state is not valid.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic descriptor is absent.

Events

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

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

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

Cy_BLE_ESSC_SetLongCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_ESSC_SetLongCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ess_char_index_t	charIndex,
		uint8_t	charInstance,
		cy_en_ble_ess_descr_index_t	descrIndex,
		uint16_t	attrSize,
		uint8_t *	attrValue
	)

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

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_ess_char_index_t.
charInstance	The instance number of the characteristic specified by "charIndex".
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_ess_descr_index_t.
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	This operation is not permitted on the specified attribute.
CY_BLE_ERROR_INVALID_STATE	The state is not valid.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic descriptor is absent.

Events

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

• CY_BLE_EVT_ESSC_WRITE_DESCR_RESPONSE - In case if the requested attribute is successfully written on the peer device, the details (charIndex, descrIndex etc.) are provided with event parameter structure of type cy_stc_ble_ess_descr_value_t.

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

• CY_BLE_EVT_GATTC_WRITE_RSP - In case if the requested attribute is successfully written on the peer device.
• 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.

Cy_BLE_ESSC_GetLongCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_ESSC_GetLongCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ess_char_index_t	charIndex,
		uint8_t	charInstance,
		cy_en_ble_ess_descr_index_t	descrIndex,
		uint16_t	attrSize,
		uint8_t *	attrValue
	)

Sends a request to read long characteristic descriptor of the specified characteristic of the service.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_ess_char_index_t.
charInstance	The instance number of the characteristic specified by "charIndex".
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_ess_descr_index_t.
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the buffer where the read long characteristic descriptor value should be stored.

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	This operation is not permitted on the specified attribute.
CY_BLE_ERROR_INVALID_STATE	The state is not valid.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic descriptor is absent.

Events

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

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

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