General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_PLXSS_SetCharacteristicValue (cy_en_ble_plxs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets a characteristic value of the service, which is identified by charIndex. More...

cy_en_ble_api_result_t	Cy_BLE_PLXSS_GetCharacteristicValue (cy_en_ble_plxs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets a characteristic value of the service, which is identified by charIndex. More...

cy_en_ble_api_result_t	Cy_BLE_PLXSS_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_plxs_char_index_t charIndex, cy_en_ble_plxs_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets a characteristic descriptor of a specified characteristic of the service. More...

cy_en_ble_api_result_t	Cy_BLE_PLXSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_plxs_char_index_t charIndex, cy_en_ble_plxs_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_PLXSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_plxs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends a notification of the specified characteristic to the client device, as defined by the charIndex value. More...

cy_en_ble_api_result_t	Cy_BLE_PLXSS_SendIndication (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_plxs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends an indication of the specified characteristic to the client device, as defined by the charIndex value. More...

Function Documentation

◆ Cy_BLE_PLXSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_PLXSS_SetCharacteristicValue	(	cy_en_ble_plxs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

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

Parameters

charIndex	The index of a service characteristic.
attrSize	The size 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_ERROR_GATT_DB_INVALID_ATTR_HANDLE	Optional characteristic is absent.

◆ Cy_BLE_PLXSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_PLXSS_GetCharacteristicValue	(	cy_en_ble_plxs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

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

Parameters

charIndex	The index of a service characteristic.
attrSize	The size of the characteristic value attribute.
*attrValue	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_ERROR_GATT_DB_INVALID_ATTR_HANDLE	Optional characteristic is absent.

◆ Cy_BLE_PLXSS_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_PLXSS_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_plxs_char_index_t	charIndex,
		cy_en_ble_plxs_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets a characteristic descriptor of a specified characteristic of the service.

Parameters

connHandle	The connection handle which consist of the device ID and ATT connection ID.
charIndex	The index of a service characteristic of type cy_en_ble_plxs_char_index_t.
descrIndex	The index of a service characteristic descriptor of type cy_en_ble_plxs_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 is 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_PLXSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_PLXSS_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_plxs_char_index_t	charIndex,
		cy_en_ble_plxs_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets the characteristic descriptor of the specified characteristic.

Parameters

connHandle	The connection handle which consist of the device ID and ATT connection ID.
charIndex	The index of the characteristic.
descrIndex	The index of the descriptor.
attrSize	The size of the descriptor value attribute.
*attrValue	Pointer to the location where the 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_ERROR_GATT_DB_INVALID_ATTR_HANDLE	Optional characteristic is absent.

◆ Cy_BLE_PLXSS_SendNotification()

cy_en_ble_api_result_t Cy_BLE_PLXSS_SendNotification	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_plxs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends a notification of the specified characteristic to the client device, as defined by the charIndex value.

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

Parameters

connHandle	The connection handle which consist of the device ID and ATT connection ID.
charIndex	The index of the service characteristic.
attrSize	The size of the characteristic value attribute.
*attrValue	Pointer to the Characteristic value data that should be sent to 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_GATT_DB_INVALID_ATTR_HANDLE	Optional characteristic is absent.
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_PLXSS_SendIndication()

cy_en_ble_api_result_t Cy_BLE_PLXSS_SendIndication	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_plxs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends an indication of the specified characteristic to the client device, as defined by the charIndex value.

On enabling indication successfully it sends out a 'Handle Value Indication' which results in CY_BLE_EVT_PLXSC_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 which consist of the device ID and ATT connection ID.
charIndex	The index of the service characteristic.
attrSize	The size of the characteristic value attribute.
*attrValue	Pointer to the Characteristic value data that should be sent to 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_GATT_DB_INVALID_ATTR_HANDLE	Optional characteristic is absent.
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 PLXS service-specific callback is registered (with Cy_BLE_PLXS_RegisterAttrCallback):

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

Otherwise (if the PLXS 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.

General Description

Functions

Function Documentation

◆ Cy_BLE_PLXSS_SetCharacteristicValue()

◆ Cy_BLE_PLXSS_GetCharacteristicValue()

◆ Cy_BLE_PLXSS_SetCharacteristicDescriptor()

◆ Cy_BLE_PLXSS_GetCharacteristicDescriptor()

◆ Cy_BLE_PLXSS_SendNotification()

◆ Cy_BLE_PLXSS_SendIndication()