README.md 2.2 KB
Newer Older
M
me-no-dev 已提交
1 2
# Arduino core for the ESP32
[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ![](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg)
M
Me No Dev 已提交
3

4
### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
T
The Gitter Badger 已提交
5

6 7 8 9
## Contents
- [Installation Instructions](#installation-instructions)
- [Decoding Exceptions](#decoding-exceptions)
- [Issue/Bug report template](#issuebug-report-template)
10
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
11

M
Me No Dev 已提交
12
## Installation Instructions
13 14 15
- Using Arduino IDE Boards Manager (preferred)
  + [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md)
- Using Arduino IDE with the development repository
16 17 18 19
  + [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)
20
  + [Instructions for openSUSE](docs/arduino-ide/opensuse.md)
21 22 23
- [Using PlatformIO](docs/platformio.md)
- [Building with make](docs/make.md)
- [Using as ESP-IDF component](docs/esp-idf_component.md)
K
Karan Sharma 已提交
24
- [Using OTAWebUpdater](docs/OTAWebUpdate/OTAWebUpdate.md)
F
Fabian Affolter 已提交
25

M
Me No Dev 已提交
26 27 28 29
#### Decoding exceptions

You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace.

30 31
#### 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).
32

33
Finally, if you're sure no one else had the issue, follow the [ISSUE_TEMPLATE](docs/ISSUE_TEMPLATE.md) while reporting any issue.
34

35 36
## ESP32Dev Board PINMAP

37
![Pin Functions](docs/esp32_pinmap.png)
I
Ion 已提交
38 39 40 41

## Hint

Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process