通用HAL說明

Wi-Fi配網(wǎng)模塊中依賴生活物聯(lián)網(wǎng)平臺(tái)SDK的公共HAL接口（如下表所示）。請您參照生活物聯(lián)網(wǎng)平臺(tái)SDK中對應(yīng)模塊的說明完成對接。

HAL適配概述

Wi-Fi配網(wǎng)模塊需要適配的HAL接口的詳細(xì)說明如下表所示。

HAL_Wifi_Get_Mac

原型

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

接口說明

獲取Wi-Fi網(wǎng)口的MAC地址，格式為XX:XX:XX:XX:XX:XX。

參數(shù)說明

返回值說明

指向緩沖區(qū)數(shù)組起始位置的字符指針。

HAL_Wifi_Get_IP

原型

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

接口說明

獲取Wi-Fi網(wǎng)口的IP地址，點(diǎn)分十進(jìn)制格式保存在字符串?dāng)?shù)組出參，二進(jìn)制格式則作為返回值，并以網(wǎng)絡(luò)字節(jié)序（大端）表達(dá)。

參數(shù)說明

返回值說明

二進(jìn)制形式的IP地址，以網(wǎng)絡(luò)字節(jié)序（大端）組織。

HAL_Awss_Get_Channelscan_Interval_Ms

原型

int HAL_Awss_Get_Channelscan_Interval_Ms(void);

接口說明

獲取在每個(gè)信道（channel）上掃描的時(shí)間長度，單位是毫秒，建議設(shè)置為200ms~400ms（默認(rèn)250ms）。

參數(shù)說明

void

返回值說明

時(shí)間長度，單位為毫秒。

HAL_Awss_Get_Timeout_Interval_Ms

原型

int HAL_Awss_Get_Timeout_Interval_Ms(void);

接口說明

獲取配網(wǎng)服務(wù)（AWSS）的超時(shí)時(shí)間長度，單位是毫秒，建議配置為60s或60000ms。

參數(shù)說明

void

返回值說明

超時(shí)時(shí)長，單位是毫秒。

HAL_Awss_Get_Encrypt_Type

原型

int HAL_Awss_Get_Encrypt_Type(void);

接口說明

獲取一鍵配網(wǎng)服務(wù)的安全等級。

參數(shù)說明

void

返回值說明

HAL_Awss_Get_Conn_Encrypt_Type

原型

int HAL_Awss_Get_Conn_Encrypt_Type(void);

接口說明

獲取零配，熱點(diǎn)配網(wǎng)的安全等級。

參數(shù)說明

void

返回值說明

HAL_Awss_Open_Monitor

原型

void HAL_Awss_Open_Monitor(_IN_ awss_recv_80211_frame_cb_t cb);

接口說明

設(shè)置Wi-Fi網(wǎng)卡工作在監(jiān)聽（Monitor）模式，并在收到802.11幀的時(shí)候調(diào)用被傳入的回調(diào)函數(shù)。

參數(shù)說明

/**
 * @brief   802.11幀的處理函數(shù)，可以將802.11 Frame傳遞給這個(gè)函數(shù)
 *
 * @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);

接口說明

設(shè)置Wi-Fi網(wǎng)卡離開監(jiān)聽（Monitor）模式，并開始以站點(diǎn)（Station）模式工作。

參數(shù)說明

void

返回值說明

void

HAL_Wifi_Scan

原型

int HAL_Wifi_Scan(awss_wifi_scan_result_cb_t cb);

接口說明

啟動(dòng)一次Wi-Fi的空中掃描，該API是一個(gè)阻塞操作，掃描沒有完成不能結(jié)束。所有的AP列表收集完成后，一個(gè)一個(gè)通過回調(diào)函數(shù)告知AWSS，最好不要限制AP的數(shù)量，否則可能導(dǎo)致中文GBK編碼的SSID熱點(diǎn)配網(wǎng)失敗。

參數(shù)說明

返回值說明

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]);

接口說明

設(shè)置Wi-Fi網(wǎng)卡切換到指定的信道（channel）上。

參數(shù)說明

返回值說明

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網(wǎng)卡連接指定熱點(diǎn)（Access Point）的函數(shù)，bssid指定特定AP，另外bssid也可能為空或無效值（全0或全0xff）。

參數(shù)說明

返回值說明

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);

接口說明

在當(dāng)前信道（channel）上以基本數(shù)據(jù)速率（1Mbps）發(fā)送裸的802.11幀（raw 802.11 frame）。

參數(shù)說明

/* 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中的數(shù)據(jù)幀
} 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);

接口說明

使能或禁用對特定管理幀的過濾。

參數(shù)說明

返回值說明

HAL_Sys_Net_Is_Ready

原型

int HAL_Sys_Net_Is_Ready();

接口說明

檢查系統(tǒng)網(wǎng)絡(luò)是否可用（設(shè)備是否已經(jīng)成功獲得IP地址并且當(dāng)前IP地址可用）。

參數(shù)說明

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]);

接口說明

獲取所連接的熱點(diǎn)（Access Point）的信息。

參數(shù)說明

返回值說明

HAL_Wifi_Get_Link_Stat

原型

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

接口說明

獲取當(dāng)前與AP連接鏈路狀態(tài)的信息（channel、RSSI等）。

參數(shù)說明

返回值說明

HAL_Awss_Open_Ap

原型

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

接口說明

開啟設(shè)備熱點(diǎn)（SoftAP模式）。

參數(shù)說明

返回值說明

HAL_Awss_Close_Ap

原型

int HAL_Awss_Close_Ap(void);

接口說明

關(guān)閉設(shè)備熱點(diǎn)。

參數(shù)說明

void

返回值說明