alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs:fix event typo

Browse Source 
1.In the description of the ESP_API header file, it should be the event that the application layer needs to handle, not the BTA layer.
2.Fix name typo of BTA_GATTS_CREATE_SRVC_EVT event

Closes https://github.com/espressif/esp-idf/issues/5446
This commit is contained in:
liminyang 2020-06-29 11:57:36 +08:00
parent 45fff86e05
commit 02f3d39858
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
components/bt/host/bluedroid/api/include/api/esp_gatts_api.h
View File

@ -326,7 +326,7 @@ esp_err_t esp_ble_gatts_app_unregister(esp_gatt_if_t gatts_if);
/** /**
* @brief Create a service. When service creation is done, a callback * @brief Create a service. When service creation is done, a callback
* event BTA_GATTS_CREATE_SRVC_EVT is called to report status * event ESP_GATTS_CREATE_EVT is called to report status
* and service ID to the profile. The service ID obtained in * and service ID to the profile. The service ID obtained in
* the callback function needs to be used when adding included * the callback function needs to be used when adding included
* service and characteristics/descriptors into the service. * service and characteristics/descriptors into the service.
@ -363,7 +363,7 @@ esp_err_t esp_ble_gatts_create_attr_tab(const esp_gatts_attr_db_t *gatts_attr_db
/** /**
* @brief This function is called to add an included service. This function have to be called between * @brief This function is called to add an included service. This function have to be called between
* 'esp_ble_gatts_create_service' and 'esp_ble_gatts_add_char'. After included * 'esp_ble_gatts_create_service' and 'esp_ble_gatts_add_char'. After included
* service is included, a callback event BTA_GATTS_ADD_INCL_SRVC_EVT * service is included, a callback event ESP_GATTS_ADD_INCL_SRVC_EVT
* is reported the included service ID. * is reported the included service ID.
* *
* @param[in] service_handle: service handle to which this included service is to * @param[in] service_handle: service handle to which this included service is to
@ -402,7 +402,7 @@ esp_err_t esp_ble_gatts_add_char(uint16_t service_handle, esp_bt_uuid_t *char_
/** /**
* @brief This function is called to add characteristic descriptor. When * @brief This function is called to add characteristic descriptor. When
* it's done, a callback event BTA_GATTS_ADD_DESCR_EVT is called * it's done, a callback event ESP_GATTS_ADD_DESCR_EVT is called
* to report the status and an ID number for this descriptor. * to report the status and an ID number for this descriptor.
* *
* @param[in] service_handle: service handle to which this characteristic descriptor is to * @param[in] service_handle: service handle to which this characteristic descriptor is to
@ -425,7 +425,7 @@ esp_err_t esp_ble_gatts_add_char_descr (uint16_t service_handle,
/** /**
* @brief This function is called to delete a service. When this is done, * @brief This function is called to delete a service. When this is done,
* a callback event BTA_GATTS_DELETE_EVT is report with the status. * a callback event ESP_GATTS_DELETE_EVT is report with the status.
* *
* @param[in] service_handle: service_handle to be deleted. * @param[in] service_handle: service_handle to be deleted.
* *

2
components/bt/host/bluedroid/bta/gatt/bta_gatts_api.c
View File

@ -136,7 +136,7 @@ void BTA_GATTS_AppDeregister(tBTA_GATTS_IF server_if)
** Function BTA_GATTS_CreateService ** Function BTA_GATTS_CreateService
** **
** Description Create a service. When service creation is done, a callback ** Description Create a service. When service creation is done, a callback
** event BTA_GATTS_CREATE_SRVC_EVT is called to report status ** event BTA_GATTS_CREATE_EVT is called to report status
** and service ID to the profile. The service ID obtained in ** and service ID to the profile. The service ID obtained in
** the callback function needs to be used when adding included ** the callback function needs to be used when adding included
** service and characteristics/descriptors into the service. ** service and characteristics/descriptors into the service.

2
components/bt/host/bluedroid/bta/include/bta/bta_gatt_api.h
View File

@ -1254,7 +1254,7 @@ extern void BTA_GATTS_AppDeregister(tBTA_GATTS_IF server_if);
** Function BTA_GATTS_CreateService ** Function BTA_GATTS_CreateService
** **
** Description Create a service. When service creation is done, a callback ** Description Create a service. When service creation is done, a callback
** event BTA_GATTS_CREATE_SRVC_EVT is called to report status ** event BTA_GATTS_CREATE_EVT is called to report status
** and service ID to the profile. The service ID obtained in ** and service ID to the profile. The service ID obtained in
** the callback function needs to be used when adding included ** the callback function needs to be used when adding included
** service and characteristics/descriptors into the service. ** service and characteristics/descriptors into the service.