Classes | Enumerations | Functions
ble_gattc.h File Reference

BLE GATTC API. More...

`#include "ble_error.h"`
`#include "ble_gatt.h"`
`#include "ble_att.h"`
`#include <stdint.h>`
`#include <stdbool.h>`

Go to the source code of this file.

## Classes
struct | ble_gattc_disc_char_t
| GATTC discovery characteristic structure. More...
struct | ble_gattc_read_by_uuid_t
| GATTC read by characteristic UUID structure. More...
struct | ble_gattc_write_attr_value_t
| GATTC write attribute value structure. More...
struct | ble_gattc_write_no_resp_t
| GATTC write without response structure. More...
struct | ble_gattc_multiple_att_t
| Read Multiple Handles. More...
struct | ble_gattc_read_multiple_t
| GATTC Read Multiple. More...
struct | ble_gattc_browse_attr_char_t
| GATTC Browse information about Characteristic. More...
struct | ble_gattc_browse_inc_srvc_t
| GATTC Browse information about Included Service. More...
struct | ble_gattc_browse_attr_t
| GATTC Browse information about Attribute. More...
union | ble_gattc_browse_attr_info
| GATTC Browse attribute information. More...
struct | ble_gattc_browse_srvc_t
| GATTC Browse service(s) indication. More...
struct | ble_gattc_service_t
| GATT service. More...
struct | ble_gattc_include_t
| GATT include. More...
struct | ble_gattc_char_t
| GATT characteristic. More...
struct | ble_gattc_desc_t
| GATT descriptor. More...
struct | ble_gattc_srvc_disc_t
| GATT service discovery. More...
struct | ble_gattc_incl_disc_t
| GATT include discovery. More...
struct | ble_gattc_char_disc_t
| GATT characteristic discovery. More...
struct | ble_gattc_char_desc_disc_t
| GATT characteristic descriptor discovery. More...
struct | ble_gattc_read_value_t
| GATT Client Read value. More...
struct | ble_gattc_read_rsp_t
| GATT value Read response. More...
struct | ble_gattc_write_t
| GATT Client Write. More...
struct | ble_gattc_ntf_ind_t
| GATTC Notification and Indication value indication. More...
struct | ble_gattc_evt_prf_reg_t
| GATTC profile register event for BLE_GATTC_EVT_PRIMARY_SRVC_DISC. More...
struct | ble_gattc_evt_browse_srvc_t
| GATTC Browse service(s) event for BLE_GATTC_EVT_SRVC_BROWSE. More...
struct | ble_gattc_evt_srvc_disc_t
| GATT service discovery event for BLE_GATTC_EVT_PRIMARY_SRVC_DISC. More...
struct | ble_gattc_evt_incl_disc_t
| GATT include discovery event for BLE_GATTC_EVT_INCLUDE_SRVC_DISC. More...
struct | ble_gattc_evt_char_disc_t
| GATT characteristic discovery event for BLE_GATTC_EVT_CHAR_DISC. More...
struct | ble_gattc_evt_char_desc_disc_t
| GATT characteristic descriptor discovery event for BLE_GATTC_EVT_CHAR_DESC_DISC. More...
struct | ble_gattc_evt_read_t
| GATT Client Read response event for BLE_GATTC_EVT_READ_RSP. More...
struct | ble_gattc_evt_write_t
| GATT Client Write Response event for BLE_GATTC_EVT_WRITE_RSP. More...
struct | ble_gattc_evt_ntf_ind_t
| GATTC Notification and Indication event for BLE_GATTC_EVT_NTF_IND. More...
struct | ble_gattc_evt_t
| BLE GATTC event structure. More...

## Enumerations
enum | gatt_serv_type_t { BLE_GATTC_PRI_SERV, BLE_GATTC_SEC_SERV }
| GATT Client Service type IDs. More...
enum | ble_gattc_attr_type_t { BLE_GATTC_BROWSE_NONE, BLE_GATTC_BROWSE_INC_SRVC, BLE_GATTC_BROWSE_ATTR_CHAR, BLE_GATTC_BROWSE_ATTR_VAL, BLE_GATTC_BROWSE_ATTR_DESC }
| GATT Client Service Discover Attribute type IDs. More...
enum | ble_gattc_prf_reg_evt_t { BLE_GATTC_EVT_REGISTER, BLE_GATTC_EVT_UNREGISTER }
| GATTC profile register enumeration. More...

## Functions
uint16_t | ble_gattc_mtu_exchange (uint8_t conn_idx)
| Perform MTU Exchange. More...
uint16_t | ble_gattc_services_browse (uint8_t conn_idx, const ble_uuid_t *p_srvc_uuid)
| Browse all Primary Services or specific Primary Service information on remote GATT server. More...
uint16_t | ble_gattc_primary_services_discover (uint8_t conn_idx, const ble_uuid_t *p_srvc_uuid)
| Discover Primary Services on remote GATT server. More...
uint16_t | ble_gattc_included_services_discover (uint8_t conn_idx, uint16_t start_hdl, uint16_t end_hdl)
| Discover Included Services on remote GATT server. More...
uint16_t | ble_gattc_char_discover (uint8_t conn_idx, uint16_t start_hdl, uint16_t end_hdl, const ble_uuid_t *p_char_uuid)
| Discover Characteristics on remote GATT server. More...
uint16_t | ble_gattc_char_desc_discover (uint8_t conn_idx, uint16_t start_hdl, uint16_t end_hdl)
| Discover Characteristics Descriptors on remote GATT server. More...
uint16_t | ble_gattc_read (uint8_t conn_idx, uint16_t handle, uint16_t offset)
| Read Attribute from remote GATT server. More...
uint16_t | ble_gattc_read_by_uuid (uint8_t conn_idx, uint16_t start_hdl, uint16_t end_hdl, const ble_uuid_t *p_char_uuid)
| Read Attribute by UUID. More...
uint16_t | ble_gattc_read_multiple (uint8_t conn_idx, const ble_gattc_read_multiple_t *p_param)
| Initiate a Read Multiple Characteristic Values procedure. More...
uint16_t | ble_gattc_write (uint8_t conn_idx, uint16_t handle, uint16_t offset, uint16_t length, const uint8_t *p_value)
| Write (long) Characteristic (Descriptor) Value. More...
uint16_t | ble_gattc_write_prepare (uint8_t conn_idx, uint16_t handle, uint16_t offset, uint16_t length, const uint8_t *p_value)
| Prepare Long/Reliable Write to remote GATT server. More...
uint16_t | ble_gattc_write_execute (uint8_t conn_idx, bool execute)
| Execute Reliable/Long Write to remote GATT server. More...
uint16_t | ble_gattc_write_no_resp (uint8_t conn_idx, bool signed_write, uint16_t handle, uint16_t length, const uint8_t *p_value)
| Write Attribute to remote GATT server (without response). More...
uint16_t | ble_gattc_indicate_cfm (uint8_t conn_idx, uint16_t handle)
| Confirm Reception of Indication. More...

## Detailed Description

BLE GATTC API.

Attention
  #####Copyright (c) 2019 GOODIX All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file ble_gattc.h.