Arduino as an esp-idf Component ... build issue

[RA5040]

Hardware:

Board: ESP32 Wrover Module
Core Installation/update date: 4/9/2018
IDE name: ESP32 with Arduino component
Flash Frequency: 40Mhz
Upload Speed: 115200

Description:

I am trying to run Arduino code as a component in the esp-idf initially, and then in Eclipse.

I've followed the instructions here carefully :
https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md

I got some compilation errors so I referenced this link:
#1142 (comment)

and followed the instructions there carefully (both the 23rd Feb and 14th May posts) and I THINK I've done things correctly.

However I get a build error, as follows:
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src//SD_MMC.cpp: In member function 'bool fs::SDMMCFS::begin(const char*, bool)':
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src//SD_MMC.cpp:56:26: error: 'sdmmc_host_io_int_enable' was not declared in this scope
.io_int_enable = sdmmc_host_io_int_enable,
^
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src//SD_MMC.cpp:57:24: error: 'sdmmc_host_io_int_wait' was not declared in this scope
.io_int_wait = sdmmc_host_io_int_wait,
^
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src//SD_MMC.cpp:59:5: error: 'sdmmc_host_t' has no non-static data member named 'io_int_enable'
};
^
/home/robert/esp/esp-idf/make/component_wrapper.mk:273: recipe for target 'libraries/SD_MMC/src//SD_MMC.o' failed
make[1]: *** [libraries/SD_MMC/src//SD_MMC.o] Error 1
/home/robert/esp/esp-idf/make/project.mk:453: recipe for target 'component-arduino-build' failed
make: *** [component-arduino-build] Error 2

I have deselected "Autostart Arduino setup and loop on boot" (first link above) so that the main.cpp should be as below.

I'm running on Ubuntu.

Sketch:

extern "C" void app_main()
#include <stdio.h>
#include "sdkconfig.h"
#include "Arduino.h"
extern "C" void app_main()
{
initArduino();
}

[lbernstone]

At the moment, there is no need to go through the "matching" routine- ESP-IDF and arduino-esp32 still seem to be in sync. So, make sure you have the latest versions of each development repo.
extern "C" is a marker for the compiler to indicate obligate C code. It is not needed if the C code will compile properly in C++, so use it sparingly. In fact, you can compile the basic sketch you have there with no extern calls at all.

[MarkusAD]

@RA5040 from your project directory (~/esp/blink) try:

rm -rf build
make menuconfig
make

In menuconfig under "SDK tool configuration->Compiler toolchain path/prefix" should be set to
"xtensa-esp32-elf-" (without the quotes). menuconfig needs ncurses-dev libraries installed.

[MarkusAD]

@RA5040 since you deleted your previous post, I take it you've solved your build problem.

[RA5040]

Copied blink example and built and flashed it: OK

Followed instructions in https://github.com/espressif/arduino-esp32/blob/master/docs/esp-idf_component.md ("Autostart Arduino setup and loop on boot" off)

1. Make on blink.c before any changes
   WARNING: Toolchain version is not supported: 1.22.0-73-ge28a011
   Expected to see version: 1.22.0-80-g6c4433a
   ...
   Python requirements from /home/robert/esp/esp-idf/requirements.txt are satisfied.
   /home/robert/esp/esp-idf/components/partition_table/Makefile.projbuild:60: warning: undefined variable 'quote'
   Building partitions from /home/robert/esp/blink/components/arduino/tools/partitions/default.csv...
   Partitions defined in '/home/robert/esp/blink/components/arduino/tools/partitions/default.csv' occupy 4.0MB of flash (4194304 bytes) which does not fit in configured flash size 2MB. Change the flash size in menuconfig under the 'Serial Flasher Config' menu.
   /home/robert/esp/esp-idf/components/partition_table/Makefile.projbuild:60: recipe for target '/home/robert/esp/blink/build/default.bin' failed
   make: *** [/home/robert/esp/blink/build/default.bin] Error 2

2. Make on blink.cpp before any code changes
   Same error

3. Modified code to have format

//#include "Arduino.h"
extern "C" void app_main()
{
initArduino();
...
}

4. Make on modified code:
   Same error

5. rm -rf build etc as per @markyad
   same error

6. @markyad : Installed ncurses-dev
   sudo apt-get update
   sudo apt-get install ncurses-dev

got
Note, selecting 'libncurses5-dev' instead of 'ncurses-dev'
libncurses5-dev is already the newest version (6.1-1ubuntu1.18.04).
0 upgraded, 0 newly installed, 0 to remove and 6 not upgraded.

7. Ran menuconfig and make again
   same errror

[MarkusAD]

Youve selected a 2M flash size, in menuconfig under "Serial flasher config" set "Flash Size 4M".

[MarkusAD]

WARNING: Toolchain version is not supported: 1.22.0-73-ge28a011
Expected to see version: 1.22.0-80-g6c4433a

Also its finding an old version of the toolchain, you should use the version it wants.
64 bit: https://dl.espressif.com/dl/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz
32 bit: https://dl.espressif.com/dl/xtensa-esp32-elf-linux32-1.22.0-80-g6c4433a-5.2.0.tar.gz

[RA5040]

Thanks for your help! I went right back to the Espressif installation instructions, which is why I have an older version of the toolchain ... I guess the documentation is not up to date.
At any rate, I've made your corrections and I now get the following errors:

CXX build/arduino/libraries/SD_MMC/src//SD_MMC.o
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp: In member function 'bool fs::SDMMCFS::begin(const char*, bool)':
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp:59:5: sorry, unimplemented: non-trivial designated initializers not supported
};
^
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp:59:5: sorry, unimplemented: non-trivial designated initializers not supported
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp:59:5: sorry, unimplemented: non-trivial designated initializers not supported
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp:59:5: sorry, unimplemented: non-trivial designated initializers not supported
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp:59:5: sorry, unimplemented: non-trivial designated initializers not supported
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp:59:5: sorry, unimplemented: non-trivial designated initializers not supported
/home/robert/esp/blink/components/arduino/libraries/SD_MMC/src/SD_MMC.cpp:59:5: warning: missing initializer for member 'sdmmc_host_t::command_timeout_ms' [-Wmissing-field-initializers]
/home/robert/esp/esp-idf/make/component_wrapper.mk:285: recipe for target 'libraries/SD_MMC/src//SD_MMC.o' failed
make[1]: *** [libraries/SD_MMC/src//SD_MMC.o] Error 1
/home/robert/esp/esp-idf/make/project.mk:481: recipe for target 'component-arduino-build' failed
make: *** [component-arduino-build] Error 2

[MarkusAD]

In menuconfig under "Arduino Configuration" tick "Include only specific arduino libraries" and untick "Enable SD_MMC". I had the same problem here.

[RA5040]

THANK YOU!!!
It works! I'm really delighted.

Now to try it in Eclipse ... is there anything that I need to watch out for there? Or can I just copy the project and build it?

[MarkusAD]

I dunno eclipse I just use makefiles and vi, maybe @lbernstone can help with that. Be sure to thank him as well as he also took the time to help you.

[RA5040]

Absolutely ... a lot of thanks to @ibernstone & @markyad.
I'll do a write-up on this as it may be of use to others.

[RA5040]

Here are instructions to build Arduino code in esp-idf:

MAKING ARDUINO COMPONENT

1. Install latest toolchain and esp-idf into ~/esp

2. Make blink project from esp-idf:
   cd ~/esp &&
   rm -r -f blink &&
   cp -r esp-idf/examples/get-started/blink blink &&
   cd blink

3. Create a components folder in the project folder and clone this repository inside it:
   mkdir -p components &&
   cd components &&
   git clone https://github.com/espressif/arduino-esp32.git arduino &&
   cd arduino &&
   git submodule update --init --recursive &&
   cd ../..

4. make menuconfig

• Go into Arduino Configuration:
  • Autostart Arduino setup and loop on boot: off
  • Disable mutex locks for HAL: off
  • Include only specific Arduino libraries: on
    • Enable SD_MMC: off (if this is causing a problem in Make)
• SDK tool configuration: make sure Compiler toolchain path/prefix is 'xtensa-esp32-elf-'

5. Rename blink.c to blink.cpp

6. Edit blink.cpp to be like:

#include "Arduino.h"
extern "C" void app_main()
{
initArduino();
pinMode(4, OUTPUT);
digitalWrite(4, HIGH);
//do your own thing
}

7. Make & flash
   If make fails, clear the build folders and try again:
   rm -rf build

[RA5040]

Here are instructions to move the application to Eclipse:

BUILDING AN ARDUINO APPLICATION IN ECLIPSE

A. MAKE C++ TEMPLATE APPLICATION

1. Install latest toolchain and esp-idf into ~/esp
   
2. Make blink project from esp-idf:

cd ~/esp &&
rm -r -f blink &&
cp -r esp-idf/examples/get-started/blink blink &&
cd blink

3. Create a components folder in the project folder and clone this repository inside it:

mkdir -p components &&
cd components &&
git clone https://github.com/espressif/arduino-esp32.git arduino &&
cd arduino &&
git submodule update --init --recursive &&
cd ../..

4. make menuconfig
• Go into Arduino Configuration:
    ◦ Autostart Arduino setup and loop on boot: off
    ◦ Disable mutex locks for HAL: off
    ◦ Include only specific Arduino libraries: on
        ▪ Enable SD_MMC: off (if this is causing a problem in Make)
• SDK tool configuration: make sure Compiler toolchain path/prefix is 'xtensa-esp32-elf-'
  
5. Rename blink.c to blink.cpp
   
6. Edit blink.cpp to be like

#include "Arduino.h"
extern "C" void app_main()
{
initArduino();
pinMode(4, OUTPUT);
digitalWrite(4, HIGH);
//do your own thing
}

7. Make & flash

If make fails, clear the build folders and try again:
rm -rf build

B. EDIT CODE TO MAKE IT INTO AN ARDUINO/C++ APPLICATION

1. Copy the blink application to your Eclipse workspace

2. In Eclipse do:
   • File/Import/CC++/Existing Code as a Makefile Project
   • Next
   • Browse to the blink folder in your workspace (the Project Name will automatically be put in).
   • Under Toolchain for Indexer Settings select Cross GCC
   • Click Finish

3. Rename blink.cpp file to your own application name and replace the contents with your own Arduino/C++ sketch.

4. Add "#include "Arduino.h" at the top and make sure you have extern ‘C’ void app_main and initArduino() as in A. Above. Also make calls to setup() and loop() if you have these in your sketch.

C. SET UP BUILD ENVIRONMENT TO BUILD A C++ APP

1. Right-click the project in the Project Explorer tab
   • Choose Properties
   • Choose C/C++ Build
   • Choose Environment
   • Choose Add
   ◦ Name: v
   ◦ Value: 1
   ◦ Select Add to all configurations
   ◦ OK
   • Choose Add again
   ◦ Name: IDF_PATH
   ◦ Value: enter the full path where you have installed the EPS-IDF (see 1. above). For instance: C:/msys32/home/Robert/esp/esp-idf (make sure to use '/', not '') in Windows or ~/esp/esp-idf in Linux (note: the path may already be set)
   ◦ Select Add to all configurations
   ◦ OK
   • Select the PATH variable and click on Edit
   ◦ Replace the Value with C:\msys32\usr\bin;C:\msys32\mingw32\bin;C:\msys32\opt\xtensa-esp32-elf\bin in Windows or /bin:/home/robert/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/home/robert/esp/xtensa-esp32-elf/bin (or the corresponding path if you have installed msys32 somewhere else ... obviously with your own username inserted instead of ‘robert’).
   ◦ Apply
   • Select C/C++ General
   ◦ Preprocessor Include Paths
   ◦ Providers tab
   ◦ Click on CDT Cross GCC Built-in Compiler Settings
   ◦ Replace the Command to get compiler specs with
   ▪ xtensa-esp32-elf-gcc ${FLAGS} -E -P -v -dD "${INPUTS}
   ◦ Apply
   ◦ Click on CDT GCC Build Output Parser
   ◦ Replace the Compiler command pattern with
   ▪ xtensa-esp32-elf-(g?cc)|([gc]++)|(clang)
   ▪ Apply
   ◦ Apply and Close

D. BUILD TARGET

1. Right-click on project
   • Index/Rebuild
   • Clean Project

2. Build Targets/Create
   • Target name: all (this will be used to build the app)

3. Build Targets/Create
   • Target name: flash (this will be used to build and flash the app)

4. Connect to EPS32

5. Check COM/tty port (for example using Device Manager/Ports in Windows, or ‘dmesg | grep tty’ in Linux)

6. Double-check that COM/tty port has been correctly set:
   • Open sdkconfig and check/correct the entry in:
   • CONFIG_ESPTOOLPY_PORT="COMx" / “/dev/ttyUSBx”

7. Click on the project
   • Build Targets
   • Flash (double-click)

8. Open a Terminal (you may need to go to Window/Show View/Terminal)
   • Click on Terminal icon
   • Choose terminal: Serial Terminal
   • Set up values
   • OK
   If your program terminated at flash, restart the ESP32 to see the output (if any).

NOTE: if you program shows errors even though it built without any errors, rebuild the index (right-click on project , Index, Rebuild). If that doesn't fix the problem try cleaning and rebuilding the project. If that doesn't work, go to Project/ Properties/ C/C++ General/ Code Analysis and unclick/apply and click back on/apply Syntax and Semantic Errors: you can also turn off/apply individual entries until you find the one that is causing a problem. In some cases it's simply a question of overriding the 'error' in the project editor).

E. REPLICATE

In order to avoid having to do this every single time, copy the blink folder and call it ‘Arduino-template’ for instance (and save a copy securely!).

Then when you have a new project, say ‘myProject’, copy the ‘Arduino-template’ again and rename it to ‘myProject’.

Import it into Eclipse and set the Eclipse project properties as in C. Above.

Edit Makefile and change the PROJECT NAME: = myProject

Rebuild the index, clean the project and build it.

[lbernstone]

I was not building a new enough version of IDF, I guess. There is already a PR to fix SD_MMC. #1836