WLAN STA – control built-in WiFi interfaces

This class provides a driver for WiFi STA network processors.

Micropython Example:

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from image_plus import ImagePlus


title0 = None
image_plus0 = None


def setup():
    global title0, image_plus0

    M5.begin()
    Widgets.fillScreen(0x222222)
    title0 = Widgets.Title("Image+ CoreS3 Example", 3, 0xFFFFFF, 0x0000FF, Widgets.FONTS.DejaVu18)
    image_plus0 = ImagePlus(
        "https://static-cdn.m5stack.com/resource/public/assets/aboutus/m5logo2022.png",
        43,
        51,
        True,
        3000,
        default_img="res/img/default.png",
    )

    image_plus0.setVisible(True)
    image_plus0.set_update_period(5000)
    image_plus0.set_update_enable(True)


def loop():
    global title0, image_plus0
    M5.update()


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

UIFLOW2 Example:

wlan_sta_cores3_example.m5f2

Constructors

class network.WLAN(interface_id)

Create a WLAN network interface object. Supported interfaces are network.STA_IF (station aka client, connects to upstream WiFi access points)

UIFLOW2:

Methods

WLAN.status([param])

Return the current status of the wireless connection.

When called with no argument the return value describes the network link status. The possible statuses are defined as constants:

STAT_IDLE – no connection and no activity,

STAT_CONNECTING – connecting in progress,

STAT_WRONG_PASSWORD – failed due to incorrect password,

STAT_NO_AP_FOUND – failed because no access point replied,

STAT_CONNECT_FAIL – failed due to other problems,

STAT_GOT_IP – connection successful.

When called with one argument param should be a string naming the status parameter to retrieve.

Supported parameters in WiFI STA mode are: 'rssi'.

UIFLOW2:

WLAN.isconnected(): In case of STA mode, returns True if connected to a WiFi access point and has a valid IP address.

UIFLOW2:

WLAN.active([is_active]): Activate (“up”) or deactivate (“down”) network interface, if boolean argument is passed. Otherwise, query current state if no argument is provided. Most other methods require active interface.

WLAN.connect(ssid=None, key=None, *, bssid=None): Connect to the specified wireless network, using the specified key. If bssid is given then the connection will be restricted to the access-point with that MAC address (the ssid must also be specified in this case).

WLAN.disconnect(): Disconnect from the currently connected wireless network.

WLAN.ifconfig([(ip, subnet, gateway, dns)]): Get/set IP-level network interface parameters: IP address, subnet mask, gateway and DNS server. When called with no arguments, this method returns a 4-tuple with the above information. To set the above values, pass a 4-tuple with the required information. å

WLAN.config('param')

WLAN.config(param=value, ...)

Get or set general network interface parameters. These methods allow to work with additional parameters beyond standard IP configuration (as dealt with by AbstractNIC.ipconfig()). These include network-specific and hardware-specific parameters. For setting parameters, keyword argument syntax should be used, multiple parameters can be set at once. For querying, parameters name should be quoted as a string, and only one parameter can be queried at a time:

Following are commonly supported parameters (availability of a specific parameter depends on network technology type, driver, and MicroPython port).

Parameter	Description
mac	MAC address (bytes)
ssid	WiFi access point name (string)
channel	WiFi channel (integer)
hidden	Whether SSID is hidden (boolean)
security	Security protocol supported (enumeration, see module constants)
key	Access key (string)
hostname	The hostname that will be sent to DHCP (STA interfaces) and mDNS (if supported, both STA and AP). (Deprecated, use `network.hostname()` instead)
reconnects	Number of reconnect attempts to make (integer, 0=none, -1=unlimited)
txpower	Maximum transmit power in dBm (integer or float)
pm	WiFi Power Management setting (see below for allowed values)