Skip to content

Commit 6d8156a

Browse files
committed
docs/network: esp8266: Describe wlan.config() method.
1 parent 06deec9 commit 6d8156a

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/library/network.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,37 @@ For example::
344344

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

347+
.. method:: wlan.config('param')
348+
.. method:: wlan.config(param=value, ...)
349+
350+
Get or set general network interface parameters. These methods allow to work
351+
with additional parameters beyond standard IP configuration (as dealt with by
352+
``wlan.ifconfig()``). These include network-specific and hardware-specific
353+
parameters. For setting parameters, keyword argument syntax should be used,
354+
multiple parameters can be set at once. For querying, paremeters name should
355+
be quoted as a string, and only one paramter can be queries at time::
356+
357+
# Set WiFi access point name (formally known as ESSID) and WiFi channel
358+
ap.config(essid='My AP', channel=11)
359+
# Queey params one by one
360+
print(ap.config('essid'))
361+
print(ap.config('channel'))
362+
363+
Following are commonly supported parameters (availability of a specific parameter
364+
depends on network technology type, driver, and MicroPython port).
365+
366+
========= ===========
367+
Parameter Description
368+
========= ===========
369+
essid WiFi access point name (string)
370+
channel WiFi channel (integer)
371+
hidden Whether ESSID is hidden (boolean)
372+
authmode Authentication mode supported (enumeration, see module constants)
373+
password Access password (string)
374+
========= ===========
375+
376+
377+
347378
.. only:: port_wipy
348379

349380
class WLAN

0 commit comments

Comments
 (0)