XFusion API v1.3.0
载入中...
搜索中...
未找到
ssap

SparkLink Service Access Protocol. 更多...

ssap 的协作图:

结构体

struct  xf_sle_ssapc_find_struct_param_t
 SLE SSAP 搜寻参数 更多...
 
struct  xf_sle_ssapc_desc_found_t
 SLE SSAPC 搜寻到的特征描述符 更多...
 
struct  xf_sle_ssapc_desc_found_set_t
 SLE SSAPC 搜寻到的特征描述符集合信息 更多...
 
struct  xf_sle_ssapc_property_found_t
 SLE SSAPC 搜寻到的特征 更多...
 
struct  xf_sle_ssapc_property_found_set_t
 SLE SSAPC 搜寻到的特征集合信息 更多...
 
struct  xf_sle_ssapc_service_found_t
 SLE SSAPC 搜寻到的服务 更多...
 
struct  xf_sle_ssapc_service_found_set_t
 SLE SSAPC 搜寻到的服务集合信息 更多...
 
struct  xf_sle_evt_param_connect_t
 SLE 连接事件的参数 更多...
 
struct  xf_sle_evt_param_disconnect_t
 SLE 断连事件的参数 更多...
 
struct  xf_sle_evt_param_conn_param_update_t
 SLE 连接参数更新事件的参数 更多...
 
struct  xf_sle_evt_param_req_conn_param_update_t
 SLE 请求更新连接参数事件的参数 更多...
 
struct  xf_sle_evt_param_seek_result_t
 SLE 收到扫描结果事件的参数 更多...
 
struct  xf_sle_evt_param_read_cfm_t
 SLE 接收到读确认事件的参数 更多...
 
struct  xf_sle_evt_param_write_cfm_t
 SLE 接收到读确认事件的参数 更多...
 
struct  xf_sle_evt_param_ntf_t
 SLE 接收到通知或指示事件的参数 更多...
 
union  _xf_sle_ssapc_evt_cb_param_t
 SLE SSAPC 客户端事件回调参数 更多...
 
struct  xf_sle_ssaps_desc_t
 SLE SSAPS 特征描述符信息 更多...
 
struct  xf_sle_ssaps_property_t
 SLE SSAPS 特征值信息。 更多...
 
struct  _xf_sle_ssaps_service_t
 
union  _xf_sle_ssaps_evt_cb_param_t
 SLE SSAPS 服务端事件回调参数 更多...
 
struct  xf_sle_ssaps_response_value_t
 SLE SSAPS 响应 (回应) 值信息 更多...
 
struct  xf_sle_ssaps_ntf_ind_t
 SLE SSAPS 发送通知或指示的信息 更多...
 
struct  xf_sle_ssap_exchange_info_t
 SLE SSAP 信息交换 (协商) 信息 (info exchange) 更多...
 

宏定义

#define XF_SLE_ATTR_SET_END_FLAG   NULL
 属性集合的结束标记值
 

类型定义

typedef xf_err_t(* xf_sle_ssapc_event_cb_t) (xf_sle_ssapc_event_t event, xf_sle_ssapc_evt_cb_param_t *param)
 SLE SSAPC 事件回调函数原型
 
typedef struct xf_sle_evt_param_ntf_t xf_sle_evt_param_ind_t
 
typedef union _xf_sle_ssapc_evt_cb_param_t xf_sle_ssapc_evt_cb_param_t
 SLE SSAPC 客户端事件回调参数
 
typedef xf_err_t(* xf_sle_ssaps_event_cb_t) (xf_sle_ssaps_event_t event, xf_sle_ssaps_evt_cb_param_t *param)
 SLE SSAPS 事件回调函数原型
 
typedef struct _xf_sle_ssaps_service_t xf_sle_ssaps_service_t
 SLE SSAPS 服务信息
 
typedef union _xf_sle_ssaps_evt_cb_param_t xf_sle_ssaps_evt_cb_param_t
 SLE SSAPS 服务端事件回调参数
 

枚举

enum  xf_sle_ssap_find_type_t {
  XF_SLE_SSAP_FIND_TYPE_SERVICE_STRUCTURE = 0x00 , XF_SLE_SSAP_FIND_TYPE_PRIMARY_SERVICE = 0x01 , XF_SLE_SSAP_FIND_TYPE_REFERENCE_SERVICE = 0x02 , XF_SLE_SSAP_FIND_TYPE_PROPERTY = 0x03 ,
  XF_SLE_SSAP_FIND_TYPE_METHOD = 0x04 , XF_SLE_SSAP_FIND_TYPE_EVENT = 0x05
}
 SLE SSAP 搜寻类型 更多...
 
enum  xf_sle_ssapc_event_t {
  XF_SLE_SEEK_EVT_START = _XF_SLE_SSAP_COMMON_EVT_MAX , XF_SLE_SEEK_EVT_STOP , XF_SLE_SEEK_EVT_RESULT , XF_SLE_SSAPC_EVT_FIND_STRUCT ,
  XF_SLE_SSAPC_EVT_FIND_STRUCT_CMPL , XF_SLE_SSAPC_EVT_FIND_PROPERTY , XF_SLE_SSAPC_EVT_RECV_WRITE_CFM , XF_SLE_SSAPC_EVT_RECV_READ_CFM ,
  XF_SLE_SSAPC_EVT_NOTIFICATION , XF_SLE_SSAPC_EVT_INDICATION
}
 SLE SSAPC 事件 更多...
 
enum  xf_sle_ssaps_event_t {
  XF_SLE_ADV_EVT_ENABLE = _XF_SLE_SSAP_COMMON_EVT_MAX , XF_SLE_ADV_EVT_DISABLE , XF_SLE_ADV_EVT_TERMINAL , XF_SLE_SSAPS_EVT_ADD_SERVICE ,
  XF_SLE_SSAPS_EVT_ADD_PROPERTY , XF_SLE_SSAPS_EVT_ADD_DESC , XF_SLE_SSAPS_EVT_SERVICE_START , XF_SLE_SSAPS_EVT_SERVICE_DEL_ALL ,
  XF_SLE_SSAPS_EVT_REQ_READ , XF_SLE_SSAPS_EVT_REQ_WRITE
}
 SLE SSAPS 事件 更多...
 
enum  xf_sle_ssap_service_type_t { XF_SLE_SSAP_SERVICE_TYPE_PRIMARY , XF_SLE_SSAP_SERVICE_TYPE_SECONDARY }
 SLE SSAP 服务类型 更多...
 
enum  xf_sle_ssap_permission_t {
  XF_SLE_SSAP_PERMISSION_READ = 0x01 , XF_SLE_SSAP_PERMISSION_WRITE = 0x02 , XF_SLE_SSAP_PERMISSION_ENCRYPTION_NEED = 0x04 , XF_SLE_SSAP_PERMISSION_AUTHENTICATION_NEED = 0x08 ,
  XF_SLE_SSAP_PERMISSION_AUTHORIZATION_NEED = 0x10
}
 SLE SSAP 属性权限 更多...
 
enum  xf_sle_ssap_operate_indication_t {
  XF_SLE_SSAP_OPERATE_INDICATION_BIT_READ = 0x01 , XF_SLE_SSAP_OPERATE_INDICATION_BIT_WRITE_NO_RSP = 0x02 , XF_SLE_SSAP_OPERATE_INDICATION_BIT_WRITE = 0x04 , XF_SLE_SSAP_OPERATE_INDICATION_BIT_NOTIFY = 0x08 ,
  XF_SLE_SSAP_OPERATE_INDICATION_BIT_INDICATE = 0x10 , XF_SLE_SSAP_OPERATE_INDICATION_BIT_BROADCAST = 0x20 , XF_SLE_SSAP_OPERATE_INDICATION_BIT_DESCRITOR_WRITE = 0x100 , XF_SLE_SSAP_OPERATE_INDICATION_MAX
}
 SLE SSAP 操作指示 更多...
 
enum  xf_sle_ssap_desc_type_t {
  XF_SLE_SSAP_DESC_TYPE_USER_DESCRIPTION = 0x01 , XF_SLE_SSAP_DESC_TYPE_CLIENT_CONFIGURATION = 0x02 , XF_SLE_SSAP_DESC_TYPE_SERVER_CONFIGURATION = 0x03 , XF_SLE_SSAP_DESC_TYPE_PRESENTATION_FORMAT = 0x04 ,
  XF_SLE_SSAP_DESC_TYPE_RFU = 0x05 , XF_SLE_SSAP_DESC_TYPE_CUSTOM = 0xFF
}
 SLE SSAP 描述符类型 更多...
 
enum  xf_sle_ssap_err_t {
  XF_SLE_SSAP_ERR_INVALID_PDU = 0x01 , XF_SLE_SSAP_ERR_PDU_NOT_SUPPORT = 0x02 , XF_SLE_SSAP_ERR_UNKNOW = 0x03 , XF_SLE_SSAP_ERR_INVALID_HANDLE = 0x04 ,
  XF_SLE_SSAP_ERR_INSUFFICIENT_RESOURCES = 0x05 , XF_SLE_SSAP_ERR_PROHIBIT_READING = 0x06 , XF_SLE_SSAP_ERR_PROHIBIT_WRITE = 0x07 , XF_SLE_SSAP_ERR_CLIENT_NOT_AUTHENTICATED = 0x08 ,
  XF_SLE_SSAP_ERR_CLIENT_NOT_AUTHORIZATION = 0x09 , XF_SLE_SSAP_ERR_BEARER_NOT_ENCRYPTED = 0x0A , XF_SLE_SSAP_ERR_ENTRIES_NOT_FOUND = 0x0B , XF_SLE_SSAP_ERR_DATA_NOT_FOUND = 0x0C ,
  XF_SLE_SSAP_ERR_INCORRECT_DATA_TYPE = 0x0D , XF_SLE_SSAP_ERR_INCORRECT_DATA_VALUE = 0x0E , XF_SLE_SSAP_ERR_VALUE_OUT_OF_RANGE = 0x0F , XF_SLE_SSAP_ERR_UPPERLAYER_APP_ERR_MIN = 0xAF ,
  XF_SLE_SSAP_ERR_UPPERLAYER_APPL_ERR_MAX = 0xFF
}
 SLE SSAP 协议错误码 更多...
 
enum  xf_sle_ssap_property_type_t {
  XF_SLE_SSAP_PROPERTY_TYPE_VALUE = 0x00 , XF_SLE_SSAP_DESCRIPTOR_USER_DESCRIPTION = 0x01 , XF_SLE_SSAP_DESCRIPTOR_CLIENT_CONFIGURATION = 0x02 , XF_SLE_SSAP_DESCRIPTOR_SERVER_CONFIGURATION = 0x03 ,
  XF_SLE_SSAP_DESCRIPTOR_PRESENTATION_FORMAT = 0x04 , XF_SLE_SSAP_DESCRIPTOR_RFU = 0x05 , XF_SLE_SSAP_DESCRIPTOR_CUSTOM = 0xFF
}
 SLE SSAP 特征类型 (property type) 更多...
 
enum  xf_sle_ssap_common_event_t {
  XF_SLE_EVT_ALL , XF_SLE_CONN_EVT_CONNECT , XF_SLE_CONN_EVT_DISCONNECT , XF_SLE_CONN_EVT_CONN_PARAMS_UPDATE ,
  XF_SLE_CONN_EVT_REQ_CONN_PARAMS_UPDATE , _XF_SLE_SSAP_COMMON_EVT_MAX
}
 SLE SSAP 通用事件类型 更多...
 

函数

xf_err_t xf_sle_ssapc_app_register (xf_sle_uuid_info_t *app_uuid, uint8_t *app_id)
 SLE SSAPC 客户端注册
 
xf_err_t xf_sle_ssapc_app_unregister (uint8_t app_id)
 SLE SSAPC 客户端注销
 
xf_err_t xf_sle_ssapc_discover_service (uint8_t app_id, uint16_t conn_id, xf_sle_ssapc_find_struct_param_t *param)
 SLE SSAPC 搜寻服务
 
xf_err_t xf_sle_ssapc_discovery_property (uint8_t app_id, uint16_t conn_id, xf_sle_ssapc_find_struct_param_t *param)
 SLE SSAPC 搜寻属性 (property)
 
xf_err_t xf_sle_ssapc_request_read_by_handle (uint8_t app_id, uint16_t conn_id, uint8_t type, uint16_t handle)
 SLE SSAPC 通过句柄发起读请求
 
xf_err_t xf_sle_ssapc_request_read_by_uuid (uint8_t app_id, uint16_t conn_id, uint8_t type, uint16_t start_handle, uint16_t end_handle, const xf_sle_uuid_info_t *uuid)
 SLE SSAPC 通过 UUID 发起读请求
 
xf_err_t xf_sle_ssapc_request_write_data (uint8_t app_id, uint16_t conn_id, uint16_t handle, uint8_t type, uint8_t *data, uint16_t data_len)
 SLE SSAPC 发起写请求
 
xf_err_t xf_sle_ssapc_request_write_cmd (uint8_t app_id, uint16_t conn_id, uint16_t handle, uint8_t type, uint8_t *data, uint16_t data_len)
 SLE SSAPC 发起写命令
 
xf_err_t xf_sle_ssapc_request_exchange_info (uint8_t app_id, uint16_t conn_id, xf_sle_ssap_exchange_info_t *param)
 SLE SSAPC 发送协商 (MTU、Version) 请求
 
xf_err_t xf_sle_ssapc_event_cb_register (xf_sle_ssapc_event_cb_t evt_cb, xf_sle_ssapc_event_t events)
 SLE SSAPC 事件回调注册
 
xf_err_t xf_sle_ssaps_app_register (xf_sle_uuid_info_t *app_uuid, uint8_t *app_id)
 SLE SSAPS 服务端注册
 
xf_err_t xf_sle_ssaps_app_unregister (uint8_t app_id)
 SLE SSAPS 服务端注销
 
xf_err_t xf_sle_ssaps_add_service_to_app (uint8_t app_id, xf_sle_ssaps_service_t *service)
 SLE SSAPS 服务端 (应用) 添加服务
 
xf_err_t xf_sle_ssaps_start_service (uint8_t app_id, uint16_t service_handle)
 SLE SSAPS 服务开启
 
xf_err_t xf_sle_ssaps_stop_service (uint8_t app_id, uint16_t service_handle)
 SLE SSAPS 服务停止
 
xf_err_t xf_sle_ssaps_del_services_all (uint8_t app_id)
 SLE SSAPS 删除所有服务
 
xf_err_t xf_sle_ssaps_send_response (uint8_t app_id, uint16_t conn_id, uint32_t trans_id, xf_sle_ssap_err_t err_code, xf_sle_ssaps_response_value_t *rsp)
 SLE SSAPS 发送 (请求的) 响应
 
xf_err_t xf_sle_ssaps_send_notify_indicate (uint8_t app_id, uint16_t conn_id, xf_sle_ssaps_ntf_ind_t *param)
 SLE SSAPS 发送通知或指示
 
xf_err_t xf_sle_ssaps_set_info (uint8_t app_id, xf_sle_ssap_exchange_info_t *info)
 SLE SSAPS 设置服务端 INFO (连接前)
 
xf_err_t xf_sle_ssaps_event_cb_register (xf_sle_ssaps_event_cb_t evt_cb, xf_sle_ssaps_event_t events)
 SLE SSAPS 事件回调注册
 

详细描述

SparkLink Service Access Protocol.

宏定义说明

◆ XF_SLE_ATTR_SET_END_FLAG

#define XF_SLE_ATTR_SET_END_FLAG   NULL

属性集合的结束标记值

注解
一般出现在构造服务结构时, 多个服务、特征、描述符等属性的集合的结尾部分, 一般是标记属性的 UUID 项(关键项)为 'XF_SLE_ATTR_SET_END_FLAG' 表示结束。
由于结束标记的特殊性(NULL),用户构造时也可以 对属性集合中表示结束的最后一个属性成员结构直接置 0,如: ([attr_set_type]) { {...}, {...}, {0} }

在文件 xf_sle_ssap_server_types.h56 行定义.

类型定义说明

◆ xf_sle_ssapc_event_cb_t

typedef xf_err_t(* xf_sle_ssapc_event_cb_t) (xf_sle_ssapc_event_t event, xf_sle_ssapc_evt_cb_param_t *param)

SLE SSAPC 事件回调函数原型

参数
event事件,见 xf_sle_ssapc_event_t
param事件回调参数,见 xf_sle_ssapc_evt_cb_param_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

在文件 xf_sle_ssap_client.h193 行定义.

◆ xf_sle_evt_param_ind_t

◆ xf_sle_ssapc_evt_cb_param_t

SLE SSAPC 客户端事件回调参数

◆ xf_sle_ssaps_event_cb_t

typedef xf_err_t(* xf_sle_ssaps_event_cb_t) (xf_sle_ssaps_event_t event, xf_sle_ssaps_evt_cb_param_t *param)

SLE SSAPS 事件回调函数原型

参数
event事件,见 xf_sle_ssaps_event_t
param事件回调参数,见 xf_sle_ssaps_evt_cb_param_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

在文件 xf_sle_ssap_server.h173 行定义.

◆ xf_sle_ssaps_service_t

SLE SSAPS 服务信息

在文件 xf_sle_ssap_server_types.h89 行定义.

◆ xf_sle_ssaps_evt_cb_param_t

SLE SSAPS 服务端事件回调参数

枚举类型说明

◆ xf_sle_ssap_find_type_t

SLE SSAP 搜寻类型

枚举值
XF_SLE_SSAP_FIND_TYPE_SERVICE_STRUCTURE 

服务结构

XF_SLE_SSAP_FIND_TYPE_PRIMARY_SERVICE 

首要服务

XF_SLE_SSAP_FIND_TYPE_REFERENCE_SERVICE 

引用服务

XF_SLE_SSAP_FIND_TYPE_PROPERTY 

属性 (property)

XF_SLE_SSAP_FIND_TYPE_METHOD 

方法 (method)

XF_SLE_SSAP_FIND_TYPE_EVENT 

事件 (event)

在文件 xf_sle_ssap_client_types.h41 行定义.

◆ xf_sle_ssapc_event_t

SLE SSAPC 事件

枚举值
XF_SLE_SEEK_EVT_START 

扫描开启事件

XF_SLE_SEEK_EVT_STOP 

扫描停止事件

XF_SLE_SEEK_EVT_RESULT 

收到扫描结果事件

XF_SLE_SSAPC_EVT_FIND_STRUCT 

搜寻结构事件

XF_SLE_SSAPC_EVT_FIND_STRUCT_CMPL 

搜寻结构完成事件

XF_SLE_SSAPC_EVT_FIND_PROPERTY 

搜寻属性 (property) 完成事件

XF_SLE_SSAPC_EVT_RECV_WRITE_CFM 

接收到写确认事件

XF_SLE_SSAPC_EVT_RECV_READ_CFM 

接收到读确认事件

XF_SLE_SSAPC_EVT_NOTIFICATION 

接接收到通知事件

XF_SLE_SSAPC_EVT_INDICATION 

接接收到指示事件

在文件 xf_sle_ssap_client_types.h120 行定义.

◆ xf_sle_ssaps_event_t

SLE SSAPS 事件

枚举值
XF_SLE_ADV_EVT_ENABLE 

广播使能事件

XF_SLE_ADV_EVT_DISABLE 

广播失能事件

XF_SLE_ADV_EVT_TERMINAL 
XF_SLE_SSAPS_EVT_ADD_SERVICE 

服务添加事件

XF_SLE_SSAPS_EVT_ADD_PROPERTY 

特征添加事件

XF_SLE_SSAPS_EVT_ADD_DESC 

特征描述符事件

XF_SLE_SSAPS_EVT_SERVICE_START 

服务开启事件

XF_SLE_SSAPS_EVT_SERVICE_DEL_ALL 

删除所有服务事件

XF_SLE_SSAPS_EVT_REQ_READ 

接收到读请求事件

XF_SLE_SSAPS_EVT_REQ_WRITE 

接收到写请求事件

在文件 xf_sle_ssap_server_types.h102 行定义.

◆ xf_sle_ssap_service_type_t

SLE SSAP 服务类型

枚举值
XF_SLE_SSAP_SERVICE_TYPE_PRIMARY 
XF_SLE_SSAP_SERVICE_TYPE_SECONDARY 

在文件 xf_sle_ssap_types.h48 行定义.

◆ xf_sle_ssap_permission_t

SLE SSAP 属性权限

枚举值
XF_SLE_SSAP_PERMISSION_READ 

可读

XF_SLE_SSAP_PERMISSION_WRITE 

可写

XF_SLE_SSAP_PERMISSION_ENCRYPTION_NEED 

需要加密

XF_SLE_SSAP_PERMISSION_AUTHENTICATION_NEED 

需要认证

XF_SLE_SSAP_PERMISSION_AUTHORIZATION_NEED 

需要授权

在文件 xf_sle_ssap_types.h56 行定义.

◆ xf_sle_ssap_operate_indication_t

SLE SSAP 操作指示

枚举值
XF_SLE_SSAP_OPERATE_INDICATION_BIT_READ 

读数据值:允许读取数据值

XF_SLE_SSAP_OPERATE_INDICATION_BIT_WRITE_NO_RSP 

写数据值且无需响应:允许写入数据值 (没有反馈/响应)

XF_SLE_SSAP_OPERATE_INDICATION_BIT_WRITE 

写数据值且需要响应:允许写入数据值 (有反馈/响应)

XF_SLE_SSAP_OPERATE_INDICATION_BIT_NOTIFY 

通知数据值:允许向客户端进行数据值通知

XF_SLE_SSAP_OPERATE_INDICATION_BIT_INDICATE 

指示数据值:允许向客户端进行数据值指示

XF_SLE_SSAP_OPERATE_INDICATION_BIT_BROADCAST 

广播数据值:允许对该数据值进行广播,数据值可携带在广播中

XF_SLE_SSAP_OPERATE_INDICATION_BIT_DESCRITOR_WRITE 

写描述符:描述符可被写入

XF_SLE_SSAP_OPERATE_INDICATION_MAX 

SLE SSAP 操作指示最大值

在文件 xf_sle_ssap_types.h67 行定义.

◆ xf_sle_ssap_desc_type_t

SLE SSAP 描述符类型

枚举值
XF_SLE_SSAP_DESC_TYPE_USER_DESCRIPTION 

属性说明描述符 (user description descriptor)

XF_SLE_SSAP_DESC_TYPE_CLIENT_CONFIGURATION 

客户端配置描述符 (client configuration descriptor)

XF_SLE_SSAP_DESC_TYPE_SERVER_CONFIGURATION 

服务端配置描述符 (server configuration descriptor)

XF_SLE_SSAP_DESC_TYPE_PRESENTATION_FORMAT 

格式描述符 (presentation format descriptor)

XF_SLE_SSAP_DESC_TYPE_RFU 

服务管理保留描述符 (RFU descriptor, 0x05 – 0x1F)

XF_SLE_SSAP_DESC_TYPE_CUSTOM 

厂商自定义描述符 (custom descriptor)

在文件 xf_sle_ssap_types.h81 行定义.

◆ xf_sle_ssap_err_t

SLE SSAP 协议错误码

枚举值
XF_SLE_SSAP_ERR_INVALID_PDU 

服务端接收的 PDU 无效

XF_SLE_SSAP_ERR_PDU_NOT_SUPPORT 

服务端不支持处理接收的 PDU

XF_SLE_SSAP_ERR_UNKNOW 

服务端执行请求时发生未知错误 (PDU unknow)

XF_SLE_SSAP_ERR_INVALID_HANDLE 

请求中的句柄无效

XF_SLE_SSAP_ERR_INSUFFICIENT_RESOURCES 

服务端没有足够资源完成请求

XF_SLE_SSAP_ERR_PROHIBIT_READING 

服务端禁止客户端读取值

XF_SLE_SSAP_ERR_PROHIBIT_WRITE 

服务端禁止客户端写入值

XF_SLE_SSAP_ERR_CLIENT_NOT_AUTHENTICATED 

客户端未经认证

XF_SLE_SSAP_ERR_CLIENT_NOT_AUTHORIZATION 

客户端未被授权

XF_SLE_SSAP_ERR_BEARER_NOT_ENCRYPTED 

传输 PDU 的承载未加密

XF_SLE_SSAP_ERR_ENTRIES_NOT_FOUND 

服务端未找到对应条目

XF_SLE_SSAP_ERR_DATA_NOT_FOUND 

服务端未找到对应类型数据

XF_SLE_SSAP_ERR_INCORRECT_DATA_TYPE 

客户端发送写入数据类型不符的错误

XF_SLE_SSAP_ERR_INCORRECT_DATA_VALUE 

客户端发送写入值不符的错误

XF_SLE_SSAP_ERR_VALUE_OUT_OF_RANGE 

客户端写入的值超出范围

XF_SLE_SSAP_ERR_UPPERLAYER_APP_ERR_MIN 

预留给上层协议定义应用错误

XF_SLE_SSAP_ERR_UPPERLAYER_APPL_ERR_MAX 

预留给上层协议定义应用错误

在文件 xf_sle_ssap_types.h93 行定义.

◆ xf_sle_ssap_property_type_t

SLE SSAP 特征类型 (property type)

枚举值
XF_SLE_SSAP_PROPERTY_TYPE_VALUE 

特征值 (property value)

XF_SLE_SSAP_DESCRIPTOR_USER_DESCRIPTION 

属性说明描述符 (user description descriptor)

XF_SLE_SSAP_DESCRIPTOR_CLIENT_CONFIGURATION 

客户端配置描述符 (client configuration descriptor)

XF_SLE_SSAP_DESCRIPTOR_SERVER_CONFIGURATION 

服务端配置描述符 (server configuration descriptor)

XF_SLE_SSAP_DESCRIPTOR_PRESENTATION_FORMAT 

格式描述符 (presentation format descriptor)

XF_SLE_SSAP_DESCRIPTOR_RFU 

服务管理保留描述符,0x05 – 0x1F (RFU descriptor)

XF_SLE_SSAP_DESCRIPTOR_CUSTOM 

厂商自定义描述符 (custom descriptor)

在文件 xf_sle_ssap_types.h116 行定义.

◆ xf_sle_ssap_common_event_t

SLE SSAP 通用事件类型

枚举值
XF_SLE_EVT_ALL 

所有事件

XF_SLE_CONN_EVT_CONNECT 

连接事件

XF_SLE_CONN_EVT_DISCONNECT 

断连事件

XF_SLE_CONN_EVT_CONN_PARAMS_UPDATE 

连接参数更新事件

XF_SLE_CONN_EVT_REQ_CONN_PARAMS_UPDATE 

请求更新连接参数事件

_XF_SLE_SSAP_COMMON_EVT_MAX 

SLE SSAP 通用事件类型最大值

在文件 xf_sle_ssap_types.h137 行定义.

函数说明

◆ xf_sle_ssapc_app_register()

xf_err_t xf_sle_ssapc_app_register ( xf_sle_uuid_info_t app_uuid,
uint8_t *  app_id 
)

SLE SSAPC 客户端注册

参数
[in]app_uuid要注册的客户端 (应用) 的 UUID ,见 xf_sle_uuid_info_t
[out]app_id客户端 (应用) ID
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_client/main/xf_main.c.

◆ xf_sle_ssapc_app_unregister()

xf_err_t xf_sle_ssapc_app_unregister ( uint8_t  app_id)

SLE SSAPC 客户端注销

参数
app_id客户端 ID
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssapc_discover_service()

xf_err_t xf_sle_ssapc_discover_service ( uint8_t  app_id,
uint16_t  conn_id,
xf_sle_ssapc_find_struct_param_t param 
)

SLE SSAPC 搜寻服务

参数
app_id客户端 ID (应用 ID )
conn_id连接 ID (链接 ID )
param搜寻参数,见 xf_sle_ssapc_find_struct_param_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_client/main/xf_main.c.

◆ xf_sle_ssapc_discovery_property()

xf_err_t xf_sle_ssapc_discovery_property ( uint8_t  app_id,
uint16_t  conn_id,
xf_sle_ssapc_find_struct_param_t param 
)

SLE SSAPC 搜寻属性 (property)

参数
app_id客户端 ID (应用 ID )
conn_id连接 ID (链接 ID )
param搜寻参数,见 xf_sle_ssapc_find_struct_param_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssapc_request_read_by_handle()

xf_err_t xf_sle_ssapc_request_read_by_handle ( uint8_t  app_id,
uint16_t  conn_id,
uint8_t  type,
uint16_t  handle 
)

SLE SSAPC 通过句柄发起读请求

参数
app_id客户端 ID (应用 ID)
conn_id连接 ID (链接 ID )
type类型
handle句柄
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_client/main/xf_main.c.

◆ xf_sle_ssapc_request_read_by_uuid()

xf_err_t xf_sle_ssapc_request_read_by_uuid ( uint8_t  app_id,
uint16_t  conn_id,
uint8_t  type,
uint16_t  start_handle,
uint16_t  end_handle,
const xf_sle_uuid_info_t uuid 
)

SLE SSAPC 通过 UUID 发起读请求

参数
app_id客户端 ID (应用 ID)
conn_id连接 ID (链接 ID )
type类型
start_handle起始句柄
end_handle结束句柄
uuid指定的 UUID,见 xf_sle_uuid_info_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssapc_request_write_data()

xf_err_t xf_sle_ssapc_request_write_data ( uint8_t  app_id,
uint16_t  conn_id,
uint16_t  handle,
uint8_t  type,
uint8_t *  data,
uint16_t  data_len 
)

SLE SSAPC 发起写请求

参数
app_id客户端 ID (应用 ID)
conn_id连接 ID (链接 ID )
type类型
handle句柄
data要写的数据
data_len要写的数据的长度
注解
需要 (对端) 回应 (写请求)
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_client/main/xf_main.c.

◆ xf_sle_ssapc_request_write_cmd()

xf_err_t xf_sle_ssapc_request_write_cmd ( uint8_t  app_id,
uint16_t  conn_id,
uint16_t  handle,
uint8_t  type,
uint8_t *  data,
uint16_t  data_len 
)

SLE SSAPC 发起写命令

参数
app_id客户端 ID (应用 ID)
conn_id连接 ID (链接 ID )
handle句柄
type类型
data要写的数据
data_len要写的数据的长度
注解
无需 (对端) 响应 (写命令)
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssapc_request_exchange_info()

xf_err_t xf_sle_ssapc_request_exchange_info ( uint8_t  app_id,
uint16_t  conn_id,
xf_sle_ssap_exchange_info_t param 
)

SLE SSAPC 发送协商 (MTU、Version) 请求

参数
app_id客户端 ID (应用 ID)
conn_id连接 ID (链接 ID )
param协商信息,见 xf_sle_ssap_exchange_info_t
返回
xf_err_t

◆ xf_sle_ssapc_event_cb_register()

xf_err_t xf_sle_ssapc_event_cb_register ( xf_sle_ssapc_event_cb_t  evt_cb,
xf_sle_ssapc_event_t  events 
)

SLE SSAPC 事件回调注册

参数
evt_cb事件回调,见 xf_sle_ssapc_event_cb_t
events事件,见 xf_sle_ssapc_event_t
注解
当前仅支持所有事件注册在同一个回调,暂不支持指定事件对应单独的回调, 所以 参数 'events' 填 0 即可
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_client/main/xf_main.c.

◆ xf_sle_ssaps_app_register()

xf_err_t xf_sle_ssaps_app_register ( xf_sle_uuid_info_t app_uuid,
uint8_t *  app_id 
)

SLE SSAPS 服务端注册

参数
[in]app_uuid要注册的服务端 (应用) 的 UUID ,见 xf_sle_uuid_info_t
[out]app_id服务端 (应用) ID
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_server/main/xf_main.c.

◆ xf_sle_ssaps_app_unregister()

xf_err_t xf_sle_ssaps_app_unregister ( uint8_t  app_id)

SLE SSAPS 服务端注销

参数
app_id服务端 (应用) ID
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssaps_add_service_to_app()

xf_err_t xf_sle_ssaps_add_service_to_app ( uint8_t  app_id,
xf_sle_ssaps_service_t service 
)

SLE SSAPS 服务端 (应用) 添加服务

参数
app_id服务端 (应用) ID
service要添加的服务信息 ,见 xf_sle_ssaps_service_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_server/main/xf_main.c.

◆ xf_sle_ssaps_start_service()

xf_err_t xf_sle_ssaps_start_service ( uint8_t  app_id,
uint16_t  service_handle 
)

SLE SSAPS 服务开启

参数
app_id服务端 (应用) ID
service_handle指定的服务句柄
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_server/main/xf_main.c.

◆ xf_sle_ssaps_stop_service()

xf_err_t xf_sle_ssaps_stop_service ( uint8_t  app_id,
uint16_t  service_handle 
)

SLE SSAPS 服务停止

参数
app_id服务端 (应用) ID
service_handle指定的服务句柄
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssaps_del_services_all()

xf_err_t xf_sle_ssaps_del_services_all ( uint8_t  app_id)

SLE SSAPS 删除所有服务

参数
app_id服务端 (应用) ID
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssaps_send_response()

xf_err_t xf_sle_ssaps_send_response ( uint8_t  app_id,
uint16_t  conn_id,
uint32_t  trans_id,
xf_sle_ssap_err_t  err_code,
xf_sle_ssaps_response_value_t rsp 
)

SLE SSAPS 发送 (请求的) 响应

参数
app_id服务端 (应用) ID
conn_id链接 (连接) ID
trans_id传输 ID
err_code错误码,见 xf_sle_ssap_err_t
rsp发送的响应的信息,见 xf_sle_ssaps_response_value_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_server/main/xf_main.c.

◆ xf_sle_ssaps_send_notify_indicate()

xf_err_t xf_sle_ssaps_send_notify_indicate ( uint8_t  app_id,
uint16_t  conn_id,
xf_sle_ssaps_ntf_ind_t param 
)

SLE SSAPS 发送通知或指示

Description: 向对端发送通知或指示,具体发送状态取决于特征描述符:客户端特征配置
value = 0x0000:不允许通知和指示 value = 0x0001:允许通知 value = 0x0002:允许指示
参数
app_id服务端 (应用) ID
conn_id链接 (连接) ID ,如果向全部对端发送则输入conn_id = 0xffff;
param通知或指示参数,见 xf_sle_ssaps_ntf_ind_t
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssaps_set_info()

xf_err_t xf_sle_ssaps_set_info ( uint8_t  app_id,
xf_sle_ssap_exchange_info_t info 
)

SLE SSAPS 设置服务端 INFO (连接前)

参数
app_id服务端 (应用) ID
info服务端 INFO
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t

◆ xf_sle_ssaps_event_cb_register()

xf_err_t xf_sle_ssaps_event_cb_register ( xf_sle_ssaps_event_cb_t  evt_cb,
xf_sle_ssaps_event_t  events 
)

SLE SSAPS 事件回调注册

参数
evt_cb事件回调,见 xf_sle_ssaps_event_cb_t
events事件,见 xf_sle_ssaps_event_t
注解
当前仅支持所有事件注册在同一个回调,暂不支持指定事件对应单独的回调, 所以 参数 'events' 填 0 即可
返回
xf_err_t
  • XF_OK 成功
  • XF_FAIL 失败
  • (OTHER) xf_err_t
示例
examples/wireless/sle/sample_ssap_server/main/xf_main.c.