-
Notifications
You must be signed in to change notification settings - Fork 7.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the 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
- Loading branch information
1 parent
3a8e28d
commit e6ba0f6
Showing
18 changed files
with
159 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |