BTS GATT STRU API

宏定义
#define	SDK_BLE_MTU_MAX   517
	协议规定的BLE MTU最大值。
#define	SDK_BLE_MTU_MIN   23
	用户可配置的BLE MTU最小值。

枚举
enum	gatt_characteristic_property_t {   GATT_CHARACTER_PROPERTY_BIT_BROADCAST = 0x01 , GATT_CHARACTER_PROPERTY_BIT_READ = 0x02 , GATT_CHARACTER_PROPERTY_BIT_WRITE_NO_RSP = 0x04 , GATT_CHARACTER_PROPERTY_BIT_WRITE = 0x08 ,   GATT_CHARACTER_PROPERTY_BIT_NOTIFY = 0x10 , GATT_CHARACTER_PROPERTY_BIT_INDICATE = 0x20 , GATT_CHARACTER_PROPERTY_BIT_SIGNED_WRITE = 0x40 , GATT_CHARACTER_PROPERTY_BIT_EXTENDED_PROPERTY = 0x80 }
	gatt特征特性比特位属性定义。 更多...
enum	gatt_attribute_permission_t {   GATT_ATTRIBUTE_PERMISSION_READ = 0x01 , GATT_ATTRIBUTE_PERMISSION_WRITE = 0x02 , GATT_ATTRIBUTE_PERMISSION_ENCRYPTION_NEED = 0x04 , GATT_ATTRIBUTE_PERMISSION_AUTHENTICATION_NEED = 0x08 ,   GATT_ATTRIBUTE_PERMISSION_AUTHORIZATION_NEED = 0x10 , GATT_ATTRIBUTE_PERMISSION_MITM_NEED = 0x20 }
	定义了当前Attribute的操作权限。 更多...
enum	gatt_status_t {   GATT_STATUS_SUCCESS = 0x00 , GATT_STATUS_INVALID_HANDLE = 0x01 , GATT_STATUS_READ_NOT_PERMITTED = 0x02 , GATT_STATUS_WRITE_NOT_PERMITTED = 0x03 ,   GATT_STATUS_INVALID_PDU = 0x04 , GATT_STATUS_INSUFFICIENT_AUTHENTICATION = 0x05 , GATT_STATUS_REQUEST_NOT_SUPPORTED = 0x06 , GATT_STATUS_INVALID_OFFSET = 0x07 ,   GATT_STATUS_INSUFFICIENT_AUTHORIZATION = 0x08 , GATT_STATUS_PREPARE_QUEUE_FULL = 0x09 , GATT_STATUS_ATTRIBUTE_NOT_FOUND = 0x0A , GATT_STATUS_ATTRIBUTE_NOT_LONG = 0x0B ,   GATT_STATUS_INSUFFICIENT_ENCRYPTION_KEY_SIZE = 0x0C , GATT_STATUS_INVALID_ATTRIBUTE_VALUE_LENGTH = 0x0D , GATT_STATUS_UNLIKELY_ERROR = 0x0E , GATT_STATUS_INSUFFICIENT_ENCRYPTION = 0x0F ,   GATT_STATUS_UNSUPPORTED_GROUP_TYPE = 0x10 , GATT_STATUS_INSUFFICIENT_RESOURCES = 0x11 , GATT_STATUS_DATABASE_OUT_OF_SYNC = 0x12 , GATT_STATUS_VALUE_NOT_ALLOWED = 0x13 }
	定义gatt操作错误码。 更多...

详细描述

Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2022. All rights reserved.

Description: BTS GATT STRU module.

宏定义说明

SDK_BLE_MTU_MAX

#define SDK_BLE_MTU_MAX   517

协议规定的BLE MTU最大值。

SDK_BLE_MTU_MIN

#define SDK_BLE_MTU_MIN   23

用户可配置的BLE MTU最小值。

枚举类型说明

gatt_attribute_permission_t

enum gatt_attribute_permission_t

定义了当前Attribute的操作权限。

枚举值
GATT_ATTRIBUTE_PERMISSION_READ	可读
GATT_ATTRIBUTE_PERMISSION_WRITE	可写
GATT_ATTRIBUTE_PERMISSION_ENCRYPTION_NEED	需要加密
GATT_ATTRIBUTE_PERMISSION_AUTHENTICATION_NEED	需要认证
GATT_ATTRIBUTE_PERMISSION_AUTHORIZATION_NEED	需要授权
GATT_ATTRIBUTE_PERMISSION_MITM_NEED	需要MITM保护

gatt_characteristic_property_t

enum gatt_characteristic_property_t

gatt特征特性比特位属性定义。

枚举值
GATT_CHARACTER_PROPERTY_BIT_BROADCAST	广播特征值
GATT_CHARACTER_PROPERTY_BIT_READ	读特征值
GATT_CHARACTER_PROPERTY_BIT_WRITE_NO_RSP	写特征值并且不需要响应
GATT_CHARACTER_PROPERTY_BIT_WRITE	写特征值
GATT_CHARACTER_PROPERTY_BIT_NOTIFY	通知特征值
GATT_CHARACTER_PROPERTY_BIT_INDICATE	指示特征值
GATT_CHARACTER_PROPERTY_BIT_SIGNED_WRITE	签名写特征值
GATT_CHARACTER_PROPERTY_BIT_EXTENDED_PROPERTY	在特征扩展特性描述符中定义了附加的特征特性

gatt_status_t

enum gatt_status_t

定义gatt操作错误码。

枚举值
GATT_STATUS_SUCCESS	执行成功错误码
GATT_STATUS_INVALID_HANDLE	无效handle错误码
GATT_STATUS_READ_NOT_PERMITTED	不可读错误码
GATT_STATUS_WRITE_NOT_PERMITTED	不可写错误码
GATT_STATUS_INVALID_PDU	无效PDU错误码
GATT_STATUS_INSUFFICIENT_AUTHENTICATION	未认证的读写错误码
GATT_STATUS_REQUEST_NOT_SUPPORTED	不支持client发送的请求
GATT_STATUS_INVALID_OFFSET	无效偏移的读写错误码
GATT_STATUS_INSUFFICIENT_AUTHORIZATION	未授权错误码
GATT_STATUS_PREPARE_QUEUE_FULL	排队的prepare writes太多，队列已满错误码
GATT_STATUS_ATTRIBUTE_NOT_FOUND	排队的prepare writes太多，队列已满错误码
GATT_STATUS_ATTRIBUTE_NOT_LONG	该attribute不是long attribute, 不能使用 ATT_READ_BLOB_REQ PDU
GATT_STATUS_INSUFFICIENT_ENCRYPTION_KEY_SIZE	用于加密此连接的加密密钥大小不足
GATT_STATUS_INVALID_ATTRIBUTE_VALUE_LENGTH	用于加密此连接的加密密钥大小不足
GATT_STATUS_UNLIKELY_ERROR	不可能的错误码
GATT_STATUS_INSUFFICIENT_ENCRYPTION	加密不足错误码
GATT_STATUS_UNSUPPORTED_GROUP_TYPE	不支持的 grouping attribute错误码
GATT_STATUS_INSUFFICIENT_RESOURCES	资源不足错误码
GATT_STATUS_DATABASE_OUT_OF_SYNC	服务端与客户端未同步数据库错误码
GATT_STATUS_VALUE_NOT_ALLOWED	非法的参数值错误码