esp_gatts.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. GATT SERVER API
  2. ===============
  3. Overview
  4. --------
  5. `Instructions`_
  6. Application Example
  7. -------------------
  8. Check `/examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
  9. `14_gatts_demo <https://github.com/espressif/esp-idf/blob/master/examples/14_gatt_server/main/gatts_demo.c>`_
  10. This is a gatt server demo. Use gatt api to create a gatt server with send advertising. This gatt server can be connected and the service can be discovery.
  11. `Instructions`_
  12. .. _Instructions: template.html
  13. API Reference
  14. -------------
  15. Header Files
  16. ^^^^^^^^^^^^
  17. * `bt/bluedroid/api/include/esp_gatts_api.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_gatts_api.h>`_
  18. Macros
  19. ^^^^^^
  20. .. doxygendefine:: ESP_GATT_PREP_WRITE_CANCEL
  21. .. doxygendefine:: ESP_GATT_PREP_WRITE_EXEC
  22. Type Definitions
  23. ^^^^^^^^^^^^^^^^
  24. Enumerations
  25. ^^^^^^^^^^^^
  26. .. doxygenenum:: esp_gatts_cb_event_t
  27. Structures
  28. ^^^^^^^^^^
  29. .. doxygenstruct:: esp_ble_gatts_cb_param_t
  30. :members:
  31. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_reg_evt_param
  32. :members:
  33. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_read_evt_param
  34. :members:
  35. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_write_evt_param
  36. :members:
  37. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_exec_write_evt_param
  38. :members:
  39. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_mtu_evt_param
  40. :members:
  41. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_conf_evt_param
  42. :members:
  43. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_create_evt_param
  44. :members:
  45. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_add_incl_srvc_evt_param
  46. :members:
  47. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_add_char_evt_param
  48. :members:
  49. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_add_char_descr_evt_param
  50. :members:
  51. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_delete_evt_param
  52. :members:
  53. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_start_evt_param
  54. :members:
  55. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_stop_evt_param
  56. :members:
  57. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_connect_evt_param
  58. :members:
  59. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_disconnect_evt_param
  60. :members:
  61. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_congest_evt_param
  62. :members:
  63. .. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_rsp_evt_param
  64. :members:
  65. Functions
  66. ^^^^^^^^^
  67. .. doxygenfunction:: esp_ble_gatts_register_callback
  68. .. doxygenfunction:: esp_ble_gatts_app_register
  69. .. doxygenfunction:: esp_ble_gatts_app_unregister
  70. .. doxygenfunction:: esp_ble_gatts_create_service
  71. .. doxygenfunction:: esp_ble_gatts_add_included_service
  72. .. doxygenfunction:: esp_ble_gatts_add_char
  73. .. doxygenfunction:: esp_ble_gatts_add_char_descr
  74. .. doxygenfunction:: esp_ble_gatts_delete_service
  75. .. doxygenfunction:: esp_ble_gatts_start_service
  76. .. doxygenfunction:: esp_ble_gatts_stop_service
  77. .. doxygenfunction:: esp_ble_gatts_send_indicate
  78. .. doxygenfunction:: esp_ble_gatts_send_response
  79. .. doxygenfunction:: esp_ble_gatts_open
  80. .. doxygenfunction:: esp_ble_gatts_close