Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
- mention analogWriteRange and analogWriteFreq
- update change log
- add pwm output symbol for pin 16 to svg
  • Loading branch information
igrr committed Jul 22, 2015
1 parent 11594b1 commit d35b72d
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 11 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ $ cd Arduino/build
$ ant dist
```

### Documentation ###
Latest development version:
Documentation for latest development version:

- [Reference](hardware/esp8266com/esp8266/doc/reference.md)
- [Supported boards](hardware/esp8266com/esp8266/doc/boards.md)
Expand Down
32 changes: 29 additions & 3 deletions doc/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,49 @@
title: Change log
---


*Future release*

### 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

- ESP8266WebServer: add gzip streaming, fix sendContent behaviour,
add setContentSize method.
- ESP8266WiFi: add BSSID, channel, isHidden methods, fix AP/STA mode
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

- 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
May 22, 2015
Expand Down
2 changes: 1 addition & 1 deletion doc/esp12.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions doc/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

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

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).
Expand All @@ -34,12 +38,9 @@ This line has to appear outside of any functions, for instance right after the `
## Analog output
`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.
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`.
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)`.
PWM frequency is 1kHz by default. Call `analogWriteFreq(new_frequency)` to change the frequency.
## Timing and delays
`millis()` and `micros()` return the number of milliseconds and microseconds elapsed after reset, respectively.
Expand Down

0 comments on commit d35b72d

Please sign in to comment.