CSCS Server Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_CSCSS_SetCharacteristicValue (cy_en_ble_cscs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sets characteristic value of the Cycling Speed and Cadence service, which is identified by charIndex, to the local database. More...
cy_en_ble_api_result_t	Cy_BLE_CSCSS_GetCharacteristicValue (cy_en_ble_cscs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets a characteristic value of the Cycling Speed and Cadence service, which is identified by charIndex, from the GATT database. More...
cy_en_ble_api_result_t	Cy_BLE_CSCSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cscs_char_index_t charIndex, cy_en_ble_cscs_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets a characteristic descriptor of a specified characteristic of the Cycling Speed and Cadence service, from the GATT database. More...
cy_en_ble_api_result_t	Cy_BLE_CSCSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cscs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends notification with a characteristic value, which is specified by charIndex, of the Cycling Speed and Cadence service to the client device. More...
cy_en_ble_api_result_t	Cy_BLE_CSCSS_SendIndication (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cscs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Sends indication with a characteristic value, which is specified by charIndex, of the Cycling Speed and Cadence service to the client device. More...

Function Documentation

Cy_BLE_CSCSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_CSCSS_SetCharacteristicValue	(	cy_en_ble_cscs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets characteristic value of the Cycling Speed and Cadence service, which is identified by charIndex, to the local database.

Parameters

charIndex	The index of a service characteristic of type cy_en_ble_cscs_char_index_t. Valid values are, CY_BLE_CSCS_CSC_FEATURE CY_BLE_CSCS_SENSOR_LOCATION
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_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic is absent.

Cy_BLE_CSCSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_CSCSS_GetCharacteristicValue	(	cy_en_ble_cscs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets a characteristic value of the Cycling Speed and Cadence service, which is identified by charIndex, from the GATT database.

Parameters

charIndex	The index of a service characteristic of type cy_en_ble_cscs_char_index_t. Valid value is, CY_BLE_CSCS_SC_CONTROL_POINT.
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 parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	Optional characteristic is absent.

Cy_BLE_CSCSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_CSCSS_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cscs_char_index_t	charIndex,
		cy_en_ble_cscs_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets a characteristic descriptor of a specified characteristic of the Cycling Speed and Cadence service, from the GATT database.

Parameters

connHandle	The connection handle
charIndex	The index of a service characteristic of type cy_en_ble_cscs_char_index_t. Valid values are, CY_BLE_CSCS_CSC_MEASUREMENT CY_BLE_CSCS_SC_CONTROL_POINT.
descrIndex	The index of a service characteristic descriptor of type cy_en_ble_cscs_descr_index_t. Valid value is CY_BLE_CSCS_CCCD.
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 parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic is absent.

Cy_BLE_CSCSS_SendNotification()

cy_en_ble_api_result_t Cy_BLE_CSCSS_SendNotification	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cscs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends notification with a characteristic value, which is specified by charIndex, of the Cycling Speed and Cadence service to the client device.

On enabling notification successfully for a service characteristic it sends out a 'Handle Value Notification' which results in CY_BLE_EVT_CSCSC_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_cscs_char_index_t. Valid value is CY_BLE_CSCS_CSC_MEASUREMENT.
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	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.

Cy_BLE_CSCSS_SendIndication()

cy_en_ble_api_result_t Cy_BLE_CSCSS_SendIndication	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cscs_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends indication with a characteristic value, which is specified by charIndex, of the Cycling Speed and Cadence service to the client device.

On enabling indication successfully it sends out a 'Handle Value Indication' which results in CY_BLE_EVT_CSCSC_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_cscs_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	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_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 CSCS service-specific callback is registered with Cy_BLE_CSCS_RegisterAttrCallback():

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

Otherwise, if the CSCS 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.