Merge branch 'master' into feature/HTTPClient_WiFiClient_parameter

Author: Jeroen88

.travis.yml

@@ -44,19 +44,28 @@ script:
   - $TRAVIS_BUILD_DIR/tests/common.sh
 
 deploy:
-  provider: releases
-  prerelease: true
-  skip_cleanup: true
-  api_key:
-    secure: A4FBmqyhlzy33oPeZVolg2Q/A3ZcJ3WnRQqQJ3NAPy+qGM5xcboOYtwcLL9vKaHZGfUB7lUP9QVZFGou1Wrmo9DnPvAoe3+XvCaDRGzVMxeIpu7UStbBD4Knbh98tlbMvZCXYRlT4VcusI9bMLK6UWw4sMdPislBh2FEfglTiag=
-  file_glob: true
-  file:
-    - package/versions/$TRAVIS_TAG/esp8266-$TRAVIS_TAG.zip
-    - package/versions/$TRAVIS_TAG/package_esp8266com_index.json
-  on:
-    repo: esp8266/Arduino
-    tags: true
-    condition: "$BUILD_TYPE = package"
+  - provider: releases
+    draft: true
+    skip_cleanup: true
+    api_key:
+      secure: A4FBmqyhlzy33oPeZVolg2Q/A3ZcJ3WnRQqQJ3NAPy+qGM5xcboOYtwcLL9vKaHZGfUB7lUP9QVZFGou1Wrmo9DnPvAoe3+XvCaDRGzVMxeIpu7UStbBD4Knbh98tlbMvZCXYRlT4VcusI9bMLK6UWw4sMdPislBh2FEfglTiag=
+    file_glob: true
+    file:
+      - package/versions/$TRAVIS_TAG/esp8266-$TRAVIS_TAG.zip
+      - package/versions/$TRAVIS_TAG/package_esp8266com_index.json
+    on:
+      repo: esp8266/Arduino
+      tags: true
+      condition: "$BUILD_TYPE = package"
+  
+  - provider: script
+    skip_cleanup: true
+    script: bash package/deploy_package_index.sh
+    on:
+      repo: esp8266/Arduino
+      tags: true
+      condition: "$BUILD_TYPE = package"
+
 
 notifications:
   email:

README.md

@@ -28,7 +28,7 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package
 #### Latest release [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/)
 Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index.json`
 
-Documentation: [https://arduino-esp8266.readthedocs.io/en/2.4.1/](https://arduino-esp8266.readthedocs.io/en/2.4.1/)
+Documentation: [https://arduino-esp8266.readthedocs.io/en/2.4.2/](https://arduino-esp8266.readthedocs.io/en/2.4.2/)
 
 ### Using git version
 [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)

cores/esp8266/HardwareSerial.cpp

@@ -108,6 +108,30 @@ void HardwareSerial::flush()
     delayMicroseconds(11000000 / uart_get_baudrate(_uart) + 1);
 }
 
+void HardwareSerial::startDetectBaudrate()
+{
+    uart_start_detect_baudrate(_uart_nr);
+}
+
+unsigned long HardwareSerial::testBaudrate()
+{
+    return uart_detect_baudrate(_uart_nr);
+}
+
+unsigned long HardwareSerial::detectBaudrate(time_t timeoutMillis)
+{
+    time_t startMillis = millis();
+    unsigned long detectedBaudrate;
+    while ((time_t) millis() - startMillis < timeoutMillis) {
+        if ((detectedBaudrate = testBaudrate())) {
+          break;
+        }
+        yield();
+        delay(100);
+    }    
+    return detectedBaudrate;
+}
+
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SERIAL)
 HardwareSerial Serial(UART0);
 #endif

cores/esp8266/HardwareSerial.h

@@ -184,6 +184,12 @@ class HardwareSerial: public Stream
         return uart_has_overrun(_uart);
     }
 
+    void startDetectBaudrate();
+
+    unsigned long testBaudrate();
+
+    unsigned long detectBaudrate(time_t timeoutMillis);
+
 protected:
     int _uart_nr;
     uart_t* _uart = nullptr;

cores/esp8266/uart.c

@@ -44,6 +44,7 @@
 #include "uart.h"
 #include "esp8266_peri.h"
 #include "user_interface.h"
+#include "uart_register.h"
 
 const char overrun_str [] ICACHE_RODATA_ATTR STORE_ATTR = "uart input full!\r\n";
 static int s_uart_debug_nr = UART0;
@@ -739,3 +740,49 @@ uart_get_debug()
 {
     return s_uart_debug_nr;
 }
+
+/*
+To start detection of baud rate with the UART the UART_AUTOBAUD_EN bit needs to be cleared and set. The ROM function uart_baudrate_detect() does this only once, so on a next call the UartDev.rcv_state is not equal to BAUD_RATE_DET. Instead of poking around in the UartDev struct with unknown effect, the UART_AUTOBAUD_EN bit is directly triggered by the function uart_detect_baudrate().
+*/
+void
+uart_start_detect_baudrate(int uart_nr)
+{
+    USA(uart_nr) &= ~(UART_GLITCH_FILT << UART_GLITCH_FILT_S | UART_AUTOBAUD_EN);
+    USA(uart_nr) = 0x08 << UART_GLITCH_FILT_S | UART_AUTOBAUD_EN;
+}
+
+int
+uart_detect_baudrate(int uart_nr)
+{
+    static bool doTrigger = true;
+
+    if (doTrigger)
+    {
+        uart_start_detect_baudrate(uart_nr);
+        doTrigger = false;
+    }
+
+    int32_t divisor = uart_baudrate_detect(uart_nr, 1);
+    if (!divisor) {
+        return 0;
+    }
+
+    doTrigger = true;    // Initialize for a next round
+    int32_t baudrate = UART_CLK_FREQ / divisor;
+
+    static const int default_rates[] = {300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230400, 256000, 460800, 921600, 1843200, 3686400};
+
+    size_t i;
+    for (i = 1; i < sizeof(default_rates) / sizeof(default_rates[0]) - 1; i++)	// find the nearest real baudrate
+    {
+        if (baudrate <= default_rates[i])
+        {
+            if (baudrate - default_rates[i - 1] < default_rates[i] - baudrate) {
+                i--;
+            }
+            break;
+        }
+    }
+
+    return default_rates[i];
+}

cores/esp8266/uart.h

@@ -141,6 +141,9 @@ bool uart_has_overrun (uart_t* uart); // returns then clear overrun flag
 void uart_set_debug(int uart_nr);
 int uart_get_debug();
 
+void uart_start_detect_baudrate(int uart_nr);
+int uart_detect_baudrate(int uart_nr);
+
 
 #if defined (__cplusplus)
 } // extern "C"

doc/faq/a05-board-generator.rst

@@ -19,7 +19,7 @@ available in the IDE menu.
 How can I run the script ?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Python 2 needs to be installed on your system.
+Python needs to be installed on your system.
 
 The script is located in the ``tools`` subdirectory of the core's root installation.
 It needs to be run from the root directory,

doc/reference.rst

@@ -155,6 +155,17 @@ current speed. For example
 | Note that this implementation is **only for ESP8266 based boards**,
   and will not works with other Arduino boards.
 
+
+To detect an unknown baudrate of data coming into Serial use ``Serial.detectBaudrate(time_t timeoutMillis)``. This method tries to detect the baudrate for a maximum of timeoutMillis ms. It returns zero if no baudrate was detected, or the detected baudrate otherwise. The ``detectBaudrate()`` function may be called before ``Serial.begin()`` is called, because it does not need the receive buffer nor the SerialConfig parameters.
+
+The uart can not detect other parameters like number of start- or stopbits, number of data bits or parity.
+
+The detection itself does not change the baudrate, after detection it should be set as usual using ``Serial.begin(detectedBaudrate)``.
+
+Detection is very fast, it takes only a few incoming bytes.
+
+SerialDetectBaudrate.ino is a full example of usage.
+
 Progmem
 -------
 

libraries/esp8266/examples/SerialDetectBaudrate/SerialDetectBaudrate.ino

@@ -0,0 +1,34 @@
+#define TIMEOUT (10000UL)     // Maximum time to wait for serial activity to start
+
+void setup() {
+  // put your setup code here, to run once:
+
+  Serial.begin(115200);
+
+  // Serial.detectBaudrate() may also be called before Serial.begin()
+  // There must be activity on the serial port for the baudrate to be detected
+  unsigned long detectedBaudrate = Serial.detectBaudrate(TIMEOUT);
+
+  if (detectedBaudrate) {
+    Serial.printf("\nDetected baudrate is %lu, switching to that baudrate now...\n", detectedBaudrate);
+
+    // Wait for printf to finish
+    while (Serial.availableForWrite() != UART_TX_FIFO_SIZE) {
+      yield();
+    }
+
+    // Clear Tx buffer to avoid extra characters being printed
+    Serial.flush();
+
+    // After this, any writing to Serial will print gibberish on the serial monitor if the baudrate doesn't match
+    Serial.begin(detectedBaudrate);
+  } else {
+    Serial.println("\nNothing detected");
+  }
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+}
+

package/README.md

@@ -0,0 +1,79 @@
+# Release tools
+
+## Overview
+
+This directory contains scripts used to automate the release process of esp8266/Arduino project.
+The purpose of the release process is to generate the following outputs from the repository:
+
+* Boards manager package index for Arduino IDE (i.e. `package_esp8266_index.json`). See [specification](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.6.x-package_index.json-format-specification) of package index file for more info.
+
+* Boards manager package for Arduino IDE. This is a .zip file which contains source code of esp8266/Arduino project, platform.txt, boards.txt and a few other supporting files. See [3-rd party hardware specification](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5-3rd-party-Hardware-specification) for more info about the layout of the boards manager package.
+
+* Github Release for esp8266/Arduino project. This is used to host the boards manager package mentioned above, and also contains the release notes.
+
+Here is an overview of the release process.
+
+1. Release process starts when a maintainer pushes a tag into the repository.
+
+2. Travis CI runs a build for this tag, and one of the jobs (with `BUILD_TYPE=package`) is used to prepare the boards manager package. This job runs `build_boards_manager_package.sh`.
+
+3. `build_boards_manager_package.sh` does a few things to build the boards manager package (.zip) file and the json index:
+
+   *  Pack source files into a zip file, excluding some files and tweaking platform.txt.
+   *  Download current latest package index json file from Github Releases. This file contains descriptions of all previous releases.
+   *  Generate package index for the new release.
+   *  Combines new release with previous releases in one json file (using `merge_packages.py` script).
+
+4. Travis CI uploads boards manager package (.zip file) and package index (.json file) to Github Releases, creating a draft release at the same time.
+
+5. Travis CI also uploads package index .json file to `http://arduino.esp8266.com/stable/package_esp8266_index.json`, i.e. well-known URL used by most users. 
+
+6. When the draft release is created, maintainer edits release description and inserts changelog into the description field, unmarks the release as draft, and publishes the release.
+
+7. Housekeeping is performed in Github issue tracker to close the completed milestone, update issue tags, etc.
+
+
+## Creating a release (for maintainers)
+
+1. Assemble release notes.
+
+   * Since most changes are integrated into master using squash-rebase policy (i.e. one commit per PR), `git log --oneline` gives a good overview of changes in the release.
+
+   * Prepare release notes in Markdown format.
+
+   * Combine related changes into the following categories, in that order:
+
+      - Core
+      - *Libraries* — one section per library that received changes. If library only had a single change or a few changes, it is also okay to combine changes to a few such libraries under single "Other Libraries" entry.
+      - Upstream dependencies
+      - Documentation
+      - Boards
+
+   * Not all commit descriptions which come from `git log` will explain changes well. Reword items as necessary, with the goal that a general user of this project should be able to understand what the change is related to. Preserve references to PRs or issues (`#XXXX`).
+
+   * Don't include fixes for issues which have been introduced since last release.
+
+   * Aggregate minor fixes (e.g. typos, small documentation changes) in a few items. Focus on preparing a good overview of the release for the users, rather than mentioning every change.
+
+   * When done, put release notes into a private Gist and send the link to other maintainers for review.
+
+2. Tag the latest commit. In this project, tags have form `X.Y.Z`, e.g. `2.4.0`, or `X.Y.Z-rcN` for release versions. Notice that there's no `v`at the beginning of the tag. Tags must be annotated, not lightweight tags. To create a tag, use git command (assuming that the master branch is checked out):
+
+   ```
+   git tag -a -m "Release 2.4.0" 2.4.0
+   ```
+   
+   Push the tag to esp8266/Arduino Github repository.
+
+
+3. Wait for Travis CI build for the tag to pass. Check that the new (draft) release has been created. Check that the boards manager package .zip file has been successfully uploaded as a release artifact.
+
+4. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266_index.json contains an entry for the new version (it may not be the first one).
+
+5. Navigate to release list in Github, press "Edit" button to edit release description, paste release notes. Remove "draft" status of the release and publish it.
+
+6. In the issue tracker, remove "staged-for-release" label for all issues which have it, and close them. Close the milestone associated with the released version.
+
+7. Make a commit to master branch, updating the version in platform.txt file. This should correspond to the version of the *next* milestone.
+
+

package/arduino-esp8266-travis.enc

@@ -0,0 +1,35 @@
+#!/bin/bash
+#
+# This script updates package index hosted on arduino.esp8266.com.
+# Normally is run by Travis CI for tagged versions, as a deploy step.
+
+tag=`git describe --tags`
+
+cd $(dirname "$0")
+
+# Decrypt and install SSH private key.
+# "encrypted_xxx_key" and "encrypted_xxx_iv" are environment variables
+# known to Travis CI builds.
+openssl aes-256-cbc -K $encrypted_3f14690ceb9b_key -iv $encrypted_3f14690ceb9b_iv -in arduino-esp8266-travis.enc -out arduino-esp8266-travis -d
+eval "$(ssh-agent -s)"
+chmod 600 arduino-esp8266-travis
+ssh-add arduino-esp8266-travis
+
+# Set SSH server public key
+echo "arduino.esp8266.com,104.131.82.128 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBAvoxsdf1jJ1XX7RrCtAQyjvZ3b33bWYfB/XDvEMLtxnJhZr+P/wa7yuZ+UJJ1wuJc+wcIMBNZ2Zz/MbdRMey7A=" \
+    >> $HOME/.ssh/known_hosts
+
+branch=stable
+[email protected]
+base_dir=apps/download_files/download
+
+# Upload package_esp8266com_index.json
+ssh $ssh_dl_server "mkdir -p $base_dir/versions/$tag"
+scp versions/$tag/package_esp8266com_index.json $ssh_dl_server:$base_dir/versions/$tag/
+
+# Change symlink for stable version
+oldver=$(ssh $ssh_dl_server "readlink $base_dir/$branch")
+newver="versions/$tag"
+echo "Changing version of $branch from $oldver to $newver"
+
+ssh $ssh_dl_server "pushd apps/download_files/download && ln -snf versions/$tag $branch"