ANS Server Functions

General Description

API unique to ANS designs configured as a GATT Server role.

A letter 's' is appended to the API name: Cy_BLE_ANSS_

Functions
cy_en_ble_api_result_t	Cy_BLE_ANSS_SetCharacteristicValue (cy_en_ble_ans_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets a characteristic value of alert notification service, which is a value identified by charIndex, to the local database. More...
cy_en_ble_api_result_t	Cy_BLE_ANSS_GetCharacteristicValue (cy_en_ble_ans_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets a characteristic value of alert notification service. More...
cy_en_ble_api_result_t	Cy_BLE_ANSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ans_char_index_t charIndex, cy_en_ble_ans_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets a characteristic descriptor of the specified characteristic of alert notification service. More...
cy_en_ble_api_result_t	Cy_BLE_ANSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ans_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends a notification with the characteristic value, as specified by its charIndex, to the client device. More...

Function Documentation

Cy_BLE_ANSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_ANSS_SetCharacteristicValue	(	cy_en_ble_ans_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets a characteristic value of alert notification service, which is a value identified by charIndex, to the local database.

Parameters

charIndex	The index of the service characteristic of type cy_en_ble_ans_char_index_t. The valid values are, CY_BLE_ANS_SUPPORTED_NEW_ALERT_CAT CY_BLE_ANS_SUPPORTED_UNREAD_ALERT_CAT
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to characteristic value data that should be stored in the GATT database.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic is absent.

Cy_BLE_ANSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_ANSS_GetCharacteristicValue	(	cy_en_ble_ans_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets a characteristic value of alert notification service.

The value is identified by charIndex.

Parameters

charIndex	The index of the service characteristic of type cy_en_ble_ans_char_index_t. The valid values are, CY_BLE_ANS_NEW_ALERT CY_BLE_ANS_UNREAD_ALERT_STATUS
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the location where characteristic value data should be stored.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The characteristic value was read successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.

Cy_BLE_ANSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_ANSS_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ans_char_index_t	charIndex,
		cy_en_ble_ans_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets a characteristic descriptor of the specified characteristic of alert notification service.

Parameters

connHandle	The connection handle
charIndex	The index of the service characteristic of type cy_en_ble_ans_char_index_t. The valid values are, CY_BLE_ANS_NEW_ALERT CY_BLE_ANS_UNREAD_ALERT_STATUS
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_ans_descr_index_t. The valid value is, CY_BLE_ANS_CCCD
attrSize	The size of the characteristic descriptor attribute.
attrValue	The pointer to the location where characteristic descriptor value data should be stored.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The characteristic descriptor value was read successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.

Cy_BLE_ANSS_SendNotification()

cy_en_ble_api_result_t Cy_BLE_ANSS_SendNotification	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_ans_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends a notification with the characteristic value, as specified by its charIndex, to the client device.

On enabling notification successfully for a service characteristic it sends out a 'handle value notification', which results in CY_BLE_EVT_ANSC_NOTIFICATION event at the GATT client's end.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_ans_char_index_t. The valid values are, CY_BLE_ANS_UNREAD_ALERT_STATUS CY_BLE_ANS_NEW_ALERT
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the characteristic value data that should be sent to the client device.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was handled 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	An optional characteristic is absent.
CY_BLE_ERROR_INVALID_STATE	Connection with the client is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_NTF_DISABLED	Notification is not enabled by the client.