arduino-esp32/README.md

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

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

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

Latest Stable Release  [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)

Latest Development Release  [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads-pre/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)


### Installation Instructions
- Using Arduino IDE Boards Manager (preferred)
  + [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md)
- Using Arduino IDE with the development repository
  + [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)
  + [Instructions for openSUSE](docs/arduino-ide/opensuse.md)
- [Using PlatformIO](docs/platformio.md)
- [Building with make](docs/make.md)
- [Using as ESP-IDF component](docs/esp-idf_component.md)
- [Using OTAWebUpdater](docs/OTAWebUpdate/OTAWebUpdate.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 are sure no one else had the issue, follow the [ISSUE_TEMPLATE](docs/ISSUE_TEMPLATE.md) while reporting any issue.

### ESP32Dev Board PINMAP

![Pin Functions](docs/esp32_pinmap.png)

### Tip

Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process
Update README.md 2019-09-24 22:23:42 +02:00			`# 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)`
Update README.md Add Travis build badge 2017-01-28 13:15:42 +01:00
DOCUMENTATION: Moved installation instructions to separate page (#561) * 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 2017-08-17 15:14:01 +02:00			`### 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)`
Add Gitter badge (#96) 2016-12-13 11:12:44 +01:00
DOCUMENTATION: Moved installation instructions to separate page (#561) * 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 2017-08-17 15:14:01 +02:00			`## Contents`
Update README.md 2019-09-24 22:32:13 +02:00			`- [Development Status](#development-status)`
DOCUMENTATION: Moved installation instructions to separate page (#561) * 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 2017-08-17 15:14:01 +02:00			`- [Installation Instructions](#installation-instructions)`
			`- [Decoding Exceptions](#decoding-exceptions)`
			`- [Issue/Bug report template](#issuebug-report-template)`
Initial version of build script for @PlatformIO; CI integration for Linux, macOS and Windows (#153) * Initial version of build script for @PlatformIO; CI integration for Linux, macOS and Windows * Remove CI badges 2017-01-28 13:19:56 +01:00			`- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)`
Format README contents; add instructions for @PlatformIO (#88) 2016-12-10 17:28:24 +01:00
Update README.md 2019-09-24 22:32:13 +02:00			`### Development Status`

Updated Readme.md (#4400) * Updated Readme.md Added links to latest release. Made it look a lot cleaner. * Update README.md 2020-10-14 13:26:41 +02:00			Latest Stable Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)

Update README.md 2020-11-06 16:21:12 +01:00			Latest Development Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads-pre/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)
Updated Readme.md (#4400) * Updated Readme.md Added links to latest release. Made it look a lot cleaner. * Update README.md 2020-10-14 13:26:41 +02:00
Update README.md 2019-09-24 22:32:13 +02:00
			`### Installation Instructions`
Added instructions for installation with boards manager (#1630) * Added instructions for installation with boards manager (stolen directly from esp8266) * changed to production link instead of dev * Added to main README. Made mods to images as requested. * Added links for development package 2018-07-26 08:10:46 +02:00			`- Using Arduino IDE Boards Manager (preferred)`
			`+ [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md)`
			`- Using Arduino IDE with the development repository`
DOCUMENTATION: Moved installation instructions to separate page (#561) * 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 2017-08-17 15:14:01 +02:00			`+ [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)`
Update README.md with install instructions for openSUSE (#585) * Update README.md * Create opensuse.md 2017-09-26 11:49:18 +02:00			`+ [Instructions for openSUSE](docs/arduino-ide/opensuse.md)`
DOCUMENTATION: Moved installation instructions to separate page (#561) * 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 2017-08-17 15:14:01 +02:00			`- [Using PlatformIO](docs/platformio.md)`
			`- [Building with make](docs/make.md)`
			`- [Using as ESP-IDF component](docs/esp-idf_component.md)`
Added OTAWebUpdater Doc (#1583) 2018-07-03 20:43:18 +02:00			`- [Using OTAWebUpdater](docs/OTAWebUpdate/OTAWebUpdate.md)`
Fix heading (#412) 2017-06-02 18:21:54 +02:00
Update README.md 2019-09-24 22:32:13 +02:00			`### Decoding exceptions`
Update README.md Add exception decoder and fix layout 2017-01-05 16:59:20 +01:00
			`You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace.`

Update README.md 2019-09-24 22:32:13 +02:00			`### Issue/Bug report template`
DOCUMENTATION: Moved installation instructions to separate page (#561) * 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 2017-08-17 15:14:01 +02:00			`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).`
Added reference to makeEspArduino (#155) 2017-01-28 17:11:17 +01:00
Update README.md (#3353) 2019-10-14 19:38:04 +02:00			`Finally, if you are sure no one else had the issue, follow the [ISSUE_TEMPLATE](docs/ISSUE_TEMPLATE.md) while reporting any issue.`
Added reference to makeEspArduino (#155) 2017-01-28 17:11:17 +01:00
Update README.md 2019-09-24 22:32:13 +02:00			`### ESP32Dev Board PINMAP`
Format README contents; add instructions for @PlatformIO (#88) 2016-12-10 17:28:24 +01:00
DOCUMENTATION: Moved installation instructions to separate page (#561) * 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 2017-08-17 15:14:01 +02:00			`![Pin Functions](docs/esp32_pinmap.png)`
Add hint (#170) * Add hint * Update README.md * Update README.md * Update README.md 2017-02-05 13:48:13 +01:00
Update README.md (#3353) 2019-10-14 19:38:04 +02:00			`### Tip`
Add hint (#170) * Add hint * Update README.md * Update README.md * Update README.md 2017-02-05 13:48:13 +01:00
			`Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process`