arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-19 23:22:16 +03:00
Code

Documentation update

Browse Source 
- mention analogWriteRange and analogWriteFreq
- update change log
- add pwm output symbol for pin 16 to svg
This commit is contained in:
Ivan Grokhotkov 2015-07-23 01:29:12 +03:00
parent 11594b1340
commit d35b72d41c
4 changed files with 37 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -33,8 +33,7 @@ $ cd Arduino/build
$ ant dist $ ant dist
``` ```
### Documentation ### Documentation for latest development version:
Latest development version:
- [Reference](hardware/esp8266com/esp8266/doc/reference.md) - [Reference](hardware/esp8266com/esp8266/doc/reference.md)
- [Supported boards](hardware/esp8266com/esp8266/doc/boards.md) - [Supported boards](hardware/esp8266com/esp8266/doc/boards.md)

32
doc/changes.md
View File

@ -2,11 +2,27 @@
title: Change log title: Change log
--- ---
*Future release*
### Core ### Core
- Updated I2C library to better handle repeated start for certain devices. - I2C library updated to better handle repeated start for certain devices,
improved waveforms, higher frequencies for 160MHz core clock, fix case where
using different pins would not work with libs calling begin internally.
- Add Adafruit HUZZAH board
- Add SparkFun Thing board
- Add SweetPea ESP-210 board
- Add eboot bootloader
- Timer0 support
- Add PWM range and frequency control
- Add ESP.eraseConfig method
- Fix pin change interrupt handling (#322)
- Add SLC and I2S register definitions
- Fix math functions calling themselves recursively (#233, #354)
- Print stack on exception and soft WDT reset
- Add Updater class
- Remove implementations of WDT-related functions
- Provide selection between A0 and VCC (#443, #338)
### Libraries ### Libraries
@ -14,11 +30,21 @@ title: Change log
add setContentSize method. add setContentSize method.
- ESP8266WiFi: add BSSID, channel, isHidden methods, fix AP/STA mode - ESP8266WiFi: add BSSID, channel, isHidden methods, fix AP/STA mode
selection (#28). selection (#28).
- Better handling of WiFi disconnect (#231)
- Add API to set the beginning of local ports range for WiFiClient.
- Add RSSI function
- Add function to get the MAC / BSSID as String
- Servo library support
- Add ESP8266WiFiMesh library
- Add ESP8266SSDP library
### Tools ### Tools
- SDK updated to 1.1.0 (#306) - Update SDK to v1.2.0_15_07_03
- Better sketch size reporting (#314)
- Update esptool to 0.4.5
---
## 1.6.4-673-g8cd3697 ## 1.6.4-673-g8cd3697
May 22, 2015 May 22, 2015

2
doc/esp12.svg
View File

@ -544,7 +544,7 @@
y="506.7485" y="506.7485"
x="238.70137" x="238.70137"
id="tspan4480" id="tspan4480"
sodipodi:role="line">D16</tspan></text> sodipodi:role="line">D16~</tspan></text>
</g> </g>
<g <g
transform="translate(20,40)" transform="translate(20,40)"

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

11
doc/reference.md
View File

@ -17,6 +17,10 @@ Digital pins 6—11 are not shown on this diagram because they are used to conne
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). 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).
Pin interrupts are supported through `attachInterrupt`, `detachInterrupt` functions.
Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
types are supported: `CHANGE`, `RISING`, `FALLING`.
## Analog input ## Analog input
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). 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 `
## Analog output ## Analog output
`analogWrite(pin, value)` enables software PWM on the given pin. PWM may be used on pins 0 to 16. `analogWrite(pin, value)` enables software PWM on the given pin. PWM may be used on pins 0 to 16.
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. 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)`.
Pin interrupts are supported through `attachInterrupt`, `detachInterrupt` functions.
Interrupts may be attached to any GPIO pin, except GPIO16. Standard Arduino interrupt
types are supported: `CHANGE`, `RISING`, `FALLING`.
PWM frequency is 1kHz by default. Call `analogWriteFreq(new_frequency)` to change the frequency.
## Timing and delays ## Timing and delays
`millis()` and `micros()` return the number of milliseconds and microseconds elapsed after reset, respectively. `millis()` and `micros()` return the number of milliseconds and microseconds elapsed after reset, respectively.