API unique to ANCS designs configured as a GATT Server role.
A letter 's' is appended to the API name: Cy_BLE_ANCSS_
|
cy_en_ble_api_result_t | Cy_BLE_ANCSS_SetCharacteristicValue (cy_en_ble_ancs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue) |
| Sets the value of the characteristic identified by charIndex. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_ANCSS_GetCharacteristicValue (cy_en_ble_ancs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue) |
| Gets the value of the characteristic, as identified by charIndex. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_ANCSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ancs_char_index_t charIndex, cy_en_ble_ancs_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue) |
| Gets a characteristic descriptor of the specified characteristic. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_ANCSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_ancs_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue) |
| Sends a notification of the specified characteristic value, as identified by the charIndex. More...
|
|
◆ Cy_BLE_ANCSS_SetCharacteristicValue()
Sets the value of the characteristic identified by charIndex.
- Parameters
-
charIndex | The index of the service characteristic. |
attrSize | The size of the characteristic value attribute. |
attrValue | The pointer to the characteristic value data that should be stored to the GATT database. |
- 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 | An optional characteristic is absent. |
◆ Cy_BLE_ANCSS_GetCharacteristicValue()
Gets the value of the characteristic, as identified by charIndex.
- Parameters
-
charIndex | The index of the service characteristic. |
attrSize | The size of the characteristic value attribute. |
attrValue | The pointer to the location where characteristic value data should be stored. |
- Returns
- A return value of type cy_en_ble_api_result_t.
Error Codes | Description |
CY_BLE_SUCCESS | The characteristic value was read successfully. |
CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed. |
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE | A characteristic is absent. |
◆ Cy_BLE_ANCSS_GetCharacteristicDescriptor()
Gets a characteristic descriptor of the specified characteristic.
- Parameters
-
connHandle | The connection handle. |
charIndex | The index of the characteristic. |
descrIndex | The index of the descriptor. |
attrSize | The size of the descriptor value attribute. |
attrValue | The pointer to the location where characteristic descriptor value data should be stored. |
- Returns
- A return value of type cy_en_ble_api_result_t.
Error Codes | Description |
CY_BLE_SUCCESS | The characteristic descriptor value was read successfully. |
CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed. |
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE | A descriptor is absent. |
◆ Cy_BLE_ANCSS_SendNotification()
Sends a notification of the specified characteristic value, as identified by the charIndex.
On enabling notification successfully for a service characteristic, this function sends out a Handle Value notification that results in a CY_BLE_EVT_ANCSC_NOTIFICATION event at the GATT client's end.
- Parameters
-
connHandle | The connection handle that consists of the device ID and ATT connection ID. |
charIndex | The index of the service characteristic. |
attrSize | The size of the characteristic value attribute. |
attrValue | The pointer to the characteristic value data that should be sent to the client 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_INVALID_OPERATION | This operation is not permitted. |
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE | An optional characteristic is absent. |
CY_BLE_ERROR_INVALID_STATE | Connection with the client is not established. |
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED | Memory allocation failed. |
CY_BLE_ERROR_NTF_DISABLED | Notification is not enabled by the client. |