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

类型定义

typedef unsigned int(* wifi_mac_derivation_ptr) (unsigned char *origin_mac, unsigned char num, unsigned char type, unsigned char *output_mac, unsigned char out_put_num)
 mac派生方法指针定义。
 

函数

errcode_t wifi_init (void)
 Wifi初始化。
 
errcode_t wifi_deinit (void)
 Wifi去初始化。
 
int32_t wifi_is_wifi_inited (void)
 获取WiFi初始化状态。
 
errcode_t wifi_sta_enable (void)
 开启STA。
 
errcode_t wifi_sta_disable (void)
 关闭STA。
 
int32_t wifi_is_sta_enabled (void)
 获取sta使能状态。
 
wifi_dev_twifi_get_dev (wifi_iftype_t iftype)
 获取dev使能状态。
 
errcode_t wifi_sta_set_protocol_mode (protocol_mode_enum mode)
 设置Sta的协议模式。
 
protocol_mode_enum wifi_sta_get_protocol_mode (void)
 获取Sta的协议模式。
 
errcode_t wifi_sta_scan (void)
 station进行全信道基础扫描。
 
errcode_t wifi_sta_scan_advance (const wifi_scan_params_stru *scan_param)
 station执行带特定参数的扫描。
 
errcode_t wifi_sta_set_scan_policy (wifi_if_type_enum iftype, wifi_scan_strategy_stru *scan_strategy)
 station设置扫描参数。
 
errcode_t wifi_raw_scan (wifi_scan_params_stru *scan_param, wifi_scan_no_save_cb cb)
 station执行带特定参数的原始扫描(不经过wpa,回调由用户指定)。
 
errcode_t wifi_sta_scan_stop (void)
 强制停止Sta全信道扫描。
 
errcode_t wifi_sta_get_scan_info (wifi_scan_info_stru *result, uint32_t *size)
 获取station扫描结果。
 
errcode_t wifi_sta_scan_result_clear (void)
 清空station扫描结果。
 
errcode_t wifi_set_channel (wifi_if_type_enum iftype, int32_t channel)
 切换信道。
 
errcode_t wifi_get_channel (wifi_if_type_enum iftype, int32_t *channel)
 获取信道。
 
errcode_t wifi_sta_connect (const wifi_sta_config_stru *config)
 station进行连接网络。
 
errcode_t wifi_sta_disconnect (void)
 station断开相连的网络。
 
errcode_t wifi_sta_get_ap_info (wifi_linked_info_stru *result)
 获取station连接的网络状态。
 
errcode_t wifi_sta_set_reconnect_policy (int32_t enable, uint32_t seconds, uint32_t period, uint32_t max_try_count)
 station设置重新连接网络机制。
 
errcode_t wifi_sta_set_pmf_mode (wifi_pmf_option_enum pmf)
 配置station的pmf。
 
wifi_pmf_option_enum wifi_sta_get_pmf_mode (void)
 获取station的pmf设置。
 
int16_t wifi_sta_get_connect_status_code (void)
 查询Authentication与Association帧status code。
 
errcode_t wifi_set_mgmt_frame_rx_cb (wifi_rx_mgmt_cb data_cb, uint8_t mode)
 注册管理帧收包回调函数。
 
errcode_t wifi_set_promis_mode (wifi_if_type_enum iftype, int32_t enable, const wifi_ptype_filter_stru *filter)
 设置混杂模式。
 
errcode_t wifi_set_promis_rx_pkt_cb (wifi_promis_cb data_cb)
 注册混杂模式的收包回调函数。
 
errcode_t wifi_sta_fast_connect (const wifi_fast_connect_stru *fast_request)
 station进行快速连接网络。
 
errcode_t wifi_register_event_cb (const wifi_event_stru *event)
 APP注册的事件处理接口。
 
errcode_t wifi_unregister_event_cb (const wifi_event_stru *event)
 APP去注册的事件处理接口。
 
errcode_t wifi_set_app_ie (wifi_if_type_enum iftype, ie_index_enmu ie_index, uint8_t frame_type_bitmap, const uint8_t *ie, uint16_t ie_len)
 在管理帧中添加用户IE字段。
 
errcode_t wifi_del_app_ie (wifi_if_type_enum iftype, ie_index_enmu ie_index, uint8_t frame_type_bitmap)
 在管理帧中删除用户IE字段。
 
errcode_t wifi_csi_start (void)
 开启CSI上报。
 
errcode_t wifi_csi_stop (void)
 关闭CSI上报。
 
errcode_t wifi_set_csi_config (const int8_t *ifname, const csi_config_stru *config)
 配置CSI。
 
errcode_t wifi_register_csi_report_cb (wifi_csi_data_cb data_cb)
 注册CSI数据上报回调函数。
 
errcode_t wifi_send_custom_pkt (const wifi_if_type_enum iftype, const uint8_t *data, uint32_t len)
 发送用户定制报文,报文须按照802.11协议格式封装。
 
errcode_t wifi_set_pkt_retry_policy (uint8_t type, uint8_t limit)
 设置数据帧和管理帧的最大软件重传次数。
 
errcode_t wifi_reset_mac_phy (void)
 复位MAC和PHY接口,解决MAC,PHY挂死问题。
 
errcode_t wifi_set_linkloss_config (linkloss_paras_stru *linkloss_paras)
 设置Linkloss的参数。
 
errcode_t wifi_set_base_mac_addr (const int8_t *mac_addr, uint8_t mac_len)
 设置基础mac地址。
 
errcode_t wifi_get_base_mac_addr (int8_t *mac_addr, uint8_t mac_len)
 获取基础mac地址。
 
errcode_t wifi_softap_set_mac_addr (const int8_t *mac_addr, uint8_t mac_len)
 设置softap mac地址。
 
errcode_t wifi_softap_get_mac_addr (int8_t *mac_addr, uint8_t mac_len)
 获取softap mac地址。
 
errcode_t wifi_set_mac_derivation_ptr (wifi_mac_derivation_ptr ptr)
 设置mac派生策略。
 
errcode_t wifi_set_low_current_boot_mode (uint8_t flag)
 设置低启动电流模式。
 
errcode_t wifi_get_country_code (int8_t *country_code, uint8_t *len)
 获取国家码。
 
errcode_t wifi_set_country_code (const int8_t *country_code, uint8_t len)
 设置国家码。
 
errcode_t wifi_sta_set_pm (uint8_t ps_switch)
 设置低功耗模式。
 
errcode_t wifi_set_sdp_mode (wifi_if_type_enum iftype, int32_t enable, int32_t ratio)
 设置sdp模式。
 
errcode_t wifi_set_sdp_subscribe (wifi_if_type_enum iftype, char *sdp_subscribe, int32_t local_handle)
 设置sdp subscribe。
 
errcode_t wifi_sta_wps_pbc (uint8_t *bssid)
 wps pbc连接。
 
errcode_t wifi_sta_wps_pin (int8_t *pin, uint8_t *bssid)
 wps_pin 连接。
 
errcode_t wifi_sta_get_wps_pin (int8_t *pin, uint32_t len)
 wps_pin 连接。
 
errcode_t wifi_set_psd_mode (ext_psd_option_param *psd_option)
 设置PSD模式。
 
errcode_t wifi_set_psd_cb (wifi_psd_cb data_cb)
 设置PSD回调接口。
 

详细描述

类型定义说明

◆ wifi_mac_derivation_ptr

typedef unsigned int(* wifi_mac_derivation_ptr) (unsigned char *origin_mac, unsigned char num, unsigned char type, unsigned char *output_mac, unsigned char out_put_num)

mac派生方法指针定义。

函数说明

◆ wifi_csi_start()

errcode_t wifi_csi_start ( void  )

开启CSI上报。

◆ wifi_csi_stop()

errcode_t wifi_csi_stop ( void  )

关闭CSI上报。

◆ wifi_deinit()

errcode_t wifi_deinit ( void  )

Wifi去初始化。

◆ wifi_del_app_ie()

errcode_t wifi_del_app_ie ( wifi_if_type_enum  iftype,
ie_index_enmu  ie_index,
uint8_t  frame_type_bitmap 
)

在管理帧中删除用户IE字段。

◆ wifi_get_base_mac_addr()

errcode_t wifi_get_base_mac_addr ( int8_t *  mac_addr,
uint8_t  mac_len 
)

获取基础mac地址。

◆ wifi_get_channel()

errcode_t wifi_get_channel ( wifi_if_type_enum  iftype,
int32_t *  channel 
)

获取信道。

◆ wifi_get_country_code()

errcode_t wifi_get_country_code ( int8_t *  country_code,
uint8_t *  len 
)

获取国家码。

◆ wifi_get_dev()

wifi_dev_t * wifi_get_dev ( wifi_iftype_t  iftype)

获取dev使能状态。

◆ wifi_init()

errcode_t wifi_init ( void  )

Wifi初始化。

◆ wifi_is_sta_enabled()

int32_t wifi_is_sta_enabled ( void  )

获取sta使能状态。

◆ wifi_is_wifi_inited()

int32_t wifi_is_wifi_inited ( void  )

获取WiFi初始化状态。

◆ wifi_raw_scan()

errcode_t wifi_raw_scan ( wifi_scan_params_stru scan_param,
wifi_scan_no_save_cb  cb 
)

station执行带特定参数的原始扫描(不经过wpa,回调由用户指定)。

◆ wifi_register_csi_report_cb()

errcode_t wifi_register_csi_report_cb ( wifi_csi_data_cb  data_cb)

注册CSI数据上报回调函数。

◆ wifi_register_event_cb()

errcode_t wifi_register_event_cb ( const wifi_event_stru event)

APP注册的事件处理接口。

◆ wifi_reset_mac_phy()

errcode_t wifi_reset_mac_phy ( void  )

复位MAC和PHY接口,解决MAC,PHY挂死问题。

◆ wifi_send_custom_pkt()

errcode_t wifi_send_custom_pkt ( const wifi_if_type_enum  iftype,
const uint8_t *  data,
uint32_t  len 
)

发送用户定制报文,报文须按照802.11协议格式封装。

◆ wifi_set_app_ie()

errcode_t wifi_set_app_ie ( wifi_if_type_enum  iftype,
ie_index_enmu  ie_index,
uint8_t  frame_type_bitmap,
const uint8_t *  ie,
uint16_t  ie_len 
)

在管理帧中添加用户IE字段。

◆ wifi_set_base_mac_addr()

errcode_t wifi_set_base_mac_addr ( const int8_t *  mac_addr,
uint8_t  mac_len 
)

设置基础mac地址。

◆ wifi_set_channel()

errcode_t wifi_set_channel ( wifi_if_type_enum  iftype,
int32_t  channel 
)

切换信道。

◆ wifi_set_country_code()

errcode_t wifi_set_country_code ( const int8_t *  country_code,
uint8_t  len 
)

设置国家码。

◆ wifi_set_csi_config()

errcode_t wifi_set_csi_config ( const int8_t *  ifname,
const csi_config_stru config 
)

配置CSI。

◆ wifi_set_linkloss_config()

errcode_t wifi_set_linkloss_config ( linkloss_paras_stru linkloss_paras)

设置Linkloss的参数。

◆ wifi_set_low_current_boot_mode()

errcode_t wifi_set_low_current_boot_mode ( uint8_t  flag)

设置低启动电流模式。

◆ wifi_set_mac_derivation_ptr()

errcode_t wifi_set_mac_derivation_ptr ( wifi_mac_derivation_ptr  ptr)

设置mac派生策略。

◆ wifi_set_mgmt_frame_rx_cb()

errcode_t wifi_set_mgmt_frame_rx_cb ( wifi_rx_mgmt_cb  data_cb,
uint8_t  mode 
)

注册管理帧收包回调函数。

◆ wifi_set_pkt_retry_policy()

errcode_t wifi_set_pkt_retry_policy ( uint8_t  type,
uint8_t  limit 
)

设置数据帧和管理帧的最大软件重传次数。

◆ wifi_set_promis_mode()

errcode_t wifi_set_promis_mode ( wifi_if_type_enum  iftype,
int32_t  enable,
const wifi_ptype_filter_stru filter 
)

设置混杂模式。

◆ wifi_set_promis_rx_pkt_cb()

errcode_t wifi_set_promis_rx_pkt_cb ( wifi_promis_cb  data_cb)

注册混杂模式的收包回调函数。

◆ wifi_set_psd_cb()

errcode_t wifi_set_psd_cb ( wifi_psd_cb  data_cb)

设置PSD回调接口。

◆ wifi_set_psd_mode()

errcode_t wifi_set_psd_mode ( ext_psd_option_param psd_option)

设置PSD模式。

◆ wifi_set_sdp_mode()

errcode_t wifi_set_sdp_mode ( wifi_if_type_enum  iftype,
int32_t  enable,
int32_t  ratio 
)

设置sdp模式。

◆ wifi_set_sdp_subscribe()

errcode_t wifi_set_sdp_subscribe ( wifi_if_type_enum  iftype,
char *  sdp_subscribe,
int32_t  local_handle 
)

设置sdp subscribe。

◆ wifi_softap_get_mac_addr()

errcode_t wifi_softap_get_mac_addr ( int8_t *  mac_addr,
uint8_t  mac_len 
)

获取softap mac地址。

◆ wifi_softap_set_mac_addr()

errcode_t wifi_softap_set_mac_addr ( const int8_t *  mac_addr,
uint8_t  mac_len 
)

设置softap mac地址。

◆ wifi_sta_connect()

errcode_t wifi_sta_connect ( const wifi_sta_config_stru config)

station进行连接网络。

◆ wifi_sta_disable()

errcode_t wifi_sta_disable ( void  )

关闭STA。

◆ wifi_sta_disconnect()

errcode_t wifi_sta_disconnect ( void  )

station断开相连的网络。

◆ wifi_sta_enable()

errcode_t wifi_sta_enable ( void  )

开启STA。

◆ wifi_sta_fast_connect()

errcode_t wifi_sta_fast_connect ( const wifi_fast_connect_stru fast_request)

station进行快速连接网络。

◆ wifi_sta_get_ap_info()

errcode_t wifi_sta_get_ap_info ( wifi_linked_info_stru result)

获取station连接的网络状态。

◆ wifi_sta_get_connect_status_code()

int16_t wifi_sta_get_connect_status_code ( void  )

查询Authentication与Association帧status code。

◆ wifi_sta_get_pmf_mode()

wifi_pmf_option_enum wifi_sta_get_pmf_mode ( void  )

获取station的pmf设置。

◆ wifi_sta_get_protocol_mode()

protocol_mode_enum wifi_sta_get_protocol_mode ( void  )

获取Sta的协议模式。

◆ wifi_sta_get_scan_info()

errcode_t wifi_sta_get_scan_info ( wifi_scan_info_stru result,
uint32_t *  size 
)

获取station扫描结果。

◆ wifi_sta_get_wps_pin()

errcode_t wifi_sta_get_wps_pin ( int8_t *  pin,
uint32_t  len 
)

wps_pin 连接。

◆ wifi_sta_scan()

errcode_t wifi_sta_scan ( void  )

station进行全信道基础扫描。

◆ wifi_sta_scan_advance()

errcode_t wifi_sta_scan_advance ( const wifi_scan_params_stru scan_param)

station执行带特定参数的扫描。

◆ wifi_sta_scan_result_clear()

errcode_t wifi_sta_scan_result_clear ( void  )

清空station扫描结果。

◆ wifi_sta_scan_stop()

errcode_t wifi_sta_scan_stop ( void  )

强制停止Sta全信道扫描。

◆ wifi_sta_set_pm()

errcode_t wifi_sta_set_pm ( uint8_t  ps_switch)

设置低功耗模式。

◆ wifi_sta_set_pmf_mode()

errcode_t wifi_sta_set_pmf_mode ( wifi_pmf_option_enum  pmf)

配置station的pmf。

◆ wifi_sta_set_protocol_mode()

errcode_t wifi_sta_set_protocol_mode ( protocol_mode_enum  mode)

设置Sta的协议模式。

◆ wifi_sta_set_reconnect_policy()

errcode_t wifi_sta_set_reconnect_policy ( int32_t  enable,
uint32_t  seconds,
uint32_t  period,
uint32_t  max_try_count 
)

station设置重新连接网络机制。

◆ wifi_sta_set_scan_policy()

errcode_t wifi_sta_set_scan_policy ( wifi_if_type_enum  iftype,
wifi_scan_strategy_stru scan_strategy 
)

station设置扫描参数。

◆ wifi_sta_wps_pbc()

errcode_t wifi_sta_wps_pbc ( uint8_t *  bssid)

wps pbc连接。

◆ wifi_sta_wps_pin()

errcode_t wifi_sta_wps_pin ( int8_t *  pin,
uint8_t *  bssid 
)

wps_pin 连接。

◆ wifi_unregister_event_cb()

errcode_t wifi_unregister_event_cb ( const wifi_event_stru event)

APP去注册的事件处理接口。