Merge branch 'master' into i2c_slave_by_bjoham

Author: devyte

README.md

@@ -30,16 +30,20 @@ Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index
 
 Documentation: [https://arduino-esp8266.readthedocs.io/en/2.4.2/](https://arduino-esp8266.readthedocs.io/en/2.4.2/)
 
-### Using git version
+### Using git version (basic instructions)
 [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
 
 - Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software).
-- Go to Arduino application directory
+- Go to Arduino directory
   - For Mac OS X, it is `Arduino.app` showing as the Arduino icon.  
     This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
     ```bash
     cd <application-directory>/Arduino.app/Contents/Java
     ```
+  - For Linux, it is ~/arduino by default.
+    ```bash
+    cd ~arduino
+    ```
 - Clone this repository into hardware/esp8266com/esp8266 directory (or clone it elsewhere and create a symlink)
 ```bash
 cd hardware

boards.txt

@@ -125,7 +125,7 @@ Soft Access Point
 ~~~~~~~~~~~~~~~~~
 
 An `access point (AP) <https://en.wikipedia.org/wiki/Wireless_access_point>`__ is a device that provides access to Wi-Fi network to other devices (stations)
-and connects them further to a wired network. ESP8266 can provide similar functionality except it does not have interface to a wired network. Such mode of operation is called soft access point (soft-AP). The maximum number of stations that can simultaneously be connected to the soft-AP can be set `from 1 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__, but defaults to 4.
+and connects them further to a wired network. ESP8266 can provide similar functionality except it does not have interface to a wired network. Such mode of operation is called soft access point (soft-AP). The maximum number of stations that can simultaneously be connected to the soft-AP can be set `from 0 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__, but defaults to 4.
 
 .. figure:: pictures/esp8266-soft-access-point.png
    :alt: ESP8266 operating in the Soft Access Point mode
@@ -293,7 +293,7 @@ What's Inside?
 
 If you like to analyze in detail what is inside of the ESP8266WiFi library, go directly to the `ESP8266WiFi <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi/src>`__ folder of esp8266 / Arduino repository on the GitHub.
 
-To make the analysis easier, rather than looking into individual header or source files, use one of free tools to automatically generate documentation. The class index in chapter `Class Description <class-description>`__ above has been prepared in no time using great `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`__, that is the de facto standard tool for generating documentation from annotated C++ sources.
+To make the analysis easier, rather than looking into individual header or source files, use one of free tools to automatically generate documentation. The class index in chapter `Class Description`_ above has been prepared in no time using great `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`__, that is the de facto standard tool for generating documentation from annotated C++ sources.
 
 .. figure:: pictures/doxygen-esp8266wifi-documentation.png
    :alt: Example of documentation prepared by Doxygen

doc/esp8266wifi/readme.rst

@@ -54,7 +54,7 @@ Meaning of all parameters is as follows:
 - ``password`` - optional character string with a password. For WPA2-PSK network it should be at least 8 character long. If not specified, the access point will be open for anybody to connect. 
 - ``channel`` - optional parameter to set Wi-Fi channel, from 1 to 13. Default channel = 1. 
 - ``hidden`` - optional parameter, if set to ``true`` will hide SSID. 
-- ``max_connection`` - optional parameter to set max simultaneous connected stations, `from 1 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__. Defaults to 4. Once the max number has been reached, any other station that wants to connect will be forced to wait until an already connected station disconnects.
+- ``max_connection`` - optional parameter to set max simultaneous connected stations, `from 0 to 8 <https://bbs.espressif.com/viewtopic.php?f=46&t=481&p=1832&hilit=max_connection#p1832>`__. Defaults to 4. Once the max number has been reached, any other station that wants to connect will be forced to wait until an already connected station disconnects.
 
 Function will return ``true`` or ``false`` depending on result of setting the soft-AP.
 
@@ -141,7 +141,7 @@ Get the count of the stations that are connected to the soft-AP interface.
 
     Stations connected to soft-AP = 2
 
-Note: the maximum number of stations that may be connected to ESP8266 soft-AP is 4 by default. This can be changed from 1 to 8 via the ``max_connection`` argument of the softAP method.
+Note: the maximum number of stations that may be connected to ESP8266 soft-AP is 4 by default. This can be changed from 0 to 8 via the ``max_connection`` argument of the softAP method.
 
 softAPdisconnect
 ^^^^^^^^^^^^^^^^

doc/esp8266wifi/soft-access-point-class.rst

@@ -0,0 +1,45 @@
+#######################################
+# Syntax Coloring Map For DNSServer
+#######################################
+
+#######################################
+# Library (KEYWORD3)
+#######################################
+
+DNSServer	KEYWORD3		RESERVED_WORD
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+DNSReplyCode	KEYWORD1		DATA_TYPE
+DNSHeader	KEYWORD1		DATA_TYPE
+DNSServer	KEYWORD1		DATA_TYPE
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+processNextRequest	KEYWORD2
+setErrorReplyCode	KEYWORD2
+setTTL	KEYWORD2
+start	KEYWORD2
+stop	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
+DNS_QR_QUERY	LITERAL1		RESERVED_WORD_2
+DNS_QR_RESPONSE	LITERAL1		RESERVED_WORD_2
+DNS_OPCODE_QUERY	LITERAL1		RESERVED_WORD_2
+MAX_DNSNAME_LENGTH	LITERAL1		RESERVED_WORD_2
+NoError	LITERAL1		RESERVED_WORD_2
+FormError	LITERAL1		RESERVED_WORD_2
+ServerFailure	LITERAL1		RESERVED_WORD_2
+NonExistentDomain	LITERAL1		RESERVED_WORD_2
+NotImplemented	LITERAL1		RESERVED_WORD_2
+Refused	LITERAL1		RESERVED_WORD_2
+YXDomain	LITERAL1		RESERVED_WORD_2
+YXRRSet	LITERAL1		RESERVED_WORD_2
+NXRRSet	LITERAL1		RESERVED_WORD_2

libraries/DNSServer/keywords.txt

@@ -1,5 +1,5 @@
 name=DNSServer
-version=1.1.0
+version=1.1.1
 author=Kristijan Novoselić
 maintainer=Kristijan Novoselić, <[email protected]>
 sentence=A simple DNS server for ESP8266.

libraries/DNSServer/library.properties

@@ -13,7 +13,7 @@ bool DNSServer::start(const uint16_t &port, const String &domainName,
                      const IPAddress &resolvedIP)
 {
   _port = port;
-  _buffer = NULL;
+  
   _domainName = domainName;
   _resolvedIP[0] = resolvedIP[0];
   _resolvedIP[1] = resolvedIP[1];
@@ -36,8 +36,6 @@ void DNSServer::setTTL(const uint32_t &ttl)
 void DNSServer::stop()
 {
   _udp.stop();
-  free(_buffer);
-  _buffer = NULL;
 }
 
 void DNSServer::downcaseAndRemoveWwwPrefix(String &domainName)
@@ -48,82 +46,106 @@ void DNSServer::downcaseAndRemoveWwwPrefix(String &domainName)
 
 void DNSServer::processNextRequest()
 {
-  _currentPacketSize = _udp.parsePacket();
-  if (_currentPacketSize)
+  size_t packetSize = _udp.parsePacket();
+
+  if (packetSize >= sizeof(DNSHeader))
   {
-    if (_buffer != NULL) free(_buffer);
-    _buffer = (unsigned char*)malloc(_currentPacketSize * sizeof(char));
-    if (_buffer == NULL) return;
-    _udp.read(_buffer, _currentPacketSize);
-    _dnsHeader = (DNSHeader*) _buffer;
-
-    if (_dnsHeader->QR == DNS_QR_QUERY &&
-        _dnsHeader->OPCode == DNS_OPCODE_QUERY &&
-        requestIncludesOnlyOneQuestion() &&
-        (_domainName == "*" || getDomainNameWithoutWwwPrefix() == _domainName)
+    uint8_t* buffer = reinterpret_cast<uint8_t*>(malloc(packetSize));
+    if (buffer == NULL) return;
+
+    _udp.read(buffer, packetSize);
+
+    DNSHeader* dnsHeader = reinterpret_cast<DNSHeader*>(buffer);
+
+    if (dnsHeader->QR == DNS_QR_QUERY &&
+        dnsHeader->OPCode == DNS_OPCODE_QUERY &&
+        requestIncludesOnlyOneQuestion(dnsHeader) &&
+        (_domainName == "*" || getDomainNameWithoutWwwPrefix(buffer, packetSize) == _domainName)
        )
     {
-      replyWithIP();
+      replyWithIP(buffer, packetSize);
     }
-    else if (_dnsHeader->QR == DNS_QR_QUERY)
+    else if (dnsHeader->QR == DNS_QR_QUERY)
     {
-      replyWithCustomCode();
+      replyWithCustomCode(buffer, packetSize);
     }
 
-    free(_buffer);
-    _buffer = NULL;
+    free(buffer);
   }
 }
 
-bool DNSServer::requestIncludesOnlyOneQuestion()
+bool DNSServer::requestIncludesOnlyOneQuestion(const DNSHeader* dnsHeader)
 {
-  return ntohs(_dnsHeader->QDCount) == 1 &&
-         _dnsHeader->ANCount == 0 &&
-         _dnsHeader->NSCount == 0 &&
-         _dnsHeader->ARCount == 0;
+  return ntohs(dnsHeader->QDCount) == 1 &&
+         dnsHeader->ANCount == 0 &&
+         dnsHeader->NSCount == 0 &&
+         dnsHeader->ARCount == 0;
 }
 
-String DNSServer::getDomainNameWithoutWwwPrefix()
+String DNSServer::getDomainNameWithoutWwwPrefix(const uint8_t* buffer, size_t packetSize)
 {
-  String parsedDomainName = "";
-  if (_buffer == NULL) return parsedDomainName;
-  unsigned char *start = _buffer + 12;
-  if (*start == 0)
-  {
-    return parsedDomainName;
-  }
-  int pos = 0;
-  while(true)
+  String parsedDomainName;
+  
+  const uint8_t* pos = buffer + sizeof(DNSHeader);
+  const uint8_t* end = buffer + packetSize;
+
+  // to minimize reallocations due to concats below
+  // we reserve enough space that a median or average domain
+  // name size cold be easily contained without a reallocation
+  // - max size would be 253, in 2013, average is 11 and max was 42
+  //
+  parsedDomainName.reserve(32); 
+
+  uint8_t labelLength = *pos;
+
+  while (true)
   {
-    unsigned char labelLength = *(start + pos);
-    for(int i = 0; i < labelLength; i++)
+    if (labelLength == 0)
+    {
+        // no more labels
+        downcaseAndRemoveWwwPrefix(parsedDomainName);
+        return parsedDomainName;
+    }
+
+    // append next label
+    for (int i = 0; i < labelLength && pos < end; i++)
     {
       pos++;
-      parsedDomainName += (char)*(start + pos);
+      parsedDomainName += static_cast<char>(*pos);
     }
-    pos++;
-    if (*(start + pos) == 0)
+
+    if (pos >= end)
     {
-      downcaseAndRemoveWwwPrefix(parsedDomainName);
-      return parsedDomainName;
+        // malformed packet, return an empty domain name
+        parsedDomainName = "";
+        return parsedDomainName;
     }
     else
     {
-      parsedDomainName += ".";
+        // next label
+        pos++;
+        labelLength = *pos;
+
+        // if there is another label, add delimiter
+        if (labelLength != 0)
+        {
+            parsedDomainName += ".";
+        }
     }
   }
 }
 
-void DNSServer::replyWithIP()
+void DNSServer::replyWithIP(uint8_t* buffer, size_t packetSize)
 {
-  if (_buffer == NULL) return;
-  _dnsHeader->QR = DNS_QR_RESPONSE;
-  _dnsHeader->ANCount = _dnsHeader->QDCount;
-  _dnsHeader->QDCount = _dnsHeader->QDCount; 
-  //_dnsHeader->RA = 1;  
+  DNSHeader* dnsHeader = reinterpret_cast<DNSHeader*>(buffer);
+
+  dnsHeader->QR = DNS_QR_RESPONSE;
+  dnsHeader->ANCount = dnsHeader->QDCount;
+  dnsHeader->QDCount = dnsHeader->QDCount; 
+  //dnsHeader->RA = 1;  
 
   _udp.beginPacket(_udp.remoteIP(), _udp.remotePort());
-  _udp.write(_buffer, _currentPacketSize);
+  _udp.write(buffer, packetSize);
 
   _udp.write((uint8_t)192); //  answer name is a pointer
   _udp.write((uint8_t)12);  // pointer to offset at 0x00c
@@ -142,22 +164,26 @@ void DNSServer::replyWithIP()
   _udp.write(_resolvedIP, sizeof(_resolvedIP));
   _udp.endPacket();
 
-
-
   #ifdef DEBUG_ESP_DNS
     DEBUG_ESP_PORT.printf("DNS responds: %s for %s\n",
-            IPAddress(_resolvedIP).toString().c_str(), getDomainNameWithoutWwwPrefix().c_str() );
+            IPAddress(_resolvedIP).toString().c_str(), getDomainNameWithoutWwwPrefix(buffer, packetSize).c_str() );
   #endif
 }
 
-void DNSServer::replyWithCustomCode()
+void DNSServer::replyWithCustomCode(uint8_t* buffer, size_t packetSize)
 {
-  if (_buffer == NULL) return;
-  _dnsHeader->QR = DNS_QR_RESPONSE;
-  _dnsHeader->RCode = (unsigned char)_errorReplyCode;
-  _dnsHeader->QDCount = 0;
+  if (packetSize < sizeof(DNSHeader))
+  {
+    return;
+  }
+
+  DNSHeader* dnsHeader = reinterpret_cast<DNSHeader*>(buffer);
+
+  dnsHeader->QR = DNS_QR_RESPONSE;
+  dnsHeader->RCode = (unsigned char)_errorReplyCode;
+  dnsHeader->QDCount = 0;
 
   _udp.beginPacket(_udp.remoteIP(), _udp.remotePort());
-  _udp.write(_buffer, sizeof(DNSHeader));
+  _udp.write(buffer, sizeof(DNSHeader));
   _udp.endPacket();
 }

libraries/DNSServer/src/DNSServer.cpp

@@ -6,6 +6,8 @@
 #define DNS_QR_RESPONSE 1
 #define DNS_OPCODE_QUERY 0
 
+#define MAX_DNSNAME_LENGTH 253
+
 enum class DNSReplyCode
 {
   NoError = 0,
@@ -40,6 +42,9 @@ class DNSServer
 {
   public:
     DNSServer();
+    ~DNSServer() {
+        stop();
+    };
     void processNextRequest();
     void setErrorReplyCode(const DNSReplyCode &replyCode);
     void setTTL(const uint32_t &ttl);
@@ -56,16 +61,13 @@ class DNSServer
     uint16_t _port;
     String _domainName;
     unsigned char _resolvedIP[4];
-    int _currentPacketSize;
-    unsigned char* _buffer;
-    DNSHeader* _dnsHeader;
     uint32_t _ttl;
     DNSReplyCode _errorReplyCode;
 
     void downcaseAndRemoveWwwPrefix(String &domainName);
-    String getDomainNameWithoutWwwPrefix();
-    bool requestIncludesOnlyOneQuestion();
-    void replyWithIP();
-    void replyWithCustomCode();
+    String getDomainNameWithoutWwwPrefix(const uint8_t* buffer, size_t packetSize);
+    bool requestIncludesOnlyOneQuestion(const DNSHeader* dnsHeader);
+    void replyWithIP(uint8_t* buffer, size_t packetSize);
+    void replyWithCustomCode(uint8_t* buffer, size_t packetSize);
 };
 #endif

libraries/DNSServer/src/DNSServer.h

@@ -0,0 +1,35 @@
+#######################################
+# Syntax Coloring Map For ESP8266AVRISP
+#######################################
+
+#######################################
+# Library (KEYWORD3)
+#######################################
+
+ESP8266AVRISP	KEYWORD3		RESERVED_WORD
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+AVRISPState_t	KEYWORD1		DATA_TYPE
+AVRISP_parameter_t	KEYWORD1		DATA_TYPE
+ESP8266AVRISP	KEYWORD1		DATA_TYPE
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+begin	KEYWORD2
+setSpiFrequency	KEYWORD2
+setReset	KEYWORD2
+update	KEYWORD2
+serve	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
+AVRISP_STATE_IDLE	LITERAL1		RESERVED_WORD_2
+AVRISP_STATE_PENDING	LITERAL1		RESERVED_WORD_2
+AVRISP_STATE_ACTIVE	LITERAL1		RESERVED_WORD_2