class PPP – create network connections over serial PPP¶

This class allows you to create a network connection over a serial port using the PPP protocol.

Note

Currently only the esp32 port has PPP support enabled in the default firmware build. PPP support can be enabled in custom builds of the stm32 and rp2 ports by enabling networking support and setting MICROPY_PY_NETWORK_PPP_LWIP to 1.

Example usage:

import network

ppp = network.PPP(uart)
ppp.connect()

while not ppp.isconnected():
    pass

print(ppp.ipconfig("addr4"))

# use the socket module as usual, etc

ppp.disconnect()

Constructors¶

class network.PPP(stream: Any) → None¶

Create a PPP driver object.

Arguments are:

stream is any object that supports the stream protocol, but is most commonly a machine.UART instance. This stream object must have an irq() method and an IRQ_RXIDLE constant, for use by PPP.connect.

connect(security: int = SEC_NONE, user: str | None = None, key: str | None = None) → None¶

Initiate a PPP connection with the given parameters:

security is the type of security, either PPP.SEC_NONE, PPP.SEC_PAP, or PPP.SEC_CHAP.

user is an optional user name to use with the security mode.

key is an optional password to use with the security mode.

When this method is called the underlying stream has its interrupt configured to call PPP.poll via stream.irq(ppp.poll, stream.IRQ_RXIDLE). This makes sure the stream is polled, and data passed up the PPP stack, wheverver data becomes available on the stream.

The connection proceeds asynchronously, in the background.

disconnect() → None¶: Terminate the connection. This must be called to cleanly close the PPP connection.

isconnected() → bool¶: Returns True if the PPP link is connected and up. Returns False otherwise.

status() → int¶: Returns the PPP status.

config(config_parameters: str | Any) → Any¶

Sets or gets parameters of the PPP interface. The only parameter that can be retrieved and set is the underlying stream, using:

stream = PPP.config("stream")
PPP.config(stream=stream)

ipconfig(param: str) → Any¶
ipconfig(**kwargs: Any) → None: See AbstractNIC.ipconfig.

ifconfig(config: Tuple[str, str, str, str] | None = None) → Tuple[str, str, str, str] | None¶: See AbstractNIC.ifconfig.

poll(irq_arg: Any | None = None) → None¶

Poll the underlying stream for data, and pass it up the PPP stack. This is called automatically if the stream is a UART with a RXIDLE interrupt, so it’s not usually necessary to call it manually.

The optional irq_arg argument is ignored, this argument exists only so this function is compatible with the machine.UART.irq() handler argument.

SEC_NONE: int¶
SEC_PAP: int¶
SEC_CHAP: int¶: The type of connection security.