API unique to RSCS designs configured as a GATT Client role.
A letter 'c' is appended to the API name: Cy_BLE_RSCSC_
|
cy_en_ble_api_result_t | Cy_BLE_RSCSC_SetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_rscs_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_RSCSC_GetCharacteristicValue (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_rscs_char_index_t charIndex) |
| Sends a request to the peer device to set the characteristic value of the Running Speed and Cadence service. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_RSCSC_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_rscs_char_index_t charIndex, cy_en_ble_rscs_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue) |
| Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of the Running Speed and Cadence service. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_RSCSC_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_rscs_char_index_t charIndex, uint8_t descrIndex) |
| Sends a request to the peer device to get characteristic descriptor of the specified characteristic of the Running Speed and Cadence service. More...
|
|
◆ Cy_BLE_RSCSC_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_RSCSS_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 | Size of the characteristic value attribute. |
attrValue | 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 RSCS service-specific callback is registered (with Cy_BLE_RSCS_RegisterAttrCallback):
Otherwise (if the RSCS service-specific callback is not registered):
◆ Cy_BLE_RSCSC_GetCharacteristicValue()
Sends a request to the peer device to set the characteristic value of the Running Speed and Cadence service.
- Parameters
-
connHandle | The connection handle. |
charIndex | The index of the 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_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 RSCS service-specific callback is registered (with Cy_BLE_RSCS_RegisterAttrCallback):
Otherwise (if the RSCS service-specific callback is not registered):
◆ Cy_BLE_RSCSC_SetCharacteristicDescriptor()
Sends a request to the peer device to get the characteristic descriptor of the specified characteristic of the Running Speed and Cadence 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 a RSCS characteristic. |
descrIndex | The index of a RSCS characteristic descriptor. |
attrSize | The size of the characteristic descriptor 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_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 RSCS service-specific callback is registered (with Cy_BLE_RSCS_RegisterAttrCallback):
Otherwise (if the RSCS service-specific callback is not registered):
◆ Cy_BLE_RSCSC_GetCharacteristicDescriptor()
Sends a request to the peer device to get characteristic descriptor of the specified characteristic of the Running Speed and Cadence 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 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 | Peer device doesn't have a particular descriptor. |
- Events
- In case of successful execution (return value = CY_BLE_SUCCESS) the following events can appear:
If the RSCS service-specific callback is registered (with Cy_BLE_RSCS_RegisterAttrCallback):
Otherwise (if the RSCS service-specific callback is not registered):