Validate wifi credentials #116
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| "'networks' must be a list/tuple of dicts of 'ssid' and 'password'" | ||
| ) | ||
|
|
||
| self._wifi_credentials = list( |
There was a problem hiding this comment.
This looks good, couple questions:
- what about APs with no password?
- to
isinstanceis faster and generally better then type can we use those? - can we add tests?
There was a problem hiding this comment.
Got you on 1 and 2, but I'm not very familiar with pytest. Let me know if I got it right.
By the way, I totally forgot that APs could have empty passwords. 😆
There was a problem hiding this comment.
I'll look at the tests tomorrow. I'll make suggestions for anything to add/change
There was a problem hiding this comment.
And right - who would want something without a password? But people still complain when they can't connect because of it ...
There was a problem hiding this comment.
@justmobilize I think I've got the test figured out now, but let me know if it needs any adjustment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If a device hasn't been configured properly either with
CIRCUITPY_WIFI_SSIDandCIRCUITPY_WIFI_PASSWORDor the "networks" setting,adafruit_portalbase.network.NetworkBase.connectwill result in an obscureTypeErrorfrom theadafruit_esp32spilibrary.This update filters the
adafruit_portalbase.network.NetworkBase._wifi_credentialslist to ensure that it includes valid ssid/password pairs. If no valid credentials are available, it will trigger anOSErrorexception with a descriptive message.I am testing using the following program written for the Adafruit Fruit Jam with the
adafruit_fruitjamlibrary. The device has no WiFi credentials configured.Here is the REPL output before this update:
Here's the REPL output after this update:
Note: I felt that
OSErrorwas appropriate for this exception because it is related to the device configuration before a request is made, butConnectionErrormay follow the relative CPython implementation more closely.