diff options
| author | Angus Gratton <angus@redyak.com.au> | 2025-01-28 11:54:57 +1100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2025-02-11 16:11:33 +1100 |
| commit | bab099826e956bcc000b8a3c45b144c97d870fe2 (patch) | |
| tree | 21f40b98a957022d153477b5183affc921655481 /docs/library | |
| parent | 12dd9cb74598bb0144cb7ac7dcbc5f5631372afa (diff) | |
docs: Note which ports have default or optional network.PPP support.
Also add the default values of these macros to the respective
`mpconfigport.h` files, to improve discoverability.
Signed-off-by: Angus Gratton <angus@redyak.com.au>
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/network.PPP.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/library/network.PPP.rst b/docs/library/network.PPP.rst index 17a8d1c1c..15ab1da19 100644 --- a/docs/library/network.PPP.rst +++ b/docs/library/network.PPP.rst @@ -5,7 +5,12 @@ 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. It is only available on selected ports and boards. +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:: |