maix.network.wifi module

You can use maix.network.wifi to access this module with MaixPy
This module is generated from MaixCDK

Module

No module

Enum

Variable

Function

list_devices

def list_devices() -> list[str]

item	doc
brief	List WiFi interfaces
return	WiFi interface list, string type

C++ defination code:

std::vector<std::string> list_devices()

Class

AP_Info

item	doc
brief	WiFi AP info

C++ defination code:

class AP_Info

ssid

item	doc
type	var
brief	WiFi AP info SSID
static	False
readonly	False

C++ defination code:

std::vector<uint8_t> ssid

bssid

item	doc
type	var
brief	WiFi AP info BSSID
static	False
readonly	False

C++ defination code:

std::string bssid

security

item	doc
type	var
brief	WiFi AP info security
static	False
readonly	False

C++ defination code:

std::string security

channel

item	doc
type	var
brief	WiFi AP info channel
static	False
readonly	False

C++ defination code:

int channel

frequency

item	doc
type	var
brief	WiFi AP info frequency
static	False
readonly	False

C++ defination code:

int frequency

rssi

item	doc
type	var
brief	WiFi AP info rssi
static	False
readonly	False

C++ defination code:

int rssi

ssid_str

def ssid_str(self) -> str

item	doc
type	func
brief	WiFi AP info ssid_str
static	False

C++ defination code:

std::string ssid_str()

Wifi

item	doc
brief	Wifi class

C++ defination code:

class Wifi

__init__

item	doc
type	func
brief	Wifi class
param	iface: wifi interface name, default is wlan0
static	False

C++ defination code:

Wifi(std::string iface = "wlan0")

get_ip

item	doc
type	func
brief	Get current WiFi ip
return	ip, string type, if network not connected, will return empty string.
static	False

C++ defination code:

std::string get_ip()

get_mac

item	doc
type	func
brief	Get current WiFi MAC address
return	ip, string type.
static	False

C++ defination code:

std::string get_mac()

get_gateway

item	doc
type	func
brief	Get current WiFi ip
return	ip, string type, if network not connected, will return empty string.
static	False

C++ defination code:

std::string get_gateway()

start_scan

item	doc
type	func
brief	WiFi start scan AP info around in background.
return	If success, return err.Err.ERR_NONE, else means failed.
static	False

C++ defination code:

err::Err start_scan()

get_scan_result

item	doc
type	func
brief	Get WiFi scan AP info.
return	wifi.AP_Info list.
static	False

C++ defination code:

std::vector<network::wifi::AP_Info> get_scan_result()

stop_scan

item	doc
type	func
brief	Stop WiFi scan AP info.
static	False

C++ defination code:

void stop_scan()

connect

item	doc
type	func
brief	Connect to WiFi AP.
param	ssid: SSID of AP password: password of AP, if no password, leave it empty. wait: wait for got IP or failed or timeout. timeout: connect timeout internal, unit second.
return	If success, return err.Err.ERR_NONE, else means failed.
static	False

C++ defination code:

err::Err connect(const std::string &ssid, const std::string &password, bool wait = true, int timeout = 60)

disconnect

item	doc
type	func
brief	Disconnect from WiFi AP.
return	If success, return err.Err.ERR_NONE, else means failed.
static	False

C++ defination code:

err::Err disconnect()

is_connected

item	doc
type	func
brief	See if WiFi is connected to AP.
return	If connected return true, else false.
static	False

C++ defination code:

bool is_connected()

network

nn