CPS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_CPSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cps_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	This function is used to write the characteristic (which is identified by charIndex) value attribute in the server. More...
cy_en_ble_api_result_t	Cy_BLE_CPSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cps_char_index_t charIndex)
	Sends a request to the peer device to get a characteristic value, as identified by its charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_CPSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cps_char_index_t charIndex, cy_en_ble_cps_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends a request to the peer device to set the characteristic descriptor of the specified characteristic of Cycling Power service. More...
cy_en_ble_api_result_t	Cy_BLE_CPSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cps_char_index_t charIndex, cy_en_ble_cps_descr_index_t descrIndex)
	Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of Cycling Power service. More...
cy_en_ble_api_result_t	Cy_BLE_CPSC_StartObserve (uint8_t scanParamIndex)
	This function is used for observing GAP peripheral devices. More...
cy_en_ble_api_result_t	Cy_BLE_CPSC_StopObserve (void)
	This function used to stop the discovery of devices. More...

Function Documentation

Cy_BLE_CPSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_CPSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cps_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

This function is used to write the characteristic (which is identified by charIndex) value attribute in the server.

As a result a Write Request is sent to the GATT Server and on successful execution of the request on the server side, the CY_BLE_EVT_CPSS_WRITE_CHAR event is generated. On successful request execution on the server side, the Write Response is sent to the client.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_cps_char_index_t. The valid values are, CY_BLE_CPS_POWER_MEASURE CY_BLE_CPS_POWER_FEATURE CY_BLE_CPS_SENSOR_LOCATION CY_BLE_CPS_POWER_VECTOR CY_BLE_CPS_POWER_CP
attrSize	The size of the characteristic value attribute.
attrValue	Pointer to the characteristic value data that should be send 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_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
CY_BLE_ERROR_INVALID_STATE	Connection with the server is not established.
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 CPS service-specific callback is registered with Cy_BLE_CPS_RegisterAttrCallback():

• CY_BLE_EVT_CPSC_WRITE_CHAR_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_cps_char_value_t.

Otherwise (if the CPS 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_CPSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_CPSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cps_char_index_t	charIndex
	)

Sends a request to the peer device to get a characteristic value, as identified by its charIndex.

The Read Response returns the characteristic Value in the Attribute Value parameter.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_cps_char_index_t. The valid values are, CY_BLE_CPS_POWER_MEASURE CY_BLE_CPS_POWER_FEATURE CY_BLE_CPS_SENSOR_LOCATION CY_BLE_CPS_POWER_VECTOR CY_BLE_CPS_POWER_CP

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_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic

Events

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

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

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

• CY_BLE_EVT_GATTC_READ_RSP - If the requested attribute is successfully read on the peer device, the details (handle, value, etc.) are provided with an event parameter structure cy_stc_ble_gattc_read_rsp_param_t.
• 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.

Cy_BLE_CPSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_CPSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cps_char_index_t	charIndex,
		cy_en_ble_cps_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends a request to the peer device to set the characteristic descriptor of the specified characteristic of Cycling Power 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_CPSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_CPSS_NOTIFICATION_DISABLED
• CY_BLE_EVT_CPSS_INDICATION_ENABLED
• CY_BLE_EVT_CPSS_INDICATION_DISABLED
• CY_BLE_EVT_CPSS_BROADCAST_ENABLED
• CY_BLE_EVT_CPSS_BROADCAST_DISABLED

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_cps_char_index_t. The valid values are, CY_BLE_CPS_POWER_MEASURE CY_BLE_CPS_POWER_FEATURE CY_BLE_CPS_SENSOR_LOCATION CY_BLE_CPS_POWER_VECTOR CY_BLE_CPS_POWER_CP
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_cps_descr_index_t. The valid values are, CY_BLE_CPS_CCCD CY_BLE_CPS_SCCD
attrSize	The size of the characteristic 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	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 CPS service-specific callback is registered with Cy_BLE_CPS_RegisterAttrCallback():

• CY_BLE_EVT_CPSC_WRITE_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_cps_descr_value_t.

Otherwise (if an ANC 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).

Cy_BLE_CPSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_CPSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cps_char_index_t	charIndex,
		cy_en_ble_cps_descr_index_t	descrIndex
	)

Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of Cycling Power service.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_cps_char_index_t. The valid values are, CY_BLE_CPS_POWER_MEASURE CY_BLE_CPS_POWER_FEATURE CY_BLE_CPS_SENSOR_LOCATION CY_BLE_CPS_POWER_VECTOR CY_BLE_CPS_POWER_CP
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_cps_descr_index_t. The valid values are, CY_BLE_CPS_CCCD CY_BLE_CPS_SCCD *

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	This operation is not permitted on the specified attribute.
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 CPS service-specific callback is registered with Cy_BLE_CPS_RegisterAttrCallback():

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

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

• CY_BLE_EVT_GATTC_READ_RSP - If the requested attribute is successfully read on the peer device, the details (handle, value, etc.) are provided with an event parameter structure cy_stc_ble_gattc_read_rsp_param_t.
• 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.

Cy_BLE_CPSC_StartObserve()

cy_en_ble_api_result_t Cy_BLE_CPSC_StartObserve

(

uint8_t

scanParamIndex

)

This function is used for observing GAP peripheral devices.

A device performing the observer role receives only advertisement data from devices irrespective of their discoverable mode settings. Advertisement data received is provided by the event, CY_BLE_EVT_CPSC_SCAN_PROGRESS_RESULT. This procedure sets the scanType sub parameter to passive scanning.

If 'scanTo' sub-parameter is set to zero value, then passive scanning procedure will continue until you call Cy_BLE_CPSC_StopObserve(). Possible generated events are:

• CY_BLE_EVT_CPSC_SCAN_PROGRESS_RESULT

Parameters

scanParamIndex

The index of the scan configuration.

Returns

cy_en_ble_api_result_t : Return value indicates whether the function succeeded or failed. The following are possible error codes.

Error Codes	Description
CY_BLE_SUCCESS	On successful operation.
CY_BLE_ERROR_INVALID_PARAMETER	On specifying NULL as input parameter. for 'scanInfo' or if any element within 'scanInfo' has an invalid value.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.

Cy_BLE_CPSC_StopObserve()

cy_en_ble_api_result_t Cy_BLE_CPSC_StopObserve

(

void

)

This function used to stop the discovery of devices.

Returns

cy_en_ble_api_result_t : Return value indicates whether the function succeeded or failed. The following are possible error codes.

Error Codes	Description
CY_BLE_SUCCESS	On successful operation.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_INVALID_STATE	On calling this function not in CPS observing state.