circuitpython/docs/library
Alessandro Gatti 4d034f817c esp8266/network_wlan: Allow enumerating connected stations in AP mode.
This commit introduces the ability to obtain a list of stations
connected to the device when in soft-AP mode.

A new parameter ("stations") to pass to WLAN.status is supported,
returning a tuple of (bssid, ipv4) entries, one per connected station.
An empty tuple is returned if no stations are connected, and an
exception is raised if an error occurred whilst building the python
objects to return to the interpreter.

Documentation is also updated to cover the new parameter.

This fixes #5395.

Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
2025-03-05 16:15:31 +11:00
..
_thread.rst docs/_thread: Add a placeholder docs for _thread module. 2017-11-10 00:09:43 +02:00
array.rst docs/reference: Add strings vs bytes to speed optimisation tips. 2025-02-11 16:17:00 +11:00
asyncio.rst docs/library/asyncio: Document that ThreadSafeFlag now works on unix. 2024-05-15 14:13:30 +10:00
binascii.rst docs/library/binascii: Add docs for binascii.crc32 method. 2024-12-03 22:22:55 +11:00
bluetooth.rst docs,ports: Fix some comments and error messages with doubled-up words. 2024-11-30 13:08:33 +11:00
btree.rst extmod/modbtree: Use buffer protocol for keys/values. 2022-06-21 00:44:49 +10:00
builtins.rst docs/reference: Add strings vs bytes to speed optimisation tips. 2025-02-11 16:17:00 +11:00
cmath.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
collections.rst docs/library/collections: Update deque docs to describe new features. 2024-03-19 10:09:11 +11:00
cryptolib.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
deflate.rst extmod/moddeflate: Change default window size. 2023-09-01 12:23:37 +10:00
errno.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
esp.rst docs/library/esp: Correct the description of esp.osdebug(). 2023-11-22 16:48:35 +11:00
esp32.rst docs/library: Move vfs functions and classes from os to vfs module docs. 2024-02-07 13:25:09 +11:00
espnow.rst docs/library/espnow: Clarify usage of the "rate" configuration key. 2025-02-11 16:23:35 +11:00
framebuf.rst docs: Fix double 'the' in documentation. 2025-02-25 17:07:16 +11:00
gc.rst docs/library/gc: Clarify mem_alloc and mem_free only for Python heap. 2023-09-15 12:19:13 +10:00
gzip.rst docs/library/deflate: Add docs for deflate.DeflateIO. 2023-07-21 19:32:42 +10:00
hashlib.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
heapq.rst docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
index.rst docs/library/marshal: Document the marshal module. 2025-02-11 16:59:11 +11:00
io.rst docs/library/io: Remove io.FileIO and io.TextIOWrapper. 2023-10-16 23:07:13 +11:00
json.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
lcd160cr.rst docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
machine.ADC.rst all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
machine.ADCBlock.rst all: Prune trailing whitespace. 2024-03-07 16:25:17 +11:00
machine.ADCWiPy.rst docs: Remove trailing spaces and convert tabs to spaces. 2021-12-15 11:49:22 +11:00
machine.I2C.rst all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
machine.I2S.rst docs: Rename uasyncio to asyncio. 2023-06-19 18:36:54 +10:00
machine.Pin.rst docs/library/machine.Pin: Show availability of low, high and toggle. 2025-02-28 16:51:54 +11:00
machine.PWM.rst all: Prune trailing whitespace. 2024-03-07 16:25:17 +11:00
machine.rst docs: Add a "Reset and Boot Sequence" reference page. 2024-11-19 10:57:26 +11:00
machine.RTC.rst ports: Fix machine.RTC.init() method so argument order matches the docs. 2024-12-19 16:04:47 +11:00
machine.SD.rst docs: Use vfs module instead of os. 2024-02-07 13:25:10 +11:00
machine.SDCard.rst docs: Use vfs module instead of os. 2024-02-07 13:25:10 +11:00
machine.Signal.rst docs/library/machine.Signal.rst: Correct typo: usecases to use cases. 2020-10-20 17:21:30 +11:00
machine.SPI.rst all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
machine.Timer.rst all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
machine.TimerWiPy.rst docs,ports: Fix some comments and error messages with doubled-up words. 2024-11-30 13:08:33 +11:00
machine.UART.rst docs: Fix double 'the' in documentation. 2025-02-25 17:07:16 +11:00
machine.USBDevice.rst doc: Note that machine.USBDevice is now available on esp32 port. 2024-12-20 14:02:17 +11:00
machine.WDT.rst docs/esp32: Update esp32 docs based on IDF v5 changes. 2023-06-23 15:34:49 +10:00
marshal.rst docs/library/marshal: Document the marshal module. 2025-02-11 16:59:11 +11:00
math.rst docs/library: Document math.log with two arguments. 2024-09-17 11:22:26 +10:00
micropython.rst py/objringio: Add micropython.RingIO() interface for general use. 2024-09-19 18:00:44 +10:00
neopixel.rst docs/library/neopixel: Mention bitstream timing tuple. 2024-08-01 12:04:58 +10:00
network.LAN.rst docs/esp32: Add documentation for SPI Ethernet devices on esp32 port. 2025-02-11 12:56:42 +11:00
network.PPP.rst docs: Note which ports have default or optional network.PPP support. 2025-02-11 16:11:33 +11:00
network.rst docs/library: Document the network.PPP class. 2024-08-29 23:47:55 +10:00
network.WIZNET5K.rst docs/esp32: Add documentation for SPI Ethernet devices on esp32 port. 2025-02-11 12:56:42 +11:00
network.WLAN.rst esp8266/network_wlan: Allow enumerating connected stations in AP mode. 2025-03-05 16:15:31 +11:00
network.WLANWiPy.rst docs: Update docs to replace ifconfig with ipconfig. 2024-07-05 16:06:04 +10:00
openamp.rst docs/library/openamp: Document the new openamp module. 2024-03-15 18:11:28 +11:00
os.rst docs/library: Move vfs functions and classes from os to vfs module docs. 2024-02-07 13:25:09 +11:00
platform.rst docs/library/platform: Add docs for the platform library. 2023-09-04 22:40:56 +10:00
pyb.Accel.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.ADC.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.CAN.rst stm32/pyb_can: Make pyb.CAN baud calculation a little more forgiving. 2025-01-17 12:13:17 +11:00
pyb.DAC.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.ExtInt.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.Flash.rst docs/library: Move vfs functions and classes from os to vfs module docs. 2024-02-07 13:25:09 +11:00
pyb.I2C.rst all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
pyb.LCD.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.LED.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.Pin.rst docs/library/pyb.Pin: Add Pin.ALT constant. 2022-07-29 12:16:32 +10:00
pyb.rst docs: Add a "Reset and Boot Sequence" reference page. 2024-11-19 10:57:26 +11:00
pyb.RTC.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.Servo.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.SPI.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.Switch.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.Timer.rst docs,ports: Fix some comments and error messages with doubled-up words. 2024-11-30 13:08:33 +11:00
pyb.UART.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.USB_HID.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
pyb.USB_VCP.rst docs/library: Remove unnecessary "pyb." prefix on class names. 2022-06-21 14:33:23 +10:00
random.rst all: Rename UMODULE to MODULE in preprocessor/Makefile vars. 2023-06-08 17:54:11 +10:00
re.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
rp2.DMA.rst docs/library/rp2.DMA: Add documentation for rp2 DMA support. 2024-03-19 17:10:54 +11:00
rp2.Flash.rst docs/library: Move vfs functions and classes from os to vfs module docs. 2024-02-07 13:25:09 +11:00
rp2.PIO.rst rp2/rp2_pio: Add support for RP2350A/B variants in PIO interface. 2024-10-15 12:09:48 +11:00
rp2.rst rp2/rp2_pio: Add side_pindir support for PIO. 2025-02-08 12:34:26 +11:00
rp2.StateMachine.rst docs/library/rp2.DMA: Add documentation for rp2 DMA support. 2024-03-19 17:10:54 +11:00
select.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
socket.rst docs/library/socket: Use correct sockaddr variable name. 2023-01-13 17:40:01 +11:00
ssl.rst extmod/modtls_mbedtls: Wire in support for DTLS. 2025-02-14 12:55:25 +11:00
stm.rst stm32/subghz: Add STM32WL55 subghz radio interface to stm module. 2023-08-23 11:58:11 +10:00
struct.rst py/binary: Support half-float 'e' format in struct pack/unpack. 2024-03-20 14:13:49 +11:00
sys.rst py/modsys: Add sys.implementation._build entry. 2025-03-05 12:23:40 +11:00
time.rst all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
uctypes.rst docs: Replace ufoo with foo in all docs. 2021-08-13 22:53:29 +10:00
vfs.rst docs/library: Move vfs functions and classes from os to vfs module docs. 2024-02-07 13:25:09 +11:00
wipy.rst docs: Add usocket and ussl modules' documentation. 2015-10-21 15:30:56 +02:00
wm8960.rst all: Fix various spelling mistakes found by codespell 2.2.6. 2023-10-03 11:24:50 +11:00
zephyr.DiskAccess.rst docs/library: Move vfs functions and classes from os to vfs module docs. 2024-02-07 13:25:09 +11:00
zephyr.FlashArea.rst docs/library: Move vfs functions and classes from os to vfs module docs. 2024-02-07 13:25:09 +11:00
zephyr.rst all: Fix spelling mistakes based on codespell check. 2023-04-27 18:03:06 +10:00
zephyr.zsensor.rst docs/library/zephyr: Add libraries specific to the Zephyr port. 2021-08-13 20:21:14 +10:00
zlib.rst docs/library/deflate: Add docs for deflate.DeflateIO. 2023-07-21 19:32:42 +10:00