[Fixed backport]: Add WPS and netstatus #4464

volodymyrlut · 2019-02-05T16:46:48Z

This PR is basically a fixed version of @mactijn port of @jhgoebbert PR#218 which had conflicts with master and haven't passed the CI check.

We've fixed issues, merged code and tested functionality on our ESP-32 boards, but I would kindly ask maintainers to properly review the code.

It can be used as follows:

import machine
import time
import network

button = machine.Pin(12, machine.Pin.IN, machine.Pin.PULL_UP)
wlan = network.WLAN(network.STA_IF)
wlan.active(True)
while True:
    if button.value() == 0:
        wlan.start_wps()
        print('start_wps')
        while wlan.status() == network.STA_WPS_PROBING:
            print("probing with WPS")
            time.sleep(0.5)

        if wlan.status() == network.STA_WPS_SUCCESS:
            print("WPS successful")
            print("   ESSID:    ", wlan.config('essid'))
            print("   Password: ", wlan.config('password'))
            wlan.connect(wlan.config('essid'), wlan.config('password'))
            print("Waiting for connection...")
            while not wlan.isconnected():
                machine.idle()
            print("Connected.")

        elif wlan.status() == network.STA_WPS_FAILED:
            print("WPS failed")

        elif wlan.status() == network.STA_WPS_TIMEOUT:
            print("WPS timeout")

mattytrentini · 2019-02-07T10:57:52Z

ports/esp32/modnetwork.c

 // This function is called by the system-event task and so runs in a different
 // thread to the main MicroPython task.  It must not raise any Python exceptions.
 static esp_err_t event_handler(void *ctx, system_event_t *event) {
   switch(event->event_id) {
    case SYSTEM_EVENT_STA_START:
        ESP_LOGI("wifi", "STA_START");
        break;
+    case SYSTEM_EVENT_STA_GOT_IP:
+            wifi_sta_status = STATION_GOT_IP;


(formatting) Inconsistent indentation; just drop four spaces.

mattytrentini · 2019-02-07T11:12:33Z

The code looks really good, thanks for your efforts! WPS is actually a neat solution for establishing connectivity in the IoT space so I think this feature could be quite useful.

This weekend I'll build and test it against my router.

volodymyrlut · 2019-02-07T12:01:03Z

@mattytrentini thank you!

You can use the code example I've attached to the first comment here to test it (it worked on my ESP32 perfectly). I would like to see it merged someday.

Have a good day!

mattytrentini · 2019-02-10T14:04:01Z

Pulled code into a checkout of master:head, rebuilt and tried your example code (changing the pin to something more convenient on my board)...and it appears to work!

True
I (264939) wpa: manufacturer: ESPRESSIF, model number: ESP32, model name: ESPRESSIF IOT, device name: ESP STATION
I (264939) wpa: wifi_wps_enable

start_wps
probing with WPS
probing with WPS
probing with WPS
probing with WPS
probing with WPS
probing with WPS
I (268359) wifi: new:<1,1>, old:<1,0>, ap:<255,255>, sta:<1,1>, prof:1
I (268999) wifi: state: init -> auth (b0)
I (269009) wifi: state: auth -> assoc (0)
probing with WPS
I (269019) wifi: state: assoc -> run (10)
probing with WPS
probing with WPS
probing with WPS
probing with WPS
probing with WPS
probing with WPS
probing with WPS
probing with WPS
probing with WPS
I (274349) wifi: STA_WPS_ER_SUCCESS
I (274349) wpa: wifi_wps_disable

I (274349) wifi: state: run -> init (0)
I (274349) wifi: new:<1,0>, old:<1,1>, ap:<255,255>, sta:<1,1>, prof:1
I (274359) wifi: STA_DISCONNECTED, reason:8
WPS successful
   ESSID:     TrentNet3
   Password:  xxxxxxxx
Waiting for connection...
I (274949) wifi: new:<1,1>, old:<1,0>, ap:<255,255>, sta:<1,1>, prof:1
I (275599) wifi: state: init -> auth (b0)
I (275599) wifi: state: auth -> assoc (0)
I (275609) wifi: state: assoc -> run (10)
I (275849) wifi: connected with TrentNet3, channel 1, bssid = 00:04:ed:8a:39:6f
I (275849) wifi: pm start, type: 1

I (275859) network: CONNECTED
I (277899) event: sta ip: 192.168.1.114, mask: 255.255.255.0, gw: 192.168.1.254
I (277899) network: GOT_IP
Connected.
Traceback (most recent call last):
  File "<stdin>", line 30, in <module>
KeyboardInterrupt: 
>>> wlan.isconnected()
True
>>> wlan.ifconfig()
('192.168.1.114', '255.255.255.0', '192.168.1.254', '192.168.1.254')

Nice job! The only thing that remains is some documentation. A WPS entry in the QuickStart would be the way to go...I could add it but would certainly appreciate it if you were able to make a first-pass!

volodymyrlut · 2019-02-11T11:42:06Z

@mattytrentini ok, for sure.
I'll take care of docs:)

volodymyrlut · 2019-02-11T13:14:21Z

@mattytrentini I've added docs under the networking part of quickref:
https://github.com/odditive/micropython/blob/add-wps-and-netstatus/docs/esp32/quickref.rst

Can you please read it through and tell me whether it is ok?
Thank you.

volodymyrlut · 2019-02-18T11:36:04Z

Hello, @mattytrentini!

How can I help you to make this PR merged?

dpgeorge · 2019-02-26T06:41:53Z

Thanks @volodymyrlut for the contribution. I agree with @mattytrentini that this would be a nice addition, but we should think a bit how the user facing API looks in Python so that it can be made the same on other ports (eg esp8266).

At first thought WPS (enrollee) is just another way to connect to an AP, so could simply be exposed as wlan.connect(wps=True). Then connection would proceed as if you provided an SSID and password, and status can be checked via wlan.status() using the existing status codes.

So you could reconnect next time without using WPS there would need to be a way to get the SSID and password (from the successful WPS connection), to save them, to reuse them. Exposing them through wlan.config() makes sense (as you've done here).

The other way to think about it is with WPS as a completely separate, independent feature which is used to retrieve the SSID and password of the AP. This could be exposed using the existing config method like wlan.config(wps=True) which turns on WPS. And its status (eg success, timeout) obtained via wlan.status('wps'). Once successful, the SSID and password could be obtained using wlan.config() again.

What is done in this PR seems to be a bit of both of the above, adding a new method start_wps() and coupling in the status results to the connection status codes. I'd rather keep those codes separated because they are difficult to get right, see eg the recent commit 21f9329

gmli · 2020-04-11T10:02:31Z

Any update about WPS support ?

volodymyrlut · 2020-04-16T17:47:16Z

@gmli unfortunately I cannot currently help with this issue. If the problems mentioned by @mattytrentini would be resolved by someone, I think it could be merged.

Anyways, there is no technical limitations to make it work.

tialm · 2020-05-17T21:43:19Z

This would be awesome to have straight out of the box! Any news? What does need to be solved?

FabriSku · 2020-12-13T16:26:46Z

Thanks so much for your valuable work. I wanted to ask you about this code example for WPS which is followed by an error "AttributeError: 'WLAN' object has no attribute 'start_wps'".
do the files named modnetwork.c and makefile do something? what are they and what are they for? Thanks in advance for the answer.

update logic for displayio.TileGrid's transform_xy

eydam-prototyping · 2021-06-27T13:16:44Z

Hello,
I started a new PR #7452, since this one wasn't merged.
It would be great, if some of you have time to test it and report the results, so we could merge it this time.

big-vl · 2022-10-16T18:32:53Z

The branch is outdated, I would like to see this update.

projectgus · 2024-03-07T23:53:51Z

This is an automated heads-up that we've just merged a Pull Request
that removes the STATIC macro from MicroPython's C API.

See #13763

A search suggests this PR might apply the STATIC macro to some C code. If it
does, then next time you rebase the PR (or merge from master) then you should
please replace all the STATIC keywords with static.

Although this is an automated message, feel free to @-reply to me directly if
you have any questions about this.

Resolved conflicts and updated Makefile

364a6eb

volodymyrlut force-pushed the add-wps-and-netstatus branch from f47ac8e to 364a6eb Compare February 6, 2019 11:37

mattytrentini reviewed Feb 7, 2019

View reviewed changes

Fix inconsistent intendation

36d0e65

volodymyrlut added 3 commits February 11, 2019 15:09

Add info about WPS to quickstart

2ed64b8

Update quickref.rst

9251a65

Update quickref.rst

315dbd9

tannewt added a commit to tannewt/circuitpython that referenced this pull request Mar 23, 2021

Merge pull request micropython#4464 from kmatch98/transform_fix

98425c9

update logic for displayio.TileGrid's transform_xy

dpgeorge mentioned this pull request May 11, 2021

[backport] WPS Support #3530

Closed

eydam-prototyping mentioned this pull request Jun 24, 2021

ports/esp32/modnetwork.c: Added WPS. #7452

Closed

soenkegissel mentioned this pull request Aug 13, 2022

Raspberry Pi Pico W: Add WPS functionality #9049

Open

Gadgetoid mentioned this pull request Feb 29, 2024

global: Remove the STATIC macro. #13763

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fixed backport]: Add WPS and netstatus #4464

[Fixed backport]: Add WPS and netstatus #4464

volodymyrlut commented Feb 5, 2019

mattytrentini Feb 7, 2019

volodymyrlut Feb 7, 2019

mattytrentini commented Feb 7, 2019

volodymyrlut commented Feb 7, 2019

mattytrentini commented Feb 10, 2019

volodymyrlut commented Feb 11, 2019

volodymyrlut commented Feb 11, 2019

volodymyrlut commented Feb 18, 2019

dpgeorge commented Feb 26, 2019

gmli commented Apr 11, 2020

volodymyrlut commented Apr 16, 2020

tialm commented May 17, 2020

FabriSku commented Dec 13, 2020

eydam-prototyping commented Jun 27, 2021

big-vl commented Oct 16, 2022 •

edited

Loading

projectgus commented Mar 7, 2024

[Fixed backport]: Add WPS and netstatus #4464

Are you sure you want to change the base?

[Fixed backport]: Add WPS and netstatus #4464

Conversation

volodymyrlut commented Feb 5, 2019

mattytrentini Feb 7, 2019

Choose a reason for hiding this comment

volodymyrlut Feb 7, 2019

Choose a reason for hiding this comment

mattytrentini commented Feb 7, 2019

volodymyrlut commented Feb 7, 2019

mattytrentini commented Feb 10, 2019

volodymyrlut commented Feb 11, 2019

volodymyrlut commented Feb 11, 2019

volodymyrlut commented Feb 18, 2019

dpgeorge commented Feb 26, 2019

gmli commented Apr 11, 2020

volodymyrlut commented Apr 16, 2020

tialm commented May 17, 2020

FabriSku commented Dec 13, 2020

eydam-prototyping commented Jun 27, 2021

big-vl commented Oct 16, 2022 • edited Loading

projectgus commented Mar 7, 2024

big-vl commented Oct 16, 2022 •

edited

Loading