Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TextWithArduinoGraphics example does not instruct user to install library dependency #371

Open
sterretjeToo opened this issue Sep 1, 2024 · 2 comments
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project

Comments

@sterretjeToo
Copy link

sterretjeToo commented Sep 1, 2024

The "Arduino_LED_Matrix" library's "TextWithArduinoGraphics" example has a dependency on the "ArduinoGraphics" library:

// To use ArduinoGraphics APIs, please include BEFORE Arduino_LED_Matrix
#include "ArduinoGraphics.h"

"ArduinoGraphics" is a standalone library, not installed by default. So the user must install the dependency in order to use the example. The example does not mention that requirement. If the user does not install the sketch's dependency compiling the sketch will fail:

/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/arduino-builder -dump-prefs -logger=machine -hardware /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/hardware -hardware /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages -tools /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/tools-builder -tools /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/hardware/tools/avr -tools /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages -built-in-libraries /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/libraries -libraries /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/sketchbook/libraries -fqbn=arduino:renesas_uno:unor4wifi -ide-version=10819 -build-path /tmp/arduino_build_393590 -warnings=all -build-cache /tmp/arduino_cache_403337 -prefs=build.warn_data_percentage=75 -prefs=runtime.tools.dfu-util.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/dfu-util/0.11.0-arduino5 -prefs=runtime.tools.dfu-util-0.11.0-arduino5.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/dfu-util/0.11.0-arduino5 -prefs=runtime.tools.arm-none-eabi-gcc.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4 -prefs=runtime.tools.arm-none-eabi-gcc-7-2017q4.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4 -prefs=runtime.tools.openocd.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/openocd/0.11.0-arduino2 -prefs=runtime.tools.openocd-0.11.0-arduino2.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/openocd/0.11.0-arduino2 -prefs=runtime.tools.bossac.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/bossac/1.9.1-arduino5 -prefs=runtime.tools.bossac-1.9.1-arduino5.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/bossac/1.9.1-arduino5 -verbose /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.1.0/libraries/Arduino_LED_Matrix/examples/TextWithArduinoGraphics/TextWithArduinoGraphics.ino
/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/arduino-builder -compile -logger=machine -hardware /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/hardware -hardware /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages -tools /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/tools-builder -tools /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/hardware/tools/avr -tools /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages -built-in-libraries /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/libraries -libraries /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/sketchbook/libraries -fqbn=arduino:renesas_uno:unor4wifi -ide-version=10819 -build-path /tmp/arduino_build_393590 -warnings=all -build-cache /tmp/arduino_cache_403337 -prefs=build.warn_data_percentage=75 -prefs=runtime.tools.dfu-util.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/dfu-util/0.11.0-arduino5 -prefs=runtime.tools.dfu-util-0.11.0-arduino5.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/dfu-util/0.11.0-arduino5 -prefs=runtime.tools.arm-none-eabi-gcc.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4 -prefs=runtime.tools.arm-none-eabi-gcc-7-2017q4.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4 -prefs=runtime.tools.openocd.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/openocd/0.11.0-arduino2 -prefs=runtime.tools.openocd-0.11.0-arduino2.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/openocd/0.11.0-arduino2 -prefs=runtime.tools.bossac.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/bossac/1.9.1-arduino5 -prefs=runtime.tools.bossac-1.9.1-arduino5.path=/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/bossac/1.9.1-arduino5 -verbose /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.1.0/libraries/Arduino_LED_Matrix/examples/TextWithArduinoGraphics/TextWithArduinoGraphics.ino
Using board 'unor4wifi' from platform in folder: /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0
Using core 'arduino' from platform in folder: /home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0
Detecting libraries used...
/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/tools/arm-none-eabi-gcc/7-2017q4/bin/arm-none-eabi-g++ -c -w -Os -g3 -fno-use-cxa-atexit -fno-rtti -fno-exceptions -nostdlib -DF_CPU=48000000 -DNO_USB -DBACKTRACE_SUPPORT -DARDUINO_UNOR4_WIFI -std=gnu++17 -mcpu=cortex-m4 -mfloat-abi=hard -mfpu=fpv4-sp-d16 -fsigned-char -ffunction-sections -fdata-sections -fmessage-length=0 -fno-builtin -w -x c++ -E -CC -DARDUINO=10819 "-DPROJECT_NAME=\"/tmp/arduino_build_393590/TextWithArduinoGraphics.ino\"" -DARDUINO_UNOWIFIR4 -DARDUINO_ARCH_RENESAS_UNO -DARDUINO_ARCH_RENESAS -DARDUINO_FSP -D_XOPEN_SOURCE=700 -mthumb @/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0/variants/UNOWIFIR4/defines.txt -DCFG_TUSB_MCU=OPT_MCU_RAXXX -I/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0/cores/arduino/tinyusb -I/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0/cores/arduino/api/deprecated -I/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0/cores/arduino/api/deprecated-avr-comp -I/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0/cores/arduino -I/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0/variants/UNOWIFIR4 -iprefix/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0 @/home/wim/Downloads/1_arduino_ide_1.x/arduino-1.8.19-UnoR4/portable/packages/arduino/hardware/renesas_uno/1.2.0/variants/UNOWIFIR4/includes.txt /tmp/arduino_build_393590/sketch/TextWithArduinoGraphics.ino.cpp -o /dev/null
Alternatives for ArduinoGraphics.h: []
ResolveLibrary(ArduinoGraphics.h)
TextWithArduinoGraphics:2:10: fatal error: ArduinoGraphics.h: No such file or directory
 #include "ArduinoGraphics.h"
  -> candidates: []
          ^~~~~~~~~~~~~~~~~~~
compilation terminated.
exit status 1
ArduinoGraphics.h: No such file or directory

Please add a note in the example that this is a requirement.

Additional context

Originally reported at https://forum.arduino.cc/t/1297300

@sterretjeToo sterretjeToo changed the title TextWithArduinoGraphics does not compile due to missing library TextWithArduinoGraphics example does not compile due to missing library Sep 1, 2024
@JAndrassy
Copy link
Contributor

install the ArduinoGraphics library in Library Manager in IDE

@sterretjeToo
Copy link
Author

@JAndrassy

I know and I mentioned that that solves the issue. But not everybody does know; as I mentioned, that example should compile out-of-the-box or dependencies should be made clear.

@per1234 per1234 changed the title TextWithArduinoGraphics example does not compile due to missing library TextWithArduinoGraphics example does not instruct user to install library dependency Sep 1, 2024
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

No branches or pull requests

3 participants