API unique to GLS designs configured as a GATT Client role.
A letter 'c' is appended to the API name: Cy_BLE_GLSC_
|
cy_en_ble_api_result_t | Cy_BLE_GLSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_gls_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_GLSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_gls_char_index_t charIndex) |
| This function is used to read the characteristic Value from a server which is identified by charIndex. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_GLSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_gls_char_index_t charIndex, cy_en_ble_gls_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 Glucose service. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_GLSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_gls_char_index_t charIndex, cy_en_ble_gls_descr_index_t descrIndex) |
| Gets the characteristic descriptor of the specified characteristic. More...
|
|
◆ Cy_BLE_GLSC_SetCharacteristicValue()
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_GLSS_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_gls_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 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 GLS service-specific callback is registered with Cy_BLE_GLS_RegisterAttrCallback():
Otherwise (if the GLS service-specific callback is not registered):
◆ Cy_BLE_GLSC_GetCharacteristicValue()
This function is used to read the characteristic Value from a server which is identified by charIndex.
Sends a request to the peer device to get a characteristic value, as identified by its charIndex.
- Parameters
-
- 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 GLS service-specific callback is registered with Cy_BLE_GLS_RegisterAttrCallback():
Otherwise (if an GLS service-specific callback is not registered):
◆ Cy_BLE_GLSC_SetCharacteristicDescriptor()
Sends a request to the peer device to set the characteristic descriptor of the specified characteristic of Glucose 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:
- Parameters
-
connHandle | The connection handle. |
charIndex | The index of the service characteristic of type cy_en_ble_gls_char_index_t. |
descrIndex | The index of the service characteristic descriptor of type cy_en_ble_gls_descr_index_t. |
attrSize | The size of the characteristic descriptor value attribute. |
*attrValue | 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_GATT_DB_INVALID_ATTR_HANDLE | The peer device doesn't have the particular 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 GLS service-specific callback is registered with Cy_BLE_GLS_RegisterAttrCallback():
Otherwise (if an GLS service-specific callback is not registered):
◆ Cy_BLE_GLSC_GetCharacteristicDescriptor()
Gets the characteristic descriptor of the specified characteristic.
Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of Glucose service.
- Parameters
-
- 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 GLS service-specific callback is registered with Cy_BLE_GLS_RegisterAttrCallback():
Otherwise (if an GLS service-specific callback is not registered):