Skip to content

Commit c6e2a29

Browse files
committed
Documentation update
- mention analogWriteRange and analogWriteFreq - update change log - add pwm output symbol for pin 16 to svg
1 parent 29ccc06 commit c6e2a29

File tree

4 files changed

+37
-11
lines changed

4 files changed

+37
-11
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ $ cd Arduino/build
3333
$ ant dist
3434
```
3535

36-
### Documentation ###
37-
Latest development version:
36+
Documentation for latest development version:
3837

3938
- [Reference](hardware/esp8266com/esp8266/doc/reference.md)
4039
- [Supported boards](hardware/esp8266com/esp8266/doc/boards.md)

hardware/esp8266com/esp8266/doc/changes.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,49 @@
22
title: Change log
33
---
44

5-
5+
*Future release*
66

77
### Core
88

9-
- Updated I2C library to better handle repeated start for certain devices.
9+
- I2C library updated to better handle repeated start for certain devices,
10+
improved waveforms, higher frequencies for 160MHz core clock, fix case where
11+
using different pins would not work with libs calling begin internally.
12+
- Add Adafruit HUZZAH board
13+
- Add SparkFun Thing board
14+
- Add SweetPea ESP-210 board
15+
- Add eboot bootloader
16+
- Timer0 support
17+
- Add PWM range and frequency control
18+
- Add ESP.eraseConfig method
19+
- Fix pin change interrupt handling (#322)
20+
- Add SLC and I2S register definitions
21+
- Fix math functions calling themselves recursively (#233, #354)
22+
- Print stack on exception and soft WDT reset
23+
- Add Updater class
24+
- Remove implementations of WDT-related functions
25+
- Provide selection between A0 and VCC (#443, #338)
1026

1127
### Libraries
1228

1329
- ESP8266WebServer: add gzip streaming, fix sendContent behaviour,
1430
add setContentSize method.
1531
- ESP8266WiFi: add BSSID, channel, isHidden methods, fix AP/STA mode
1632
selection (#28).
33+
- Better handling of WiFi disconnect (#231)
34+
- Add API to set the beginning of local ports range for WiFiClient.
35+
- Add RSSI function
36+
- Add function to get the MAC / BSSID as String
37+
- Servo library support
38+
- Add ESP8266WiFiMesh library
39+
- Add ESP8266SSDP library
1740

1841
### Tools
1942

20-
- SDK updated to 1.1.0 (#306)
43+
- Update SDK to v1.2.0_15_07_03
44+
- Better sketch size reporting (#314)
45+
- Update esptool to 0.4.5
2146

47+
---
2248

2349
## 1.6.4-673-g8cd3697
2450
May 22, 2015

hardware/esp8266com/esp8266/doc/esp12.svg

Lines changed: 1 addition & 1 deletion
Loading

hardware/esp8266com/esp8266/doc/reference.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Digital pins 6—11 are not shown on this diagram because they are used to conne
1717

1818
Note that some boards and modules (ESP-12ED, NodeMCU 1.0) also break out pins 9 and 11. These may be used as IO if flash chip works in DIO mode (as opposed to QIO, which is the default one).
1919

20+
Pin interrupts are supported through `attachInterrupt`, `detachInterrupt` functions.
21+
Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
22+
types are supported: `CHANGE`, `RISING`, `FALLING`.
23+
2024
## Analog input
2125

2226
ESP8266 has a single ADC channel available to users. It may be used either to read voltage at ADC pin, or to read module supply voltage (VCC).
@@ -34,12 +38,9 @@ This line has to appear outside of any functions, for instance right after the `
3438
## Analog output
3539
3640
`analogWrite(pin, value)` enables software PWM on the given pin. PWM may be used on pins 0 to 16.
37-
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.
38-
39-
Pin interrupts are supported through `attachInterrupt`, `detachInterrupt` functions.
40-
Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
41-
types are supported: `CHANGE`, `RISING`, `FALLING`.
41+
Call `analogWrite(pin, 0)` to disable PWM on the pin. `value` may be in range from 0 to `PWMRANGE`, which is equal to 1023 by default. PWM range may be changed by calling `analogWriteRange(new_range)`.
4242
43+
PWM frequency is 1kHz by default. Call `analogWriteFreq(new_frequency)` to change the frequency.
4344
4445
## Timing and delays
4546
`millis()` and `micros()` return the number of milliseconds and microseconds elapsed after reset, respectively.

0 commit comments

Comments
 (0)