Merge pull request #682 from nkolban/master

Issue #589 changes to the default station and access point creations.

Author: gfwilliams

libs/network/esp8266/jswrap_esp8266.c

@@ -162,17 +162,33 @@ JsVar *jswrap_ESP8266_getAddressAsString(
   "name"     : "disconnect",
   "generate" : "jswrap_ESP8266_wifi_disconnect",
   "params"   : [
+    ["options", "JsVar", "Options controlling the function (optional)."],
     ["callback", "JsVar", "A function to be called back on completion (optional)."]
   ]
-}*/
-void jswrap_ESP8266_wifi_disconnect(JsVar *jsCallback) {
+}
+* The options is a JavaScript object that contains the following properties:
+* * `default` - If set to true, then auto connect of this device as a station will be
+* disabled.  The default of `default` is false.
+*/
+void jswrap_ESP8266_wifi_disconnect(JsVar *jsOptions, JsVar *jsCallback) {
   os_printf("> jswrap_ESP8266_wifi_disconnect\n");
   if (g_jsDisconnectCallback != NULL) {
     jsvUnLock(g_jsDisconnectCallback);
     g_jsDisconnectCallback = NULL;
   }
   g_jsDisconnectCallback = jsvLockAgainSafe(jsCallback);
 
+  bool setDefault = false;
+  if (jsOptions != NULL && jsvIsObject(jsOptions)) {
+    JsVar *jsDefault = jsvObjectGetChild(jsOptions, "default", 0);
+    if (jsvIsBoolean(jsDefault)) {
+      if(jsvGetBool(jsDefault)) {
+        wifi_station_set_auto_connect(0);
+      }
+    }
+    jsvUnLock(jsDefault);
+  }
+
   bool rc = wifi_station_disconnect();
   JsVar *params[1];
 
@@ -197,12 +213,17 @@ void jswrap_ESP8266_wifi_disconnect(JsVar *jsCallback) {
   "name"     : "stopAP",
   "generate" : "jswrap_ESP8266_wifi_stopAP",
   "params"   : [
+    ["options", "JsVar", "Options controlling the stop of an access point."],
     ["callback", "JsVar", "A function to be called back on completion (optional)."]
   ]
 }
 * Stop being an access point.
+* The options contain:
+* * default - A boolean.  If set to true, then the access point will be stopped at boot time.
+* The default for `default` is false which means that the start/stop of an access point at boot time
+* will not be changed.
 */
-void jswrap_ESP8266_wifi_stopAP(JsVar *jsCallback) {
+void jswrap_ESP8266_wifi_stopAP(JsVar *jsOptions, JsVar *jsCallback) {
   os_printf("> jswrap_ESP8266_wifi_stopAP\n");
 
   if (g_jsStopAPCallback != NULL) {
@@ -219,12 +240,30 @@ void jswrap_ESP8266_wifi_stopAP(JsVar *jsCallback) {
   // SOFTAP_MODE     NULL_MODE
   // STATIONAP_MODE  STATION_MODE
 
+  bool setDefault = false;
+  if (jsOptions != NULL && jsvIsObject(jsOptions)) {
+    JsVar *jsDefault = jsvObjectGetChild(jsOptions, "default", 0);
+    if (jsvIsBoolean(jsDefault)) {
+      setDefault = jsvGetBool(jsDefault);
+    }
+    jsvUnLock(jsDefault);
+  }
+
   if (currentMode == STATION_MODE || currentMode == STATIONAP_MODE) {
-    wifi_set_opmode_current(STATION_MODE);
+    if (setDefault == false) {
+      wifi_set_opmode_current(STATION_MODE);
+    } else {
+      wifi_set_opmode(STATION_MODE);
+    }
   } else {
-    wifi_set_opmode_current(NULL_MODE);
+    if (setDefault == false) {
+      wifi_set_opmode_current(NULL_MODE);
+    } else {
+      wifi_set_opmode(NULL_MODE);
+    }
   }
 
+
   // No real return code to check, so hard code to be true.
   bool rc = true;
 
@@ -258,7 +297,7 @@ void jswrap_ESP8266_wifi_stopAP(JsVar *jsCallback) {
 * Connect to an access point as a station.
 * When the outcome is known, the callback function is invoked.  The options object contains
 * properties that control the connection.  Included in this object are:
-* * autoConnect (Boolean) - When true, these settings will be used to autoConnect on next boot.
+* * default (Boolean) - When true, these settings will be used to connect on next boot.
 * * dnsServers (array of String) - An array of up to two DNS servers in dotted decimal format string.
 */
 void jswrap_ESP8266_wifi_connect(
@@ -324,21 +363,7 @@ void jswrap_ESP8266_wifi_connect(
 
  os_printf(">  - ssid=%s, password=\"%s\"\n", ssid, password);
 
- // Set the WiFi mode of the ESP8266
-
- // Current         Resulting
- // --------------  --------------
- // NULL_MODE       STATION_MODE
- // STATION_MODE    STATION_MODE
- // SOFTAP_MODE     STATIONAP_MODE
- // STATIONAP_MODE  STATIONAP_MODE
 
- uint8 currentMode = wifi_get_opmode();
- if (currentMode == SOFTAP_MODE || currentMode == STATIONAP_MODE) {
-   wifi_set_opmode_current(STATIONAP_MODE);
- } else {
-   wifi_set_opmode_current(STATION_MODE);
- }
 
  struct station_config stationConfig;
  memset(&stationConfig, 0, sizeof(stationConfig));
@@ -382,27 +407,23 @@ void jswrap_ESP8266_wifi_connect(
 #elif ISSUE_618 == 3
    // Add a return code to the function and return an already connected error.
 #endif
- }
-
-
- if (jsOptions != NULL && jsvIsObject(jsOptions)) {
-   // Do we have a child property called autoConnect?
-   JsVar *jsAutoConnect = jsvObjectGetChild(jsOptions, "autoConnect", 0);
-   if (jsvIsBoolean(jsAutoConnect)) {
-     if (jsvGetBool(jsAutoConnect) != false) {
-       // autoConnect == true
-       os_printf(" - Setting auto connect to true\n");
-       wifi_station_set_auto_connect(true);
-       // Set the WiFi configuration (includes setting default)
-       wifi_station_set_config(&stationConfig);
-     } else {
-       // autoConnect == false
-       os_printf(" - Setting auto connect to false\n");
-       wifi_station_set_auto_connect(false);
-     }
+  }
+  bool isDefault = false;
+  if (jsOptions != NULL && jsvIsObject(jsOptions)) {
+    // Do we have a child property called autoConnect?
+    JsVar *jsDefault = jsvObjectGetChild(jsOptions, "default", 0);
+    if (jsvIsBoolean(jsDefault)) {
+      isDefault = jsvGetBool(jsDefault);
+      if (isDefault) {
+        // autoConnect == true
+        os_printf(" - Setting auto connect to true\n");
+        wifi_station_set_auto_connect(true);
+        // Set the WiFi configuration (includes setting default)
+        wifi_station_set_config(&stationConfig);
+      }
    }
-   jsvUnLock(jsAutoConnect);
-   // End of autoConnect processing
+   jsvUnLock(jsDefault);
+   // End of default processing
 
    // Do we have a child property called dnsServers?
    JsVar *jsDNSServers = jsvObjectGetChild(jsOptions, "dnsServers", 0);
@@ -443,7 +464,31 @@ void jswrap_ESP8266_wifi_connect(
      }
    }
    jsvUnLock(jsDNSServers);
- } // End of dnsServers processing
+ } // End of options processing
+
+ // Set the WiFi mode of the ESP8266
+
+  // Current         Resulting
+  // --------------  --------------
+  // NULL_MODE       STATION_MODE
+  // STATION_MODE    STATION_MODE
+  // SOFTAP_MODE     STATIONAP_MODE
+  // STATIONAP_MODE  STATIONAP_MODE
+
+  uint8 currentMode = wifi_get_opmode();
+  if (currentMode == SOFTAP_MODE || currentMode == STATIONAP_MODE) {
+    if(isDefault) {
+      wifi_set_opmode(STATIONAP_MODE);
+    } else {
+      wifi_set_opmode_current(STATIONAP_MODE);
+    }
+  } else {
+    if (isDefault) {
+      wifi_set_opmode(STATION_MODE);
+    } else {
+      wifi_set_opmode_current(STATION_MODE);
+    }
+  }
 
  // Perform the network level connection.
  wifi_station_connect();
@@ -519,6 +564,7 @@ void jswrap_ESP8266_wifi_scan(
 * Create a logical access point allowing WiFi stations to connect.
 * The `options` object can contain the following properties.
 * * authMode - The authentication mode to use.  Can be one of "open", "wpa2", "wpa", "wpa_wpa2".
+* * `default` - When true, sets the creation of an access point as the default at boot.
 */
 void jswrap_ESP8266_wifi_createAP(
     JsVar *jsSsid,     //!< The network SSID that we will use to listen as.
@@ -547,6 +593,7 @@ void jswrap_ESP8266_wifi_createAP(
 
   softApConfig.authmode = (AUTH_MODE)-1;
 
+  bool isDefault = false;
   // Handle any options that may have been supplied.
   if (jsOptions != NULL && jsvIsObject(jsOptions)) {
 
@@ -576,6 +623,11 @@ void jswrap_ESP8266_wifi_createAP(
       jsvUnLock(jsAuth);
       assert(softApConfig.authmode != (AUTH_MODE)-1);
     } // End of jsAuth is present.
+
+    JsVar *jsDefault = jsvObjectGetChild(jsOptions, "default", 0);
+    if (jsvIsBoolean(jsDefault)) {
+      isDefault = jsvGetBool(jsDefault);
+    }
   } // End of jsOptions is present
 
   // If no password has been supplied, then be open.  Otherwise, use WPA2 and the
@@ -618,9 +670,17 @@ void jswrap_ESP8266_wifi_createAP(
   // STATIONAP_MODE  STATIONAP_MODE
 
   if (currentMode == STATION_MODE || currentMode == STATIONAP_MODE) {
-    wifi_set_opmode_current(STATIONAP_MODE);
+    if (isDefault) {
+      wifi_set_opmode(STATIONAP_MODE);
+    } else {
+      wifi_set_opmode_current(STATIONAP_MODE);
+    }
   } else {
-    wifi_set_opmode_current(SOFTAP_MODE);
+    if (isDefault) {
+      wifi_set_opmode(SOFTAP_MODE);
+    } else {
+      wifi_set_opmode_current(SOFTAP_MODE);
+    }
   }
 
   softApConfig.ssid_len       = 0; // Null terminated SSID

libs/network/esp8266/jswrap_esp8266.h

@@ -48,10 +48,10 @@ void   jswrap_ESP8266WiFi_stopAP();
 
 void   jswrap_ESP8266_wifi_connect(JsVar *jsSsid, JsVar *jsPassword, JsVar *jsOptions, JsVar *jsCallback);
 void   jswrap_ESP8266_wifi_createAP(JsVar *jsSsid, JsVar *jsPassword, JsVar *jsOptions, JsVar *jsCallback);
-void   jswrap_ESP8266_wifi_disconnect();
+void   jswrap_ESP8266_wifi_disconnect(JsVar *jsOptions, JsVar *jsCallback);
 JsVar *jswrap_ESP8266_wifi_getIP();
 void   jswrap_ESP8266_wifi_scan(JsVar *jsCallback);
-void   jswrap_ESP8266_wifi_stopAP(JsVar *jsCallback);
+void   jswrap_ESP8266_wifi_stopAP(JsVar *jsOptions, JsVar *jsCallback);
 
 void   jswrap_ESP8266_dumpAllSocketData();
 void   jswrap_ESP8266_dumpSocket(JsVar *jsSocketId);

libs/network/esp8266/network_esp8266.c

@@ -583,10 +583,11 @@ static void doClose(
 
 
   if (pSocketData->creationType == SOCKET_CREATED_SERVER) {
+    dumpEspConn(pSocketData->pEspconn);
     int rc = espconn_delete(pSocketData->pEspconn);
     if (rc != 0) {
       os_printf("espconn_delete: rc=%s (%d)\n",esp8266_errorToString(rc),  rc);
-      setSocketInError(socketId, "espconn_disconnect", rc);
+      setSocketInError(socketId, "espconn_delete", rc);
     }
     pSocketData->state = SOCKET_STATE_CLOSING;
   }
@@ -845,6 +846,13 @@ static void esp8266_callback_recvCB(
     pSocketData->rxBuf = pNewBuf;
     pSocketData->rxBufLen += len;
   } // End of new data allocated.
+  // Now that we have received some data, stop receiving any further data until this data is consumed.
+  /*
+  int rc = espconn_recv_hold(pEspconn);
+  if (rc != 0) {
+    os_printf(" - espconn_recv_hold: %d\n", rc);
+  }
+  */
   dumpEspConn(pEspconn);
   os_printf("<< recvCB\n");
 }
@@ -931,6 +939,13 @@ int net_ESP8266_BOARD_recv(
     os_free(pSocketData->rxBuf);
     pSocketData->rxBuf = NULL;
     //os_printf("RX - A\n");
+
+    /*
+    int rc = espconn_recv_unhold(pSocketData->pEspconn);
+    if (rc != 0) {
+      os_printf("espconn_recv_unhold: %d\n", rc);
+    }
+    */
     return retLen;
   }
 

targets/esp8266/docs/05-User_Guide.md

@@ -134,7 +134,7 @@ and
 
 Connect to a named access point.
 
-`wifi.connect(ssid, password, options, callback)`
+`wifi.connect(ssid ,password [,options [,callback]])`
 
 When called, this function places the ESP8266 in station mode.  This means that we will not be an access point.
 Once done, we then connect to the named access point using the network and password parameters supplied by `ssid` and `password`.  The optional callback is a function that is invoked when an IP address has been assigned to us meaning that we are now ready for TCP/IP based work.
@@ -146,10 +146,8 @@ Once done, we then connect to the named access point using the network and passw
 
 The `options` object can contain the following optional properties:
 
-* `autoConnect` - A boolean value.  When `true`, a reconnect to the supplied access point
-will be performed each time the ESP8266 boots.  When `false`, reconnection to the access point will not
-be attempted when the device boots.  When not set, the current `autoConnect` settings will be
-maintained.
+* `default` - A boolean value.  When `true`, a reconnect to the supplied access point
+will be performed each time the ESP8266 boots.
 * `dnsServers` - An array of strings.  Specify an array of up to two IP addresses supplied as
 dotted decimal strings.  Each entry represents the server address of a DNS server to be used for
 DNS lookups.
@@ -176,7 +174,7 @@ For example:
 
 Become an access point.
 
-`wifi.createAP(ssid [,password] [,options] [,callback])`
+`wifi.createAP(ssid [,password [,options [,callback]]])`
 
 Become an access point for the network supplied by `ssid` with a password of `password`.  If no
 password is supplied or is null, then the access point is considered open and be connected to by
@@ -186,6 +184,7 @@ eight characters in size.
 The `options` allows us to supply options.
 
 * `authMode` - The authentication mode to use.  Can be one of `open`, `wpa2`, `wpa` or `wpa_wpa2`.  If not supplied then the value will be `wpa2` if a password is supplied and `open` if no password is supplied.
+* `default` - If true then we will automatically be an access point at boot time.  The default is false in which case the current boot settings will be maintained.
 
 The `callback` is a a function with the following signature:
 
@@ -198,14 +197,20 @@ The `err` parameter is an object with properties of `errorCode` and `errorMessag
 ##wifi.disconnect
 Disconnect the ESP8266 from the access point.
 
-`wifi.disconnect(callback)`
+`wifi.disconnect([options [,callback]])`
 
 For example:
 
     var wifi = require("wifi");
     // ... connect ...
     wifi.disconnect();
 
+The optional `options` is a JavaScript object that controls the operation of this function.  It
+may be `null` if not needed.  If supplied, it may contain the following properties:
+
+* `default` - A boolean which, if set to true, will result in the device not attempt to connect on 
+subsequent boots.
+
 The optional `callback` function will be invoked when the disconnect outcome is known.  The signature of
 the callback function is:
 
@@ -266,11 +271,16 @@ For example:
 
 Don't be an access point any longer.
 
-`wifi.stopAP([callback])`
+`wifi.stopAP([options[,callback]])`
 
 If we are playing the role of an access point, stop performing that function.  Connected stations will be
 disconnected and we will no longer be visible as a WiFi network.
 
+The `options` is a JavaScript object controlling the options for the function.  It may be `null`.  The
+following properties are honored:
+
+* `default` - A boolean.  If set to true, then the access point will not be started at boot time.
+
 The optional `callback` is a callback function to be invoked when the device is no longer an
 access point.  The signature for the callback is: