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

结构体

struct  sle_connection_param_update_req_t
 星闪逻辑链路更新参数请求 更多...
 
struct  sle_connection_param_update_t
 星闪逻辑链路更新参数 更多...
 
struct  sle_connection_param_update_evt_t
 星闪逻辑链路更新事件参数 更多...
 
struct  sle_auth_info_evt_t
 星闪认证结果 更多...
 
struct  sle_set_phy_t
 星闪phy参数 更多...
 
struct  sle_default_connect_param_t
 星闪默认连接参数 更多...
 
struct  sle_connection_callbacks_t
 SLE连接管理回调函数接口定义。 更多...
 

类型定义

typedef void(* sle_connect_state_changed_callback) (uint16_t conn_id, const sle_addr_t *addr, sle_acb_state_t conn_state, sle_pair_state_t pair_state, sle_disc_reason_t disc_reason)
 连接状态改变的回调函数。
 
typedef void(* sle_connect_param_update_callback) (uint16_t conn_id, errcode_t status, const sle_connection_param_update_evt_t *param)
 连接参数更新的回调函数。
 
typedef void(* sle_connect_param_update_req_callback) (uint16_t conn_id, errcode_t status, const sle_connection_param_update_req_t *param)
 连接参数更新请求完成前的回调函数。
 
typedef void(* sle_auth_complete_callback) (uint16_t conn_id, const sle_addr_t *addr, errcode_t status, const sle_auth_info_evt_t *evt)
 认证完成的回调函数。
 
typedef void(* sle_pair_complete_callback) (uint16_t conn_id, const sle_addr_t *addr, errcode_t status)
 配对完成的回调函数。
 
typedef void(* sle_read_rssi_callback) (uint16_t conn_id, int8_t rssi, errcode_t status)
 读取rssi的回调函数。
 
typedef void(* sle_low_latency_callback) (uint8_t status, sle_addr_t *addr, uint8_t rate)
 设置low latency的回调函数。
 
typedef void(* sle_set_phy_callback) (uint16_t conn_id, errcode_t status, const sle_set_phy_t *param)
 设置PHY的回调函数。
 

枚举

enum  sle_pair_state_t { SLE_PAIR_NONE = 0x01 , SLE_PAIR_PAIRING = 0x02 , SLE_PAIR_PAIRED = 0x03 }
 星闪配对状态。 更多...
 
enum  sle_disc_reason_t { SLE_DISCONNECT_BY_REMOTE = 0x10 , SLE_DISCONNECT_BY_LOCAL = 0x11 }
 星闪断链原因。 更多...
 
enum  sle_acb_state_t { SLE_ACB_STATE_NONE = 0x00 , SLE_ACB_STATE_CONNECTED = 0x01 , SLE_ACB_STATE_DISCONNECTED = 0x02 }
 SLE ACB连接状态。 更多...
 
enum  sle_crypto_algo_t { SLE_CRYTO_ALGO_AC1 = 0x00 , SLE_CRYTO_ALGO_AC2 = 0x01 , SLE_CRYTO_ALGO_EA1 = 0x02 , SLE_CRYTO_ALGO_EA2 = 0x03 }
 星闪加密算法类型。 更多...
 
enum  sle_key_deriv_algo_t { SLE_KEY_DERIV_ALGO_HA1 = 0x00 , SLE_KEY_DERIV_ALGO_HA2 = 0x01 }
 星闪秘钥分发算法类型。 更多...
 
enum  sle_integr_chk_ind_t { SLE_ENCRYPTION_ENABLE_INTEGRITY_CHK_ENABLE = 0x00 , SLE_ENCRYPTION_DISABLE_INTEGRITY_CHK_ENABLE = 0x01 , SLE_ENCRYPTION_ENABLE_INTEGRITY_CHK_DISABLE = 0x02 , SLE_ENCRYPTION_DISABLE_INTEGRITY_CHK_DISABLE = 0x03 }
 星闪完整性校验指示类型。 更多...
 
enum  sle_radio_frame_t {
  SLE_RADIO_FRAME_1 = 0 , SLE_RADIO_FRAME_2 = 1 , SLE_RADIO_FRAME_3_M0 = 2 , SLE_RADIO_FRAME_3_M1 = 3 ,
  SLE_RADIO_FRAME_3_M2 = 4 , SLE_RADIO_FRAME_3_M3 = 5 , SLE_RADIO_FRAME_3_M4 = 6 , SLE_RADIO_FRAME_3_M5 = 7 ,
  SLE_RADIO_FRAME_4_M0 = 8 , SLE_RADIO_FRAME_4_M1 = 9 , SLE_RADIO_FRAME_4_M2 = 10 , SLE_RADIO_FRAME_4_M3 = 11 ,
  SLE_RADIO_FRAME_4_M4 = 12 , SLE_RADIO_FRAME_4_M5 = 13 , SLE_RADIO_FRAME_END
}
 星闪无线帧类型,bitmap表示 更多...
 
enum  sle_phy_tx_rx_t { SLE_PHY_1M = 0x0 , SLE_PHY_2M = 0x1 , SLE_PHY_4M = 0x2 , SLE_PHY_SUPPORT_NUM }
 星闪发送/接收PHY类型,bitmap表示 更多...
 
enum  sle_phy_tx_rx_pilot_density_t {
  SLE_PHY_PILOT_DENSITY_4_TO_1 = 0x0 , SLE_PHY_PILOT_DENSITY_8_TO_1 = 0x1 , SLE_PHY_PILOT_DENSITY_16_TO_1 = 0x2 , SLE_PHY_PILOT_DENSITY_NO = 0x3 ,
  SLE_PHY_PILOT_DENSITY_NUM
}
 星闪发送/接收导频密度指示,bitmap表示 更多...
 

函数

errcode_t sle_connect_remote_device (const sle_addr_t *addr)
 发送连接请求。
 
errcode_t sle_disconnect_remote_device (const sle_addr_t *addr)
 发送断开连接请求。
 
errcode_t sle_disconnect_all_remote_device (void)
 断开所有连接。
 
errcode_t sle_update_connect_param (sle_connection_param_update_t *params)
 发送更新连接参数请求。
 
errcode_t sle_pair_remote_device (const sle_addr_t *addr)
 发送配对请求。
 
errcode_t sle_remove_paired_remote_device (const sle_addr_t *addr)
 删除配对。
 
errcode_t sle_remove_all_pairs (void)
 删除所有配对。
 
errcode_t sle_get_paired_devices_num (uint16_t *number)
 获取配对设备数量。
 
errcode_t sle_get_paired_devices (sle_addr_t *addr, uint16_t *number)
 获取配对设备。
 
errcode_t sle_get_bonded_devices (sle_addr_t *addr, uint16_t *number)
 获取绑定设备。
 
errcode_t sle_get_pair_state (const sle_addr_t *addr, uint8_t *state)
 获取配对状态。
 
errcode_t sle_read_remote_device_rssi (uint16_t conn_id)
 读取对端设备rssi值。
 
errcode_t sle_set_phy_param (uint16_t conn_id, sle_set_phy_t *param)
 设置PHY参数
 
errcode_t sle_set_mcs (uint16_t conn_id, uint8_t mcs)
 设置调制与编码策略。
 
errcode_t sle_set_data_len (uint16_t conn_id, uint16_t tx_octets)
 设置连接链路上所偏好的最大传输payload字节数
 
errcode_t sle_default_connection_param_set (sle_default_connect_param_t *set_param)
 设置 sle 默认连接参数
 
errcode_t sle_connection_register_callbacks (sle_connection_callbacks_t *func)
 注册SLE连接管理回调函数。
 
errcode_t sle_customize_max_pwr (int8_t ble_pwr, int8_t sle_pwr)
 配置定制化信息
 

详细描述

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

Description: SLE Connection Manager module.

类型定义说明

◆ sle_auth_complete_callback

typedef void(* sle_auth_complete_callback) (uint16_t conn_id, const sle_addr_t *addr, errcode_t status, const sle_auth_info_evt_t *evt)

认证完成的回调函数。

◆ sle_connect_param_update_callback

typedef void(* sle_connect_param_update_callback) (uint16_t conn_id, errcode_t status, const sle_connection_param_update_evt_t *param)

连接参数更新的回调函数。

◆ sle_connect_param_update_req_callback

typedef void(* sle_connect_param_update_req_callback) (uint16_t conn_id, errcode_t status, const sle_connection_param_update_req_t *param)

连接参数更新请求完成前的回调函数。

◆ sle_connect_state_changed_callback

typedef void(* sle_connect_state_changed_callback) (uint16_t conn_id, const sle_addr_t *addr, sle_acb_state_t conn_state, sle_pair_state_t pair_state, sle_disc_reason_t disc_reason)

连接状态改变的回调函数。

◆ sle_low_latency_callback

typedef void(* sle_low_latency_callback) (uint8_t status, sle_addr_t *addr, uint8_t rate)

设置low latency的回调函数。

◆ sle_pair_complete_callback

typedef void(* sle_pair_complete_callback) (uint16_t conn_id, const sle_addr_t *addr, errcode_t status)

配对完成的回调函数。

◆ sle_read_rssi_callback

typedef void(* sle_read_rssi_callback) (uint16_t conn_id, int8_t rssi, errcode_t status)

读取rssi的回调函数。

◆ sle_set_phy_callback

typedef void(* sle_set_phy_callback) (uint16_t conn_id, errcode_t status, const sle_set_phy_t *param)

设置PHY的回调函数。

枚举类型说明

◆ sle_acb_state_t

SLE ACB连接状态。

枚举值
SLE_ACB_STATE_NONE 

SLE ACB 未连接状态

SLE_ACB_STATE_CONNECTED 

SLE ACB 已连接

SLE_ACB_STATE_DISCONNECTED 

SLE ACB 已断接

◆ sle_crypto_algo_t

星闪加密算法类型。

枚举值
SLE_CRYTO_ALGO_AC1 

AC1加密算法类型

SLE_CRYTO_ALGO_AC2 

AC2加密算法类型

SLE_CRYTO_ALGO_EA1 

EA1加密算法类型

SLE_CRYTO_ALGO_EA2 

EA2加密算法类型

◆ sle_disc_reason_t

星闪断链原因。

枚举值
SLE_DISCONNECT_BY_REMOTE 

远端断链

SLE_DISCONNECT_BY_LOCAL 

本端断链

◆ sle_integr_chk_ind_t

星闪完整性校验指示类型。

枚举值
SLE_ENCRYPTION_ENABLE_INTEGRITY_CHK_ENABLE 

加密和完整性保护同时启动

SLE_ENCRYPTION_DISABLE_INTEGRITY_CHK_ENABLE 

不启动加密,启动完整性保护

SLE_ENCRYPTION_ENABLE_INTEGRITY_CHK_DISABLE 

启动加密,不启动完整性保护

SLE_ENCRYPTION_DISABLE_INTEGRITY_CHK_DISABLE 

不启动加密,不启动完整性保护

◆ sle_key_deriv_algo_t

星闪秘钥分发算法类型。

枚举值
SLE_KEY_DERIV_ALGO_HA1 

HA1秘钥分发算法类型

SLE_KEY_DERIV_ALGO_HA2 

HA2秘钥分发算法类型

◆ sle_pair_state_t

星闪配对状态。

枚举值
SLE_PAIR_NONE 

未配对状态

SLE_PAIR_PAIRING 

正在配对

SLE_PAIR_PAIRED 

已完成配对

◆ sle_phy_tx_rx_pilot_density_t

星闪发送/接收导频密度指示,bitmap表示

枚举值
SLE_PHY_PILOT_DENSITY_4_TO_1 

导频密度为4:1

SLE_PHY_PILOT_DENSITY_8_TO_1 

导频密度为8:1

SLE_PHY_PILOT_DENSITY_16_TO_1 

导频密度为16:1

SLE_PHY_PILOT_DENSITY_NO 

无导频

SLE_PHY_PILOT_DENSITY_NUM 

◆ sle_phy_tx_rx_t

星闪发送/接收PHY类型,bitmap表示

枚举值
SLE_PHY_1M 

1M PHY

SLE_PHY_2M 

2M PHY

SLE_PHY_4M 

4M PHY

SLE_PHY_SUPPORT_NUM 

◆ sle_radio_frame_t

星闪无线帧类型,bitmap表示

枚举值
SLE_RADIO_FRAME_1 

无线帧类型1。

SLE_RADIO_FRAME_2 

无线帧类型2。

SLE_RADIO_FRAME_3_M0 

无线帧类型3,m序列0。

SLE_RADIO_FRAME_3_M1 

无线帧类型3,m序列1。

SLE_RADIO_FRAME_3_M2 

无线帧类型3,m序列2。

SLE_RADIO_FRAME_3_M3 

无线帧类型3,m序列3。

SLE_RADIO_FRAME_3_M4 

无线帧类型3,m序列4。

SLE_RADIO_FRAME_3_M5 

无线帧类型3,m序列5。

SLE_RADIO_FRAME_4_M0 

无线帧类型4,m序列0

SLE_RADIO_FRAME_4_M1 

无线帧类型4,m序列1

SLE_RADIO_FRAME_4_M2 

无线帧类型4,m序列2。

SLE_RADIO_FRAME_4_M3 

无线帧类型4,m序列3。

SLE_RADIO_FRAME_4_M4 

无线帧类型4,m序列4。

SLE_RADIO_FRAME_4_M5 

无线帧类型4,m序列5。

SLE_RADIO_FRAME_END 

函数说明

◆ sle_connect_remote_device()

errcode_t sle_connect_remote_device ( const sle_addr_t addr)

发送连接请求。

◆ sle_connection_register_callbacks()

errcode_t sle_connection_register_callbacks ( sle_connection_callbacks_t func)

注册SLE连接管理回调函数。

◆ sle_customize_max_pwr()

errcode_t sle_customize_max_pwr ( int8_t  ble_pwr,
int8_t  sle_pwr 
)

配置定制化信息

◆ sle_default_connection_param_set()

errcode_t sle_default_connection_param_set ( sle_default_connect_param_t set_param)

设置 sle 默认连接参数

◆ sle_disconnect_all_remote_device()

errcode_t sle_disconnect_all_remote_device ( void  )

断开所有连接。

◆ sle_disconnect_remote_device()

errcode_t sle_disconnect_remote_device ( const sle_addr_t addr)

发送断开连接请求。

◆ sle_get_bonded_devices()

errcode_t sle_get_bonded_devices ( sle_addr_t addr,
uint16_t *  number 
)

获取绑定设备。

◆ sle_get_pair_state()

errcode_t sle_get_pair_state ( const sle_addr_t addr,
uint8_t *  state 
)

获取配对状态。

◆ sle_get_paired_devices()

errcode_t sle_get_paired_devices ( sle_addr_t addr,
uint16_t *  number 
)

获取配对设备。

◆ sle_get_paired_devices_num()

errcode_t sle_get_paired_devices_num ( uint16_t *  number)

获取配对设备数量。

◆ sle_pair_remote_device()

errcode_t sle_pair_remote_device ( const sle_addr_t addr)

发送配对请求。

◆ sle_read_remote_device_rssi()

errcode_t sle_read_remote_device_rssi ( uint16_t  conn_id)

读取对端设备rssi值。

◆ sle_remove_all_pairs()

errcode_t sle_remove_all_pairs ( void  )

删除所有配对。

◆ sle_remove_paired_remote_device()

errcode_t sle_remove_paired_remote_device ( const sle_addr_t addr)

删除配对。

◆ sle_set_data_len()

errcode_t sle_set_data_len ( uint16_t  conn_id,
uint16_t  tx_octets 
)

设置连接链路上所偏好的最大传输payload字节数

◆ sle_set_mcs()

errcode_t sle_set_mcs ( uint16_t  conn_id,
uint8_t  mcs 
)

设置调制与编码策略。

◆ sle_set_phy_param()

errcode_t sle_set_phy_param ( uint16_t  conn_id,
sle_set_phy_t param 
)

设置PHY参数

◆ sle_update_connect_param()

errcode_t sle_update_connect_param ( sle_connection_param_update_t params)

发送更新连接参数请求。