class WLANWiPy – WiPy specific WiFi control — MicroPython latest documentation (original) (raw)

This is the documentation for the latest development branch of MicroPython and may refer to features that are not available in released versions.

If you are looking for the documentation for a specific release, use the drop-down menu on the left and select the desired version.

Note

This class is a non-standard WLAN implementation for the WiPy. It is available simply as network.WLAN on the WiPy but is named in the documentation below as network.WLANWiPy to distinguish it from the more general network.WLAN class.

This class provides a driver for the WiFi network processor in the WiPy. Example usage:

import network import time

setup as a station

wlan = network.WLAN(mode=WLAN.STA) wlan.connect('your-ssid', auth=(WLAN.WPA2, 'your-key')) while not wlan.isconnected(): time.sleep_ms(50) print(wlan.ipconfig("addr4"))

now use socket as usual

...

Constructors¶

class network.WLANWiPy(id=0, ...)¶

Create a WLAN object, and optionally configure it. See init() for params of configuration.

Note

The WLAN constructor is special in the sense that if no arguments besides the id are given, it will return the already existing WLAN instance without re-configuring it. This is because WLAN is a system feature of the WiPy. If the already existing instance is not initialized it will do the same as the other constructors an will initialize it with default values.

Methods¶

WLANWiPy.init(mode, *, ssid, auth, channel, antenna)¶

Set or get the WiFi network processor configuration.

Arguments are:

• mode can be either WLAN.STA or WLAN.AP.
• ssid is a string with the ssid name. Only needed when mode is WLAN.AP.
• auth is a tuple with (sec, key). Security can be None, WLAN.WEP,WLAN.WPA or WLAN.WPA2. The key is a string with the network password. If sec is WLAN.WEP the key must be a string representing hexadecimal values (e.g. ‘ABC1DE45BF’). Only needed when mode is WLAN.AP.
• channel a number in the range 1-11. Only needed when mode is WLAN.AP.
• antenna selects between the internal and the external antenna. Can be eitherWLAN.INT_ANT or WLAN.EXT_ANT.

For example, you can do:

create and configure as an access point

wlan.init(mode=WLAN.AP, ssid='wipy-wlan', auth=(WLAN.WPA2,'www.wipy.io'), channel=7, antenna=WLAN.INT_ANT)

or:

configure as an station

wlan.init(mode=WLAN.STA)

WLANWiPy.connect(ssid, *, auth=None, bssid=None, timeout=None)¶

Connect to a WiFi access point using the given SSID, and other security parameters.

• auth is a tuple with (sec, key). Security can be None, WLAN.WEP,WLAN.WPA or WLAN.WPA2. The key is a string with the network password. If sec is WLAN.WEP the key must be a string representing hexadecimal values (e.g. ‘ABC1DE45BF’).
• bssid is the MAC address of the AP to connect to. Useful when there are several APs with the same ssid.
• timeout is the maximum time in milliseconds to wait for the connection to succeed.

WLANWiPy.scan()¶

Performs a network scan and returns a list of named tuples with (ssid, bssid, sec, channel, rssi). Note that channel is always None since this info is not provided by the WiPy.

WLANWiPy.disconnect()¶

Disconnect from the WiFi access point.

WLANWiPy.isconnected()¶

In case of STA mode, returns True if connected to a WiFi access point and has a valid IP address. In AP mode returns True when a station is connected, False otherwise.

WLANWiPy.ipconfig('param')¶

WLANWiPy.ipconfig(param=value, ...)

See AbstractNIC.ipconfig. Supported parameters are: dhcp4, addr4, gw4.

WLANWiPy.mode([_mode_])¶

Get or set the WLAN mode.

WLANWiPy.ssid([_ssid_])¶

Get or set the SSID when in AP mode.

WLANWiPy.auth([_auth_])¶

Get or set the authentication type when in AP mode.

WLANWiPy.channel([_channel_])¶

Get or set the channel (only applicable in AP mode).

WLANWiPy.antenna([_antenna_])¶

Get or set the antenna type (external or internal).

WLANWiPy.mac([_mac_addr_])¶

Get or set a 6-byte long bytes object with the MAC address.

WLANWiPy.irq(*, handler, wake)¶

Create a callback to be triggered when a WLAN event occurs during machine.SLEEPmode. Events are triggered by socket activity or by WLAN connection/disconnection.

• handler is the function that gets called when the IRQ is triggered.
• wake must be machine.SLEEP.

Returns an IRQ object.

Constants¶

WLANWiPy.STA¶

WLANWiPy.AP¶

selects the WLAN mode

WLANWiPy.WEP¶

WLANWiPy.WPA¶

WLANWiPy.WPA2¶

selects the network security

WLANWiPy.INT_ANT¶

WLANWiPy.EXT_ANT¶

selects the antenna type