ScPS Client Functions

General Description

API unique to ScPS designs configured as a GATT Client role.

A letter 'c' is appended to the API name: Cy_BLE_SCPSC_

Functions
cy_en_ble_api_result_t	Cy_BLE_SCPSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_scps_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets a characteristic value of the Scan Parameters service, which is identified by charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_SCPSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_scps_char_index_t charIndex, cy_en_ble_scps_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets characteristic descriptor of specified characteristic of the Scan Parameters service. More...
cy_en_ble_api_result_t	Cy_BLE_SCPSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_scps_char_index_t charIndex, cy_en_ble_scps_descr_index_t descrIndex)
	Gets characteristic descriptor of specified characteristic of the Scan Parameters service. More...

Function Documentation

Cy_BLE_SCPSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_SCPSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_scps_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

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

This function call can result in generation of the following events based on the response from the server device:

• CY_BLE_EVT_GATTC_WRITE_RSP
• CY_BLE_EVT_GATTC_ERROR_RSP

The CY_BLE_EVT_SCPSS_SCAN_INT_WIN_WRITE_CHAR event is received by the peer device on invoking this function.

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 server device.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was sent 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 server is not established.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Cy_BLE_SCPSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_SCPSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_scps_char_index_t	charIndex,
		cy_en_ble_scps_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets characteristic descriptor of specified characteristic of the Scan Parameters service.

Internally, Write Request is sent to the GATT Server and on successful execution of the request on the server side, the following events can be generated:

• CY_BLE_EVT_SCPSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_SCPSS_NOTIFICATION_DISABLED

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 descriptor value attribute.
attrValue	The pointer to the characteristic descriptor value data that should be sent to the server device.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was sent 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 server is not established.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Events

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

• CY_BLE_EVT_SCPSC_WRITE_DESCR_RESPONSE - In case if the requested attribute is successfully written on the peer device, the details (charIndex, etc.) are provided with event parameter structure of type cy_stc_ble_scps_descr_value_t.

Otherwise, if the SCPS service-specific callback is not registered:

• CY_BLE_EVT_GATTC_WRITE_RSP - In case if the requested attribute is successfully written on the peer device.
• CY_BLE_EVT_GATTC_ERROR_RSP - In case if an error occurred with the requested attribute on the peer device, the details are provided with event parameters structure cy_stc_ble_gatt_err_param_t.

Cy_BLE_SCPSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_SCPSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_scps_char_index_t	charIndex,
		cy_en_ble_scps_descr_index_t	descrIndex
	)

Gets characteristic descriptor of specified characteristic of the Scan Parameters service.

This function call can result in generation of the following events based on the response from the server device:

• CY_BLE_EVT_SCPSC_READ_DESCR_RESPONSE
• CY_BLE_EVT_GATTC_ERROR_RSP

Parameters

connHandle	The connection handle.
charIndex	The index of a service Characteristic.
descrIndex	The index of a service characteristic descriptor.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was sent 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	The peer device doesn't have the particular characteristic.
CY_BLE_ERROR_INVALID_STATE	The state is not valid.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Events

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

• CY_BLE_EVT_SCPSC_READ_DESCR_RESPONSE - In case if the requested attribute is successfully written on the peer device, the details (charIndex, descrIndex etc.) are provided with event parameter structure of type cy_stc_ble_scps_descr_value_t.

Otherwise (if an SCPS service-specific callback is not registered):

• CY_BLE_EVT_GATTC_WRITE_RSP - If the requested attribute is successfully written on the peer device.
• CY_BLE_EVT_GATTC_ERROR_RSP - If an error occurred with the requested attribute on the peer device, the details are provided with an event parameter structure cy_stc_ble_gatt_err_param_t.