API unique to BMS designs configured as a GATT Server role.
A letter 's' is appended to the API name: Cy_BLE_BMSS_
|
cy_en_ble_api_result_t | Cy_BLE_BMSS_SetCharacteristicValue (cy_en_ble_bms_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue) |
| Sets a characteristic value of Bond Management service, which is a value identified by charIndex, to the local database. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_BMSS_GetCharacteristicValue (cy_en_ble_bms_char_index_t charIndex, uint8_t attrSize, uint8_t *attrValue) |
| Gets a characteristic value of Bond Management service. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_BMSS_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bms_char_index_t charIndex, cy_en_ble_bms_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue) |
| Sets a characteristic descriptor of the specified characteristic of the Bond Management service. More...
|
|
cy_en_ble_api_result_t | Cy_BLE_BMSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_bms_char_index_t charIndex, cy_en_ble_bms_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue) |
| Gets a characteristic descriptor of the specified characteristic of the Bond Management service. More...
|
|
◆ Cy_BLE_BMSS_SetCharacteristicValue()
Sets a characteristic value of Bond Management service, which is a value identified by charIndex, to the local database.
- Parameters
-
charIndex | The index of the service characteristic of type cy_en_ble_bms_char_index_t. The valid values are,
|
attrSize | The size of the characteristic value attribute. |
attrValue | The pointer to the characteristic value data that should be stored in 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_BMSS_GetCharacteristicValue()
Gets a characteristic value of Bond Management service.
The value is identified by charIndex.
- Parameters
-
charIndex | The index of the service characteristic of cy_en_ble_bms_char_index_t. The valid values are,
|
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 | An optional characteristic is absent. |
◆ Cy_BLE_BMSS_SetCharacteristicDescriptor()
Sets a characteristic descriptor of the specified characteristic of the 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,
|
descrIndex | The index of the service characteristic descriptor of type cy_en_ble_bms_descr_index_t. The valid value is
|
attrSize | The size of the characteristic descriptor attribute. |
attrValue | The pointer to the descriptor 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 characteristic descriptor value was read successfully. |
CY_BLE_ERROR_INVALID_PARAMETER | Validation of the input parameter failed. |
◆ Cy_BLE_BMSS_GetCharacteristicDescriptor()
Gets a characteristic descriptor of the specified characteristic of the 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,
|
descrIndex | The index of the service characteristic descriptor of type cy_en_ble_bms_descr_index_t. The valid value is
|
attrSize | The size of the characteristic descriptor 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. |