Wi-Fi设备配网适配开发

通用HAL说明

Wi-Fi配网模块中依赖生活物联网平台SDK的公共HAL接口（如下表所示）。请您参照生活物联网平台SDK中对应模块的说明完成对接。

HAL适配概述

Wi-Fi配网模块需要适配的HAL接口的详细说明如下表所示。

HAL_Wifi_Get_Mac

原型

char *HAL_Wifi_Get_Mac(_OU_ char mac_str[HAL_MAC_LEN]);

接口说明

获取Wi-Fi网口的MAC地址，格式为XX:XX:XX:XX:XX:XX。

参数说明

返回值说明

指向缓冲区数组起始位置的字符指针。

HAL_Wifi_Get_IP

原型

uint32_t HAL_Wifi_Get_IP(_OU_ char ip_str[NETWORK_ADDR_LEN], _IN_ const char *ifname);

接口说明

获取Wi-Fi网口的IP地址，点分十进制格式保存在字符串数组出参，二进制格式则作为返回值，并以网络字节序（大端）表达。

参数说明

返回值说明

二进制形式的IP地址，以网络字节序（大端）组织。

HAL_Awss_Get_Channelscan_Interval_Ms

原型

int HAL_Awss_Get_Channelscan_Interval_Ms(void);

接口说明

获取在每个信道（channel）上扫描的时间长度，单位是毫秒，建议设置为200ms~400ms（默认250ms）。

参数说明

void

返回值说明

时间长度，单位为毫秒。

HAL_Awss_Get_Timeout_Interval_Ms

原型

int HAL_Awss_Get_Timeout_Interval_Ms(void);

接口说明

获取配网服务（AWSS）的超时时间长度，单位是毫秒，建议配置为60s或60000ms。

参数说明

void

返回值说明

超时时长，单位是毫秒。

HAL_Awss_Get_Encrypt_Type

原型

int HAL_Awss_Get_Encrypt_Type(void);

接口说明

获取一键配网服务的安全等级。

参数说明

void

返回值说明

HAL_Awss_Get_Conn_Encrypt_Type

原型

int HAL_Awss_Get_Conn_Encrypt_Type(void);

接口说明

获取零配，热点配网的安全等级。

参数说明

void

返回值说明

HAL_Awss_Open_Monitor

原型

void HAL_Awss_Open_Monitor(_IN_ awss_recv_80211_frame_cb_t cb);

接口说明

设置Wi-Fi网卡工作在监听（Monitor）模式，并在收到802.11帧的时候调用被传入的回调函数。

参数说明

/**
 * @brief   802.11帧的处理函数，可以将802.11 Frame传递给这个函数
 *
 * @param[in] buf @n 80211 frame buffer, or pointer to struct ht40_ctrl
 * @param[in] length @n 80211 frame buffer length
 * @param[in] link_type @n AWSS_LINK_TYPE_NONE for most rtos HAL,
 *              and for linux HAL, do the following step to check
 *              which header type the driver supported.
   @verbatim
               a) iwconfig wlan0 mode monitor    #open monitor mode
               b) iwconfig wlan0 channel 6    #switch channel 6
               c) tcpdump -i wlan0 -s0 -w file.pacp    #capture 80211 frame & save
               d) open file.pacp with wireshark or omnipeek
                   check the link header type and fcs included or not
   @endverbatim
 * @param[in] with_fcs @n 80211 frame buffer include fcs(4 byte) or not
 * @param[in] rssi @n rssi of packet, range of [-127, -1]
 */
typedef int (*awss_recv_80211_frame_cb_t)(char *buf, int length,
        enum AWSS_LINK_TYPE link_type, int with_fcs, signed char rssi);

返回值说明

void

HAL_Awss_Close_Monitor

原型

void HAL_Awss_Close_Monitor(void);

接口说明

设置Wi-Fi网卡离开监听（Monitor）模式，并开始以站点（Station）模式工作。

参数说明

void

返回值说明

void

HAL_Wifi_Scan

原型

int HAL_Wifi_Scan(awss_wifi_scan_result_cb_t cb);

接口说明

启动一次Wi-Fi的空中扫描，该API是一个阻塞操作，扫描没有完成不能结束。所有的AP列表收集完成后，一个一个通过回调函数告知AWSS，最好不要限制AP的数量，否则可能导致中文GBK编码的SSID热点配网失败。

参数说明

返回值说明

HAL_Awss_Switch_Channel

原型

void HAL_Awss_Switch_Channel(
            _IN_ char primary_channel,
            _IN_OPT_ char secondary_channel,
            _IN_OPT_ uint8_t bssid[ETH_ALEN]);

接口说明

设置Wi-Fi网卡切换到指定的信道（channel）上。

参数说明

返回值说明

void

HAL_Awss_Connect_Ap

原型

int HAL_Awss_Connect_Ap(
            _IN_ uint32_t connection_timeout_ms,
            _IN_ char ssid[HAL_MAX_SSID_LEN],
            _IN_ char passwd[HAL_MAX_PASSWD_LEN],
            _IN_OPT_ enum AWSS_AUTH_TYPE auth,
            _IN_OPT_ enum AWSS_ENC_TYPE encry,
            _IN_OPT_ uint8_t bssid[ETH_ALEN],
            _IN_OPT_ uint8_t channel);

接口说明

要求Wi-Fi网卡连接指定热点（Access Point）的函数，bssid指定特定AP，另外bssid也可能为空或无效值（全0或全0xff）。

参数说明

返回值说明

HAL_Wifi_Send_80211_Raw_Frame

原型

int HAL_Wifi_Send_80211_Raw_Frame(_IN_ enum HAL_Awss_Frame_Type type,
        _IN_ uint8_t *buffer, _IN_ int len);

接口说明

在当前信道（channel）上以基本数据速率（1Mbps）发送裸的802.11帧（raw 802.11 frame）。

参数说明

/* 80211 frame type */
typedef enum HAL_Awss_Frame_Type {
    FRAME_ACTION,                 // 802.11中的Action帧
    FRAME_BEACON,                // 802.11中的Beacon帧
    FRAME_PROBE_REQ,           // 802.11中的Probe Request帧
    FRAME_PROBE_RESPONSE,       // 802.11中的Probe Response帧
    FRAME_DATA                 // 802.11中的数据帧
} HAL_Awss_Frame_Type_t;

返回值说明

HAL_Wifi_Enable_Mgmt_Frame_Filter

原型

int HAL_Wifi_Enable_Mgmt_Frame_Filter(
            _IN_ uint32_t filter_mask,
            _IN_OPT_ uint8_t vendor_oui[3],
            _IN_ awss_wifi_mgmt_frame_cb_t callback);

接口说明

使能或禁用对特定管理帧的过滤。

参数说明

返回值说明

HAL_Sys_Net_Is_Ready

原型

int HAL_Sys_Net_Is_Ready();

接口说明

检查系统网络是否可用（设备是否已经成功获得IP地址并且当前IP地址可用）。

参数说明

void

返回值说明

HAL_Wifi_Get_Ap_Info

原型

int HAL_Wifi_Get_Ap_Info(
            _OU_ char ssid[HAL_MAX_SSID_LEN],
            _OU_ char passwd[HAL_MAX_PASSWD_LEN],
            _OU_ uint8_t bssid[ETH_ALEN]);

接口说明

获取所连接的热点（Access Point）的信息。

参数说明

返回值说明

HAL_Wifi_Get_Link_Stat

原型

int HAL_Wifi_Get_Link_Stat(_OU_ int *p_rssi,
                           _OU_ int *p_channel);

接口说明

获取当前与AP连接链路状态的信息（channel、RSSI等）。

参数说明

返回值说明

HAL_Awss_Open_Ap

原型

int HAL_Awss_Open_Ap(const char *ssid, 
                     const char *passwd, 
                     int beacon_interval, 
                     int hide);

接口说明

开启设备热点（SoftAP模式）。

参数说明

返回值说明

HAL_Awss_Close_Ap

原型

int HAL_Awss_Close_Ap(void);

接口说明

关闭设备热点。

参数说明

void

返回值说明