e6ba0f6281
* DOCUMENTATION: Moved installation instructions to separate page * Added Fedora to contents table * Added Issue/Bug Report section to README * Some minor improvements * DOCUMENTATION: Rename directory doc to docs * Also move ISSUE_TEMPLATE.md to docs directory * DOCUMENTATION: Use current repo's files * This makes it consistent instead of having few local and few pointing to espressif/arduino-esp32 by all linking to local files * DOCUMENTATION: Fix hyperlink to issue/bug template in contents * DOCUMENTATION: contents: supress platform specific installation instruction
48 lines
2.3 KiB
Markdown
48 lines
2.3 KiB
Markdown
# Arduino core for ESP32 WiFi chip
|
|
|
|
[](https://travis-ci.org/espressif/arduino-esp32)
|
|
|
|
### Need help or have a question? Join the chat at [](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
## Contents
|
|
- [Development Status](#development-status)
|
|
- [Installation Instructions](#installation-instructions)
|
|
- [Decoding Exceptions](#decoding-exceptions)
|
|
- [Issue/Bug report template](#issuebug-report-template)
|
|
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
|
|
|
|
## Development Status
|
|
Most of the framework is implemented. Most noticable is the missing analogWrite. While analogWrite is on it's way, there are a few other options that you can use:
|
|
- 16 channels [LEDC](cores/esp32/esp32-hal-ledc.h) which is PWM
|
|
- 8 channels [SigmaDelta](cores/esp32/esp32-hal-sigmadelta.h) which uses SigmaDelta modulation
|
|
- 2 channels [DAC](cores/esp32/esp32-hal-dac.h) which gives real analog output
|
|
|
|
## Installation Instructions
|
|
|
|
- Using Arduino IDE
|
|
+ [Instructions for Windows](docs/arduino-ide/windows.md)
|
|
+ [Instructions for Mac](docs/arduino-ide/mac.md)
|
|
+ [Instructions for Debian/Ubuntu Linux](docs/arduino-ide/debian_ubuntu.md)
|
|
+ [Instructions for Fedora](docs/arduino-ide/fedora.md)
|
|
- [Using PlatformIO](docs/platformio.md)
|
|
- [Building with make](docs/make.md)
|
|
- [Using as ESP-IDF component](docs/esp-idf_component.md)
|
|
|
|
#### Decoding exceptions
|
|
|
|
You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace.
|
|
|
|
#### Issue/Bug report template
|
|
Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labelled as [for reference](https://github.com/espressif/arduino-esp32/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3A%22for%20reference%22%20).
|
|
|
|
Finally, if you're sure no one else had the issue, follow the [ISSUE_TEMPLATE](docs/ISSUE_TEMPLATE.md) while reporting any issue.
|
|
|
|
|
|
## ESP32Dev Board PINMAP
|
|
|
|
|
|
|
|
## Hint
|
|
|
|
Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process
|