|
1 | | -ESP-IDF template app |
| 1 | +RobotathonESP32 |
2 | 2 | ==================== |
3 | 3 |
|
4 | | -This is a template application to be used with [Espressif IoT Development Framework](https://github.com/espressif/esp-idf). |
| 4 | +This is the repository that utilizes the ESP32 to control robots for the Robtathon competition. It uses the following components: |
| 5 | +* [Arduino Core for ESP32](https://github.com/espressif/arduino-esp32) |
| 6 | +* [ESP-IDF Extension for VSCode](https://github.com/espressif/vscode-esp-idf-extension) |
| 7 | +* [Bluepad32](https://github.com/ricardoquesada/bluepad32/tree/main) |
5 | 8 |
|
6 | | -Please check [ESP-IDF docs](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for getting started instructions. |
| 9 | +Getting Started |
| 10 | +=================== |
7 | 11 |
|
8 | | -*Code in this repository is in the Public Domain (or CC0 licensed, at your option.) |
9 | | -Unless required by applicable law or agreed to in writing, this |
10 | | -software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR |
11 | | -CONDITIONS OF ANY KIND, either express or implied.* |
| 12 | +## 1. VSCode |
| 13 | +This project was built and tested using VSCode. Although any IDE should work in theory, you will not get the features provided by the ESP-IDF extension and will likely need to work through the command line. As such, using VSCode is highly recommended. |
| 14 | + |
| 15 | +VSCode can be installed [from here](https://code.visualstudio.com/). |
| 16 | + |
| 17 | +## 2. Cloning the Repo |
| 18 | +Clone this repo to a location using the method of your choice. I prefer to use the command line, although any method will do. |
| 19 | +```sh |
| 20 | +git clone https://github.com/eddieliao/RobotathonESP32.git |
| 21 | +``` |
| 22 | +## 3. Install the ESP-IDF Extension |
| 23 | +The [ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/) is a developement framework that is used to build and flash for the ESP32. While it can be [installed manually](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html), we highly recommend that you install it using the VSCode extension. |
| 24 | + |
| 25 | +To install the ESP-IDF Extension, simply go click on the Extension icon in the right taskbar in VSCode and search for "Espressif IDF". Click install. |
| 26 | + |
| 27 | +Full installation and setup instructions be [found here](https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md). |
| 28 | + |
| 29 | +## 4. Setting up ESP-IDF |
| 30 | +After installation, a setup wizard will appear. It can also be opened by searching for **ESP-IDF: Configure ESP-IDF extension** in the Command Palette (accessible through the top search bar). |
| 31 | + |
| 32 | +Choose the "Express" option. When prompted to do so, select **ESP-IDF version v4.4**. You can leave everything else default. Wait until the setup wizard displays a message stating that settings have been configured. |
| 33 | + |
| 34 | +## 5. Using the repo |
| 35 | +The Arduino Core means that code can be written for the ESP32 just like you would for any Arduino board. To do this, use the `setup()` and `loop()` methods found in `arduino_main.cpp`. |
| 36 | + |
| 37 | +To build for the ESP32, click the "Build Project" button (cylinder) in the bottom taskbar. |
| 38 | + |
| 39 | +To flash onto an ESP32, click the "Flash Project" button (lightning bolt) in the bottom taskbar. |
| 40 | + |
| 41 | +To read serial output coming from the ESP32, click the "Monitor Device" button (monitor) in the bottom taskbar. |
0 commit comments