Add esp-idf cmake build system component registration #164

andreaskuster · 2021-06-25T08:49:49Z

In order to use this library as a ESP-IDF component (ESP32), we need these component registration files in place. They are non-intrusive and shouldn't influence other parts of your library, but allow to use this great library as git submodule / library in the project while profiting from updates/bug fixes in your repo.

More info: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html#minimal-component-cmakelists

I especially need this to add a CI pipeline to this PR: bblanchon/ArduinoJson#1562

CLAassistant · 2021-06-25T08:49:53Z

All committers have signed the CLA.

andreaskuster · 2021-06-25T11:29:41Z

A comptibility issue with the arduino-esp32 framework arised during advanced testing. The generic Server class expects the virtual void begin(uint16_t port) to be implemented. I added a wrapper to this PR in order to fix this as well.

_SOURCE -DIDF_VER=\"v4.4-dev-1594-g1d7068e4b\" -DESP_PLATFORM -DARDUINO=10812 -DARDUINO_ESP32_DEV -DARDUINO_ARCH_ESP32 -DARDUINO_BOARD=\"ESP32_DEV\" -DARDUINO_VARIANT=\"esp32\" -DESP32 -MD -MT esp-idf/main/CMakeFiles/__idf_main.dir/main.cpp.obj -MF esp-idf/main/CMakeFiles/__idf_main.dir/main.cpp.obj.d -o esp-idf/main/CMakeFiles/__idf_main.dir/main.cpp.obj -c ../main/main.cpp
../main/main.cpp:23:16: error: cannot declare variable 'server' to be of abstract type 'EthernetServer'
 EthernetServer server(80);
                ^~~~~~
In file included from ../main/main.cpp:19:
../components/Ethernet/src/Ethernet.h:253:7: note:   because the following virtual functions are pure within 'EthernetServer':
 class EthernetServer : public Server {
       ^~~~~~~~~~~~~~
In file included from ../components/arduino/cores/esp32/Arduino.h:155,
                 from ../components/ArduinoJson/src/ArduinoJson/Configuration.hpp:155,
                 from ../components/ArduinoJson/src/ArduinoJson.hpp:7,
                 from ../components/ArduinoJson/src/ArduinoJson.h:9,
                 from ../main/main.cpp:18:
../components/arduino/cores/esp32/Server.h:28:18: note: 	'virtual void Server::begin(uint16_t)'
     virtual void begin(uint16_t port=0) =0;
                  ^~~~~
ninja: build stopped: subcommand failed.
ninja failed with exit code 1

github-actions · 2021-06-25T13:32:34Z

Memory usage change @ c8fe12e

Board	flash	%	RAM for global variables	%
arduino:avr:leonardo	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:avr:mega	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:avr:nano	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:megaavr:nona4809	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:megaavr:uno2018	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:sam:arduino_due_x_dbg	0 - 0	0.0 - 0.0	N/A	N/A
arduino:samd:arduino_zero_edbg	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkr1000	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrfox1200	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrgsm1400	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrnb1500	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrvidor4000	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrwan1300	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrwan1310	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrwifi1010	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:mkrzero	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0
arduino:samd:nano_33_iot	0 - 0	0.0 - 0.0	0 - 0	0.0 - 0.0

Click for full report table

Board	examples/AdvancedChatServer RAM for global variables	%	examples/BarometricPressureWebServer RAM for global variables	%	examples/ChatServer RAM for global variables	%	examples/DhcpAddressPrinter RAM for global variables	%	examples/DhcpChatServer RAM for global variables	%	examples/LinkStatus RAM for global variables	%	examples/TelnetClient RAM for global variables	%	examples/UDPSendReceiveString RAM for global variables	%	examples/UdpNtpClient RAM for global variables	%	examples/WebClient RAM for global variables	%	examples/WebClientRepeating RAM for global variables	%	examples/WebServer RAM for global variables	%
arduino:avr:leonardo	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:avr:mega	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:avr:nano	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:megaavr:nona4809	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:megaavr:uno2018	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:sam:arduino_due_x_dbg	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A	N/A
arduino:samd:arduino_zero_edbg	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkr1000	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrfox1200	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrgsm1400	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrnb1500	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrvidor4000	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrwan1300	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrwan1310	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrwifi1010	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:mkrzero	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0
arduino:samd:nano_33_iot	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0	0	0.0

Click for full report CSV

Board,examples/AdvancedChatServer<br>flash,%,examples/AdvancedChatServer<br>RAM for global variables,%,examples/BarometricPressureWebServer<br>flash,%,examples/BarometricPressureWebServer<br>RAM for global variables,%,examples/ChatServer<br>flash,%,examples/ChatServer<br>RAM for global variables,%,examples/DhcpAddressPrinter<br>flash,%,examples/DhcpAddressPrinter<br>RAM for global variables,%,examples/DhcpChatServer<br>flash,%,examples/DhcpChatServer<br>RAM for global variables,%,examples/LinkStatus<br>flash,%,examples/LinkStatus<br>RAM for global variables,%,examples/TelnetClient<br>flash,%,examples/TelnetClient<br>RAM for global variables,%,examples/UDPSendReceiveString<br>flash,%,examples/UDPSendReceiveString<br>RAM for global variables,%,examples/UdpNtpClient<br>flash,%,examples/UdpNtpClient<br>RAM for global variables,%,examples/WebClient<br>flash,%,examples/WebClient<br>RAM for global variables,%,examples/WebClientRepeating<br>flash,%,examples/WebClientRepeating<br>RAM for global variables,%,examples/WebServer<br>flash,%,examples/WebServer<br>RAM for global variables,%
arduino:avr:leonardo,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:avr:mega,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:avr:nano,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:megaavr:nona4809,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:megaavr:uno2018,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:sam:arduino_due_x_dbg,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A,0,0.0,N/A,N/A
arduino:samd:arduino_zero_edbg,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkr1000,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrfox1200,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrgsm1400,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrnb1500,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrvidor4000,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrwan1300,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrwan1310,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrwifi1010,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:mkrzero,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:nano_33_iot,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0

JAndrassy · 2021-06-25T14:45:33Z

A comptibility issue with the arduino-esp32 framework arised during advanced testing. The generic Server class expects the virtual void begin(uint16_t port) to be implemented. I added a wrapper to this PR in order to fix this as well.

the esp32 Arduino has modified Arduino API's Server class. many networking libraries for Arduino are now not compatible with esp32 Arduino.

andreaskuster · 2021-06-25T20:26:37Z

A comptibility issue with the arduino-esp32 framework arised during advanced testing. The generic Server class expects the virtual void begin(uint16_t port) to be implemented. I added a wrapper to this PR in order to fix this as well.

the esp32 Arduino has modified Arduino API's Server class. many networking libraries for Arduino are now not compatible with esp32 Arduino.

@JAndrassy Yeah that is a pity, but I guess we should make such a widely used libary as much compatible as possible. So far, I regression tested all examples in ArduinoJson/examples, with class instances of EthernetClient, EthernetServer, EthernetUDP.

I think we should merge this as is since it does not break any existing functionality and add new PRs in case other compatibility issues arise.

Add esp-idf cmake build system component registration

64c0e43

Add compatibility wrapper for begin(uint16_t port) function.

c8fe12e

andreaskuster mentioned this pull request Jun 25, 2021

Add ci pipeline to PR: Compile under esp-idf new build sytem qt1/ArduinoJson#1

Open

andreaskuster mentioned this pull request Jun 27, 2021

Add ci pipeline to PR: Compile under esp-idf new build sytem bblanchon/ArduinoJson#1599

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add esp-idf cmake build system component registration #164

Add esp-idf cmake build system component registration #164

andreaskuster commented Jun 25, 2021

CLAassistant commented Jun 25, 2021 •

edited

andreaskuster commented Jun 25, 2021

github-actions bot commented Jun 25, 2021

JAndrassy commented Jun 25, 2021

andreaskuster commented Jun 25, 2021 •

edited

Add esp-idf cmake build system component registration #164

Are you sure you want to change the base?

Add esp-idf cmake build system component registration #164

Conversation

andreaskuster commented Jun 25, 2021

CLAassistant commented Jun 25, 2021 • edited

andreaskuster commented Jun 25, 2021

github-actions bot commented Jun 25, 2021

JAndrassy commented Jun 25, 2021

andreaskuster commented Jun 25, 2021 • edited

CLAassistant commented Jun 25, 2021 •

edited

andreaskuster commented Jun 25, 2021 •

edited