PASS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_PASSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_pass_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_PASSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_pass_char_index_t charIndex)
	This function is used to read the characteristic Value from a Server which is identified by the charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_PASSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_pass_char_index_t charIndex, cy_en_ble_pass_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	This function is used to write the characteristic Value to the server which is identified by the charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_PASSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_pass_char_index_t charIndex, cy_en_ble_pass_descr_index_t descrIndex)
	Gets a characteristic descriptor of a specified characteristic of the service. More...

Function Documentation

Cy_BLE_PASSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_PASSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_pass_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_PASSS_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 a 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 handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
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.

Events

• CY_BLE_EVT_GATTC_WRITE_RSP - The requested attribute is successfully written on the peer device.
• CY_BLE_EVT_GATTC_ERROR_RSP - There is some trouble 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_PASSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_PASSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_pass_char_index_t	charIndex
	)

This function is used to read the characteristic Value from a Server which is identified by the charIndex.

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

The Read Response only contains the characteristic Value that is less than or equal to (MTU - 1) octets in length. If the characteristic Value is greater than (MTU - 1) octets in length, the Read Long Characteristic Value procedure may be used if the rest of the characteristic Value is required.

Parameters

connHandle	The connection handle.
charIndex	The index of a service characteristic.

Returns

A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The Read Request was sent successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
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.

Events

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

• CY_BLE_EVT_PASSC_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_pass_char_value_t.

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

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

cy_en_ble_api_result_t Cy_BLE_PASSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_pass_char_index_t	charIndex,
		cy_en_ble_pass_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

This function is used to write the characteristic Value to the server which is identified by the charIndex.

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_PASSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_PASSS_NOTIFICATION_DISABLED

Parameters

connHandle	The connection handle.
charIndex	The index of a service characteristic.
descrIndex	The index of a service characteristic descriptor.
attrSize	The size of the characteristic 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 Read Request was sent successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
CY_BLE_ERROR_INVALID_OPERATION	This operation is not permitted on the specified attribute.
CY_BLE_ERROR_INVALID_STATE	Connection with the client 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 PASS service-specific callback is registered (with Cy_BLE_PASS_RegisterAttrCallback):

• CY_BLE_EVT_PASSC_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_pass_descr_value_t.

Otherwise (if the PASS 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_PASSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_PASSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_pass_char_index_t	charIndex,
		cy_en_ble_pass_descr_index_t	descrIndex
	)

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

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 Read Request was sent successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular characteristic.
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 PASS service-specific callback is registered (with Cy_BLE_PASS_RegisterAttrCallback):

• CY_BLE_EVT_PASSC_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_pass_descr_value_t.

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

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