Adding softAP SSID & PSK query API #4138

IMAN4K · 2018-01-11T09:24:53Z

Signed-off-by: Iman Ahmadvand [email protected] (github: @IMAN4K)

Signatures: String ESP8266WiFiAP::softAPSSID() const; String ESP8266WiFiAP::softAPPSK() const;

devyte · 2018-01-15T17:05:32Z

libraries/ESP8266WiFi/src/ESP8266WiFiAP.cpp

+String ESP8266WiFiAPClass::softAPPSK() const {
+	struct softap_config config;
+	wifi_softap_get_config(&config);
+	return String(reinterpret_cast<char*>(config.password));


On second thought, this could cause an issue. When a 64-byte psk is used, it is not 0-terminated, and String assumes a null-terminator.
Instead, a char psk[65] should be declared, config.password should be memcpy()d into it, and then psk[64] = 0;. Then, return String(psk).

@devyte
Yes That's right.
This is the String constructor:

String::String(const char *cstr) { init(); if(cstr) copy(cstr, strlen(cstr)); }

devyte · 2018-01-15T17:06:25Z

libraries/ESP8266WiFi/src/ESP8266WiFiAP.cpp

+}
+
+/**
+* Get the configurd(Not-In-Flash) softAP PSK or PASSWORD.


Minor typo -> configured.

d-a-v · 2018-01-24T13:14:51Z

libraries/ESP8266WiFi/src/ESP8266WiFiAP.cpp

+String ESP8266WiFiAPClass::softAPSSID() const {
+	struct softap_config config;
+	wifi_softap_get_config(&config);
+	char* name = reinterpret_cast<char*>(config.ssid);


why not just

config.ssid[sizeof(config.ssid) - 1] = 0; // guard return String((const char*)(void*)config.ssid) ?

String(char*) will anyway search for the last \0

@d-a-v
Based on @devyte comment, user must be able to configure 64 byte length PSK at max, not 63

OK sorry I did not see the hidden-outdated comment.

Signatures: static bool IPAddress::isValid(const String& arg); static bool IPAddress::isValid(const char* arg, size_t len);

igrr · 2018-02-19T14:06:34Z

libraries/ESP8266WiFi/src/ESP8266WiFiAP.h

@@ -47,6 +47,9 @@ class ESP8266WiFiAPClass {
        uint8_t* softAPmacAddress(uint8_t* mac);
        String softAPmacAddress(void);

+		String softAPSSID() const;


Indentation on this line is different from nearby lines

igrr · 2018-02-19T14:07:00Z

libraries/ESP8266WiFi/src/ESP8266WiFiAP.cpp

+* @return String SSID.
+*/
+String ESP8266WiFiAPClass::softAPSSID() const {
+	struct softap_config config;


Indentation in this function is different from nearby functions

devyte · 2018-03-18T19:13:13Z

cores/esp8266/IPAddress.cpp

@@ -112,4 +112,51 @@ String IPAddress::toString() const
    return String(szRet);
 }

+/* ref: https://code.woboq.org/userspace/glibc/resolv/inet_pton.c.html#inet_pton4 */
+static bool inet_pton4(const char *start, const char *end) {


How is this function different from IPAddress::fromString(), found here? If they serve equivalent purpose, I'd rather not duplicate.

@devyte
So sorry for late reply.
You say we should modify bool IPAddress::fromString(const char *address) function for adding validate support ? without duplicate
Because current IPAddress public API doesn't support validating IPV4 as string

@devyte
My suggestion:
1.Adding a private validating method:
static bool IPAddress::isValid(const char* arg, size_t len);
2.Adding correspond public method:
static bool IPAddress::isValid(const String& ip);
3.Reuse method of 1 inside 2 and bool IPAddress::fromString(const char *address) function

@IMAN4K said:

Because current IPAddress public API doesn't support validating IPV4 as string

Are you saying that the following does not validate a string?
bool isvalid = IPAddress().fromString("17604123874106239");

@devyte
Yes that's correct, my mistake!
But we need to make an object for every validation.
It's better with a public static member(with good api name isValid rather than fromString), then every where in code:
if (IPAddress::isValid(...)) ...

The object constructed is 4 bytes in size, essentially one int, which is a temporary instantiated on the stack and immediately destroyed, so that's not a problem (btw, destruction is trivial).
What I suggest is a static convenience method like you propose, but something like this:

bool IPAddress::isValid(const char *str) { return IPAddress().fromString(str); } bool IPAddress::isValid(String &str) { return IPAddress().fromString(str); }

Ok.
I'll make changes very soon.

devyte · 2018-03-23T18:32:38Z

@IMAN4K will you be replying to this?

devyte · 2018-03-24T16:12:09Z

cores/esp8266/IPAddress.cpp

@@ -112,4 +112,51 @@ String IPAddress::toString() const
    return String(szRet);
 }

+/* ref: https://code.woboq.org/userspace/glibc/resolv/inet_pton.c.html#inet_pton4 */
+static bool inet_pton4(const char *start, const char *end) {


The object constructed is 4 bytes in size, essentially one int, which is a temporary instantiated on the stack and immediately destroyed, so that's not a problem (btw, destruction is trivial).
What I suggest is a static convenience method like you propose, but something like this:

bool IPAddress::isValid(const char *str) { return IPAddress().fromString(str); } bool IPAddress::isValid(String &str) { return IPAddress().fromString(str); }

signatures: static bool isValid(const String& arg); static bool isValid(const char* arg);

softAP SSID & PSK query API added.

e5c6259

Signatures: String ESP8266WiFiAP::softAPSSID() const; String ESP8266WiFiAP::softAPPSK() const;

devyte approved these changes Jan 12, 2018

View reviewed changes

devyte requested changes Jan 15, 2018

View reviewed changes

IMAN4K added 4 commits January 17, 2018 13:18

Fix for proper C-style string copy

3b79cb4

Merge branch 'master' into master

04d96d9

Merge branch 'master' into master

6501ba4

Merge branch 'master' into master

9f3e1bd

devyte approved these changes Jan 24, 2018

View reviewed changes

Merge branch 'master' into master

1d74009

devyte mentioned this pull request Jan 24, 2018

Retrieving softAP SSID #4230

Closed

d-a-v reviewed Jan 24, 2018

View reviewed changes

d-a-v approved these changes Jan 24, 2018

View reviewed changes

IMAN4K added 5 commits January 24, 2018 17:53

Merge branch 'master' into master

0f6979f

Merge branch 'master' into master

3ecd00f

Merge branch 'master' into master

bff42fd

Merge branch 'master' of github.com:esp8266/Arduino

0339f5e

add API to validate input ip as string

dcf64e1

Signatures: static bool IPAddress::isValid(const String& arg); static bool IPAddress::isValid(const char* arg, size_t len);

igrr requested changes Feb 19, 2018

View reviewed changes

IMAN4K and others added 4 commits February 22, 2018 22:48

fix indentation

a62c5ab

Merge branch 'master' into master

60b4a1d

Merge branch 'master' into master

3a80358

Merge branch 'master' into master

641d6c5

devyte requested changes Mar 18, 2018

View reviewed changes

devyte requested changes Mar 24, 2018

View reviewed changes

IMAN4K added 3 commits March 25, 2018 14:51

Merge branch 'master' into master

a2fe942

Merge branch 'master' into master

0309ded

fix ip string validation to use built-in implementation.

6ca28ab

signatures: static bool isValid(const String& arg); static bool isValid(const char* arg);

devyte approved these changes Mar 28, 2018

View reviewed changes

devyte merged commit 241531a into esp8266:master Mar 28, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding softAP SSID & PSK query API #4138

Adding softAP SSID & PSK query API #4138

IMAN4K commented Jan 11, 2018

devyte Jan 15, 2018

IMAN4K Jan 17, 2018

devyte Jan 15, 2018

d-a-v Jan 24, 2018

IMAN4K Jan 24, 2018 •

edited

Loading

d-a-v Jan 24, 2018

igrr Feb 19, 2018

igrr Feb 19, 2018

devyte Mar 18, 2018

IMAN4K Mar 23, 2018 •

edited

Loading

IMAN4K Mar 23, 2018 •

edited

Loading

devyte Mar 24, 2018

IMAN4K Mar 24, 2018 •

edited

Loading

devyte Mar 24, 2018

IMAN4K Mar 27, 2018

devyte commented Mar 23, 2018

devyte Mar 24, 2018

Adding softAP SSID & PSK query API #4138

Adding softAP SSID & PSK query API #4138

Conversation

IMAN4K commented Jan 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IMAN4K Jan 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IMAN4K Mar 23, 2018 • edited Loading

Choose a reason for hiding this comment

IMAN4K Mar 23, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IMAN4K Mar 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devyte commented Mar 23, 2018

Choose a reason for hiding this comment

IMAN4K Jan 24, 2018 •

edited

Loading

IMAN4K Mar 23, 2018 •

edited

Loading

IMAN4K Mar 23, 2018 •

edited

Loading

IMAN4K Mar 24, 2018 •

edited

Loading