From 6b05ec5b8673fbb4626f50f88806eb447455344d Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Fri, 22 May 2015 02:20:41 +0300 Subject: [PATCH] Update readme and change log #295 #299 --- README.md | 12 ++++++++---- changes.md | 19 +++++++++++++------ 2 files changed, 21 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0ae241a91..a6f2dca83 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ GPIO16 can be ```INPUT```, ```OUTPUT``` or ```INPUT_PULLDOWN```. ```analogRead(A0)``` reads the value of the ADC channel connected to the TOUT pin. ```analogWrite(pin, value)``` enables software PWM on the given pin. PWM may be used on pins 0 to 15. -Call ```analogWrite(pin, 0)``` to disable PWM on the pin. +Call ```analogWrite(pin, 0)``` to disable PWM on the pin. ```value``` may be in range from 0 to ```PWMRANGE```, which is currently equal to 1023. Pin interrupts are supported through ```attachInterrupt```, ```detachInterrupt``` functions. Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt @@ -85,7 +85,7 @@ Both ```Serial``` and ```Serial1``` objects support 5, 6, 7, 8 data bits, odd (O #### Progmem #### The Program memory features work much the same way as on a regular Arduino; placing read only data and strings in read only memory and freeing heap for your application. -The important difference is that on the esp8266 the literal strings are not pooled. This means that the same literal string defined inside a ```F("")``` and/or ```PSTR("")``` will take up space for each instance in the code. So you will need to manage the duplicate strings yourself. +The important difference is that on the esp8266 the literal strings are not pooled. This means that the same literal string defined inside a ```F("")``` and/or ```PSTR("")``` will take up space for each instance in the code. So you will need to manage the duplicate strings yourself. #### WiFi(ESP8266WiFi library) #### @@ -171,8 +171,8 @@ Several APIs may be used to get flash chip info: #### OneWire (from https://www.pjrc.com/teensy/td_libs_OneWire.html) #### Library was adapted to work with ESP8266 by including register definitions into OneWire.h -Note that if you have OneWire library in your Arduino/libraries folder, it will be used -instead of the one that comes with the Arduino IDE (this one). +Note that if you already have OneWire library in your Arduino/libraries folder, it will be used +instead of the one that comes with this package. #### mDNS responder (ESP8266mDNS library) #### @@ -253,3 +253,7 @@ Espressif SDK included in this build is under Espressif Public License. Esptool written by Christian Klippel is licensed under GPLv2, currently maintained by Ivan Grokhotkov: https://github.com/igrr/esptool-ck. ESP8266 core support, ESP8266WiFi, Ticker, ESP8266WebServer libraries were written by Ivan Grokhotkov, ivan@esp8266.com. + +[SPI Flash File System (SPIFFS)](https://github.com/pellepl/spiffs) written by Peter Andersson is used in this project. It is distributed under MIT license. + + diff --git a/changes.md b/changes.md index 25c27a12f..ef8a331f4 100644 --- a/changes.md +++ b/changes.md @@ -1,21 +1,28 @@ +# Change log +## Current version -# Current version +### Tools + +- Add 32-bit Linux toolchain. +- Rebuild toolchain and esptool with support for OS X down to 10.6. + +### Libraries -- Add 32-bit Linux toolchain - Better connection handling in ESP8266WebServer. The server now sends Content-Length and Connection: close headers, then waits for the client to disconnect. By not closing the connection - actively, server avoids TIME_WAIT TCP state, and the TCP stack is able to + actively, server avoids TIME_WAIT TCP state, and TCP stack is able to release the memory immediately, without waiting for 2xMSL period. If the client doesn't disconnect in 2000ms, the server closes the connection actively. - Add Hash library, which has a function to calculate SHA1 hash. + --- -# 1.6.4-g545ffde -19 May, 2015 +## 1.6.4-g545ffde +May 19, 2015 -- Initial release of board manager package +- Initial release of Boards Manager package for ESP8266 platform.