HTS Server Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_HTSS_SetCharacteristicValue (cy_en_ble_hts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets the characteristic value of the service in the local database. More...
cy_en_ble_api_result_t	Cy_BLE_HTSS_GetCharacteristicValue (cy_en_ble_hts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets the characteristic value of the service, which is a value identified by charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_HTSS_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex, cy_en_ble_hts_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets the characteristic descriptor of the specified characteristic. More...
cy_en_ble_api_result_t	Cy_BLE_HTSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex, cy_en_ble_hts_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets the characteristic descriptor of the specified characteristic. More...
cy_en_ble_api_result_t	Cy_BLE_HTSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends notification with a characteristic value of the Health Thermometer service, which is a value specified by charIndex, to the client device. More...
cy_en_ble_api_result_t	Cy_BLE_HTSS_SendIndication (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends indication with a characteristic value of the Health Thermometer service, which is a value specified by charIndex, to the client device. More...

Function Documentation

Cy_BLE_HTSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_HTSS_SetCharacteristicValue	(	cy_en_ble_hts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets the characteristic value of the service in the local database.

Parameters

charIndex	The index of the service characteristic.
attrSize	The size (in Bytes) of the characteristic value attribute.
attrValue	The pointer to the 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_HTSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_HTSS_GetCharacteristicValue	(	cy_en_ble_hts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

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

Parameters

charIndex	The index of the service characteristic.
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 request was handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.

Cy_BLE_HTSS_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_HTSS_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex,
		cy_en_ble_hts_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets 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.
attrSize	The size of the characteristic descriptor attribute.
attrValue	The pointer to the descriptor 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_HTSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_HTSS_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex,
		cy_en_ble_hts_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

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.
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 request was handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.

Cy_BLE_HTSS_SendNotification()

cy_en_ble_api_result_t Cy_BLE_HTSS_SendNotification	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends notification with a characteristic value of the Health Thermometer service, which is a value specified by 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_HTSC_NOTIFICATION event at the GATT Client's end.

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 client's 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_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.

Cy_BLE_HTSS_SendIndication()

cy_en_ble_api_result_t Cy_BLE_HTSS_SendIndication	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends indication with a characteristic value of the Health Thermometer service, which is a value specified by charIndex, to the client device.

On enabling indication successfully it sends out a 'Handle Value Indication' which results in CY_BLE_EVT_HTSC_INDICATION or CY_BLE_EVT_GATTC_HANDLE_VALUE_IND (if service-specific callback function is not registered) event at the GATT Client's end.

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 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_INVALID_STATE	Connection with the client is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_IND_DISABLED	Indication is not enabled by the client.

Events

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

• CY_BLE_EVT_HTSS_INDICATION_CONFIRMED - In case if the indication is successfully delivered to the peer device.

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

• CY_BLE_EVT_GATTS_HANDLE_VALUE_CNF - In case if the indication is successfully delivered to the peer device.