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
37
docs/ISSUE_TEMPLATE.md
Normal file
@ -0,0 +1,37 @@
|
||||
Please fill the info fields, it helps to get you faster support ;)
|
||||
|
||||
If you have a Guru Meditation Error, please decode it:
|
||||
https://github.com/me-no-dev/EspExceptionDecoder
|
||||
|
||||
----------------------------- Remove above -----------------------------
|
||||
|
||||
|
||||
### Hardware:
|
||||
Board: ?ESP32 Dev Module?
|
||||
Core Installation/update date: ?11/jul/2017?
|
||||
IDE name: ?Arduino IDE? ?Platform.io? ?IDF component?
|
||||
Flash Frequency: ?40Mhz?
|
||||
Upload Speed: ?115200?
|
||||
|
||||
|
||||
### Description:
|
||||
Describe your problem here
|
||||
|
||||
|
||||
### Sketch:
|
||||
```cpp
|
||||
|
||||
//Change the code below by your sketch
|
||||
#include <Arduino.h>
|
||||
|
||||
void setup() {
|
||||
}
|
||||
|
||||
void loop() {
|
||||
}
|
||||
```
|
||||
|
||||
### Debug Messages:
|
||||
```
|
||||
Enable Core debug level: Debug on tools menu of Arduino IDE, then put the serial output here
|
||||
```
|
19
docs/arduino-ide/debian_ubuntu.md
Normal file
@ -0,0 +1,19 @@
|
||||
Installation instructions for Debian / Ubuntu OS
|
||||
=================================================
|
||||
|
||||
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout $USER && \
|
||||
sudo apt-get install git && \
|
||||
wget https://bootstrap.pypa.io/get-pip.py && \
|
||||
sudo python get-pip.py && \
|
||||
sudo pip install pyserial && \
|
||||
mkdir -p ~/Arduino/hardware/espressif && \
|
||||
cd ~/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32/tools/ && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
16
docs/arduino-ide/fedora.md
Normal file
@ -0,0 +1,16 @@
|
||||
Installation instructions for Fedora
|
||||
=====================================
|
||||
|
||||
- Install the latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software). `$ sudo dnf -y install arduino` will most likely install an older release.
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout $USER && \
|
||||
sudo dnf install git python3-pip python3-pyserial && \
|
||||
mkdir -p ~/Arduino/hardware/espressif && \
|
||||
cd ~/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32/tools/ && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
14
docs/arduino-ide/mac.md
Normal file
@ -0,0 +1,14 @@
|
||||
Installation instructions for Mac OS
|
||||
=====================================
|
||||
|
||||
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
mkdir -p ~/Documents/Arduino/hardware/espressif && \
|
||||
cd ~/Documents/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32/tools/ && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
BIN
docs/arduino-ide/win-screenshots/arduino-ide.png
Normal file
After Width: | Height: | Size: 186 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-1.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-2.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-3.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-4.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-5.png
Normal file
After Width: | Height: | Size: 84 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-update-1.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-update-2.png
Normal file
After Width: | Height: | Size: 39 KiB |
49
docs/arduino-ide/windows.md
Normal file
@ -0,0 +1,49 @@
|
||||
## Steps to install Arduino ESP32 support on Windows
|
||||
### Tested on 32 and 64 bit Windows 10 machines
|
||||
|
||||
1. Download and install the latest Arduino IDE ```Windows Installer``` from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
2. Download and install Git from [git-scm.com](https://git-scm.com/download/win)
|
||||
3. Start ```Git GUI``` and run through the following steps:
|
||||
- Select ```Clone Existing Repository```
|
||||
|
||||

|
||||
|
||||
- Select source and destination
|
||||
- Source Location: ```https://github.com/espressif/arduino-esp32.git```
|
||||
- Target Directory: ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32```
|
||||
- Change this to your Sketchbook Location if you have a different directory listed underneath the "Sketchbook location" in Arduino preferences.
|
||||
- Click ```Clone``` to start cloning the repository
|
||||
|
||||

|
||||

|
||||
|
||||
- Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe```
|
||||
|
||||

|
||||
|
||||
- When ```get.exe``` finishes, you should see the following files in the directory
|
||||
|
||||

|
||||
|
||||
4. Plug your ESP32 board and wait for the drivers to install (or install manually any that might be required)
|
||||
5. Start Arduino IDE
|
||||
6. Select your board in ```Tools > Board``` menu
|
||||
7. Select the COM port that the board is attached to
|
||||
8. Compile and upload (You might need to hold the boot button while uploading)
|
||||
|
||||

|
||||
|
||||
### How to update to the latest code
|
||||
|
||||
1. Start ```Git GUI``` and you should see the repository under ```Open Recent Repository```. Click on it!
|
||||
|
||||

|
||||
|
||||
2. From menu ```Remote``` select ```Fetch from``` > ```origin```
|
||||
|
||||

|
||||
|
||||
3. Wait for git to pull any changes and close ```Git GUI```
|
||||
4. Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe```
|
||||
|
||||

|
55
docs/esp-idf_component.md
Normal file
@ -0,0 +1,55 @@
|
||||
To use as a component of ESP-IDF
|
||||
=================================================
|
||||
|
||||
- Download and install [esp-idf](https://github.com/espressif/esp-idf)
|
||||
- Create blank idf project (from one of the examples)
|
||||
- in the project folder, create a folder called components and clone this repository inside
|
||||
|
||||
```bash
|
||||
mkdir -p components && \
|
||||
cd components && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git arduino && \
|
||||
cd .. && \
|
||||
make menuconfig
|
||||
```
|
||||
- ```make menuconfig``` has some Arduino options
|
||||
- "Autostart Arduino setup and loop on boot"
|
||||
- If you enable this options, your main.cpp should be formated like any other sketch
|
||||
|
||||
```arduino
|
||||
//file: main.cpp
|
||||
#include "Arduino.h"
|
||||
|
||||
void setup(){
|
||||
Serial.begin(115200);
|
||||
}
|
||||
|
||||
void loop(){
|
||||
Serial.println("loop");
|
||||
delay(1000);
|
||||
}
|
||||
```
|
||||
|
||||
- Else you need to implement ```app_main()``` and call ```initArduino();``` in it.
|
||||
|
||||
Keep in mind that setup() and loop() will not be called in this case.
|
||||
If you plan to base your code on examples provided in [esp-idf](https://github.com/espressif/esp-idf/tree/master/examples), please make sure move the app_main() function in main.cpp from the files in the example.
|
||||
|
||||
```arduino
|
||||
//file: main.cpp
|
||||
#include "Arduino.h"
|
||||
|
||||
extern "C" void app_main()
|
||||
{
|
||||
initArduino();
|
||||
pinMode(4, OUTPUT);
|
||||
digitalWrite(4, HIGH);
|
||||
//do your own thing
|
||||
}
|
||||
```
|
||||
- "Disable mutex locks for HAL"
|
||||
- If enabled, there will be no protection on the drivers from concurently accessing them from another thread/interrupt/core
|
||||
- "Autoconnect WiFi on boot"
|
||||
- If enabled, WiFi will start with the last known configuration
|
||||
- Else it will wait for WiFi.begin
|
||||
- ```make flash monitor``` will build, upload and open serial monitor to your board
|
BIN
docs/esp32_pinmap.png
Normal file
After Width: | Height: | Size: 537 KiB |
4
docs/make.md
Normal file
@ -0,0 +1,4 @@
|
||||
To use make
|
||||
============
|
||||
|
||||
[makeEspArduino](https://github.com/plerup/makeEspArduino) is a generic makefile for any ESP8266/ESP32 Arduino project.Using make instead of the Arduino IDE makes it easier to do automated and production builds.
|
12
docs/platformio.md
Normal file
@ -0,0 +1,12 @@
|
||||
Installation instructions for using PlatformIO
|
||||
=================================================
|
||||
|
||||
[PlatformIO](http://platformio.org) is an open source ecosystem for IoT development with cross platform build system, library manager and full support for Espressif ESP32 development. It works on the popular host OS: Mac OS X, Windows,Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
|
||||
|
||||
- [What is PlatformIO?](http://docs.platformio.org/page/what-is-platformio.html)
|
||||
- [PlatformIO IDE](http://platformio.org/platformio-ide)
|
||||
- Quick Start with [PlatformIO IDE](http://docs.platformio.org/page/ide/atom.html#quick-start) or [PlatformIO Core](http://docs.platformio.org/page/core.html)
|
||||
- [Integration with Cloud and Standalone IDEs](http://docs.platformio.org/page/ide.html) -
|
||||
Cloud9, Codeanywehre, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM and Visual Studio
|
||||
- [Project Examples](https://github.com/platformio/platform-espressif32/tree/develop/examples)
|
||||
- [Using "Stage" (Git) version of Arduino Core](http://docs.platformio.org/page/platforms/espressif32.html#using-arduino-framework-with-staging-version)
|