Maxim Integrated / MaximBLE

Dependents:   BLE_Thermometer MAXWSNENV_demo

Embed: (wiki syntax)

« Back to documentation index

att_api.h File Reference

att_api.h File Reference

Attribute protocol client and server API. More...

Go to the source code of this file.

Data Structures

struct  attCfg_t
struct  attsAttr_t
struct  attsGroup_tag
struct  attsCccSet_t
struct  attcDiscChar_tag
struct  attcDiscCfg_t
struct  attcDiscCb_t
struct  attEvt_t
struct  attsCccEvt_t

Typedefs

typedef uint8_t(* attsReadCback_t )(dmConnId_t connId, uint16_t handle, uint8_t operation, uint16_t offset, attsAttr_t *pAttr)
typedef uint8_t(* attsWriteCback_t )(dmConnId_t connId, uint16_t handle, uint8_t operation, uint16_t offset, uint16_t len, uint8_t *pValue, attsAttr_t *pAttr)
typedef struct attsGroup_tag attsGroup_t
typedef struct attcDiscChar_tag attcDiscChar_t
typedef void(* attCback_t )(attEvt_t *pEvt)
typedef uint8_t(* attsAuthorCback_t )(dmConnId_t connId, uint8_t permit, uint16_t handle)
typedef void(* attsCccCback_t )(attsCccEvt_t *pEvt)

Enumerations

enum  {
  ATTC_FIND_INFO_RSP = ATT_CBACK_START, ATTC_FIND_BY_TYPE_VALUE_RSP, ATTC_READ_BY_TYPE_RSP, ATTC_READ_RSP,
  ATTC_READ_LONG_RSP, ATTC_READ_MULTIPLE_RSP, ATTC_READ_BY_GROUP_TYPE_RSP, ATTC_WRITE_RSP,
  ATTC_WRITE_CMD_RSP, ATTC_PREPARE_WRITE_RSP, ATTC_EXECUTE_WRITE_RSP, ATTC_HANDLE_VALUE_NTF,
  ATTC_HANDLE_VALUE_IND, ATTS_HANDLE_VALUE_CNF, ATTS_CCC_STATE_IND
}

Functions

void AttsInit (void)
 Initialize ATT server.
void AttsIndInit (void)
 Initialize ATT server for indications/notifications.
void AttsSignInit (void)
 Initialize ATT server for data signing.
void AttcInit (void)
 Initialize ATT client.
void AttcSignInit (void)
 Initialize ATT client for data signing.

Variables

attCfg_tpAttCfg

Detailed Description

Attribute protocol client and server API.

Date:
2012-05-07 19:54:28 -0700 (Mon, 07 May 2012)
Revision:
315

Copyright (c) 2009-2016 ARM Limited. All rights reserved.

SPDX-License-Identifier: LicenseRef-PBL

Licensed under the Permissive Binary License, Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.mbed.com/licenses/PBL-1.0

See the License for the specific language governing permissions and limitations under the License.

Definition in file att_api.h.


Typedef Documentation

typedef void(* attCback_t)(attEvt_t *pEvt)

ATT callback type

Definition at line 213 of file att_api.h.

ATT client structure for characteristic and descriptor discovery

typedef uint8_t(* attsAuthorCback_t)(dmConnId_t connId, uint8_t permit, uint16_t handle)

ATTS authorization callback type

Definition at line 216 of file att_api.h.

typedef void(* attsCccCback_t)(attsCccEvt_t *pEvt)

ATTS client characteristic configuration callback

Definition at line 219 of file att_api.h.

typedef struct attsGroup_tag attsGroup_t

Attribute group

typedef uint8_t(* attsReadCback_t)(dmConnId_t connId, uint16_t handle, uint8_t operation, uint16_t offset, attsAttr_t *pAttr)

Attribute group read callback

Definition at line 126 of file att_api.h.

typedef uint8_t(* attsWriteCback_t)(dmConnId_t connId, uint16_t handle, uint8_t operation, uint16_t offset, uint16_t len, uint8_t *pValue, attsAttr_t *pAttr)

Attribute group write callback

Definition at line 130 of file att_api.h.


Enumeration Type Documentation

anonymous enum
Enumerator:
ATTC_FIND_INFO_RSP 

ATT client callback events

ATTC_FIND_BY_TYPE_VALUE_RSP 

Find information response

ATTC_READ_BY_TYPE_RSP 

Find by type value response

ATTC_READ_RSP 

Read by type value response

ATTC_READ_LONG_RSP 

Read response

ATTC_READ_MULTIPLE_RSP 

Read long response

ATTC_READ_BY_GROUP_TYPE_RSP 

Read multiple response

ATTC_WRITE_RSP 

Read group type response

ATTC_WRITE_CMD_RSP 

Write response

ATTC_PREPARE_WRITE_RSP 

Write command response

ATTC_EXECUTE_WRITE_RSP 

Prepare write response

ATTC_HANDLE_VALUE_NTF 

Execute write response

ATTC_HANDLE_VALUE_IND 

Handle value notification

ATTS_HANDLE_VALUE_CNF 

Handle value indication

ATT server callback events

ATTS_CCC_STATE_IND 

Handle value confirmation

Client chracteristic configuration state change

Definition at line 70 of file att_api.h.


Function Documentation

AttcInit ( void   )

Initialize ATT client.

Returns:
None.
AttcSignInit ( void   )

Initialize ATT client for data signing.

Returns:
None.
AttsIndInit ( void   )

Initialize ATT server for indications/notifications.

Returns:
None.
AttsInit ( void   )

Initialize ATT server.

Returns:
None.
AttsSignInit ( void   )

Initialize ATT server for data signing.

Returns:
None.

Variable Documentation

Configuration pointer