BMS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_BMSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bms_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_BMSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bms_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_BMSC_ReliableWriteCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bms_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue)
	Performs a Reliable Write command for the Bond Management Control Point characteristic (identified by charIndex) value attribute to the server. More...
cy_en_ble_api_result_t	Cy_BLE_BMSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bms_char_index_t charIndex, cy_en_ble_bms_descr_index_t descrIndex)
	Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of Bond Management service. More...

Function Documentation

Cy_BLE_BMSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_BMSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_bms_char_index_t	charIndex
	)

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

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of cy_en_ble_bms_char_index_t. The valid values are, CY_BLE_BMS_BMCP CY_BLE_BMS_BMFT

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

If execution is successful(return value = CY_BLE_SUCCESS), these events can appear:
If a BMS service-specific callback is registered with Cy_BLE_BMS_RegisterAttrCallback():

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

Otherwise (if a BMS 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 the event parameters 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 the event parameters structure cy_stc_ble_gatt_err_param_t.

Cy_BLE_BMSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_BMSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_bms_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.

The function supports the Write Long procedure - it depends on the attrSize parameter - if it is larger than the current MTU size - 1, then the Write Long will be executed. As a result, a Write Request is sent to the GATT Server and on successful execution of the request on the server side, a CY_BLE_EVT_BMSS_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 cy_en_ble_bms_char_index_t. The valid values are, CY_BLE_BMS_BMCP CY_BLE_BMS_BMFT
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_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

If execution is successful(return value = CY_BLE_SUCCESS), these events can appear:
If a BMS service-specific callback is registered with Cy_BLE_BMS_RegisterAttrCallback():

• CY_BLE_EVT_BMSC_WRITE_CHAR_RESPONSE - if the requested attribute is successfully written on the peer device, the details (charIndex, etc.) are provided with an event parameter structure of type cy_stc_ble_bms_char_value_t.

Otherwise (if a BMS service-specific callback is not registered):

• CY_BLE_EVT_GATTC_EXEC_WRITE_RSP - 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_BMSC_ReliableWriteCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_BMSC_ReliableWriteCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_bms_char_index_t	charIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Performs a Reliable Write command for the Bond Management Control Point characteristic (identified by charIndex) value attribute to the server.

The Write Response only confirms the operation success.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of cy_en_ble_bms_char_index_t. The valid values are, CY_BLE_BMS_BMCP
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 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

If execution is successful(return value = CY_BLE_SUCCESS), these events can appear:
If a BMS service-specific callback is registered with Cy_BLE_BMS_RegisterAttrCallback():

• CY_BLE_EVT_BMSC_WRITE_CHAR_RESPONSE - if the requested attribute is successfully written on the peer device, the details (charIndex, etc.) are provided with an event parameter structure of type cy_stc_ble_bms_char_value_t.

Otherwise (if a BMS service-specific callback is not registered):

• CY_BLE_EVT_GATTC_EXEC_WRITE_RSP - 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_BMSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_BMSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_bms_char_index_t	charIndex,
		cy_en_ble_bms_descr_index_t	descrIndex
	)

Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of Bond Management service.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of cy_en_ble_bms_char_index_t. The valid values are, CY_BLE_BMS_BMCP CY_BLE_BMS_BMFT
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_bms_descr_index_t. The valid value is CY_BLE_BMS_CEPD

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.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	The peer device doesn't have the particular descriptor.

Events

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

• CY_BLE_EVT_BMSC_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_bms_descr_value_t.

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