CGMS Client Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_CGMSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cgms_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_CGMSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cgms_char_index_t charIndex)
	This function is used to read the characteristic value from a server identified by charIndex. More...
cy_en_ble_api_result_t	Cy_BLE_CGMSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cgms_char_index_t charIndex, cy_en_ble_cgms_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 Continuous Glucose Monitoring service. More...
cy_en_ble_api_result_t	Cy_BLE_CGMSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_cgms_char_index_t charIndex, cy_en_ble_cgms_descr_index_t descrIndex)
	Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of Continuous Glucose Monitoring service. More...

Function Documentation

Cy_BLE_CGMSC_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_CGMSC_SetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cgms_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_CGMSS_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_cgms_char_index_t. The valid values are CY_BLE_CGMS_CGMT CY_BLE_CGMS_CGFT CY_BLE_CGMS_CGST CY_BLE_CGMS_SSTM CY_BLE_CGMS_SRTM CY_BLE_CGMS_RACP CY_BLE_CGMS_SOCP
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_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 CGMS service-specific callback is registered with Cy_BLE_CGMS_RegisterAttrCallback():

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

Otherwise (if an CGMS 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_CGMSC_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_CGMSC_GetCharacteristicValue	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cgms_char_index_t	charIndex
	)

This function is used to read the characteristic value from a server identified by charIndex.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_cgms_char_index_t. The valid values are CY_BLE_CGMS_CGMT CY_BLE_CGMS_CGFT CY_BLE_CGMS_CGST CY_BLE_CGMS_SSTM CY_BLE_CGMS_SRTM CY_BLE_CGMS_RACP CY_BLE_CGMS_SOCP

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 CGMS service-specific callback is registered with Cy_BLE_CGMS_RegisterAttrCallback():

• CY_BLE_EVT_CGMSC_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_cgms_char_value_t.

Otherwise (if an CGMS 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_CGMSC_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_CGMSC_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cgms_char_index_t	charIndex,
		cy_en_ble_cgms_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 Continuous Glucose Monitoring 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_CGMSS_INDICATION_ENABLED
• CY_BLE_EVT_CGMSS_INDICATION_DISABLED
• CY_BLE_EVT_CGMSS_NOTIFICATION_ENABLED
• CY_BLE_EVT_CGMSS_NOTIFICATION_DISABLED

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_cgms_char_index_t. The valid values are CY_BLE_CGMS_CGMT CY_BLE_CGMS_CGFT CY_BLE_CGMS_CGST CY_BLE_CGMS_SSTM CY_BLE_CGMS_SRTM CY_BLE_CGMS_RACP CY_BLE_CGMS_SOCP
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_cgms_descr_index_t. The valid value is, CY_BLE_CGMS_CCCD
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 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 CGMS service-specific callback is registered with Cy_BLE_CGMS_RegisterAttrCallback():

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

Otherwise (if an CGMS 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_CGMSC_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_CGMSC_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_cgms_char_index_t	charIndex,
		cy_en_ble_cgms_descr_index_t	descrIndex
	)

Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of Continuous Glucose Monitoring service.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic of type cy_en_ble_cgms_char_index_t. The valid values are CY_BLE_CGMS_CGMT CY_BLE_CGMS_CGFT CY_BLE_CGMS_CGST CY_BLE_CGMS_SSTM CY_BLE_CGMS_SRTM CY_BLE_CGMS_RACP CY_BLE_CGMS_SOCP
descrIndex	The index of the service characteristic descriptor of type cy_en_ble_cgms_descr_index_t. The valid value is, CY_BLE_CGMS_CCCD

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 CGMS service-specific callback is registered (with Cy_BLE_CGMS_RegisterAttrCallback):

• CY_BLE_EVT_CGMSC_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_cgms_descr_value_t.

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