Skip to content

network.LAN.rst

Latest commit

 

History

History
98 lines (62 loc) · 3.13 KB

network.LAN.rst

File metadata and controls

98 lines (62 loc) · 3.13 KB
.. currentmodule:: network

class LAN -- control an Ethernet module

This class allows you to control the Ethernet interface. The PHY hardware type is board-specific.

Example usage, for a board with built-in LAN support:

import network
nic = network.LAN(0)
print(nic.ipconfig("addr4"))

# now use socket as usual
...

Constructors

Methods

.. method:: LAN.active([state])

   With a parameter, it sets the interface active if *state* is true, otherwise it
   sets it inactive.
   Without a parameter, it returns the state.


.. method:: LAN.isconnected()

   Returns ``True`` if the physical Ethernet link is connected and up.
   Returns ``False`` otherwise.


.. method:: LAN.status()

   Returns the LAN status.


.. method:: LAN.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'))


.. method:: LAN.config(config_parameters)

   Sets or gets parameters of the LAN interface. The only parameter that can be
   retrieved is the MAC address, using::

      mac = LAN.config("mac")

   The parameters that can be set are:

    - ``trace=n`` sets trace levels; suitable values are:

        - 2: trace TX
        - 4: trace RX
        - 8: full trace

    - ``low_power=bool`` sets or clears low power mode, valid values being ``False``
      or ``True``.

Specific LAN class implementations

On the mimxrt port, suitable values for the phy_type constructor argument are: PHY_KSZ8081, PHY_DP83825, PHY_DP83848, PHY_LAN8720, PHY_RTL8211F.