esp8266_fix1595_fix1640

ChangeLog

@@ -39,6 +39,7 @@
             nRF52: Add setAdvertising({},{scannable:false}) for disabling scan response
             nRF52: Add note about connectable:false requiring >=100ms intervals
             STM32: Fix issue where occasionally STM32 would be ~0.2s late waking from light sleep
+            ESP8266: add Wifi.connect options channel and bssid for faster AP connects (fix #1595, #1640)
 
      2v01 : ESP32: update to esp-idf V3.1
             Fix issues with Class Extends

libs/network/esp8266/jswrap_esp8266_network.c

@@ -293,31 +293,26 @@ void jswrap_wifi_connect(
     JsVar *jsCallback
   ) {
 
-  // Notes:
-  // The callback function is saved in the file local variable called g_jsGotIpCallback.  The
-  // callback will be made when the WiFi callback found in the function called wifiEventHandler.
-
   DBGV("> Wifi.connect\n");
 
-  // Check that the ssid value isn't obviously in error.
+  struct station_config stationConfig;
+  memset(&stationConfig, 0, sizeof(stationConfig));
+
+  // Handle parameter ssid
+  char ssid[33];
   if (!jsvIsString(jsSsid)) {
     jsExceptionHere(JSET_ERROR, "No SSID provided");
     return;
-  }
+  } else {
-
+    int len = jsvGetString(jsSsid, ssid, sizeof(ssid)-1);
-  // Create SSID string
+    ssid[len]='\0';
-  char ssid[33];
+    os_strncpy((char *)stationConfig.ssid, ssid, 32);
-  int len = jsvGetString(jsSsid, ssid, sizeof(ssid)-1);
-  ssid[len]='\0';
-
-  // Make sure jsOptions is NULL or an object
-  if (jsOptions != NULL && !jsvIsObject(jsOptions)) {
-    EXPECT_OPT_EXCEPTION(jsOptions);
-    return;
   }
 
   // Check callback
-  if (g_jsGotIpCallback != NULL) jsvUnLock(g_jsGotIpCallback);
+  if (g_jsGotIpCallback != NULL) {
+    jsvUnLock(g_jsGotIpCallback);
+  }
   g_jsGotIpCallback = NULL;
   if (jsCallback != NULL && !jsvIsUndefined(jsCallback) && !jsvIsFunction(jsCallback)) {
     EXPECT_CB_EXCEPTION(jsCallback);
@@ -329,32 +324,111 @@ void jswrap_wifi_connect(
   g_jsDisconnectCallback = NULL;
   g_disconnecting = false; // we're gonna be connecting...
 
-  // Get the optional password
+  // Check for jsOptions
-  char password[65];
-  os_memset(password, 0, sizeof(password));
   if (jsOptions != NULL) {
-    JsVar *jsPassword = jsvObjectGetChild(jsOptions, "password", 0);
+    if (!jsvIsObject(jsOptions)) {
-    if (jsPassword != NULL && !jsvIsString(jsPassword)) {
+      jsExceptionHere(JSET_ERROR, "Expecting an Object");
-      jsExceptionHere(JSET_ERROR, "Expecting options.password to be a string but got %t", jsPassword);
-      jsvUnLock(jsPassword);
       return;
-    }
-    if (jsPassword != NULL) {
-      len = jsvGetString(jsPassword, password, sizeof(password)-1);
-      password[len]='\0';
     } else {
-      password[0] = '\0';
-    }
-    jsvUnLock(jsPassword);
-  }
 
-  // structure for SDK call, it's a shame we need to copy ssid and password but if we placed
+      // Handle password
-  // them straight into the stationConfig struct we wouldn't be able to printf them for debug
+      char password[65];
-  struct station_config stationConfig;
+      os_memset(password, 0, sizeof(password));
-  memset(&stationConfig, 0, sizeof(stationConfig));
+
-  os_strncpy((char *)stationConfig.ssid, ssid, 32);
+      JsVar *jsPassword = jsvObjectGetChild(jsOptions, "password", 0);
-  os_strncpy((char *)stationConfig.password, password, 64);
+      if (jsPassword != NULL && !jsvIsString(jsPassword)) {
-  DBGV(" - ssid:%s passwordLen:%d\n", ssid, strlen(password));
+        jsExceptionHere(JSET_ERROR, "Expecting options.password to be a string but got %t", jsPassword);
+        jsvUnLock(jsPassword);
+        return;
+      }
+      if (jsPassword != NULL) {
+        int len = jsvGetString(jsPassword, password, sizeof(password)-1);
+        password[len]='\0';
+      } else {
+        password[0] = '\0';
+      }
+      os_strncpy((char *)stationConfig.password, password, 64);
+      DBGV(" - ssid:%s passwordLen:%d\n", ssid, strlen(password));
+      jsvUnLock(jsPassword);
+
+      // Handle bssid
+      JsVar *jsBssid= jsvObjectGetChild(jsOptions, "bssid", 0);
+      if (jsBssid != NULL && jsvIsString(jsBssid)) {
+        char macAddrString[6 * 3 + 1 ];
+        int len = jsvGetString(jsBssid, macAddrString, sizeof(macAddrString)-1);
+        macAddrString[len] ='\0';
+        DBGV("bssid %s, len: %d\n",macAddrString,len);
+        bool isMAC = networkParseMACAddress((unsigned char*) stationConfig.bssid, (char *) macAddrString);
+        if ( isMAC ) {
+           stationConfig.bssid_set = 1;
+           DBGV("stationConfig.bssid_set = 1, %d %d %d %d %d %d\n", 
+             stationConfig.bssid[0], stationConfig.bssid[1], stationConfig.bssid[2],
+             stationConfig.bssid[3], stationConfig.bssid[4], stationConfig.bssid[5]
+            );
+        } else { 
+          jsExceptionHere(JSET_ERROR, "Expecting bssid as \"aa:bb:cc:dd:cc:ff\"");
+          jsvUnLock(jsBssid);
+          return;
+        }
+      } 
+      jsvUnLock(jsBssid);
+
+      //Handle channel
+      JsVar *jsChannel = jsvObjectGetChild(jsOptions, "channel", 0);
+      if(jsChannel != NULL && jsvIsInt(jsChannel)){
+        uint8 channel = jsvGetInteger(jsChannel);
+        if ( channel >= 0 && channel <= 14) {
+          DBGV("channel %d\n", channel);
+          wifi_set_channel(channel);
+        } else  {
+          jsExceptionHere(JSET_ERROR, "Expecting options.channel to be a integer between 0 and  14, but got %t", jsChannel);
+          jsvUnLock(jsChannel); 
+          return;   
+        }
+      }
+      jsvUnLock(jsChannel);
+
+      // Handle  dnsServers
+      JsVar *jsDNSServers = jsvObjectGetChild(jsOptions, "dnsServers", 0);
+      if (jsvIsArray(jsDNSServers) != false) {
+        int count = 0;
+        DBGV(" - We have DNS servers!!\n");
+        JsVarInt numDNSServers = jsvGetArrayLength(jsDNSServers);
+        ip_addr_t dnsAddresses[2];
+        if (numDNSServers == 0) {
+          DBGV("No servers!!");
+          count = 0;
+        }
+        if (numDNSServers > 0) {
+          // One server
+          count = 1;
+          JsVar *jsCurrentDNSServer = jsvGetArrayItem(jsDNSServers, 0);
+          char buffer[50];
+          size_t size = jsvGetString(jsCurrentDNSServer, buffer, sizeof(buffer)-1);
+          buffer[size] = '\0';
+          jsvUnLock(jsCurrentDNSServer);
+          dnsAddresses[0].addr = networkParseIPAddress(buffer);
+        }
+        if (numDNSServers > 1) {
+          // Two servers
+          count = 2;
+          JsVar *jsCurrentDNSServer = jsvGetArrayItem(jsDNSServers, 1);
+          char buffer[50];
+          size_t size = jsvGetString(jsCurrentDNSServer, buffer, sizeof(buffer)-1);
+          buffer[size] = '\0';
+          jsvUnLock(jsCurrentDNSServer);
+          dnsAddresses[1].addr = networkParseIPAddress(buffer);
+        }
+        if (numDNSServers > 2) {
+          DBG("Ignoring DNS servers after first 2.");
+        }
+        if (count > 0) {
+          espconn_dns_setserver((char)count, dnsAddresses);
+        }
+      }
+      jsvUnLock(jsDNSServers);
+    }
+  }
 
   int8 wifiConnectStatus = wifi_station_get_connect_status();
   if (wifiConnectStatus < 0) wifiConnectStatus = 0;
@@ -390,46 +464,6 @@ void jswrap_wifi_connect(
   // Set the station configuration
   int8 ok = wifi_station_set_config_current(&stationConfig);
 
-  // Do we have a child property called dnsServers?
-  JsVar *jsDNSServers = jsvObjectGetChild(jsOptions, "dnsServers", 0);
-  int count = 0;
-  if (jsvIsArray(jsDNSServers) != false) {
-    DBGV(" - We have DNS servers!!\n");
-    JsVarInt numDNSServers = jsvGetArrayLength(jsDNSServers);
-    ip_addr_t dnsAddresses[2];
-    if (numDNSServers == 0) {
-      DBGV("No servers!!");
-      count = 0;
-    }
-    if (numDNSServers > 0) {
-      // One server
-      count = 1;
-      JsVar *jsCurrentDNSServer = jsvGetArrayItem(jsDNSServers, 0);
-      char buffer[50];
-      size_t size = jsvGetString(jsCurrentDNSServer, buffer, sizeof(buffer)-1);
-      buffer[size] = '\0';
-      jsvUnLock(jsCurrentDNSServer);
-      dnsAddresses[0].addr = networkParseIPAddress(buffer);
-    }
-    if (numDNSServers > 1) {
-      // Two servers
-      count = 2;
-      JsVar *jsCurrentDNSServer = jsvGetArrayItem(jsDNSServers, 1);
-      char buffer[50];
-      size_t size = jsvGetString(jsCurrentDNSServer, buffer, sizeof(buffer)-1);
-      buffer[size] = '\0';
-      jsvUnLock(jsCurrentDNSServer);
-      dnsAddresses[1].addr = networkParseIPAddress(buffer);
-    }
-    if (numDNSServers > 2) {
-      DBG("Ignoring DNS servers after first 2.");
-    }
-    if (count > 0) {
-      espconn_dns_setserver((char)count, dnsAddresses);
-    }
-  }
-  jsvUnLock(jsDNSServers);
-
   // ensure we have a default DHCP hostname
   char *old_hostname = wifi_station_get_hostname();
   if (old_hostname == NULL || old_hostname[0] == 0)

libs/network/jswrap_wifi.c

@@ -59,7 +59,7 @@ On other platforms, place `wifi.connect` in a function called `onInit`.
     ["details","JsVar","An object with event details"]
   ]
 }
-The 'connected' event is called when an association with an access point has succeeded, i.e., a connection to the AP's network has been established.
+The 'associated' event is called when an association with an access point has succeeded, i.e., a connection to the AP's network has been established.
 
 On ESP32/ESP8266 there is a `details` parameter which includes:
 
@@ -222,6 +222,8 @@ The options properties may contain:
 
 * `password` - Password string to be used to access the network.
 * `dnsServers` (array of String) - An array of up to two DNS servers in dotted decimal format string.
+* `channel`  - Wifi channel of the access point  (integer, typ 0..14, 0 means any channel).
+* `bssid`   -  Mac address of the access point (string, type "00:00:00:00:00:00").
 
 Notes: