Rename utils.h file to prevent conflicts with other libraries

[irl-ops]

What happened?

I am using another library that also contains a utils/utils.h file. The compiler just uses whichever one was included first, this is obviously problematic.

With "utils" being a very common file name, maybe you could rename the file utils.h? Possible something like lcdMenuUtils.h? I don't have any issues with the other files in the utils folder but I suspect this same issue could arise with files like constants.h, maybe you want to rename those at the same time?

Thanks for the great library!

Version

• I have checked that I am using the latest version of the library.

What environment are you seeing the problem in?

Platform IO

Board type

ESP32

Relevant log output

[irl-ops]

Some more info because they asked for it over on the RadioLib side too:

The error I get is below:

In file included from .pio/libdeps/esp32dev/LcdMenu/src/MenuItem.h:32,
                 from .pio/libdeps/esp32dev/LcdMenu/src/MenuScreen.h:4,
                 from .pio/libdeps/esp32dev/LcdMenu/src/LcdMenu.h:28,
                 from src/main.cpp:3:
.pio/libdeps/esp32dev/LcdMenu/src/renderer/MenuRenderer.h: In member function 'virtual void MenuRenderer::updateTimer()':
.pio/libdeps/esp32dev/LcdMenu/src/renderer/MenuRenderer.h:117:9: error: 'LOG' was not declared in this scope
  117 |         LOG(F("MenuRenderer::timeout"));

If I rename the utils.h file from either library (and update the references to it in the code of course) then the code compiles just fine.

Below is a very basic example program that throws this error. Note I am using platformIO not Arduino, not sure if that makes a difference.

main.cpp:

#include <Arduino.h>
#include <RadioLib.h>
#include <LcdMenu.h>
#include <MenuScreen.h>
#include <display/LiquidCrystal_I2CAdapter.h>
#include <input/KeyboardAdapter.h>
#include <renderer/CharacterDisplayRenderer.h>

// radio:
SX1278 radio = new Module(10, 2, 9, 3);

// LCD:
#define LCD_ROWS 2
#define LCD_COLS 16
// Initialize the main menu items
// clang-format off
MENU_SCREEN(mainScreen, mainItems,
    ITEM_BASIC("Start service"),
    ITEM_BASIC("Connect to WiFi"),
    ITEM_BASIC("Settings"),
    ITEM_BASIC("Blink SOS"),
    ITEM_BASIC("Blink random"));
// clang-format on

LiquidCrystal_I2C lcd(0x27, LCD_COLS, LCD_ROWS);
CharacterDisplayRenderer renderer(new LiquidCrystal_I2CAdapter(&lcd), LCD_COLS, LCD_ROWS);
LcdMenu menu(renderer);
KeyboardAdapter keyboard(&menu, &Serial);

void setup() {
  Serial.begin(9600);

  // radio init:
  int state = radio.begin();
  if (state == RADIOLIB_ERR_NONE) {
    Serial.println(F("success!"));
  } else {
    Serial.print(F("failed, code "));
    Serial.println(state);
    while (true) { delay(10); }
  }

  // LcdMenu init
  renderer.begin();
  menu.setScreen(mainScreen);
} // end setup
  
void loop() {
  /// radio
  String str;
  int state = radio.receive(str);
  //lcd:
  keyboard.observe();

  delay(100);
}

platformio.ini:

[env:esp32dev]
platform = espressif32
board = esp32dev
framework = arduino
lib_deps = 
	forntoh/LcdMenu@^5.12.0
	jgromes/RadioLib@^7.1.2
	marcoschwartz/LiquidCrystal_I2C@^1.1.4

Maybe this has something to do with the DEBUG LOG macros for the LcdMenu library, I honestly don't know enough about how preprocessor macros work to dig into that.