Skip to content

Commit 2b1760e

Browse files
committed
Merge branch 'master' into darkain
2 parents efd4ac8 + 818a55f commit 2b1760e

File tree

310 files changed

+8632
-8680
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

310 files changed

+8632
-8680
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.DS_Store
22
tools/dist/
33
tools/xtensa-lx106-elf/
4-
tools/esptool/
54
tools/mkspiffs/
5+
tools/python/
66
package/versions/
77
exclude.txt
88
tools/sdk/lib/liblwip_src.a

.gitmodules

+10-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
url = https://github.com/d-a-v/esp82xx-nonos-linklayer.git
44
[submodule "tools/sdk/ssl/bearssl"]
55
path = tools/sdk/ssl/bearssl
6-
url = https://github.com/earlephilhower/bearssl-esp8266
6+
url = https://github.com/earlephilhower/bearssl-esp8266.git
77
[submodule "libraries/SoftwareSerial"]
88
path = libraries/SoftwareSerial
99
url = https://github.com/plerup/espsoftwareserial.git
10+
[submodule "libraries/ESP8266SdFat"]
11+
path = libraries/ESP8266SdFat
12+
url = https://github.com/earlephilhower/ESP8266SdFat.git
13+
[submodule "tools/pyserial"]
14+
path = tools/pyserial
15+
url = https://github.com/pyserial/pyserial.git
16+
[submodule "tools/esptool"]
17+
path = tools/esptool
18+
url = https://github.com/espressif/esptool.git

.travis.yml

+12
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,17 @@ jobs:
6565
env:
6666
- BUILD_PARITY=odd
6767

68+
- name: "Build lwIP-v1.4 (1)"
69+
stage: build
70+
script: $TRAVIS_BUILD_DIR/tests/build1.sh
71+
env:
72+
- BUILD_PARITY=even
73+
- name: "Build lwIP-v1.4 (2)"
74+
stage: build
75+
script: $TRAVIS_BUILD_DIR/tests/build1.sh
76+
env:
77+
- BUILD_PARITY=odd
78+
6879
- name: "Host tests"
6980
stage: build
7081
script: $TRAVIS_BUILD_DIR/tests/ci/host_test.sh
@@ -92,6 +103,7 @@ jobs:
92103
stage: deploy
93104
script: tests/ci/build_package.sh
94105
env: BUILD_TYPE=package
106+
before_deploy: git submodule update --init
95107
deploy:
96108
# Create Github release, upload artifacts
97109
- provider: releases

README.md

+23-18
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Arduino core for ESP8266 WiFi chip
33

44
# Quick links
55

6-
- [Latest release documentation](https://arduino-esp8266.readthedocs.io/en/2.5.0-beta2/)
6+
- [Latest release documentation](https://arduino-esp8266.readthedocs.io/en/2.5.1/)
77
- [Current "git version" documentation](https://arduino-esp8266.readthedocs.io/en/latest/)
88
- [Install git version](https://arduino-esp8266.readthedocs.io/en/latest/installing.html#using-git-version) ([sources](doc/installing.rst#using-git-version))
99

@@ -28,20 +28,20 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
2828

2929
Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit).
3030

31-
- 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).
31+
- Install the current upstream Arduino IDE at the 1.8.7 level or later. The current version is at the [Arduino website](https://www.arduino.cc/en/main/software).
3232
- Start Arduino and open Preferences window.
33-
- Enter ```http://arduino.esp8266.com/stable/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
33+
- Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas.
3434
- Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).
3535

3636
#### Latest release [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/)
37-
Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index.json`
37+
Boards manager link: `https://arduino.esp8266.com/stable/package_esp8266com_index.json`
3838

39-
Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.0-beta2/](https://arduino-esp8266.readthedocs.io/en/2.5.0-beta2/)
39+
Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.1/](https://arduino-esp8266.readthedocs.io/en/2.5.1/)
4040

4141
### Using git version (basic instructions)
4242
[![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
4343

44-
- 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).
44+
- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](https://www.arduino.cc/en/main/software).
4545
- Go to Arduino directory
4646
- For Mac OS X, it is `Arduino.app` showing as the Arduino icon.
4747
This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
@@ -58,6 +58,8 @@ cd hardware
5858
mkdir esp8266com
5959
cd esp8266com
6060
git clone https://github.com/esp8266/Arduino.git esp8266
61+
cd esp8266
62+
git submodule update --init
6163
```
6264
- Download binary tools (you need Python 2.7)
6365
```bash
@@ -68,19 +70,19 @@ python get.py
6870

6971
### Using PlatformIO
7072

71-
[PlatformIO](http://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT
73+
[PlatformIO](https://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT
7274
development with cross platform build system, library manager and full support
7375
for Espressif (ESP8266) development. It works on the popular host OS: macOS, Windows,
7476
Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
7577

76-
- [What is PlatformIO?](http://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp8266)
77-
- [PlatformIO IDE](http://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp8266)
78-
- [PlatformIO Core](http://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp8266) (command line tool)
79-
- [Advanced usage](http://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266) -
78+
- [What is PlatformIO?](https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp8266)
79+
- [PlatformIO IDE](https://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp8266)
80+
- [PlatformIO Core](https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp8266) (command line tool)
81+
- [Advanced usage](https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266) -
8082
custom settings, uploading to SPIFFS, Over-the-Air (OTA), staging version
81-
- [Integration with Cloud and Standalone IDEs](http://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp8266) -
83+
- [Integration with Cloud and Standalone IDEs](https://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp8266) -
8284
Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode
83-
- [Project Examples](http://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266#examples)
85+
- [Project Examples](https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266#examples)
8486

8587
### Building with make
8688

@@ -93,21 +95,22 @@ Documentation for latest development version: https://arduino-esp8266.readthedoc
9395

9496
### Issues and support ###
9597

96-
[ESP8266 Community Forum](http://www.esp8266.com/u/arduinoanswers) is a well established community for questions and answers about Arduino for ESP8266.
98+
[ESP8266 Community Forum](https://www.esp8266.com/u/arduinoanswers) is a well established community for questions and answers about Arduino for ESP8266. If you need help, have a "How do I..." type question, have a problem with a 3rd party lib not hosted in this repo, or just want to discuss how to approach a problem , please ask there.
9799

98-
If you find this forum useful, please consider supporting it with a donation. <br />
100+
If you find the forum useful, please consider supporting it with a donation. <br />
99101
[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/webscr?cmd=_s-xclick&hosted_button_id=4M56YCWV6PX66)
100102

101-
If you encounter an issue which you think is a bug in the ESP8266 Arduino Core or the associated libraries, you are welcome to submit it here on Github: https://github.com/esp8266/Arduino/issues.
103+
If you encounter an issue which you think is a bug in the ESP8266 Arduino Core or the associated libraries, or if you want to propose an enhancement, you are welcome to submit it here on Github: https://github.com/esp8266/Arduino/issues.
102104

103-
Please provide as much context as possible:
105+
Please provide as much context as possible, as well as the information requested in the issue template:
104106

105107
- ESP8266 Arduino core version which you are using (you can check it in Boards Manager)
106108
- your sketch code; please wrap it into a code block, see [Github markdown manual](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code)
107109
- when encountering an issue which happens at run time, attach serial output. Wrap it into a code block, just like the code.
108110
- for issues which happen at compile time, enable verbose compiler output in the IDE preferences, and attach that output (also inside a code block)
109111
- ESP8266 development board model
110-
- IDE settings (board choich, flash size)
112+
- IDE settings (board choice, flash size)
113+
- etc
111114

112115
### Contributing
113116

@@ -135,6 +138,8 @@ ESP8266 core files are licensed under LGPL.
135138

136139
[umm_malloc](https://github.com/rhempel/umm_malloc) memory management library written by Ralph Hempel is used in this project. It is distributed under MIT license.
137140

141+
[SoftwareSerial](https://github.com/plerup/espsoftwareserial) library and examples written by Peter Lerup. Distributed under LGPL 2.1.
142+
138143
[axTLS](http://axtls.sourceforge.net/) library written by Cameron Rich, built from https://github.com/igrr/axtls-8266, is used in this project. It is distributed under [BSD license](https://github.com/igrr/axtls-8266/blob/master/LICENSE).
139144

140145
[BearSSL](https://bearssl.org) library written by Thomas Pornin, built from https://github.com/earlephilhower/bearssl-esp8266, is used in this project. It is distributed under the [MIT License](https://bearssl.org/#legal-details).

0 commit comments

Comments
 (0)