summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--docs/library/network.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst
index 6375410d10..1c8d73b5f5 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -344,6 +344,37 @@ For example::
nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))
+ .. method:: wlan.config('param')
+ .. method:: wlan.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
+ ``wlan.ifconfig()``). These include network-specific and hardware-specific
+ parameters. For setting parameters, keyword argument syntax should be used,
+ multiple parameters can be set at once. For querying, paremeters name should
+ be quoted as a string, and only one paramter can be queries at time::
+
+ # Set WiFi access point name (formally known as ESSID) and WiFi channel
+ ap.config(essid='My AP', channel=11)
+ # Queey params one by one
+ print(ap.config('essid'))
+ print(ap.config('channel'))
+
+ Following are commonly supported parameters (availability of a specific parameter
+ depends on network technology type, driver, and MicroPython port).
+
+ ========= ===========
+ Parameter Description
+ ========= ===========
+ essid WiFi access point name (string)
+ channel WiFi channel (integer)
+ hidden Whether ESSID is hidden (boolean)
+ authmode Authentication mode supported (enumeration, see module constants)
+ password Access password (string)
+ ========= ===========
+
+
+
.. only:: port_wipy
class WLAN