Merge branch 'master' into bug-esp8266#3795

Author: devyte

Diff for: cores/esp8266/uart.c

@@ -104,6 +104,9 @@ int uart_peek_char(uart_t* uart)
 
 int uart_read_char(uart_t* uart)
 {
+    if(uart == NULL) {
+        return -1;
+    }
     int data = uart_peek_char(uart);
     if(data != -1) {
         uart->rx_buffer->rpos = (uart->rx_buffer->rpos + 1) % uart->rx_buffer->size;

Diff for: doc/boards.rst

@@ -58,7 +58,7 @@ This module is sold under many names for around $6.50 on AliExpress and it's one
 
 It's an open hardware design with an ESP-12E core and 4 MB of SPI flash.
 
-Acording to the manufacturer, "with a micro USB cable, you can connect NodeMCU devkit to your laptop and flash it without any trouble". This is more or less true: the board comes with a CP2102 onboard USB to serial adapter which just works, well, the majority of the time. Sometimes flashing fails and you have to reset the board by holding down FLASH +
+According to the manufacturer, "with a micro USB cable, you can connect NodeMCU devkit to your laptop and flash it without any trouble". This is more or less true: the board comes with a CP2102 onboard USB to serial adapter which just works, well, the majority of the time. Sometimes flashing fails and you have to reset the board by holding down FLASH +
 RST, then releasing FLASH, then releasing RST. This forces the CP2102 device to power cycle and to be re-numbered by Linux.
 
 The board also features a NCP1117 voltage regulator, a blue LED on GPIO16 and a 220k/100k Ohm voltage divider on the ADC input pin.

Diff for: doc/reference.rst

@@ -94,10 +94,11 @@ Serial
 ------
 
 ``Serial`` object works much the same way as on a regular Arduino. Apart
-from hardware FIFO (128 bytes for TX and RX) HardwareSerial has
+from hardware FIFO (128 bytes for TX and RX) ``Serial`` has
 additional 256-byte TX and RX buffers. Both transmit and receive is
 interrupt-driven. Write and read functions only block the sketch
-execution when the respective FIFO/buffers are full/empty.
+execution when the respective FIFO/buffers are full/empty. Note that
+the length of additional 256-bit buffer can be customized.
 
 ``Serial`` uses UART0, which is mapped to pins GPIO1 (TX) and GPIO3
 (RX). Serial may be remapped to GPIO15 (TX) and GPIO13 (RX) by calling
@@ -121,6 +122,9 @@ instead, call ``Serial1.setDebugOutput(true)``.
 You also need to use ``Serial.setDebugOutput(true)`` to enable output
 from ``printf()`` function.
 
+The method ``Serial.setRxBufferSize(size_t size)`` allows to define the
+receiving buffer depth. The default value is 256.
+
 Both ``Serial`` and ``Serial1`` objects support 5, 6, 7, 8 data bits,
 odd (O), even (E), and no (N) parity, and 1 or 2 stop bits. To set the
 desired mode, call ``Serial.begin(baudrate, SERIAL_8N1)``,
@@ -142,6 +146,8 @@ current speed. For example
     // Will print "Serial is 57600 bps"
     Serial.printf("Serial is %d bps", br);
 
+| ``Serial`` and ``Serial1`` objects are both instances of the
+  ``HardwareSerial`` class.
 | I've done this also for official ESP8266 `Software
   Serial <https://github.com/esp8266/Arduino/blob/master/doc/libraries.md#softwareserial>`__
   library, see this `pull

Diff for: libraries/ESP8266WiFi/src/ESP8266WiFiGeneric.cpp

@@ -303,6 +303,13 @@ void ESP8266WiFiGenericClass::persistent(bool persistent) {
     _persistent = persistent;
 }
 
+/**
+ * gets the persistent state
+ * @return bool
+ */
+bool ESP8266WiFiGenericClass::getPersistent(){
+    return _persistent;
+}
 
 /**
  * set new mode

Diff for: libraries/ESP8266WiFi/src/ESP8266WiFiGeneric.h

@@ -99,7 +99,7 @@ class ESP8266WiFiGenericClass {
 
         int hostByName(const char* aHostname, IPAddress& aResult);
         int hostByName(const char* aHostname, IPAddress& aResult, uint32_t timeout_ms);
-
+        bool getPersistent();
     protected:
 
         friend class ESP8266WiFiSTAClass;

Diff for: libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp

@@ -195,6 +195,14 @@ wl_status_t ESP8266WiFiSTAClass::begin() {
     return status();
 }
 
+static void
+swap(IPAddress &lhs, IPAddress &rhs)
+{
+  IPAddress tmp = lhs;
+  lhs = rhs;
+  rhs = tmp;
+}
+
 
 /**
  * Change IP configuration settings disabling the dhcp client
@@ -210,6 +218,22 @@ bool ESP8266WiFiSTAClass::config(IPAddress local_ip, IPAddress gateway, IPAddres
         return false;
     }
 
+    //Arduino has a different arg order: ip, dns, gateway, subnet. To allow compatibility, check first octet of 3rd arg. If 255, interpret as ESP order, otherwise Arduino order.
+    if(subnet[0] != 255)
+    {
+      //octet is not 255 => interpret as Arduino order
+
+      if(dns1[0] == 0)
+      {
+        //arg order is arduino and 4th arg not given => assign it arduino default
+        dns1 = IPAddress(255,255,255,0);
+      }
+
+      //current order is arduino:                   ip-dns-gway-subnet
+      swap(gateway, subnet); //after this, order is ip-gway-dns-subnet
+      swap(subnet, dns1);    //after this, order is ip-gway-subnet-dns (correct ESP order)
+    } 
+
     struct ip_info info;
     info.ip.addr = static_cast<uint32_t>(local_ip);
     info.gw.addr = static_cast<uint32_t>(gateway);

Diff for: libraries/ESP8266WiFi/src/ESP8266WiFiSTA.h

@@ -39,6 +39,9 @@ class ESP8266WiFiSTAClass {
         wl_status_t begin(char* ssid, char *passphrase = NULL, int32_t channel = 0, const uint8_t* bssid = NULL, bool connect = true);
         wl_status_t begin();
 
+        //The argument order for ESP is not the same as for Arduino. However, there is compatibility code under the hood 
+        //to detect Arduino arg order, and handle it correctly. Be aware that the Arduino default value handling doesn't 
+        //work here (see Arduino docs for gway/subnet defaults). In other words: at least 3 args must always be given.
         bool config(IPAddress local_ip, IPAddress gateway, IPAddress subnet, IPAddress dns1 = (uint32_t)0x00000000, IPAddress dns2 = (uint32_t)0x00000000);
 
         bool reconnect();