Merge branch 'master' into new_timer1_irq

Author: earlephilhower

boards.txt

@@ -3811,7 +3811,7 @@ gen4iod.menu.VTable.heap.build.vtable_flags=-DVTABLES_IN_DRAM
 gen4iod.menu.VTable.iram=IRAM
 gen4iod.menu.VTable.iram.build.vtable_flags=-DVTABLES_IN_IRAM
 gen4iod.upload.resetmethod=nodemcu
-gen4iod.build.flash_mode=qio
+gen4iod.build.flash_mode=dio
 gen4iod.build.flash_freq=80
 gen4iod.menu.FlashSize.512K0=512K (no SPIFFS)
 gen4iod.menu.FlashSize.512K0.build.flash_size=512K

cores/esp8266/avr/pgmspace.h

@@ -0,0 +1 @@
+#include "../pgmspace.h"

cores/esp8266/pgmspace.h

@@ -29,6 +29,8 @@ extern "C" {
 
 #define _SFR_BYTE(n) (n)
 
+#ifdef __PROG_TYPES_COMPAT__
+
 typedef void prog_void;
 typedef char prog_char;
 typedef unsigned char prog_uchar;
@@ -39,6 +41,8 @@ typedef uint16_t prog_uint16_t;
 typedef int32_t prog_int32_t;
 typedef uint32_t prog_uint32_t;
 
+#endif // defined(__PROG_TYPES_COMPAT__)
+
 #define SIZE_IRRELEVANT 0x7fffffff
 
 // memchr_P and memrchr_P are not implemented due to danger in its use, and
@@ -112,8 +116,13 @@ static inline uint16_t pgm_read_word_inlined(const void* addr) {
 }
 
 // Make sure, that libraries checking existence of this macro are not failing
+#ifdef __PROG_TYPES_COMPAT__
+#define pgm_read_byte(addr) pgm_read_byte_inlined((const void*)(addr))
+#define pgm_read_word(addr) pgm_read_word_inlined((const void*)(addr))
+#else
 #define pgm_read_byte(addr) pgm_read_byte_inlined(addr)
 #define pgm_read_word(addr) pgm_read_word_inlined(addr)
+#endif
 
 #else //__ets__
 #define pgm_read_byte(addr)     (*reinterpret_cast<const uint8_t*>(addr))

doc/esp8266wifi/udp-examples.rst

@@ -36,7 +36,7 @@ Once we have libraries in place we need to create a ``WiFiUDP`` object. Then we
     WiFiUDP Udp;
     unsigned int localUdpPort = 4210;
     char incomingPacket[255];
-    char  replyPacekt[] = "Hi there! Got the message :-)";
+    char replyPacket[] = "Hi there! Got the message :-)";
 
 Wi-Fi Connection
 ~~~~~~~~~~~~~~~~
@@ -85,7 +85,7 @@ For each received packet we are sending back an acknowledge packet:
 .. code:: cpp
 
     Udp.beginPacket(Udp.remoteIP(), Udp.remotePort());
-    Udp.write(replyPacekt);
+    Udp.write(replyPacket);
     Udp.endPacket();
 
 Please note we are sending reply to the IP and port of the sender by using ``Udp.remoteIP()`` and ``Udp.remotePort()``.

doc/libraries.rst

@@ -71,7 +71,7 @@ ESP-specific APIs
 
 Some ESP-specific APIs related to deep sleep, RTC and flash memories are available in the ``ESP`` object.
 
-``ESP.deepSleep(microseconds, mode)`` will put the chip into deep sleep. ``mode`` is one of ``WAKE_RF_DEFAULT``, ``WAKE_RFCAL``, ``WAKE_NO_RFCAL``, ``WAKE_RF_DISABLED``. (GPIO16 needs to be tied to RST to wake from deepSleep.)
+``ESP.deepSleep(microseconds, mode)`` will put the chip into deep sleep. ``mode`` is one of ``WAKE_RF_DEFAULT``, ``WAKE_RFCAL``, ``WAKE_NO_RFCAL``, ``WAKE_RF_DISABLED``. (GPIO16 needs to be tied to RST to wake from deepSleep.) The chip can sleep for at most ``ESP.deepSleepMax()`` microseconds.
 
 ``ESP.rtcUserMemoryWrite(offset, &data, sizeof(data))`` and ``ESP.rtcUserMemoryRead(offset, &data, sizeof(data))`` allow data to be stored in and retrieved from the RTC user memory of the chip respectively. Total size of RTC user memory is 512 bytes, so ``offset + sizeof(data)`` shouldn't exceed 512. Data should be 4-byte aligned. The stored data can be retained between deep sleep cycles. However, the data might be lost after power cycling the chip.
 
@@ -135,6 +135,14 @@ Servo
 
 This library exposes the ability to control RC (hobby) servo motors. It will support up to 24 servos on any available output pin. By default the first 12 servos will use Timer0 and currently this will not interfere with any other support. Servo counts above 12 will use Timer1 and features that use it will be affected. While many RC servo motors will accept the 3.3V IO data pin from a ESP8266, most will not be able to run off 3.3v and will require another power source that matches their specifications. Make sure to connect the grounds between the ESP8266 and the servo motor power supply.
 
+Improved EEPROM library for ESP (ESP_EEPROM)
+--------------------------------------------
+
+An improved EEPROM library for ESPxxxx.  Uses flash memory as per the standard ESP EEPROM library but reduces reflash - so reducing wear and improving commit() performance.  
+
+As actions on the flash need to stop the interrupts, an EEPROM reflash could noticably affect anything using PWM, etc.
+
+
 Other libraries (not included with the IDE)
 -------------------------------------------
 

libraries/ESP8266WiFi/src/ESP8266WiFiScan.cpp

@@ -64,9 +64,11 @@ std::function<void(int)> ESP8266WiFiScanClass::_onComplete;
  * Start scan WiFi networks available
  * @param async         run in async mode
  * @param show_hidden   show hidden networks
+ * @param channel       scan only this channel (0 for all channels)
+ * @param ssid*         scan for only this ssid (NULL for all ssid's)
  * @return Number of discovered networks
  */
-int8_t ESP8266WiFiScanClass::scanNetworks(bool async, bool show_hidden) {
+int8_t ESP8266WiFiScanClass::scanNetworks(bool async, bool show_hidden, uint8 channel, uint8* ssid) {
     if(ESP8266WiFiScanClass::_scanStarted) {
         return WIFI_SCAN_RUNNING;
     }
@@ -84,6 +86,8 @@ int8_t ESP8266WiFiScanClass::scanNetworks(bool async, bool show_hidden) {
 
     struct scan_config config;
     memset(&config, 0, sizeof(config));
+    config.ssid = ssid;
+    config.channel = channel;
     config.show_hidden = show_hidden;
     if(wifi_station_scan(&config, reinterpret_cast<scan_done_cb_t>(&ESP8266WiFiScanClass::_scanDone))) {
         ESP8266WiFiScanClass::_scanComplete = false;

libraries/ESP8266WiFi/src/ESP8266WiFiScan.h

@@ -34,7 +34,7 @@ class ESP8266WiFiScanClass {
 
     public:
 
-        int8_t scanNetworks(bool async = false, bool show_hidden = false);
+        int8_t scanNetworks(bool async = false, bool show_hidden = false, uint8 channel = 0, uint8* ssid = NULL);
         void scanNetworksAsync(std::function<void(int)> onComplete, bool show_hidden = false);
 
         int8_t scanComplete();

libraries/ESP8266WiFi/src/WiFiClient.cpp

@@ -280,7 +280,7 @@ void WiFiClient::stop()
 
 uint8_t WiFiClient::connected()
 {
-    if (!_client)
+    if (!_client || _client->state() == CLOSED)
         return 0;
 
     return _client->state() == ESTABLISHED || available();

libraries/ESP8266WiFi/src/include/ClientContext.h

@@ -40,7 +40,7 @@ class ClientContext
         tcp_setprio(pcb, TCP_PRIO_MIN);
         tcp_arg(pcb, this);
         tcp_recv(pcb, &_s_recv);
-        tcp_sent(pcb, &_s_sent);
+        tcp_sent(pcb, &_s_acked);
         tcp_err(pcb, &_s_error);
         tcp_poll(pcb, &_s_poll, 1);
 
@@ -58,7 +58,7 @@ class ClientContext
             tcp_err(_pcb, NULL);
             tcp_poll(_pcb, NULL, 0);
             tcp_abort(_pcb);
-            _pcb = 0;
+            _pcb = nullptr;
         }
         return ERR_ABRT;
     }
@@ -79,7 +79,7 @@ class ClientContext
                 tcp_abort(_pcb);
                 err = ERR_ABRT;
             }
-            _pcb = 0;
+            _pcb = nullptr;
         }
         return err;
     }
@@ -471,11 +471,11 @@ class ClientContext
         }
     }
 
-    err_t _sent(tcp_pcb* pcb, uint16_t len)
+    err_t _acked(tcp_pcb* pcb, uint16_t len)
     {
         (void) pcb;
         (void) len;
-        DEBUGV(":sent %d\r\n", len);
+        DEBUGV(":ack %d\r\n", len);
         _write_some_from_cb();
         return ERR_OK;
     }
@@ -536,7 +536,7 @@ class ClientContext
         tcp_sent(_pcb, NULL);
         tcp_recv(_pcb, NULL);
         tcp_err(_pcb, NULL);
-        _pcb = NULL;
+        _pcb = nullptr;
         _notify_error();
     }
 
@@ -571,9 +571,9 @@ class ClientContext
         return reinterpret_cast<ClientContext*>(arg)->_poll(tpcb);
     }
 
-    static err_t _s_sent(void *arg, struct tcp_pcb *tpcb, uint16_t len)
+    static err_t _s_acked(void *arg, struct tcp_pcb *tpcb, uint16_t len)
     {
-        return reinterpret_cast<ClientContext*>(arg)->_sent(tpcb, len);
+        return reinterpret_cast<ClientContext*>(arg)->_acked(tpcb, len);
     }
 
     static err_t _s_connected(void* arg, struct tcp_pcb *pcb, err_t err)

package/build_boards_manager_package.sh

@@ -61,7 +61,7 @@ rm exclude.txt
 # Get additional libraries (TODO: add them as git submodule or subtree?)
 
 # SoftwareSerial library
-curl -L -o SoftwareSerial.zip https://github.com/plerup/espsoftwareserial/archive/3.3.1.zip
+curl -L -o SoftwareSerial.zip https://github.com/plerup/espsoftwareserial/archive/3.4.1.zip
 unzip -q SoftwareSerial.zip
 rm -rf SoftwareSerial.zip
 mv espsoftwareserial-* SoftwareSerial

tests/README.md

@@ -106,7 +106,14 @@ BSTest library also contains a Python script which can "talk" to the ESP8266 boa
 
 ### Test configuration
 
-Some tests need to connect to WiFi AP or to the PC running the tests. This configuration should be set in tests/device/libraries/test_config/test_config.h. This file is not tracked in Git. Create it by copying from tests/device/libraries/test_config/test_config.h.template, and modifying settings in that file.
+Some tests need to connect to WiFi AP or to the PC running the tests. In the test code, this configuration is read from environment variables (the ones set using C `getenv`/`setenv` functions). There are two ways environment variables can be set.
+
+- Environment variables which apply to all or most of the tests can be defined in `tests/device/test_env.cfg` file. This file is not present in Git by default. Make a copy of `tests/device/test_env.cfg.template` and change the values to suit your environment.
+
+- Environment variables which apply to a specific test can be set dynamically by the `setup` host side helper (see section below). This is done using `setenv` function defined in `mock_decorators`.
+
+Environment variables can also be used to pass some information from the test code to the host side helper. To do that, test code can set an environment variable using `setenv` C function. Then the `teardown` host side helper can obtain the value of that variable using `request_env` function defined in `mock_decorators`.
+
 
 ### Building and running the tests
 
@@ -135,15 +142,41 @@ Here are some of the supported targets:
 Some tests running on the device need a matching part running on the host. For example, HTTP client test might need a web server running on the host to connect to. TCP server test might need to be connected to by TCP client running on the host. To support such use cases, for each test file, an optional Python test file can be provided. This Python file defines setup and teardown functions which have to be run before and after the test is run on the device. `setup` and `teardown` decorators bind setup/teardown functions to the test with specified name:
 
 ```python
-from mock_decorators import setup, teardown
+from mock_decorators import setup, teardown, setenv, request_env
 
 @setup('WiFiClient test')
 def setup_wificlient_test(e):
     # create a TCP server
+    # pass environment variable to the test
+    setenv(e, 'SERVER_PORT', '10000')
+    setenv(e, 'SERVER_IP', repr(server_ip))
 
 @teardown('WiFiClient test')
 def teardown_wificlient_test(e):
     # delete TCP server
+    # request environment variable from the test, compare to the expected value
+    read_bytes = request_env(e, 'READ_BYTES')
+    assert(read_bytes == '4096')
+```
+
+Corresponding test code might look like this:
+
+```c++
+
+TEST_CASE("WiFiClient test", "[wificlient]")
+{
+    const char* server_ip = getenv("SERVER_IP");
+    int server_port = (int) strtol(getenv("SERVER_PORT"), NULL, 0);
+
+    WiFiClient client;
+    REQUIRE(client.connect(server_ip, server_port));
+
+    // read data from server
+    // ...
+
+    // Save the result back so that host side helper can read it
+    setenv("READ_BYTES", String(read_bytes).c_str(), 1);
+}
 ```
 
 

tests/device/.gitignore

@@ -2,3 +2,4 @@
 .hardware
 test_report.xml
 test_report.html
+test_env.cfg

tests/device/Makefile

@@ -12,17 +12,10 @@ BS_DIR ?= libraries/BSTest
 DEBUG_LEVEL ?= DebugLevel=None____
 FQBN ?= esp8266com:esp8266:generic:CpuFrequency=80,FlashFreq=40,FlashMode=dio,UploadSpeed=115200,FlashSize=4M1M,LwIPVariant=v2mss536,ResetMethod=none,Debug=Serial,$(DEBUG_LEVEL)
 BUILD_TOOL := $(ARDUINO_IDE_PATH)/arduino-builder
-TEST_CONFIG := libraries/test_config/test_config.h
+TEST_CONFIG := test_env.cfg
 TEST_REPORT_XML := test_report.xml
 TEST_REPORT_HTML := test_report.html
 
-ifeq ("$(UPLOAD_PORT)","")
-$(error "Failed to detect upload port, please export UPLOAD_PORT manually")
-endif
-
-ifeq ("$(ARDUINO_IDE_PATH)","")
-$(error "Please export ARDUINO_IDE_PATH")
-endif
 
 ifneq ("$(V)","1")
 	SILENT = @
@@ -35,16 +28,17 @@ endif
 
 all: count tests test_report
 
-count:
-	@echo Running $(words $(TEST_LIST)) tests
+$(TEST_LIST): | virtualenv $(TEST_CONFIG) $(BUILD_DIR) $(HARDWARE_DIR)
 
-tests: $(BUILD_DIR) $(HARDWARE_DIR) virtualenv $(TEST_CONFIG) $(TEST_LIST)
+tests: $(TEST_LIST)
 
 $(TEST_LIST): LOCAL_BUILD_DIR=$(BUILD_DIR)/$(notdir $@)
 
 $(TEST_LIST):
+	@echo Running $(words $(TEST_LIST)) tests
 	$(SILENT)mkdir -p $(LOCAL_BUILD_DIR)
 ifneq ("$(NO_BUILD)","1")
+	@test -n "$(ARDUINO_IDE_PATH)" || (echo "Please export ARDUINO_IDE_PATH" && exit 1)
 	@echo Compiling $(notdir $@)
 	$(SILENT)$(BUILD_TOOL) -compile -logger=human \
 		-libraries "$(PWD)/libraries" \
@@ -59,6 +53,7 @@ ifneq ("$(NO_BUILD)","1")
 		$@
 endif
 ifneq ("$(NO_UPLOAD)","1")
+	@test -n "$(UPLOAD_PORT)" || (echo "Failed to detect upload port, please export UPLOAD_PORT manually" && exit 1)
 	@echo Uploading binary
 	$(SILENT)$(ESPTOOL) $(UPLOAD_VERBOSE_FLAG)  \
 		-cp $(UPLOAD_PORT) \
@@ -67,6 +62,7 @@ ifneq ("$(NO_UPLOAD)","1")
 		-cf $(LOCAL_BUILD_DIR)/$(notdir $@).bin
 endif
 ifneq ("$(NO_RUN)","1")
+	@test -n "$(UPLOAD_PORT)" || (echo "Failed to detect upload port, please export UPLOAD_PORT manually" && exit 1)
 	@echo Running tests
 	$(SILENT)$(ESPTOOL) $(UPLOAD_VERBOSE_FLAG) -cp $(UPLOAD_PORT) -cd $(UPLOAD_BOARD) -cr
 	@source $(BS_DIR)/virtualenv/bin/activate && \
@@ -75,6 +71,7 @@ ifneq ("$(NO_RUN)","1")
 			-p $(UPLOAD_PORT) \
 			-n $(basename $(notdir $@)) \
 			-o $(LOCAL_BUILD_DIR)/test_result.xml \
+			--env-file $(TEST_CONFIG) \
 			`test -f $(addsuffix .py, $(basename $@)) && echo "-m $(addsuffix .py, $(basename $@))" || echo ""`
 endif
 
@@ -95,7 +92,7 @@ $(HARDWARE_DIR):
 	cd $(HARDWARE_DIR)/esp8266com && ln -s $(realpath $(ESP8266_CORE_PATH)) esp8266
 
 virtualenv:
-	make -C $(BS_DIR) virtualenv
+	@make -C $(BS_DIR) virtualenv
 
 clean:
 	rm -rf $(BUILD_DIR)
@@ -104,9 +101,9 @@ clean:
 
 $(TEST_CONFIG):
 	@echo "******    "
-	@echo "******    libraries/test_config/test_config.h does not exist"
-	@echo "******    Create one from libraries/test_config/test_config.h.template"
+	@echo "******    $(TEST_CONFIG) does not exist"
+	@echo "******    Create one from $(TEST_CONFIG).template"
 	@echo "******    "
-	false
+	@false
 
-.PHONY: tests all count virtualenv test_report $(BUILD_DIR) $(TEST_LIST)
+.PHONY: tests all count virtualenv test_report $(TEST_LIST)

tests/device/libraries/BSTest/Makefile

@@ -14,7 +14,7 @@ $(PYTHON_ENV_DIR):
 	. $(PYTHON_ENV_DIR)/bin/activate && pip install -r requirements.txt
 
 test: $(TEST_EXECUTABLE) $(PYTHON_ENV_DIR)
-	. $(PYTHON_ENV_DIR)/bin/activate && python runner.py -e $(TEST_EXECUTABLE)
+	. $(PYTHON_ENV_DIR)/bin/activate && python runner.py -e $(TEST_EXECUTABLE) -m test/test.py
 
 $(TEST_EXECUTABLE): test/test.cpp
 	g++ -std=c++11 -Isrc -o $@ test/test.cpp

tests/device/libraries/BSTest/mock_decorators.py

@@ -26,3 +26,19 @@ def func_wrapper():
 		func_env['teardown'] = func_wrapper
 		return func_wrapper
 	return decorator
+
+def setenv(test_env, key, value):
+    if 'env' not in test_env:
+        test_env['env'] = []
+    test_env['env'] += [(key, value)]
+
+def request_env(test_env, key):
+	return test_env['request_env'](key)
+
+def get_all_envs(test_name):
+	global env
+	if test_name not in env:
+		return None
+	if 'env' not in env[test_name]:
+		return None
+	return env[test_name]['env']