wifi

The wifi module provides necessary low-level functionality for managing wifi connections. Use socketpool for communicating over the network.

Available on these boards
  • AITHinker ESP32-C3S_Kit
  • AITHinker ESP32-C3S_Kit_2M
  • ATMegaZero ESP32-S2
  • Adafruit Camera
  • Adafruit Feather ESP32-S2 TFT
  • Adafruit Feather ESP32-S3 TFT
  • Adafruit Feather ESP32S2
  • Adafruit Feather ESP32S3 No PSRAM
  • Adafruit FunHouse
  • Adafruit MagTag
  • Adafruit Metro ESP32S2
  • Adafruit QT Py ESP32-S3 no psram
  • Adafruit QT Py ESP32C3
  • Adafruit QT Py ESP32S2
  • Artisense Reference Design RD00
  • BastWiFi
  • CrumpS2
  • Cytron Maker Feather AIoT S3
  • ESP 12k NodeMCU
  • ESP32-C3-DevKitM-1
  • ESP32-S2-DevKitC-1-N4
  • ESP32-S2-DevKitC-1-N4R2
  • ESP32-S3-Box-2.5
  • ESP32-S3-DevKitC-1-N8
  • ESP32-S3-DevKitC-1-N8R2
  • ESP32-S3-DevKitC-1-N8R8
  • ESP32-S3-DevKitM-1-N8
  • ESP32-S3-USB-OTG-N8
  • Feather ESP32S2 without PSRAM
  • FeatherS2
  • FeatherS2 Neo
  • FeatherS2 PreRelease
  • FeatherS3
  • Franzininho WIFI w/Wroom
  • Franzininho WIFI w/Wrover
  • Gravitech Cucumber M
  • Gravitech Cucumber MS
  • Gravitech Cucumber R
  • Gravitech Cucumber RS
  • HMI-DevKit-1.1
  • HexKyS2
  • IoTs2
  • Kaluga 1
  • LILYGO TTGO T-01C3
  • LILYGO TTGO T-OI PLUS
  • LILYGO TTGO T8 ESP32-S2
  • LILYGO TTGO T8 ESP32-S2 w/Display
  • MORPHEANS MorphESP-240
  • MicroDev microC3
  • MicroDev microS2
  • MixGo CE
  • Oak Dev Tech PixelWing ESP32S2
  • ProS3
  • S2Mini
  • S2Pico
  • Saola 1 w/Wroom
  • Saola 1 w/Wrover
  • TTGO T8 ESP32-S2-WROOM
  • Targett Module Clip w/Wroom
  • Targett Module Clip w/Wrover
  • TinyS2
  • TinyS3
  • nanoESP32-S2 w/Wrover
  • nanoESP32-S2 w/Wroom

wifi.radio :Radio

Wifi radio used to manage both station and AP modes. This object is the sole instance of wifi.Radio.

class wifi.AuthMode

The authentication protocols used by WiFi.

OPEN :object

Open network. No authentication required.

WEP :object

Wired Equivalent Privacy.

WPA :object

Wireless Protected Access.

WPA2 :object

Wireless Protected Access 2.

WPA3 :object

Wireless Protected Access 3.

PSK :object

Pre-shared Key. (password)

ENTERPRISE :object

Each user has a unique credential.

class wifi.Monitor

For monitoring WiFi packets.

wifi.__init__(self, channel: Optional[int] = 1, queue: Optional[int] = 128) None

Initialize wifi.Monitor singleton.

Parameters
  • channel (int) – The WiFi channel to scan.

  • queue (int) – The queue size for buffering the packet.

wifi.channel :int

The WiFi channel to scan.

wifi.queue :int

The queue size for buffering the packet.

wifi.deinit(self) None

De-initialize wifi.Monitor singleton.

wifi.lost(self) int

Returns the packet loss count. The counter resets after each poll.

wifi.queued(self) int

Returns the packet queued count.

wifi.packet(self) dict

Returns the monitor packet.

class wifi.Network

A wifi network provided by a nearby access point.

You cannot create an instance of wifi.Network. They are returned by wifi.Radio.start_scanning_networks.

ssid :str

String id of the network

bssid :bytes

BSSID of the network (usually the AP’s MAC address)

rssi :int

Signal strength of the network

channel :int

Channel number the network is operating on

country :str

String id of the country code

authmode :str

String id of the authmode

class wifi.Packet

The packet parameters.

CH :object

The packet’s channel.

LEN :object

The packet’s length.

RAW :object

The packet’s payload.

RSSI :object

The packet’s rssi.

class wifi.Radio

Native wifi radio.

This class manages the station and access point functionality of the native Wifi radio.

You cannot create an instance of wifi.Radio. Use wifi.radio to access the sole instance available.

enabled :bool

True when the wifi radio is enabled. If you set the value to False, any open sockets will be closed.

hostname :Union[str | ReadableBuffer]

Hostname for wifi interface. When the hostname is altered after interface started/connected the changes would only be reflected once the interface restarts/reconnects.

mac_address :circuitpython_typing.ReadableBuffer

MAC address for the station. When the address is altered after interface is connected the changes would only be reflected once the interface reconnects.

mac_address_ap :circuitpython_typing.ReadableBuffer

MAC address for the AP. When the address is altered after interface is started the changes would only be reflected once the interface restarts.

ipv4_gateway :Optional[ipaddress.IPv4Address]

IP v4 Address of the station gateway when connected to an access point. None otherwise.

ipv4_gateway_ap :Optional[ipaddress.IPv4Address]

IP v4 Address of the access point gateway, when enabled. None otherwise.

ipv4_subnet :Optional[ipaddress.IPv4Address]

IP v4 Address of the station subnet when connected to an access point. None otherwise.

ipv4_subnet_ap :Optional[ipaddress.IPv4Address]

IP v4 Address of the access point subnet, when enabled. None otherwise.

ipv4_address :Optional[ipaddress.IPv4Address]

IP v4 Address of the station when connected to an access point. None otherwise.

ipv4_address_ap :Optional[ipaddress.IPv4Address]

IP v4 Address of the access point, when enabled. None otherwise.

ipv4_dns :Optional[ipaddress.IPv4Address]

IP v4 Address of the DNS server in use when connected to an access point. None otherwise.

ap_info :Optional[Network]

Network object containing BSSID, SSID, authmode, channel, country and RSSI when connected to an access point. None otherwise.

start_scanning_networks(self, *, start_channel: int = 1, stop_channel: int = 11) Iterable[Network]

Scans for available wifi networks over the given channel range. Make sure the channels are allowed in your country.

stop_scanning_networks(self) None

Stop scanning for Wifi networks and free any resources used to do it.

start_station(self) None

Starts a Station.

stop_station(self) None

Stops the Station.

start_ap(self, ssid: Union[str | ReadableBuffer], password: Union[str | ReadableBuffer] = '', *, channel: Optional[int] = 1, authmode: Optional[AuthMode], max_connections: Optional[int] = 4) None

Starts an Access Point with the specified ssid and password.

If channel is given, the access point will use that channel unless a station is already operating on a different channel.

If authmode is given, the access point will use that Authentication mode. If a password is given, authmode must not be OPEN. If authmode isn’t given, OPEN will be used when password isn’t provided, otherwise WPA_WPA2_PSK.

If max_connections is given, the access point will allow up to that number of stations to connect.

stop_ap(self) None

Stops the Access Point.

connect(self, ssid: Union[str | ReadableBuffer], password: Union[str | ReadableBuffer] = '', *, channel: Optional[int] = 0, bssid: Optional[Union[str | ReadableBuffer]] = '', timeout: Optional[float] = None) None

Connects to the given ssid and waits for an ip address. Reconnections are handled automatically once one connection succeeds.

By default, this will scan all channels and connect to the access point (AP) with the given ssid and greatest signal strength (rssi).

If channel is given, the scan will begin with the given channel and connect to the first AP with the given ssid. This can speed up the connection time significantly because a full scan doesn’t occur.

If bssid is given, the scan will start at the first channel or the one given and connect to the AP with the given bssid and ssid.

ping(self, ip: ipaddress.IPv4Address, *, timeout: Optional[float] = 0.5) Optional[float]

Ping an IP to test connectivity. Returns echo time in seconds. Returns None when it times out.

class wifi.ScannedNetworks

Iterates over all wifi.Network objects found while scanning. This object is always created by a wifi.Radio: it has no user-visible constructor.

Cannot be instantiated directly. Use wifi.Radio.start_scanning_networks.

__iter__(self) Iterator[Network]

Returns itself since it is the iterator.

__next__(self) Network

Returns the next wifi.Network. Raises StopIteration if scanning is finished and no other results are available.