esp_gatt_defs.rst 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. GATT DEFINES
  2. ============
  3. Overview
  4. --------
  5. `Instructions`_
  6. Application Example
  7. -------------------
  8. `Instructions`_
  9. .. _Instructions: ../template.html
  10. API Reference
  11. -------------
  12. Header Files
  13. ^^^^^^^^^^^^
  14. * :component_file:`bt/bluedroid/api/include/esp_gatt_defs.h`
  15. Macros
  16. ^^^^^^
  17. .. doxygendefine:: ESP_GATT_UUID_IMMEDIATE_ALERT_SVC
  18. .. doxygendefine:: ESP_GATT_UUID_LINK_LOSS_SVC
  19. .. doxygendefine:: ESP_GATT_UUID_TX_POWER_SVC
  20. .. doxygendefine:: ESP_GATT_UUID_CURRENT_TIME_SVC
  21. .. doxygendefine:: ESP_GATT_UUID_REF_TIME_UPDATE_SVC
  22. .. doxygendefine:: ESP_GATT_UUID_NEXT_DST_CHANGE_SVC
  23. .. doxygendefine:: ESP_GATT_UUID_GLUCOSE_SVC
  24. .. doxygendefine:: ESP_GATT_UUID_HEALTH_THERMOM_SVC
  25. .. doxygendefine:: ESP_GATT_UUID_DEVICE_INFO_SVC
  26. .. doxygendefine:: ESP_GATT_UUID_HEART_RATE_SVC
  27. .. doxygendefine:: ESP_GATT_UUID_PHONE_ALERT_STATUS_SVC
  28. .. doxygendefine:: ESP_GATT_UUID_BATTERY_SERVICE_SVC
  29. .. doxygendefine:: ESP_GATT_UUID_BLOOD_PRESSURE_SVC
  30. .. doxygendefine:: ESP_GATT_UUID_ALERT_NTF_SVC
  31. .. doxygendefine:: ESP_GATT_UUID_HID_SVC
  32. .. doxygendefine:: ESP_GATT_UUID_SCAN_PARAMETERS_SVC
  33. .. doxygendefine:: ESP_GATT_UUID_RUNNING_SPEED_CADENCE_SVC
  34. .. doxygendefine:: ESP_GATT_UUID_CYCLING_SPEED_CADENCE_SVC
  35. .. doxygendefine:: ESP_GATT_UUID_CYCLING_POWER_SVC
  36. .. doxygendefine:: ESP_GATT_UUID_LOCATION_AND_NAVIGATION_SVC
  37. .. doxygendefine:: ESP_GATT_UUID_USER_DATA_SVC
  38. .. doxygendefine:: ESP_GATT_UUID_WEIGHT_SCALE_SVC
  39. .. doxygendefine:: ESP_GATT_UUID_PRI_SERVICE
  40. .. doxygendefine:: ESP_GATT_UUID_SEC_SERVICE
  41. .. doxygendefine:: ESP_GATT_UUID_INCLUDE_SERVICE
  42. .. doxygendefine:: ESP_GATT_UUID_CHAR_DECLARE
  43. .. doxygendefine:: ESP_GATT_UUID_CHAR_EXT_PROP
  44. .. doxygendefine:: ESP_GATT_UUID_CHAR_DESCRIPTION
  45. .. doxygendefine:: ESP_GATT_UUID_CHAR_CLIENT_CONFIG
  46. .. doxygendefine:: ESP_GATT_UUID_CHAR_SRVR_CONFIG
  47. .. doxygendefine:: ESP_GATT_UUID_CHAR_PRESENT_FORMAT
  48. .. doxygendefine:: ESP_GATT_UUID_CHAR_AGG_FORMAT
  49. .. doxygendefine:: ESP_GATT_UUID_CHAR_VALID_RANGE
  50. .. doxygendefine:: ESP_GATT_UUID_EXT_RPT_REF_DESCR
  51. .. doxygendefine:: ESP_GATT_UUID_RPT_REF_DESCR
  52. .. doxygendefine:: ESP_GATT_UUID_GAP_DEVICE_NAME
  53. .. doxygendefine:: ESP_GATT_UUID_GAP_ICON
  54. .. doxygendefine:: ESP_GATT_UUID_GAP_PREF_CONN_PARAM
  55. .. doxygendefine:: ESP_GATT_UUID_GAP_CENTRAL_ADDR_RESOL
  56. .. doxygendefine:: ESP_GATT_UUID_GATT_SRV_CHGD
  57. .. doxygendefine:: ESP_GATT_UUID_ALERT_LEVEL
  58. .. doxygendefine:: ESP_GATT_UUID_TX_POWER_LEVEL
  59. .. doxygendefine:: ESP_GATT_UUID_CURRENT_TIME
  60. .. doxygendefine:: ESP_GATT_UUID_LOCAL_TIME_INFO
  61. .. doxygendefine:: ESP_GATT_UUID_REF_TIME_INFO
  62. .. doxygendefine:: ESP_GATT_UUID_NW_STATUS
  63. .. doxygendefine:: ESP_GATT_UUID_NW_TRIGGER
  64. .. doxygendefine:: ESP_GATT_UUID_ALERT_STATUS
  65. .. doxygendefine:: ESP_GATT_UUID_RINGER_CP
  66. .. doxygendefine:: ESP_GATT_UUID_RINGER_SETTING
  67. .. doxygendefine:: ESP_GATT_UUID_GM_MEASUREMENT
  68. .. doxygendefine:: ESP_GATT_UUID_GM_CONTEXT
  69. .. doxygendefine:: ESP_GATT_UUID_GM_CONTROL_POINT
  70. .. doxygendefine:: ESP_GATT_UUID_GM_FEATURE
  71. .. doxygendefine:: ESP_GATT_UUID_SYSTEM_ID
  72. .. doxygendefine:: ESP_GATT_UUID_MODEL_NUMBER_STR
  73. .. doxygendefine:: ESP_GATT_UUID_SERIAL_NUMBER_STR
  74. .. doxygendefine:: ESP_GATT_UUID_FW_VERSION_STR
  75. .. doxygendefine:: ESP_GATT_UUID_HW_VERSION_STR
  76. .. doxygendefine:: ESP_GATT_UUID_SW_VERSION_STR
  77. .. doxygendefine:: ESP_GATT_UUID_MANU_NAME
  78. .. doxygendefine:: ESP_GATT_UUID_IEEE_DATA
  79. .. doxygendefine:: ESP_GATT_UUID_PNP_ID
  80. .. doxygendefine:: ESP_GATT_UUID_HID_INFORMATION
  81. .. doxygendefine:: ESP_GATT_UUID_HID_REPORT_MAP
  82. .. doxygendefine:: ESP_GATT_UUID_HID_CONTROL_POINT
  83. .. doxygendefine:: ESP_GATT_UUID_HID_REPORT
  84. .. doxygendefine:: ESP_GATT_UUID_HID_PROTO_MODE
  85. .. doxygendefine:: ESP_GATT_UUID_HID_BT_KB_INPUT
  86. .. doxygendefine:: ESP_GATT_UUID_HID_BT_KB_OUTPUT
  87. .. doxygendefine:: ESP_GATT_UUID_HID_BT_MOUSE_INPUT
  88. .. doxygendefine:: ESP_GATT_HEART_RATE_MEAS
  89. .. doxygendefine:: ESP_GATT_BODY_SENSOR_LOCATION
  90. .. doxygendefine:: ESP_GATT_HEART_RATE_CNTL_POINT
  91. .. doxygendefine:: ESP_GATT_UUID_BATTERY_LEVEL
  92. .. doxygendefine:: ESP_GATT_UUID_SC_CONTROL_POINT
  93. .. doxygendefine:: ESP_GATT_UUID_SENSOR_LOCATION
  94. .. doxygendefine:: ESP_GATT_UUID_RSC_MEASUREMENT
  95. .. doxygendefine:: ESP_GATT_UUID_RSC_FEATURE
  96. .. doxygendefine:: ESP_GATT_UUID_CSC_MEASUREMENT
  97. .. doxygendefine:: ESP_GATT_UUID_CSC_FEATURE
  98. .. doxygendefine:: ESP_GATT_UUID_SCAN_INT_WINDOW
  99. .. doxygendefine:: ESP_GATT_UUID_SCAN_REFRESH
  100. .. doxygendefine:: ESP_GATT_ILLEGAL_UUID
  101. .. doxygendefine:: ESP_GATT_ILLEGAL_HANDLE
  102. .. doxygendefine:: ESP_GATT_ATTR_HANDLE_MAX
  103. .. doxygendefine:: ESP_GATT_MAX_ATTR_LEN
  104. .. doxygendefine:: ESP_GATT_RSP_BY_APP
  105. .. doxygendefine:: ESP_GATT_AUTO_RSP
  106. .. doxygendefine:: ESP_GATT_IF_NONE
  107. Type Definitions
  108. ^^^^^^^^^^^^^^^^
  109. .. doxygentypedef:: esp_gatt_if_t
  110. Enumerations
  111. ^^^^^^^^^^^^
  112. .. doxygenenum:: esp_gatt_prep_write_type
  113. .. doxygenenum:: esp_gatt_status_t
  114. .. doxygenenum:: esp_gatt_conn_reason_t
  115. .. doxygenenum:: esp_gatt_auth_req_t
  116. .. doxygenenum:: esp_gatt_perm_t
  117. .. doxygenenum:: esp_gatt_char_prop_t
  118. .. doxygenenum:: esp_gatt_write_type_t
  119. Structures
  120. ^^^^^^^^^^
  121. .. doxygenstruct:: esp_attr_desc_t
  122. :members:
  123. .. doxygenstruct:: esp_attr_control_t
  124. :members:
  125. .. doxygenstruct:: esp_gatts_attr_db_t
  126. :members:
  127. .. doxygenstruct:: esp_attr_value_t
  128. :members:
  129. .. doxygenstruct:: esp_gatts_incl_svc_desc_t
  130. :members:
  131. .. doxygenstruct:: esp_gatts_incl128_svc_desc_t
  132. :members:
  133. .. doxygenstruct:: esp_gatt_value_t
  134. :members:
  135. .. doxygenstruct:: esp_gatt_rsp_t
  136. :members:
  137. Functions
  138. ^^^^^^^^^