`network` — network configuration¶

This module provides network drivers and routing configuration. To use this module, a MicroPython variant/build with network capabilities must be installed. Network drivers for specific hardware are available within this module and are used to configure hardware network interface(s). Network services provided by configured interfaces are then available for use via the usocket module.

For example:

# connect/ show IP config a specific network interface
# see below for examples of specific drivers
import network
import utime
nic = network.Driver(...)
if not nic.isconnected():
    nic.connect()
    print("Waiting for connection...")
    while not nic.isconnected():
        utime.sleep(1)
print(nic.ifconfig())

# now use usocket as usual
import usocket as socket
addr = socket.getaddrinfo('micropython.org', 80)[0][-1]
s = socket.socket()
s.connect(addr)
s.send(b'GET / HTTP/1.1\r\nHost: micropython.org\r\n\r\n')
data = s.recv(1000)
s.close()

Common network adapter interface¶

This section describes an (implied) abstract base class for all network interface classes implemented by MicroPython ports for different hardware. This means that MicroPython does not actually provide AbstractNIC class, but any actual NIC class, as described in the following sections, implements methods as described here.

class network.AbstractNIC(id=None, ...)¶

Instantiate a network interface object. Parameters are network interface dependent. If there are more than one interface of the same type, the first parameter should be id.

network.active([is_active])¶

Activate (“up”) or deactivate (“down”) the network interface, if a boolean argument is passed. Otherwise, query current state if no argument is provided. Most other methods require an active interface (behavior of calling them on inactive interface is undefined).

network.connect([service_id, key=None, *, ...])¶

Connect the interface to a network. This method is optional, and available only for interfaces which are not “always connected”. If no parameters are given, connect to the default (or the only) service. If a single parameter is given, it is the primary identifier of a service to connect to. It may be accompanied by a key (password) required to access said service. There can be further arbitrary keyword-only parameters, depending on the networking medium type and/or particular device. Parameters can be used to: a) specify alternative service identifer types; b) provide additional connection parameters. For various medium types, there are different sets of predefined/recommended parameters, among them:

WiFi: bssid keyword to connect to a specific BSSID (MAC address)

network.disconnect()¶

Disconnect from network.

network.isconnected()¶

Returns True if connected to network, otherwise returns False.

network.scan(*, ...)¶

Scan for the available network services/connections. Returns a list of tuples with discovered service parameters. For various network media, there are different variants of predefined/ recommended tuple formats, among them:

WiFi: (ssid, bssid, channel, RSSI, authmode, hidden). There may be further fields, specific to a particular device.

The function may accept additional keyword arguments to filter scan results (e.g. scan for a particular service, on a particular channel, for services of a particular set, etc.), and to affect scan duration and other parameters. Where possible, parameter names should match those in connect().

network.status([param])¶

Query dynamic status information of the interface. When called with no argument the return value describes the network link status. Otherwise param should be a string naming the particular status parameter to retrieve.

The return types and values are dependent on the network medium/technology. Some of the parameters that may be supported are:

WiFi STA: use 'rssi' to retrieve the RSSI of the AP signal

WiFi AP: use 'stations' to retrieve a list of all the STAs connected to the AP. The list contains tuples of the form (MAC, RSSI).
network.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. For example:
nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))
network.config('param')¶

network.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 ifconfig()). These include network-specific and hardware-specific parameters. For setting parameters, the keyword argument syntax should be used, and multiple parameters can be set at once. For querying, a parameter name should be quoted as a string, and only one parameter can be queried at a time:
# Set WiFi access point name (formally known as ESSID) and WiFi channel
ap.config(essid='My AP', channel=11)
# Query params one by one
print(ap.config('essid'))
print(ap.config('channel'))

class CC3K¶

This class provides a driver for CC3000 WiFi modules. Example usage:

import network
nic = network.CC3K(pyb.SPI(2), pyb.Pin.board.Y5, pyb.Pin.board.Y4, pyb.Pin.board.Y3)
nic.connect('your-ssid', 'your-password')
while not nic.isconnected():
    pyb.delay(50)
print(nic.ifconfig())

# now use socket as usual
...

For this example to work the CC3000 module must have the following connections:

MOSI connected to Y8

MISO connected to Y7

CLK connected to Y6

CS connected to Y5

VBEN connected to Y4

IRQ connected to Y3

It is possible to use other SPI busses and other pins for CS, VBEN and IRQ.

Constructors¶

class network.CC3K(spi, pin_cs, pin_en, pin_irq)¶

Create a CC3K driver object, initialise the CC3000 module using the given SPI bus and pins, and return the CC3K object.

Arguments are:

spi is an SPI object which is the SPI bus that the CC3000 is connected to (the MOSI, MISO and CLK pins).

pin_cs is a Pin object which is connected to the CC3000 CS pin.

pin_en is a Pin object which is connected to the CC3000 VBEN pin.

pin_irq is a Pin object which is connected to the CC3000 IRQ pin.

All of these objects will be initialised by the driver, so there is no need to initialise them yourself. For example, you can use:

nic = network.CC3K(pyb.SPI(2), pyb.Pin.board.Y5, pyb.Pin.board.Y4, pyb.Pin.board.Y3)

Methods¶

cc3k.connect(ssid, key=None, *, security=WPA2, bssid=None)¶: Connect to a WiFi access point using the given SSID, and other security parameters.

cc3k.disconnect()¶: Disconnect from the WiFi access point.

cc3k.isconnected()¶: Returns True if connected to a WiFi access point and has a valid IP address, False otherwise.

cc3k.ifconfig()¶: Returns a 7-tuple with (ip, subnet mask, gateway, DNS server, DHCP server, MAC address, SSID).

cc3k.patch_version()¶: Return the version of the patch program (firmware) on the CC3000.

cc3k.patch_program('pgm')¶: Upload the current firmware to the CC3000. You must pass ‘pgm’ as the first argument in order for the upload to proceed.

Constants¶

CC3K.WEP¶

CC3K.WPA¶

CC3K.WPA2¶: security type to use

class WIZNET5K¶

This class allows you to control WIZnet5x00 Ethernet adaptors based on the W5200 and W5500 chipsets. The particular chipset that is supported by the firmware is selected at compile-time via the MICROPY_PY_WIZNET5K option.

Example usage:

import network
nic = network.WIZNET5K(pyb.SPI(1), pyb.Pin.board.X5, pyb.Pin.board.X4)
print(nic.ifconfig())

# now use socket as usual
...

For this example to work the WIZnet5x00 module must have the following connections:

MOSI connected to X8

MISO connected to X7

SCLK connected to X6

nSS connected to X5

nRESET connected to X4

It is possible to use other SPI busses and other pins for nSS and nRESET.

Constructors¶

class network.WIZNET5K(spi, pin_cs, pin_rst)¶

Create a WIZNET5K driver object, initialise the WIZnet5x00 module using the given SPI bus and pins, and return the WIZNET5K object.

Arguments are:

spi is an SPI object which is the SPI bus that the WIZnet5x00 is connected to (the MOSI, MISO and SCLK pins).

pin_cs is a Pin object which is connected to the WIZnet5x00 nSS pin.

pin_rst is a Pin object which is connected to the WIZnet5x00 nRESET pin.

All of these objects will be initialised by the driver, so there is no need to initialise them yourself. For example, you can use:

nic = network.WIZNET5K(pyb.SPI(1), pyb.Pin.board.X5, pyb.Pin.board.X4)

Methods¶

wiznet5k.isconnected()¶: Returns True if the physical Ethernet link is connected and up. Returns False otherwise.

wiznet5k.ifconfig([(ip, subnet, gateway, dns)])¶

Get/set IP address, subnet mask, gateway and DNS.

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. For example:

nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))

wiznet5k.regs()¶: Dump the WIZnet5x00 registers. Useful for debugging.

network — network configuration¶

Common network adapter interface¶

class CC3K¶

Constructors¶

Methods¶

Constants¶

class WIZNET5K¶

Constructors¶

Methods¶

`network` — network configuration¶