# GATT Defines

## API Reference

### Header File

- components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h

- This header file can be included with:

  >     #include "esp_gatt_defs.h"

- This header file is a part of the API provided by the `bt` component. To declare that your component depends on `bt`, add the following to your CMakeLists.txt:

  >     REQUIRES bt

  > or

  >     PRIV_REQUIRES bt

### Unions

union esp_gatt_rsp_t
  #include <esp_gatt_defs.h>

  Represents the response type for a GATT remote read request.

  Public Members

  esp_gatt_value_t attr_value

    The GATT attribute value, including its data, handle, and metadata.

  uint16_t handle

    Only the handle of the GATT attribute, when that's the only required information.

### Structures

struct esp_gatt_id_t

  Represents a GATT identifier.

  Public Members

  esp_bt_uuid_t uuid

    The UUID component of the GATT ID.

  uint8_t inst_id

    The instance ID component of the GATT ID, providing further differentiation of the GATT ID.

struct esp_gatt_srvc_id_t

  Represents a GATT service identifier.

  Public Members

  esp_gatt_id_t id

    Encapsulates the UUID and instance ID of the GATT service.

  bool is_primary

    Indicates if the service is primary. A value of true means it is a primary service, false indicates a secondary service.

struct esp_attr_desc_t

  Defines an attribute's description.

  This structure is used to describe an attribute in the GATT database. It includes details such as the UUID of the attribute, its permissions, and its value.

  Public Members

  uint16_t uuid_length

    Length of the UUID in bytes.

  uint8_t *uuid_p

    Pointer to the UUID value.

  uint16_t perm

    Attribute permissions, defined by esp_gatt_perm_t.

  uint16_t max_length

    Maximum length of the attribute's value.

  uint16_t length

    Current length of the attribute's value.

  uint8_t *value

    Pointer to the attribute's value array.

struct esp_attr_control_t

  Defines the auto response setting for attribute operations.

  This structure is used to control whether the GATT stack or the application will handle responses to Read/Write operations.

  Public Members

  uint8_t auto_rsp

    Controls who handles the response to Read/Write operations.

    - If set to `ESP_GATT_RSP_BY_APP`, the application is responsible for generating the response.

    - If set to `ESP_GATT_AUTO_RSP`, the GATT stack will automatically generate the response.

struct esp_gatts_attr_db_t

  attribute type added to the GATT server database

  Public Members

  esp_attr_control_t attr_control

    The attribute control type

  esp_attr_desc_t att_desc

    The attribute type

struct esp_attr_value_t

  set the attribute value type

  Public Members

  uint16_t attr_max_len

    attribute max value length

  uint16_t attr_len

    attribute current value length

  uint8_t *attr_value

    the pointer to attribute value

struct esp_gatts_incl_svc_desc_t

  Gatt include service entry element.

  Public Members

  uint16_t start_hdl

    Gatt start handle value of included service

  uint16_t end_hdl

    Gatt end handle value of included service

  uint16_t uuid

    Gatt attribute value UUID of included service

struct esp_gatts_incl128_svc_desc_t

  Gatt include 128 bit service entry element.

  Public Members

  uint16_t start_hdl

    Gatt start handle value of included 128 bit service

  uint16_t end_hdl

    Gatt end handle value of included 128 bit service

struct esp_gatt_value_t

  Represents a GATT attribute's value.

  Public Members

  uint8_t value[ESP_GATT_MAX_ATTR_LEN]

    Array holding the value of the GATT attribute.

  uint16_t handle

    Unique identifier (handle) of the GATT attribute.

  uint16_t offset

    Offset within the attribute's value, for partial updates.

  uint16_t len

    Current length of the data in the value array.

  uint8_t auth_req

    Authentication requirements for accessing this attribute.

struct esp_gatt_conn_params_t

  Connection parameters for GATT.

  Public Members

  uint16_t interval

    Connection interval.

  uint16_t latency

    Slave latency for the connection in number of connection events.

  uint16_t timeout

    Supervision timeout for the LE Link.

struct esp_gattc_multi_t

  Represents multiple attributes for reading.

  Public Members

  uint8_t num_attr

    Number of attributes.

  uint16_t handles[ESP_GATT_MAX_READ_MULTI_HANDLES]

    List of attribute handles.

struct esp_gattc_db_elem_t

  GATT database attribute element.

  Public Members

  esp_gatt_db_attr_type_t type

    Attribute type.

  uint16_t attribute_handle

    Attribute handle.

  uint16_t start_handle

    Service start handle.

  uint16_t end_handle

    Service end handle.

  esp_gatt_char_prop_t properties

    Characteristic properties.

  esp_bt_uuid_t uuid

    Attribute UUID.

struct esp_gattc_service_elem_t

  Represents a GATT service element.

  Public Members

  bool is_primary

    Indicates if the service is primary.

  uint16_t start_handle

    Service start handle.

  uint16_t end_handle

    Service end handle.

  esp_bt_uuid_t uuid

    Service UUID.

struct esp_gattc_char_elem_t

  Represents a GATT characteristic element.

  Public Members

  uint16_t char_handle

    Characteristic handle.

  esp_gatt_char_prop_t properties

    Characteristic properties.

  esp_bt_uuid_t uuid

    Characteristic UUID.

struct esp_gattc_descr_elem_t

  Represents a GATT descriptor element.

  Public Members

  uint16_t handle

    Descriptor handle.

  esp_bt_uuid_t uuid

    Descriptor UUID.

struct esp_gattc_incl_svc_elem_t

  Represents an included GATT service element.

  Public Members

  uint16_t handle

    Current attribute handle of the included service.

  uint16_t incl_srvc_s_handle

    Start handle of the included service.

  uint16_t incl_srvc_e_handle

    End handle of the included service.

  esp_bt_uuid_t uuid

    Included service UUID.

struct esp_ble_gatt_creat_conn_params_t

  Represents a creat connection element.

  Public Members

  esp_bd_addr_t remote_bda

    The Bluetooth address of the remote device

  esp_ble_addr_type_t remote_addr_type

    Address type of the remote device

  bool is_direct

    Direct connection or background auto connection(by now, background auto connection is not supported

  bool is_aux

    Set to true for BLE 5.0 or higher to enable auxiliary connections; set to false for BLE 4.2 or lower.

  esp_ble_addr_type_t own_addr_type

    Specifies the address type used in the connection request. Set to 0xFF if the address type is unknown.

  esp_ble_phy_mask_t phy_mask

    Indicates which PHY connection parameters will be used. When is_aux is false, only the connection params for 1M PHY can be specified

  const esp_ble_conn_params_t *phy_1m_conn_params

    Connection parameters for the LE 1M PHY

  const esp_ble_conn_params_t *phy_2m_conn_params

    Connection parameters for the LE 2M PHY

  const esp_ble_conn_params_t *phy_coded_conn_params

    Connection parameters for the LE Coded PHY

### Macros

ESP_GATT_ILLEGAL_UUID

  GATT INVALID UUID.

ESP_GATT_ILLEGAL_HANDLE

  GATT INVALID HANDLE.

ESP_GATT_ATTR_HANDLE_MAX

  GATT attribute max handle.

ESP_GATT_MAX_READ_MULTI_HANDLES

  Maximum number of attributes to read in one request.

ESP_GATT_UUID_IMMEDIATE_ALERT_SVC

  Immediate Alert Service UUID.

ESP_GATT_UUID_LINK_LOSS_SVC

  Link Loss Service UUID.

ESP_GATT_UUID_TX_POWER_SVC

  TX Power Service UUID.

ESP_GATT_UUID_CURRENT_TIME_SVC

  Current Time Service UUID.

ESP_GATT_UUID_REF_TIME_UPDATE_SVC

  Reference Time Update Service UUID.

ESP_GATT_UUID_NEXT_DST_CHANGE_SVC

  Next DST Change Service UUID.

ESP_GATT_UUID_GLUCOSE_SVC

  Glucose Service UUID.

ESP_GATT_UUID_HEALTH_THERMOM_SVC

  Health Thermometer Service UUID.

ESP_GATT_UUID_DEVICE_INFO_SVC

  Device Information Service UUID.

ESP_GATT_UUID_HEART_RATE_SVC

  Heart Rate Service UUID.

ESP_GATT_UUID_PHONE_ALERT_STATUS_SVC

  Phone Alert Status Service UUID.

ESP_GATT_UUID_BATTERY_SERVICE_SVC

  Battery Service UUID.

ESP_GATT_UUID_BLOOD_PRESSURE_SVC

  Blood Pressure Service UUID.

ESP_GATT_UUID_ALERT_NTF_SVC

  Alert Notification Service UUID.

ESP_GATT_UUID_HID_SVC

  HID Service UUID.

ESP_GATT_UUID_SCAN_PARAMETERS_SVC

  Scan Parameters Service UUID.

ESP_GATT_UUID_RUNNING_SPEED_CADENCE_SVC

  Running Speed and Cadence Service UUID.

ESP_GATT_UUID_Automation_IO_SVC

  Automation IO Service UUID.

ESP_GATT_UUID_CYCLING_SPEED_CADENCE_SVC

  Cycling Speed and Cadence Service UUID.

ESP_GATT_UUID_CYCLING_POWER_SVC

  Cycling Power Service UUID.

ESP_GATT_UUID_LOCATION_AND_NAVIGATION_SVC

  Location and Navigation Service UUID.

ESP_GATT_UUID_ENVIRONMENTAL_SENSING_SVC

  Environmental Sensing Service UUID.

ESP_GATT_UUID_BODY_COMPOSITION

  Body Composition Service UUID.

ESP_GATT_UUID_USER_DATA_SVC

  User Data Service UUID.

ESP_GATT_UUID_WEIGHT_SCALE_SVC

  Weight Scale Service UUID.

ESP_GATT_UUID_BOND_MANAGEMENT_SVC

  Bond Management Service UUID.

ESP_GATT_UUID_CONT_GLUCOSE_MONITOR_SVC

  Continuous Glucose Monitoring Service UUID.

ESP_GATT_UUID_PRI_SERVICE

  Primary Service UUID.

ESP_GATT_UUID_SEC_SERVICE

  Secondary Service UUID.

ESP_GATT_UUID_INCLUDE_SERVICE

  Include Service UUID.

ESP_GATT_UUID_CHAR_DECLARE

  Characteristic Declaration UUID.

ESP_GATT_UUID_CHAR_EXT_PROP

  Characteristic Extended Properties UUID.

ESP_GATT_UUID_CHAR_DESCRIPTION

  Characteristic User Description UUID.

ESP_GATT_UUID_CHAR_CLIENT_CONFIG

  Client Characteristic Configuration UUID.

ESP_GATT_UUID_CHAR_SRVR_CONFIG

  Server Characteristic Configuration UUID.

ESP_GATT_UUID_CHAR_PRESENT_FORMAT

  Characteristic Presentation Format UUID.

ESP_GATT_UUID_CHAR_AGG_FORMAT

  Characteristic Aggregate Format UUID.

ESP_GATT_UUID_CHAR_VALID_RANGE

  Characteristic Valid Range UUID.

ESP_GATT_UUID_EXT_RPT_REF_DESCR

  External Report Reference Descriptor UUID.

ESP_GATT_UUID_RPT_REF_DESCR

  Report Reference Descriptor UUID.

ESP_GATT_UUID_NUM_DIGITALS_DESCR

  Number of Digitals Descriptor UUID.

ESP_GATT_UUID_VALUE_TRIGGER_DESCR

  Value Trigger Setting Descriptor UUID.

ESP_GATT_UUID_ENV_SENSING_CONFIG_DESCR

  Environmental Sensing Configuration Descriptor UUID.

ESP_GATT_UUID_ENV_SENSING_MEASUREMENT_DESCR

  Environmental Sensing Measurement Descriptor UUID.

ESP_GATT_UUID_ENV_SENSING_TRIGGER_DESCR

  Environmental Sensing Trigger Setting Descriptor UUID.

ESP_GATT_UUID_TIME_TRIGGER_DESCR

  Time Trigger Setting Descriptor UUID.

ESP_GATT_UUID_GAP_DEVICE_NAME

  GAP Device Name UUID.

ESP_GATT_UUID_GAP_ICON

  GAP Icon UUID.

ESP_GATT_UUID_GAP_PREF_CONN_PARAM

  GAP Preferred Connection Parameters UUID.

ESP_GATT_UUID_GAP_CENTRAL_ADDR_RESOL

  GAP Central Address Resolution UUID.

ESP_GATT_UUID_GATT_SRV_CHGD

  GATT Service Changed UUID.

ESP_GATT_UUID_ALERT_LEVEL

  Alert Level UUID.

ESP_GATT_UUID_TX_POWER_LEVEL

  TX Power Level UUID.

ESP_GATT_UUID_CURRENT_TIME

  Current Time UUID.

ESP_GATT_UUID_LOCAL_TIME_INFO

  Local Time Info UUID.

ESP_GATT_UUID_REF_TIME_INFO

  Reference Time Information UUID.

ESP_GATT_UUID_NW_STATUS

  Network Availability Status UUID.

ESP_GATT_UUID_NW_TRIGGER

  Network Availability Trigger UUID.

ESP_GATT_UUID_ALERT_STATUS

  Alert Status UUID.

ESP_GATT_UUID_RINGER_CP

  Ringer Control Point UUID.

ESP_GATT_UUID_RINGER_SETTING

  Ringer Setting UUID.

ESP_GATT_UUID_GM_MEASUREMENT

  Glucose Measurement Characteristic UUID.

ESP_GATT_UUID_GM_CONTEXT

  Glucose Measurement Context Characteristic UUID.

ESP_GATT_UUID_GM_CONTROL_POINT

  Glucose Control Point Characteristic UUID.

ESP_GATT_UUID_GM_FEATURE

  Glucose Feature Characteristic UUID.

ESP_GATT_UUID_SYSTEM_ID

  System ID Characteristic UUID.

ESP_GATT_UUID_MODEL_NUMBER_STR

  Model Number String Characteristic UUID.

ESP_GATT_UUID_SERIAL_NUMBER_STR

  Serial Number String Characteristic UUID.

ESP_GATT_UUID_FW_VERSION_STR

  Firmware Revision String Characteristic UUID.

ESP_GATT_UUID_HW_VERSION_STR

  Hardware Revision String Characteristic UUID.

ESP_GATT_UUID_SW_VERSION_STR

  Software Revision String Characteristic UUID.

ESP_GATT_UUID_MANU_NAME

  Manufacturer Name String Characteristic UUID.

ESP_GATT_UUID_IEEE_DATA

  IEEE 11073-20601 Regulatory Certification Data List Characteristic UUID.

ESP_GATT_UUID_PNP_ID

  PnP ID Characteristic UUID.

ESP_GATT_UUID_HID_INFORMATION

  HID Information Characteristic UUID.

ESP_GATT_UUID_HID_REPORT_MAP

  HID Report Map Characteristic UUID.

ESP_GATT_UUID_HID_CONTROL_POINT

  HID Control Point Characteristic UUID.

ESP_GATT_UUID_HID_REPORT

  HID Report Characteristic UUID.

ESP_GATT_UUID_HID_PROTO_MODE

  HID Protocol Mode Characteristic UUID.

ESP_GATT_UUID_HID_BT_KB_INPUT

  HID Bluetooth Keyboard Input Characteristic UUID.

ESP_GATT_UUID_HID_BT_KB_OUTPUT

  HID Bluetooth Keyboard Output Characteristic UUID.

ESP_GATT_UUID_HID_BT_MOUSE_INPUT

  HID Bluetooth Mouse Input Characteristic UUID.

ESP_GATT_HEART_RATE_MEAS

  Heart Rate Measurement Characteristic UUID.

ESP_GATT_BODY_SENSOR_LOCATION

  Body Sensor Location Characteristic UUID.

ESP_GATT_HEART_RATE_CNTL_POINT

  Heart Rate Control Point Characteristic UUID.

ESP_GATT_UUID_BATTERY_LEVEL

  Battery Level Characteristic UUID.

ESP_GATT_UUID_SC_CONTROL_POINT

  Sensor Control Point Characteristic UUID.

ESP_GATT_UUID_SENSOR_LOCATION

  Sensor Location Characteristic UUID.

ESP_GATT_UUID_RSC_MEASUREMENT

  RSC Measurement Characteristic UUID.

ESP_GATT_UUID_RSC_FEATURE

  RSC Feature Characteristic UUID.

ESP_GATT_UUID_CSC_MEASUREMENT

  CSC Measurement Characteristic UUID.

ESP_GATT_UUID_CSC_FEATURE

  CSC Feature Characteristic UUID.

ESP_GATT_UUID_SCAN_INT_WINDOW

  Scan Interval Window Characteristic UUID.

ESP_GATT_UUID_SCAN_REFRESH

  Scan Refresh UUID.

ESP_GATT_PERM_READ

  Permission to read the attribute. Corresponds to BTA_GATT_PERM_READ.

ESP_GATT_PERM_READ_ENCRYPTED

  Permission to read the attribute with encryption. Corresponds to BTA_GATT_PERM_READ_ENCRYPTED.

ESP_GATT_PERM_READ_ENC_MITM

  Permission to read the attribute with encrypted MITM (Man In The Middle) protection. Corresponds to BTA_GATT_PERM_READ_ENC_MITM.

ESP_GATT_PERM_WRITE

  Permission to write to the attribute. Corresponds to BTA_GATT_PERM_WRITE.

ESP_GATT_PERM_WRITE_ENCRYPTED

  Permission to write to the attribute with encryption. Corresponds to BTA_GATT_PERM_WRITE_ENCRYPTED.

ESP_GATT_PERM_WRITE_ENC_MITM

  Permission to write to the attribute with encrypted MITM protection. Corresponds to BTA_GATT_PERM_WRITE_ENC_MITM.

ESP_GATT_PERM_WRITE_SIGNED

  Permission for signed writes to the attribute. Corresponds to BTA_GATT_PERM_WRITE_SIGNED.

ESP_GATT_PERM_WRITE_SIGNED_MITM

  Permission for signed writes to the attribute with MITM protection. Corresponds to BTA_GATT_PERM_WRITE_SIGNED_MITM.

ESP_GATT_PERM_READ_AUTHORIZATION

  Permission to read the attribute with authorization.

ESP_GATT_PERM_WRITE_AUTHORIZATION

  Permission to write to the attribute with authorization.

ESP_GATT_PERM_ENCRYPT_KEY_SIZE(keysize)

  Macro to specify minimum encryption key size.

  Parameters:

    - keysize -- The minimum size of the encryption key, in bytes.

ESP_GATT_CHAR_PROP_BIT_BROADCAST

  Ability to broadcast.Corresponds to BTA_GATT_CHAR_PROP_BIT_BROADCAST.

ESP_GATT_CHAR_PROP_BIT_READ

  Ability to read.Corresponds to BTA_GATT_CHAR_PROP_BIT_READ.

ESP_GATT_CHAR_PROP_BIT_WRITE_NR

  Ability to write without response.Corresponds to BTA_GATT_CHAR_PROP_BIT_WRITE_NR.

ESP_GATT_CHAR_PROP_BIT_WRITE

  Ability to write.Corresponds to BTA_GATT_CHAR_PROP_BIT_WRITE.

ESP_GATT_CHAR_PROP_BIT_NOTIFY

  Ability to notify.Corresponds to BTA_GATT_CHAR_PROP_BIT_NOTIFY.

ESP_GATT_CHAR_PROP_BIT_INDICATE

  Ability to indicate.Corresponds to BTA_GATT_CHAR_PROP_BIT_INDICATE.

ESP_GATT_CHAR_PROP_BIT_AUTH

  Ability to authenticate.Corresponds to BTA_GATT_CHAR_PROP_BIT_AUTH.

ESP_GATT_CHAR_PROP_BIT_EXT_PROP

  Has extended properties.Corresponds to BTA_GATT_CHAR_PROP_BIT_EXT_PROP.

ESP_GATT_MAX_ATTR_LEN

  Defines the maximum length of a GATT attribute.

  This definition specifies the maximum number of bytes that a GATT attribute can hold. As same as GATT_MAX_ATTR_LEN.

ESP_GATT_RSP_BY_APP

  Defines attribute control for GATT operations.

  This module provides definitions for controlling attribute auto responses in GATT operations.

  Response to Write/Read operations should be handled by the application.

ESP_GATT_AUTO_RSP

  Response to Write/Read operations should be automatically handled by the GATT stack.

ESP_GATT_IF_NONE

  Macro indicating no specific GATT interface.

  No specific application GATT interface.

### Type Definitions

typedef uint16_t esp_gatt_perm_t

  Type to represent GATT attribute permissions.

typedef uint8_t esp_gatt_char_prop_t

  Type for characteristic properties bitmask.

typedef uint8_t esp_gatt_if_t

  GATT interface type for client applications.

### Enumerations

enum esp_gatt_prep_write_type

  Defines the attribute write operation types from the client.

  These values are used to specify the type of write operation in a prepare write sequence. relate to BTA_GATT_PREP_WRITE_xxx in bta/bta_gatt_api.h.

  Values:

  enumerator ESP_GATT_PREP_WRITE_CANCEL

    Prepare write cancel. Corresponds to BTA_GATT_PREP_WRITE_CANCEL.

  enumerator ESP_GATT_PREP_WRITE_EXEC

    Prepare write execute. Corresponds to BTA_GATT_PREP_WRITE_EXEC.

enum esp_gatt_status_t

  GATT operation status codes.

  These status codes are used to indicate the result of various GATT operations. relate to BTA_GATT_xxx in bta/bta_gatt_api.h .

  Values:

  enumerator ESP_GATT_OK

    0x0, Operation successful. Corresponds to BTA_GATT_OK.

  enumerator ESP_GATT_INVALID_HANDLE

    0x01, Invalid handle. Corresponds to BTA_GATT_INVALID_HANDLE.

  enumerator ESP_GATT_READ_NOT_PERMIT

    0x02, Read operation not permitted. Corresponds to BTA_GATT_READ_NOT_PERMIT.

  enumerator ESP_GATT_WRITE_NOT_PERMIT

    0x03, Write operation not permitted. Corresponds to BTA_GATT_WRITE_NOT_PERMIT.

  enumerator ESP_GATT_INVALID_PDU

    0x04, Invalid PDU. Corresponds to BTA_GATT_INVALID_PDU.

  enumerator ESP_GATT_INSUF_AUTHENTICATION

    0x05, Insufficient authentication. Corresponds to BTA_GATT_INSUF_AUTHENTICATION.

  enumerator ESP_GATT_REQ_NOT_SUPPORTED

    0x06, Request not supported. Corresponds to BTA_GATT_REQ_NOT_SUPPORTED.

  enumerator ESP_GATT_INVALID_OFFSET

    0x07, Invalid offset. Corresponds to BTA_GATT_INVALID_OFFSET.

  enumerator ESP_GATT_INSUF_AUTHORIZATION

    0x08, Insufficient authorization. Corresponds to BTA_GATT_INSUF_AUTHORIZATION.

  enumerator ESP_GATT_PREPARE_Q_FULL

    0x09, Prepare queue full. Corresponds to BTA_GATT_PREPARE_Q_FULL.

  enumerator ESP_GATT_NOT_FOUND

    0x0a, Not found. Corresponds to BTA_GATT_NOT_FOUND.

  enumerator ESP_GATT_NOT_LONG

    0x0b, Not long. Corresponds to BTA_GATT_NOT_LONG.

  enumerator ESP_GATT_INSUF_KEY_SIZE

    0x0c, Insufficient key size. Corresponds to BTA_GATT_INSUF_KEY_SIZE.

  enumerator ESP_GATT_INVALID_ATTR_LEN

    0x0d, Invalid attribute length. Corresponds to BTA_GATT_INVALID_ATTR_LEN.

  enumerator ESP_GATT_ERR_UNLIKELY

    0x0e, Unlikely error. Corresponds to BTA_GATT_ERR_UNLIKELY.

  enumerator ESP_GATT_INSUF_ENCRYPTION

    0x0f, Insufficient encryption. Corresponds to BTA_GATT_INSUF_ENCRYPTION.

  enumerator ESP_GATT_UNSUPPORT_GRP_TYPE

    0x10, Unsupported group type. Corresponds to BTA_GATT_UNSUPPORT_GRP_TYPE.

  enumerator ESP_GATT_INSUF_RESOURCE

    0x11, Insufficient resource. Corresponds to BTA_GATT_INSUF_RESOURCE.

  enumerator ESP_GATT_NO_RESOURCES

    0x80, No resources. Corresponds to BTA_GATT_NO_RESOURCES.

  enumerator ESP_GATT_INTERNAL_ERROR

    0x81, Internal error. Corresponds to BTA_GATT_INTERNAL_ERROR.

  enumerator ESP_GATT_WRONG_STATE

    0x82, Wrong state. Corresponds to BTA_GATT_WRONG_STATE.

  enumerator ESP_GATT_DB_FULL

    0x83, Database full. Corresponds to BTA_GATT_DB_FULL.

  enumerator ESP_GATT_BUSY

    0x84, Busy. Corresponds to BTA_GATT_BUSY.

  enumerator ESP_GATT_ERROR

    0x85, Generic error. Corresponds to BTA_GATT_ERROR.

  enumerator ESP_GATT_CMD_STARTED

    0x86, Command started. Corresponds to BTA_GATT_CMD_STARTED.

  enumerator ESP_GATT_ILLEGAL_PARAMETER

    0x87, Illegal parameter. Corresponds to BTA_GATT_ILLEGAL_PARAMETER.

  enumerator ESP_GATT_PENDING

    0x88, Operation pending. Corresponds to BTA_GATT_PENDING.

  enumerator ESP_GATT_AUTH_FAIL

    0x89, Authentication failed. Corresponds to BTA_GATT_AUTH_FAIL.

  enumerator ESP_GATT_MORE

    0x8a, More data available. Corresponds to BTA_GATT_MORE.

  enumerator ESP_GATT_INVALID_CFG

    0x8b, Invalid configuration. Corresponds to BTA_GATT_INVALID_CFG.

  enumerator ESP_GATT_SERVICE_STARTED

    0x8c, Service started. Corresponds to BTA_GATT_SERVICE_STARTED.

  enumerator ESP_GATT_ENCRYPTED_MITM

    0x0, Encrypted, with MITM protection. Corresponds to BTA_GATT_ENCRYPTED_MITM.

  enumerator ESP_GATT_ENCRYPTED_NO_MITM

    0x8d, Encrypted, without MITM protection. Corresponds to BTA_GATT_ENCRYPTED_NO_MITM.

  enumerator ESP_GATT_NOT_ENCRYPTED

    0x8e, Not encrypted. Corresponds to BTA_GATT_NOT_ENCRYPTED.

  enumerator ESP_GATT_CONGESTED

    0x8f, Congested. Corresponds to BTA_GATT_CONGESTED.

  enumerator ESP_GATT_DUP_REG

    0x90, Duplicate registration. Corresponds to BTA_GATT_DUP_REG.

  enumerator ESP_GATT_ALREADY_OPEN

    0x91, Already open. Corresponds to BTA_GATT_ALREADY_OPEN.

  enumerator ESP_GATT_CANCEL

    0x92, Operation cancelled. Corresponds to BTA_GATT_CANCEL.

  enumerator ESP_GATT_STACK_RSP

    0xe0, Stack response. Corresponds to BTA_GATT_STACK_RSP.

  enumerator ESP_GATT_APP_RSP

    0xe1, Application response. Corresponds to BTA_GATT_APP_RSP.

  enumerator ESP_GATT_UNKNOWN_ERROR

    0xef, Unknown error. Corresponds to BTA_GATT_UNKNOWN_ERROR.

  enumerator ESP_GATT_CCC_CFG_ERR

    0xfd, Client Characteristic Configuration Descriptor improperly configured. Corresponds to BTA_GATT_CCC_CFG_ERR.

  enumerator ESP_GATT_PRC_IN_PROGRESS

    0xfe, Procedure already in progress. Corresponds to BTA_GATT_PRC_IN_PROGRESS.

  enumerator ESP_GATT_OUT_OF_RANGE

    0xff, Attribute value out of range. Corresponds to BTA_GATT_OUT_OF_RANGE.

enum esp_gatt_conn_reason_t

  Enumerates reasons for GATT connection.

  Values:

  enumerator ESP_GATT_CONN_UNKNOWN

    Unknown connection reason. Corresponds to BTA_GATT_CONN_UNKNOWN in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_L2C_FAILURE

    General L2CAP failure. Corresponds to BTA_GATT_CONN_L2C_FAILURE in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_TIMEOUT

    Connection timeout. Corresponds to BTA_GATT_CONN_TIMEOUT in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_TERMINATE_PEER_USER

    Connection terminated by peer user. Corresponds to BTA_GATT_CONN_TERMINATE_PEER_USER in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_TERMINATE_LOCAL_HOST

    Connection terminated by local host. Corresponds to BTA_GATT_CONN_TERMINATE_LOCAL_HOST in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_FAIL_ESTABLISH

    Failure to establish connection. Corresponds to BTA_GATT_CONN_FAIL_ESTABLISH in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_LMP_TIMEOUT

    Connection failed due to LMP response timeout. Corresponds to BTA_GATT_CONN_LMP_TIMEOUT in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_CONN_CANCEL

    L2CAP connection cancelled. Corresponds to BTA_GATT_CONN_CONN_CANCEL in bta/bta_gatt_api.h

  enumerator ESP_GATT_CONN_NONE

    No connection to cancel. Corresponds to BTA_GATT_CONN_NONE in bta/bta_gatt_api.h

enum esp_gatt_auth_req_t

  Defines the GATT authentication request types.

  This enumeration lists the types of authentication requests that can be made. It corresponds to the `BTA_GATT_AUTH_REQ_xxx` values defined in `bta/bta_gatt_api.h`. The types include options for no authentication, unauthenticated encryption, authenticated encryption, and both signed versions with and without MITM (Man-In-The-Middle) protection.

  Values:

  enumerator ESP_GATT_AUTH_REQ_NONE

    No authentication required. Corresponds to BTA_GATT_AUTH_REQ_NONE.

  enumerator ESP_GATT_AUTH_REQ_NO_MITM

    Unauthenticated encryption. Corresponds to BTA_GATT_AUTH_REQ_NO_MITM.

  enumerator ESP_GATT_AUTH_REQ_MITM

    Authenticated encryption (MITM protection). Corresponds to BTA_GATT_AUTH_REQ_MITM.

  enumerator ESP_GATT_AUTH_REQ_SIGNED_NO_MITM

    Signed data, no MITM protection. Corresponds to BTA_GATT_AUTH_REQ_SIGNED_NO_MITM.

  enumerator ESP_GATT_AUTH_REQ_SIGNED_MITM

    Signed data with MITM protection. Corresponds to BTA_GATT_AUTH_REQ_SIGNED_MITM.

enum esp_service_source_t

  Enumerates the possible sources of a GATT service discovery.

  This enumeration identifies the source of a GATT service discovery process, indicating whether the service information was obtained from a remote device, from NVS (Non-Volatile Storage) flash, or the source is unknown.

  Values:

  enumerator ESP_GATT_SERVICE_FROM_REMOTE_DEVICE

    Service information from a remote device. Relates to BTA_GATTC_SERVICE_INFO_FROM_REMOTE_DEVICE.

  enumerator ESP_GATT_SERVICE_FROM_NVS_FLASH

    Service information from NVS flash. Relates to BTA_GATTC_SERVICE_INFO_FROM_NVS_FLASH.

  enumerator ESP_GATT_SERVICE_FROM_UNKNOWN

    Service source is unknown. Relates to BTA_GATTC_SERVICE_INFO_FROM_UNKNOWN.

enum esp_gatt_write_type_t

  Defines the types of GATT write operations.

  Values:

  enumerator ESP_GATT_WRITE_TYPE_NO_RSP

    Write operation where no response is needed.

  enumerator ESP_GATT_WRITE_TYPE_RSP

    Write operation that requires a remote response.

enum esp_gatt_db_attr_type_t

  Enumerates types of GATT database attributes.

  Values:

  enumerator ESP_GATT_DB_PRIMARY_SERVICE

    Primary service attribute.

  enumerator ESP_GATT_DB_SECONDARY_SERVICE

    Secondary service attribute.

  enumerator ESP_GATT_DB_CHARACTERISTIC

    Characteristic attribute.

  enumerator ESP_GATT_DB_DESCRIPTOR

    Descriptor attribute.

  enumerator ESP_GATT_DB_INCLUDED_SERVICE

    Included service attribute.

  enumerator ESP_GATT_DB_ALL

    All attribute types.

Was this page helpful?

- Thank you! We received your feedback.
- If you have any comments, fill in Espressif Documentation Feedback Form.

- We value your feedback.
- Let us know how we can improve this page by filling in Espressif Documentation Feedback Form.