General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_WPTSS_SetCharacteristicValue (cy_en_ble_wpts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets a characteristic value of the Wireless Power Transfer service in the local GATT database. More...

cy_en_ble_api_result_t	Cy_BLE_WPTSS_GetCharacteristicValue (cy_en_ble_wpts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Reads a characteristic value of the Wireless Power Transfer service, which is identified by charIndex from the GATT database. More...

cy_en_ble_api_result_t	Cy_BLE_WPTSS_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_wpts_char_index_t charIndex, cy_en_ble_wpts_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_WPTSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_wpts_char_index_t charIndex, cy_en_ble_wpts_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Reads a characteristic descriptor of a specified characteristic of the Wireless Power Transfer service from the GATT database. More...

cy_en_ble_api_result_t	Cy_BLE_WPTSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_wpts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends notification with a characteristic value of the WPTS, which is a value specified by charIndex, to the client device. More...

cy_en_ble_api_result_t	Cy_BLE_WPTSS_SendIndication (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_wpts_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends an indication with a characteristic value of the Wireless Power Transfer service, which is a value specified by charIndex, to the client device. More...

Function Documentation

◆ Cy_BLE_WPTSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_WPTSS_SetCharacteristicValue	(	cy_en_ble_wpts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets a characteristic value of the Wireless Power Transfer service in the local GATT database.

The characteristic is identified by charIndex.

Parameters

charIndex	The index of a service characteristic of type cy_en_ble_wpts_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 characteristic value was written successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameters failed.

◆ Cy_BLE_WPTSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_WPTSS_GetCharacteristicValue	(	cy_en_ble_wpts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Reads a characteristic value of the Wireless Power Transfer service, which is identified by charIndex from the GATT database.

Parameters

charIndex	The index of a service characteristic of type cy_en_ble_wpts_char_index_t.
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 parameters failed.

◆ Cy_BLE_WPTSS_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_WPTSS_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_wpts_char_index_t	charIndex,
		cy_en_ble_wpts_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 a service characteristic of type cy_en_ble_wpts_char_index_t.
descrIndex	The index of a service characteristic descriptor of type cy_en_ble_wpts_descr_index_t.
attrSize	The size of the characteristic descriptor attribute.
attrValue	The pointer to the descriptor 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 characteristic value was handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameters failed.

◆ Cy_BLE_WPTSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_WPTSS_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_wpts_char_index_t	charIndex,
		cy_en_ble_wpts_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Reads a characteristic descriptor of a specified characteristic of the Wireless Power Transfer service from the GATT database.

Parameters

connHandle	The connection handle.
charIndex	The index of a service characteristic of type cy_en_ble_wpts_char_index_t.
descrIndex	The index of a service characteristic descriptor of type cy_en_ble_wpts_descr_index_t.
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 parameters failed.

◆ Cy_BLE_WPTSS_SendNotification()

cy_en_ble_api_result_t Cy_BLE_WPTSS_SendNotification	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_wpts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends notification with a characteristic value of the WPTS, which is a value specified by charIndex, to the client device.

On enabling notification successfully for a service characteristic, sends out a 'Handle Value Notification', which results in CY_BLE_EVT_WPTSC_NOTIFICATION event at the GATT Client's end.

Parameters

connHandle	The connection handle
charIndex	The index of a service characteristic of type cy_en_ble_wpts_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 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	This operation is not permitted.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	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.

◆ Cy_BLE_WPTSS_SendIndication()

cy_en_ble_api_result_t Cy_BLE_WPTSS_SendIndication	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_wpts_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends an indication with a characteristic value of the Wireless Power Transfer service, which is a value specified by charIndex, to the client device.

On enabling indication successfully, sends out a 'Handle Value Indication', which results in CY_BLE_EVT_WPTSC_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 a service characteristic of type cy_en_ble_wpts_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 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	This operation is not permitted.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	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_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 WPTS service-specific callback is registered (with Cy_BLE_WPTS_RegisterAttrCallback):

CY_BLE_EVT_WPTSS_INDICATION_CONFIRMED - If the indication is successfully delivered to the peer device.

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

CY_BLE_EVT_GATTS_HANDLE_VALUE_CNF - If the indication is successfully delivered to the peer device.

General Description

Functions

Function Documentation

◆ Cy_BLE_WPTSS_SetCharacteristicValue()

◆ Cy_BLE_WPTSS_GetCharacteristicValue()

◆ Cy_BLE_WPTSS_SetCharacteristicDescriptor()

◆ Cy_BLE_WPTSS_GetCharacteristicDescriptor()

◆ Cy_BLE_WPTSS_SendNotification()

◆ Cy_BLE_WPTSS_SendIndication()