Skip to content

Add ability to set start and end ip for softAP #6422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

Add ability to set start and end ip for softAP #6422

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5ad6ff9
Added ability to set start and end ip for softAP
mbm60 Aug 14, 2019
802b68b
Update ESP8266WiFiAP.cpp
mbm60 Aug 14, 2019
9f1b343
Fix Static DHCP Lease
mbm60 Aug 15, 2019
eeeffbc
Update StaticLease.ino
mbm60 Aug 15, 2019
5bc4914
Update StaticLease.ino
mbm60 Aug 15, 2019
2374085
Merge branch 'master' into mbm60-patch-1
mbm60 Aug 22, 2019
2b7acf0
Merge pull request #1 from esp8266/master
mbm60 Aug 31, 2019
47bf960
Add some sainity check
mbm60 Sep 3, 2019
560460d
Fix some includes.
mbm60 Sep 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions libraries/ESP8266WiFi/examples/StaticLease/StaticLease.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ void loop() {
const char *ssid = "ESPap";
const char *password = "thereisnospoon";

/* List of mac address for static lease */
uint8 mac_CAM[6] = { 0x00, 0x0C, 0x43, 0x01, 0x60, 0x15 };
uint8 mac_PC[6] = { 0xb4, 0x52, 0x7e, 0x9a, 0x19, 0xa5 };

ESP8266WebServer server(80);

/* Set the IP Address you want for your AP */
Expand All @@ -44,7 +48,6 @@ void handleRoot() {
result += String(number_client);
result += "</h1></br>";
while (stat_info != NULL) {

result += "Client ";
result += String(i);
result += " = ";
Expand All @@ -53,7 +56,6 @@ void handleRoot() {
sprintf(wifiClientMac, "%02X:%02X:%02X:%02X:%02X:%02X", MAC2STR(stat_info->bssid));
result += wifiClientMac;
result += "</br>";

stat_info = STAILQ_NEXT(stat_info, next);
i++;
}
Expand All @@ -63,10 +65,6 @@ void handleRoot() {
}

void setup() {
/* List of mac address for static lease */
uint8 mac_CAM[6] = { 0x00, 0x0C, 0x43, 0x01, 0x60, 0x15 };
uint8 mac_PC[6] = { 0xb4, 0x52, 0x7e, 0x9a, 0x19, 0xa5 };

Serial.begin(115200);
Serial.println();
Serial.println("Configuring access point...");
Expand All @@ -75,26 +73,29 @@ void setup() {
WiFi.persistent(false);

WiFi.mode(WIFI_AP);

/* Configure AP with IP = 192.168.0.1 / Gateway = 192.168.0.1 / Subnet = 255.255.255.0
if you specify the ESP8266's IP-address with 192.168.0.1, the function softAPConfig() sets the DHCP-range as 192.168.0.100 - 192.168.0.200
*/
WiFi.softAPConfig(apIP, apIP, IPAddress(255, 255, 255, 0));
/* Setup your static leases.

As it depend from your first address, and need to be done BEFORE any request from client,
this need to be specified after WiFi.softAPConfig() and before WiFi.softAP().
/* Start Access Point. You can remove the password parameter if you want the AP to be open. */
WiFi.softAP(ssid, password);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting the softAP before setting up the static leases allows a race condition, where a client could potentially connect as soon as the AP is up, but before the leases are set up. In that case, the lease setup could lead to an address clash. This is the reason behind the current call order.

Copy link
Contributor Author

@mbm60 mbm60 Aug 29, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but I did test it and if it is before start softAP, "StaticLease" won't work


/* Setup your static leases.
As it depend from your first address, and need to be done BEFORE any request from client,
this need to be specified after WiFi.softAP().
first call to wifi_softap_add_dhcps_lease() will setup first IP address of the range
second call to wifi_softap_add_dhcps_lease() will setup second IP address of the range
...
any client not listed will use next IP address available from the range (here 192.168.0.102 and more)
*/
wifi_softap_add_dhcps_lease(mac_CAM); // always 192.168.0.100
wifi_softap_add_dhcps_lease(mac_PC); // always 192.168.0.101
/* Start Access Point. You can remove the password parameter if you want the AP to be open. */
WiFi.softAP(ssid, password);

Serial.print("AP IP address: ");
Serial.println(WiFi.softAPIP());

/* Setup HTTP Server */
server.on("/", handleRoot);
server.begin();
Expand Down
55 changes: 47 additions & 8 deletions libraries/ESP8266WiFi/src/ESP8266WiFiAP.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,12 @@ extern "C" {

#include "debug.h"


#ifndef htonl
#define htonl(x) ( ((x)<<24 & 0xFF000000UL) | \
((x)<< 8 & 0x00FF0000UL) | \
((x)>> 8 & 0x0000FF00UL) | \
((x)>>24 & 0x000000FFUL) )
#endif

// -----------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------- Private functions ------------------------------------------------
Expand Down Expand Up @@ -194,8 +199,10 @@ bool ESP8266WiFiAPClass::softAP(const String& ssid, const String& passphrase, in
* @param local_ip access point IP
* @param gateway gateway IP (0.0.0.0 to disable)
* @param subnet subnet mask
* @param dhcp_start first IP assigned by DHCP
* @param dhcp_end last IP assigned by DHCP
*/
bool ESP8266WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway, IPAddress subnet) {
bool ESP8266WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dhcp_start, IPAddress dhcp_end) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that currently the dhcp server is always on, and there is no way to turn it off. I suggest the following:

  1. Don't add additional parameters here. Instead, implement a method overload that has the additional parameters.
  2. Change the current method to add a bool dhcpEnabled at the end with default true. When true, dhcp is enabled per current defaults. When false, dhcp setup is skipped altogether.
  3. Refactor both methods to not have duplicate code.

DEBUG_WIFI("[APConfig] local_ip: %s gateway: %s subnet: %s\n", local_ip.toString().c_str(), gateway.toString().c_str(), subnet.toString().c_str());
if(!WiFi.enableAP(true)) {
// enable AP failed
Expand All @@ -214,10 +221,24 @@ bool ESP8266WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway, IPA
return false;
}
struct ip_info info;

info.ip.addr = local_ip.v4();
info.gw.addr = gateway.v4();
info.netmask.addr = subnet.v4();


uint32_t softap_ip = htonl(info.ip.addr);
uint32_t start_ip = htonl(dhcp_start.v4());
uint32_t end_ip = htonl(dhcp_end.v4());
softap_ip >>= 8;
if (( start_ip >> 8 != softap_ip ) || ( end_ip >> 8 != softap_ip )) {
DEBUG_WIFI("[APConfig] dhcp_start or dhcp_end isn't in range of local_ip Address!\n");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is not right. v4 addresses need to be shifted by the number of zeroed bits in the netmask address. It is indeed 8 with 255.255.255.0 but since netmask is not hardcoded, "8" neither should be.
There are other attempts for a proper API for network calculations like #6196 .

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. But this part of the code compares the start and the end IP with the local IP to be in the same range. And I copied it from the esp-dhcpserver.c file. for example :
If the local IP is 192.168.4.1, the start IP and end IP must be in range 192.168.4 .
The comparison with the netmask you are looking for is done elsewhere.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@d-a-v comment is correct. What happens if the subnet mask is e. g. 255.255.0.0? Then this test is incorrect.
The calculation required is a bit more elaborate.

Copy link
Contributor Author

@mbm60 mbm60 Aug 29, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@d-a-v @devyte
I understand what you mean and you are absolutely right. But if the subnetmask is e.g 255.255.0.0 and local_ip is 192.168.1.1 and the dhcp_start or dhcp_end is e.g 192.168.5.10, the "[APConfig] wifi_set_ip_info failed" error occurs in debug. Because of the following lines in the "esp-dhcpserver.c" file :

Capture

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because you are right saying it is dependent on dhcp server,
I propose you test and exit with an error when netmask != IPAddress(255,255,255,0).

Copy link
Contributor Author

@mbm60 mbm60 Aug 31, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@d-a-v Thanks for your consideration.
Since the "DHCPS_MAX_LEASE" is limited to 100, we don't need more than 254 IPs in a range. And if we were to limit the "subnet mask" to 255.255.255.0, why would there be an option to set the "subnet mask"? And wouldn't it be better to implement "softAPConfig" without it as follows?

bool ESP8266WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway,  IPAddress dhcp_start, IPAddress dhcp_end) {

IPAddress subnet(255, 255, 255, 0);
info.netmask.addr = subnet.v4();

DEBUG_WIFI("[APConfig] set dfault vaule\n");
dhcp_start = local_ip;
dhcp_start[3] += 99;
dhcp_end = dhcp_start;
dhcp_end[3] += 100;
}

if(!wifi_softap_dhcps_stop()) {
DEBUG_WIFI("[APConfig] wifi_softap_dhcps_stop failed!\n");
}
Expand All @@ -228,13 +249,14 @@ bool ESP8266WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway, IPA
}

struct dhcps_lease dhcp_lease;
IPAddress ip = local_ip;
ip[3] += 99;
dhcp_lease.start_ip.addr = ip.v4();
dhcp_lease.enable = true;

IPAddress ip = dhcp_start;
dhcp_lease.start_ip.addr = dhcp_start.v4();
DEBUG_WIFI("[APConfig] DHCP IP start: %s\n", ip.toString().c_str());

ip[3] += 100;
dhcp_lease.end_ip.addr = ip.v4();
ip = dhcp_end;
dhcp_lease.end_ip.addr = dhcp_end.v4();
DEBUG_WIFI("[APConfig] DHCP IP end: %s\n", ip.toString().c_str());

if(!wifi_softap_set_dhcps_lease(&dhcp_lease)) {
Expand Down Expand Up @@ -277,7 +299,24 @@ bool ESP8266WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway, IPA
return ret;
}

/**
* Configure access point
* @param local_ip access point IP
* @param gateway gateway IP
* @param subnet subnet mask
*/
bool ESP8266WiFiAPClass::softAPConfig(IPAddress local_ip, IPAddress gateway, IPAddress subnet) {
IPAddress dhcp_start;
IPAddress dhcp_end;

dhcp_start = local_ip;
dhcp_start[3] += 99;
dhcp_end = dhcp_start;
dhcp_end[3] += 100;

bool ret = softAPConfig(local_ip, gateway, subnet, dhcp_start, dhcp_end);
return ret;
}

/**
* Disconnect from the network (close AP)
Expand Down
1 change: 1 addition & 0 deletions libraries/ESP8266WiFi/src/ESP8266WiFiAP.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ class ESP8266WiFiAPClass {

bool softAP(const char* ssid, const char* passphrase = NULL, int channel = 1, int ssid_hidden = 0, int max_connection = 4);
bool softAP(const String& ssid,const String& passphrase = emptyString,int channel = 1,int ssid_hidden = 0,int max_connection = 4);
bool softAPConfig(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dhcp_start, IPAddress dhcp_end);
bool softAPConfig(IPAddress local_ip, IPAddress gateway, IPAddress subnet);
bool softAPdisconnect(bool wifioff = false);

Expand Down