HPS Server Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_HPSS_SetCharacteristicValue (cy_en_ble_hps_char_index_t charIndex, uint16_t attrSize, uint8_t *attrValue)
	Sets a value for one of characteristic values of the HTTP Proxy service. More...
cy_en_ble_api_result_t	Cy_BLE_HPSS_GetCharacteristicValue (cy_en_ble_hps_char_index_t charIndex, uint16_t attrSize, uint8_t *attrValue)
	Reads a characteristic value of the HTTP Proxy service, which is identified by charIndex from the GATT database. More...
cy_en_ble_api_result_t	Cy_BLE_HPSS_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hps_char_index_t charIndex, cy_en_ble_hps_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets the characteristic descriptor value of the specified characteristic. More...
cy_en_ble_api_result_t	Cy_BLE_HPSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hps_char_index_t charIndex, cy_en_ble_hps_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Reads a a characteristic descriptor of a specified characteristic of the HTTP Proxy service from the GATT database. More...
cy_en_ble_api_result_t	Cy_BLE_HPSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_hps_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends a notification with a characteristic value of the HTTP Proxy service, which is a value specified by charIndex, to the client's device. More...

Function Documentation

Cy_BLE_HPSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_HPSS_SetCharacteristicValue	(	cy_en_ble_hps_char_index_t	charIndex,
		uint16_t	attrSize,
		uint8_t *	attrValue
	)

Sets a value for one of characteristic values of the HTTP Proxy service.

The characteristic is identified by charIndex.

Parameters

charIndex	The index of the service characteristic of type cy_en_ble_hps_char_index_t.
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the characteristic value data that should be stored to 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_HPSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_HPSS_GetCharacteristicValue	(	cy_en_ble_hps_char_index_t	charIndex,
		uint16_t	attrSize,
		uint8_t *	attrValue
	)

Reads a characteristic value of the HTTP Proxy service, which is identified by charIndex from the GATT database.

Parameters

charIndex	The index of the service characteristic of type cy_en_ble_hps_char_index_t.
attrSize	The size of the HTTP Proxy service 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_HPSS_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_HPSS_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hps_char_index_t	charIndex,
		cy_en_ble_hps_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets the characteristic descriptor value of the specified characteristic.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_hps_char_index_t.
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_hps_descr_index_t.
attrSize	The size of the characteristic descriptor attribute.
attrValue	The pointer to the descriptor value data to 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 characteristic descriptor value was read successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.

Cy_BLE_HPSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_HPSS_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hps_char_index_t	charIndex,
		cy_en_ble_hps_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Reads a a characteristic descriptor of a specified characteristic of the HTTP Proxy service from the GATT database.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_hps_char_index_t.
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_hps_descr_index_t.
attrSize	The size of the descriptor value.
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_HPSS_SendNotification()

cy_en_ble_api_result_t Cy_BLE_HPSS_SendNotification	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_hps_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends a notification with a characteristic value of the HTTP Proxy service, which is a value specified by charIndex, to the client's device.

On enabling notification successfully for a service characteristic it sends out a 'Handle Value Notification' which results in CY_BLE_EVT_HPSC_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_hps_char_index_t.
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_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.