New methods to get list of associated stations in access point mode and get maximum number of stations that can be associated #8820
Conversation
|
Thanks for working on this! You could use a list of namedtuples instead of a dict, or even create a new native class with appropriate attributes. If a value isn't available, like Using the internal data structures is probably not bad if that's the only way. It may just stop working later. A PR to the appropriate upstream repo to add an API for that info might make sense. You could see if there's already an open issue or PR for that. |
|
I'd thought about using a class like the Monitor class but it felt heavy for such a simple call. I'm happy to rewrite it to do that if you'd prefer, though. I'll change the code to return If I'm understanding correctly, namedtuples would be immutable, unlike the dict? Maybe that would be preferable. I'll take a closer look at the Pi Pico SDK re: the DHCP server. I'm much more familiar with Espressif's. I'm not at all understanding what's going on with the pre-commit fail during CI. Thanks @dhalbert! |
maximum number of stations that can be associated in AP mode Added GETTER method stations_ap to wifi Radio objects, returning a list of dicts with the MAC address, RSSI and IPV4 address of each associated station. IPV4 addresses may be None if the DHCP server hasn't yet assigned an address or if the station hasn't requested one (for instance if it has a self-assigned or static IP address, or isn't running TCP/IP). Supports Espressif CPUS and the Raspberry Pi Pico W The Pico W doesn't report RSSI values
44daca7 to
d0215aa
Compare
|
Figured out the CI issue :) |
|
@dhalbert how does this sound? wifi.Radio.stations_ap returns a list of associated wifi.Station objects or throws an exception if not in AP mode (read-only) wifi.Station can't be created by users, has these properties:
|
This sounds good to me. You can make wifi.Station a named tuple. Here is an example from bitmapfilter: https://github.com/adafruit/circuitpython/blob/main/shared-bindings/bitmapfilter/__init__.c#L170-L196 |
|
If you make it a namedtuple then you don't have to create a class. I would say don't bother to raise an exception if you aren't in AP mode. There are other operations that just return None, etc. if you are in the wrong mode. In this case, just return an empty list. |
|
Even easier! I'll make it a named tuple (thanks for the example :)) and not raise the exception. Thanks! |
…in AP mode return value is now a list of named tuples with three elements IP address is now None instead of 0.0.0.0 if there's no lease information
…python into 8790-ap-connected-devices
|
Sorry for taking so long with this, been busy with other stuff.
This is solid with Espressif but I see erratic results from the Pi Pico's cyw43 SDK. You can see them in the screen cap - it sometimes reports 1 station connected despite 2 or 3 (confirmed they really were connected by pinging them). Eventually it reported all 3. I'm going to investigate more and will file an issue on it if I can confirm this behavior. I saw a bit of this before but it seems more pronounced with the newer version of the SDK. I understand what this line of code does but I'm not 100% confident it's needed or appropriate for the named tuple's type. Raspberry Pi Pico W
I expected that each time I printed ESP32
This test also shows a station which had not yet been assigned a DHCP lease and is reporting ESP32-S2
ESP32-S3
ESP32-C3
ESP32-C6
|
… no one asked for it
Co-authored-by: Dan Halbert <halbert@halwitz.org>
… will return an error if we're not in AP mode, which is sufficient
|
Made one other small change and removed a superfluous check if we're in AP mode. The ESP-IDF functions will return an error if we're not, which will lead to the correct behavior. Tested to confirm. |
Addressing issue 8790. I did this for fun and to learn more about CP internals, hope I'm not stepping on anyone's toes and am fine ignoring this if you'd prefer.
Added a new property
max_stations_apto theRadioobject, which returns the maximum number of stations the device supports in AP modeAdded a new property
stations_apto theRadioobject, which returns a list of dicts that report the MAC address, RSSI and IPv4 address for each associated station. IPv4 may be reported as 0.0.0.0 if no address has been assigned yet (the device may be associated but not have issued a DHCP request yet, may have a static IP address pre-configured, or may not even speak TCP/IP).This should work on all Espressif CPUs with WiFi (so not the H2), and the Raspberry Pi Pico.
The Raspberry Pi Pico W doesn't return RSSI values, so those are set to
Noneon the Pico W.The Pico W's SDK doesn't give much of a documented API to talk to the DHCP server. The code I wrote to retrieve IPv4 addresses for stations uses internal data structures in the DHCP server that could easily change without warning in future updates to the Pico W's SDK. It could be best to just not report IPv4 addresses for associated stations.
stations_apthrows an exception if the device isn't in AP mode.If you'd prefer different names or behavior I'd be happy to make those changes. I would tend to avoid calling associated stations "clients" as WiFi tends to use station/access point nomenclature rather than client/server. I tried to use names that were consistent with the technology and CircuitPython.
I'm not enough of a Pythonista to be clear on the best form to return results in... I thought that using a
dictfor the stations would help with future proofing in case more attributes may become available.Would you rather have the IPv4 address be
Noneif there's not one assigned yet? Would you rather not have anrssiproperty in thedicton the Pi Pico W?I'm not at all confident I got the docstrings right.
I've tested on one of each type of CPU this can run on except the ESP32-C3; I have some but haven't been able to find them yet.
Raspberry Pi Pico W
ESP32
ESP32-S2
ESP32-S3
ESP32-C6