ANCS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_ANCSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ancs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	This function is used to write the characteristic (identified by charIndex) value attribute in the server. More...
cy_en_ble_api_result_t	Cy_BLE_ANCSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ancs_char_index_t charIndex, cy_en_ble_ancs_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	This function is used to write the characteristic value to the server identified by its charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_ANCSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ancs_char_index_t charIndex, cy_en_ble_ancs_descr_index_t descrIndex)
	Gets the characteristic descriptor of the specified characteristic. More...

Function Documentation

Cy_BLE_ANCSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_ANCSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ancs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

This function is used to write the characteristic (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's side, a CY_BLE_EVT_ANCSS_WRITE_CHAR event is generated. On successful request execution on the server's side, a 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 an ANCS service-specific callback is registered with Cy_BLE_ANCS_RegisterAttrCallback():

• CY_BLE_EVT_ANCSC_WRITE_CHAR_RESPONSE - If the requested attribute is successfully written on the peer device, the details (charIndex, etc.) are provided with an event parameter structure of type cy_stc_ble_ancs_char_value_t.

Otherwise (if an ANCS 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_ANCSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_ANCSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ancs_char_index_t	charIndex,
		cy_en_ble_ancs_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

This function is used to write the characteristic value to the server identified by its charIndex.

Internally, a 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_ANCSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_ANCSS_NOTIFICATION_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 descriptor 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

If execution is successful (return value = CY_BLE_SUCCESS), these events can appear:
If an ANCS service-specific callback is registered with Cy_BLE_ANCS_RegisterAttrCallback():

• CY_BLE_EVT_ANCSC_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_ancs_descr_value_t.

Otherwise (if an ANCS 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_ANCSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_ANCSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ancs_char_index_t	charIndex,
		cy_en_ble_ancs_descr_index_t	descrIndex
	)

Gets the characteristic descriptor of the specified characteristic.

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	This operation is not permitted on the specified attribute.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular descriptor.
CY_BLE_ERROR_INVALID_STATE	The state is not valid.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Events

If execution is successful (return value = CY_BLE_SUCCESS), these following events can appear:
If an ANCS service-specific callback is registered with Cy_BLE_ANCS_RegisterAttrCallback():

• CY_BLE_EVT_ANCSC_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_ancs_descr_value_t.

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