WS63 SDK 文档 7021f4f@fbb_ws63
ws63 和 ws63e 解决方案的 SDK 文档
载入中...
搜索中...
未找到
Service Access Protocol SERVER API

结构体

struct  ssaps_property_info_t
 添加特征信息。 更多...
 
struct  ssaps_desc_info_t
 添加特征描述符信息。 更多...
 
struct  ssaps_req_read_cb_t
 读请求信息。 更多...
 
struct  ssaps_req_write_cb_t
 写请求信息。 更多...
 
struct  ssaps_send_rsp_t
 发送响应信息。 更多...
 
struct  ssaps_ntf_ind_t
 发送通知/指示信息。 更多...
 
struct  ssaps_ntf_ind_by_uuid_t
 通过uuid发送通知/指示信息。 更多...
 
struct  ssaps_callbacks_t
 SSAP server回调函数接口定义。 更多...
 

类型定义

typedef void(* ssaps_add_service_callback) (uint8_t server_id, sle_uuid_t *uuid, uint16_t handle, errcode_t status)
 服务注册的回调函数。
 
typedef void(* ssaps_add_property_callback) (uint8_t server_id, sle_uuid_t *uuid, uint16_t service_handle, uint16_t handle, errcode_t status)
 特征注册的回调函数。
 
typedef void(* ssaps_add_descriptor_callback) (uint8_t server_id, sle_uuid_t *uuid, uint16_t service_handle, uint16_t property_handle, errcode_t status)
 特征描述符注册的回调函数。
 
typedef void(* ssaps_start_service_callback) (uint8_t server_id, uint16_t handle, errcode_t status)
 开始服务的回调函数。
 
typedef void(* ssaps_delete_all_service_callback) (uint8_t server_id, errcode_t status)
 删除全部服务的回调函数。
 
typedef void(* ssaps_read_request_callback) (uint8_t server_id, uint16_t conn_id, ssaps_req_read_cb_t *read_cb_para, errcode_t status)
 收到读请求的回调函数。
 
typedef void(* ssaps_write_request_callback) (uint8_t server_id, uint16_t conn_id, ssaps_req_write_cb_t *write_cb_para, errcode_t status)
 收到写请求的回调函数。
 
typedef void(* ssaps_indicate_cfm_callback) (uint8_t server_id, uint16_t conn_id, sle_indication_cfm_result_t cfm_result, errcode_t status)
 收到指示确认的回调函数。
 
typedef void(* ssaps_mtu_changed_callback) (uint8_t server_id, uint16_t conn_id, ssap_exchange_info_t *info, errcode_t status)
 mtu大小改变的回调函数。
 

枚举

enum  sle_indication_cfm_result_t { SLE_INDICATION_CFM_FAIL = 0x00 , SLE_INDICATION_CFM_SUCESS = 0x01 }
 指示确认结果。 更多...
 

函数

errcode_t ssaps_register_server (sle_uuid_t *app_uuid, uint8_t *server_id)
 注册ssap服务端。
 
errcode_t ssaps_unregister_server (uint8_t server_id)
 注销ssap服务端。
 
errcode_t ssaps_add_service (uint8_t server_id, sle_uuid_t *service_uuid, bool is_primary)
 异步添加一个ssap服务,注册service handle在add_service_cb中返回。
 
errcode_t ssaps_add_property (uint8_t server_id, uint16_t service_handle, ssaps_property_info_t *property)
 异步添加一个ssap属性,注册属性 handle在add_property_cb中返回
 
errcode_t ssaps_add_descriptor (uint8_t server_id, uint16_t service_handle, uint16_t property_handle, ssaps_desc_info_t *descriptor)
 异步添加一个ssap描述,注册描述结果在add_descriptor_cb中返回
 
errcode_t ssaps_add_service_sync (uint8_t server_id, sle_uuid_t *service_uuid, bool is_primary, uint16_t *handle)
 添加一个ssap服务。
 
errcode_t ssaps_add_property_sync (uint8_t server_id, uint16_t service_handle, ssaps_property_info_t *property, uint16_t *handle)
 添加一个ssap特征。
 
errcode_t ssaps_add_descriptor_sync (uint8_t server_id, uint16_t service_handle, uint16_t property_handle, ssaps_desc_info_t *descriptor)
 添加一个ssap特征描述符。
 
errcode_t ssaps_start_service (uint8_t server_id, uint16_t service_handle)
 开始一个SSAP服务。
 
errcode_t ssaps_delete_all_services (uint8_t server_id)
 删除所有SSAP服务。
 
errcode_t ssaps_send_response (uint8_t server_id, uint16_t conn_id, ssaps_send_rsp_t *param)
 当收到需要用户回复响应的请求时发送响应。
 
errcode_t ssaps_notify_indicate (uint8_t server_id, uint16_t conn_id, ssaps_ntf_ind_t *param)
 向对端发送通知或指示。
 
errcode_t ssaps_notify_indicate_by_uuid (uint8_t server_id, uint16_t conn_id, ssaps_ntf_ind_by_uuid_t *param)
 通过uuid向对端发送通知或指示。
 
errcode_t ssaps_set_info (uint8_t server_id, ssap_exchange_info_t *info)
 在连接之前设置服务端info。
 
errcode_t ssaps_register_callbacks (ssaps_callbacks_t *func)
 注册 SSAP server 回调函数。
 

详细描述

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

Description: SLE Service Access Protocol SERVER module.

类型定义说明

◆ ssaps_add_descriptor_callback

typedef void(* ssaps_add_descriptor_callback) (uint8_t server_id, sle_uuid_t *uuid, uint16_t service_handle, uint16_t property_handle, errcode_t status)

特征描述符注册的回调函数。

◆ ssaps_add_property_callback

typedef void(* ssaps_add_property_callback) (uint8_t server_id, sle_uuid_t *uuid, uint16_t service_handle, uint16_t handle, errcode_t status)

特征注册的回调函数。

◆ ssaps_add_service_callback

typedef void(* ssaps_add_service_callback) (uint8_t server_id, sle_uuid_t *uuid, uint16_t handle, errcode_t status)

服务注册的回调函数。

◆ ssaps_delete_all_service_callback

typedef void(* ssaps_delete_all_service_callback) (uint8_t server_id, errcode_t status)

删除全部服务的回调函数。

◆ ssaps_indicate_cfm_callback

typedef void(* ssaps_indicate_cfm_callback) (uint8_t server_id, uint16_t conn_id, sle_indication_cfm_result_t cfm_result, errcode_t status)

收到指示确认的回调函数。

◆ ssaps_mtu_changed_callback

typedef void(* ssaps_mtu_changed_callback) (uint8_t server_id, uint16_t conn_id, ssap_exchange_info_t *info, errcode_t status)

mtu大小改变的回调函数。

◆ ssaps_read_request_callback

typedef void(* ssaps_read_request_callback) (uint8_t server_id, uint16_t conn_id, ssaps_req_read_cb_t *read_cb_para, errcode_t status)

收到读请求的回调函数。

◆ ssaps_start_service_callback

typedef void(* ssaps_start_service_callback) (uint8_t server_id, uint16_t handle, errcode_t status)

开始服务的回调函数。

◆ ssaps_write_request_callback

typedef void(* ssaps_write_request_callback) (uint8_t server_id, uint16_t conn_id, ssaps_req_write_cb_t *write_cb_para, errcode_t status)

收到写请求的回调函数。

枚举类型说明

◆ sle_indication_cfm_result_t

指示确认结果。

枚举值
SLE_INDICATION_CFM_FAIL 

指示接收失败

SLE_INDICATION_CFM_SUCESS 

指示接收成功

函数说明

◆ ssaps_add_descriptor()

errcode_t ssaps_add_descriptor ( uint8_t  server_id,
uint16_t  service_handle,
uint16_t  property_handle,
ssaps_desc_info_t descriptor 
)

异步添加一个ssap描述,注册描述结果在add_descriptor_cb中返回

◆ ssaps_add_descriptor_sync()

errcode_t ssaps_add_descriptor_sync ( uint8_t  server_id,
uint16_t  service_handle,
uint16_t  property_handle,
ssaps_desc_info_t descriptor 
)

添加一个ssap特征描述符。

◆ ssaps_add_property()

errcode_t ssaps_add_property ( uint8_t  server_id,
uint16_t  service_handle,
ssaps_property_info_t property 
)

异步添加一个ssap属性,注册属性 handle在add_property_cb中返回

◆ ssaps_add_property_sync()

errcode_t ssaps_add_property_sync ( uint8_t  server_id,
uint16_t  service_handle,
ssaps_property_info_t property,
uint16_t *  handle 
)

添加一个ssap特征。

◆ ssaps_add_service()

errcode_t ssaps_add_service ( uint8_t  server_id,
sle_uuid_t service_uuid,
bool  is_primary 
)

异步添加一个ssap服务,注册service handle在add_service_cb中返回。

◆ ssaps_add_service_sync()

errcode_t ssaps_add_service_sync ( uint8_t  server_id,
sle_uuid_t service_uuid,
bool  is_primary,
uint16_t *  handle 
)

添加一个ssap服务。

◆ ssaps_delete_all_services()

errcode_t ssaps_delete_all_services ( uint8_t  server_id)

删除所有SSAP服务。

◆ ssaps_notify_indicate()

errcode_t ssaps_notify_indicate ( uint8_t  server_id,
uint16_t  conn_id,
ssaps_ntf_ind_t param 
)

向对端发送通知或指示。

◆ ssaps_notify_indicate_by_uuid()

errcode_t ssaps_notify_indicate_by_uuid ( uint8_t  server_id,
uint16_t  conn_id,
ssaps_ntf_ind_by_uuid_t param 
)

通过uuid向对端发送通知或指示。

◆ ssaps_register_callbacks()

errcode_t ssaps_register_callbacks ( ssaps_callbacks_t func)

注册 SSAP server 回调函数。

◆ ssaps_register_server()

errcode_t ssaps_register_server ( sle_uuid_t app_uuid,
uint8_t *  server_id 
)

注册ssap服务端。

◆ ssaps_send_response()

errcode_t ssaps_send_response ( uint8_t  server_id,
uint16_t  conn_id,
ssaps_send_rsp_t param 
)

当收到需要用户回复响应的请求时发送响应。

◆ ssaps_set_info()

errcode_t ssaps_set_info ( uint8_t  server_id,
ssap_exchange_info_t info 
)

在连接之前设置服务端info。

◆ ssaps_start_service()

errcode_t ssaps_start_service ( uint8_t  server_id,
uint16_t  service_handle 
)

开始一个SSAP服务。

◆ ssaps_unregister_server()

errcode_t ssaps_unregister_server ( uint8_t  server_id)

注销ssap服务端。