Skip to content

Commit e6392d2

Browse files
committed
Update readme and change log
#295 #299
1 parent 06fb38b commit e6392d2

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ GPIO16 can be ```INPUT```, ```OUTPUT``` or ```INPUT_PULLDOWN```.
4141
```analogRead(A0)``` reads the value of the ADC channel connected to the TOUT pin.
4242

4343
```analogWrite(pin, value)``` enables software PWM on the given pin. PWM may be used on pins 0 to 15.
44-
Call ```analogWrite(pin, 0)``` to disable PWM on the pin.
44+
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.
4545

4646
Pin interrupts are supported through ```attachInterrupt```, ```detachInterrupt``` functions.
4747
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
8585
#### Progmem ####
8686

8787
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.
88-
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.
88+
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.
8989

9090
#### WiFi(ESP8266WiFi library) ####
9191

@@ -171,8 +171,8 @@ Several APIs may be used to get flash chip info:
171171
#### OneWire (from https://www.pjrc.com/teensy/td_libs_OneWire.html) ####
172172

173173
Library was adapted to work with ESP8266 by including register definitions into OneWire.h
174-
Note that if you have OneWire library in your Arduino/libraries folder, it will be used
175-
instead of the one that comes with the Arduino IDE (this one).
174+
Note that if you already have OneWire library in your Arduino/libraries folder, it will be used
175+
instead of the one that comes with this package.
176176

177177
#### mDNS responder (ESP8266mDNS library) ####
178178

@@ -253,3 +253,7 @@ Espressif SDK included in this build is under Espressif Public License.
253253
Esptool written by Christian Klippel is licensed under GPLv2, currently maintained by Ivan Grokhotkov: https://github.com/igrr/esptool-ck.
254254

255255
ESP8266 core support, ESP8266WiFi, Ticker, ESP8266WebServer libraries were written by Ivan Grokhotkov, [email protected].
256+
257+
[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.
258+
259+
+13-6
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1+
# Change log
12

3+
## Current version
24

3-
# Current version
5+
### Tools
6+
7+
- Add 32-bit Linux toolchain.
8+
- Rebuild toolchain and esptool with support for OS X down to 10.6.
9+
10+
### Libraries
411

5-
- Add 32-bit Linux toolchain
612
- Better connection handling in ESP8266WebServer.
713
The server now sends Content-Length and Connection: close headers,
814
then waits for the client to disconnect. By not closing the connection
9-
actively, server avoids TIME_WAIT TCP state, and the TCP stack is able to
15+
actively, server avoids TIME_WAIT TCP state, and TCP stack is able to
1016
release the memory immediately, without waiting for 2xMSL period.
1117
If the client doesn't disconnect in 2000ms, the server closes the connection
1218
actively.
1319
- Add Hash library, which has a function to calculate SHA1 hash.
1420

21+
1522
---
1623

17-
# 1.6.4-g545ffde
18-
19 May, 2015
24+
## 1.6.4-g545ffde
25+
May 19, 2015
1926

20-
- Initial release of board manager package
27+
- Initial release of Boards Manager package for ESP8266 platform.
2128

0 commit comments

Comments
 (0)