Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ricardoquesada/esp-idf-arduino-bluepad32-template
ESP-IDF template that has Arduino and Bluepad32 built-in
https://github.com/ricardoquesada/esp-idf-arduino-bluepad32-template
arduino bluepad32 bluetooth esp-idf esp32 gamepad
Last synced: about 2 months ago
JSON representation
ESP-IDF template that has Arduino and Bluepad32 built-in
- Host: GitHub
- URL: https://github.com/ricardoquesada/esp-idf-arduino-bluepad32-template
- Owner: ricardoquesada
- License: other
- Created: 2021-12-14T16:29:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T04:46:29.000Z (3 months ago)
- Last Synced: 2024-10-19T06:58:08.710Z (3 months ago)
- Topics: arduino, bluepad32, bluetooth, esp-idf, esp32, gamepad
- Language: C
- Homepage: https://bluepad32.readthedocs.io/
- Size: 5.58 MB
- Stars: 19
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ESP-IDF + Arduino + Bluepad32 template app
[](https://discord.gg/r5aMn6Cw5q)
This is a template application to be used with [Espressif IoT Development Framework](https://github.com/espressif/esp-idf).
Please check [ESP-IDF docs](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for getting started instructions.
Requires ESP-IDF **v4.4**.x (don't use 5.x!)
Includes the following ESP-IDF components, with a pre-configured `sdkconfig` file:
* [Arduino Core for ESP32](https://github.com/espressif/arduino-esp32) component
* [Bluepad32](https://gitlab.com/ricardoquesada/bluepad32/) component
* [BTStack](https://github.com/bluekitchen/btstack) component
## How to compile it
Clone the template project:
```sh
git clone --recursive https://gitlab.com/ricardoquesada/esp-idf-arduino-bluepad32-template.git my_project
```
After cloning the *template* you have two options:
* A) Using PlatformIO (easier)
* B) or Using ESP-IDF (requires more steps)
### A) Using PlatformIO + ESP-IDF
![open_project][pio_open_project]
1. Open Visual Studio Code, select the PlatformIO plugin
2. Click on "Pick a folder", a select the recently cloned "my_project" folder
That's it. The PlatformIO will download the ESP-IDF toolchain and its dependencies.
It might take a few minutes to download all dependencies. Be patient.
![build_project][pio_build_project]
After all dependencies were installed:
1. Click on one of the pre-created boards, like *esp32-s3-devkit-1*. Or edit `platformio.ini` file, and add your own.
2. Click on *build*
![monitor_project][pio_monitor_project]
Finally, click on "Upload and Monitor":
* It will upload your sketch
* And will enter into "monitor" mode: You can see and use the console. Try typing `help` on the console.
Further reading: [PlatformIO Espressif IoT Development Framework][pio_espidf]
[pio_open_project]: https://lh3.googleusercontent.com/pw/ABLVV85JEEjjsQqcCcfZUclYF1ItYSHPmpzP0SC4VH9Ypqp05r2ixlv9C2xv4p-r6fW_CyCNa8ylmeSjyUg_K2Sp-XUXQRTYO_6HvhQXcXxTZXgQvvNBqA8JaerwCB1UODkXgYa_6ONT19KTO52OMs0eOOeeMg=-no-gm?authuser=0
[pio_build_project]: https://lh3.googleusercontent.com/pw/ABLVV86DiV9H-wDEv1X8ra_fJAw0OG2sBoM5d0gJElPfptzVpb6n8gzOEHDfKXLMKrivzNSt03XpMWSw-hSVJUi0aavQiwgL0t1rmQeKqfYpXkGCKKwcerrNx8BBkFR3VoKQEPMF-e-xVvKVque2pi1sTa8tWA=-no-gm?authuser=0
[pio_monitor_project]: https://lh3.googleusercontent.com/pw/ABLVV845uPqRtJkUrv4JlODuTr7Shnw0HR7BdojRbxv3xWyiUO-V_Kv42YAKAV-XyoNRPY5vsyj0yRDsRxH0mxz8Q1NYzvhCKw5Ni9MH6UYR8IiaT8XS9hysR81APn8X2tnVgnmJ6ZkSPCgUURnE2MVYIWYrNQ=-no-gm?authuser=0
[pio_espidf]: https://docs.platformio.org/en/latest/frameworks/espidf.html
### or B) Using ESP-IDF
#### For Windows
1. Install [ESP-IDF v4.4][esp-idf-windows-installer]. For further info, read: [ESP-IDF Getting Started for Windows][esp-idf-windows-setup]
* Either the Online or Offline version should work
* When asked which components to install, don't change anything. Default options are Ok.
* When asked whether ESP can modify the system, answer "Yes"
2. Launch the "ESP-IDF v4.4 CMD" (type that in the Windows search box)
3. Compile it
```sh
# Compile it
cd my_project
idf.py build
# Flash + open debug terminal
idf.py flash monitor
```
[esp-idf-windows-setup]: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html
[esp-idf-windows-installer]: https://dl.espressif.com/dl/esp-idf/?idf=4.4
#### For Linux / macOS
1. Requirements and permissions
Install ESP-IDF dependencies (taken from [here][toolchain-deps]):
```sh
# For Ubuntu / Debian
sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
```
And in case you don't have permissions to open `/dev/ttyUSB0`, do:
(taken from [here][ttyusb0])
```sh
# You MUST logout/login (or in some cases reboot Linux) after running this command
sudo usermod -a -G dialout $USER
```
2. Install and setup ESP-IDF
```sh
# Needs to be done just once
# Clone the ESP-IDF git repo
mkdir ~/esp && cd ~/esp
git clone -b release/v4.4 --recursive https://github.com/espressif/esp-idf.git
# Then install the toolchain
cd ~/esp/esp-idf
./install.sh
```
3. Compile the template
Clone the template:
```sh
# Do it everytime you want to start a new project
# Clone the template somewhere
mkdir ~/src && cd ~/src
git clone --recursive https://gitlab.com/ricardoquesada/esp-idf-arduino-bluepad32-template.git my_project
```
Export the ESP-IDF environment variables in your shell:
```sh
# Do it everytime you open a new shell
# Optional: add it in your ~/.bashrc or ~/.profile
source ~/esp/esp-idf/export.sh
```
And finally compile and install your project.
```sh
# Compile it
cd ~/src/my_project
idf.py build
# Flash + open debug terminal
idf.py flash monitor
```
[toolchain-deps]: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-setup.html
[ttyusb0]: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/establish-serial-connection.html#linux-dialout-group
## Using 3rd party Arduino libraries
To include 3rd party Arduino libraries in your project, you have to:
* Add them to the `components` folder.
* Add `CMakeLists.txt` file inside the component's folder
Let's use a real case as an example:
### Example: Adding ESP32Servo
Suppose you want to use [ESP32Servo] project. The first thing to notice is that the source files are placed
in the `src` folder. We have to create a `CMakeLists.txt` file that tells ESP-IDF to look for the sources
in the `src` folder.
Example:
```sh
# 1) We clone ESP32Servo into components folder
cd components
git clone https://github.com/madhephaestus/ESP32Servo.git
cd ESP32Servo
```
And now create these files inside `components/ESP32Servo` folder:
```sh
# 2) Create CMakeLists.txt file
# Copy & paste the following lines to the terminal:
cat << EOF > CMakeLists.txt
idf_component_register(SRC_DIRS "src"
INCLUDE_DIRS "src"
REQUIRES "arduino")
EOF
```
Finally, update the dependencies in the `main/CMakeLists.txt`. E.g:
```sh
cd main
edit CMakeLists.txt
```
...and append `ESP32Servo` to `REQUIRES`. The `main/CMakeLists.txt` should look like this:
```cmake
idf_component_register(SRCS "${srcs}"
INCLUDE_DIRS "."
REQUIRES "${requires}" "ESP32Servo")
```
And that's it. Now you can include `ESP32Servo` from your code. E.g:
```cpp
// Add this include in your arduino_main.cpp file
#include
```
[esp32servo]: https://github.com/madhephaestus/ESP32Servo.git
## IDE
Arduino IDE is not supported, but you can use [Visual Studio Code][vscode] + [ESP-IDF plugin][esp-idf-plugin].
You can do:
* All the regular Visual Studio Code regular features
* ...plus configure, build, flash and monitor your project
* ...and much more
Subjective opinion: VSCode + ESP-IDF plugin is muuuuuch better than Arduino IDE. Highly recommended!
[vscode]: https://code.visualstudio.com/
[esp-idf-plugin]: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/vscode-setup.html
## Further info
* [Bluepad32 for Arduino](https://gitlab.com/ricardoquesada/bluepad32/-/blob/main/docs/plat_arduino.md)
* [Arduino as ESP-IDF component](https://docs.espressif.com/projects/arduino-esp32/en/latest/esp-idf_component.html)
* [ESP-IDF VSCode plugin](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/vscode-setup.html)
## Support
* [Discord][discord]: any question? Ask them on our Discord server.
[discord]: https://discord.gg/r5aMn6Cw5q