Proposal: add/rename a header file ESP8266_Oled_Driver_for_SSD1306_display

[jantje]

Hi Jantje here from the arduino eclipse plugin named sloeber. I bumped into this library during my regression testing because all esPert library examples fail. The reason for this is because Sloeber is unable to link #include "SSD1306.h" to the folder name ESP8266_Oled_Driver_for_SSD1306_display making that the auto import/auto install can not be executed. The examples of the library work fine because there Sloeber auto includes the library providing the examples.

I know that the Arduino IDE finds the library based on a search of the content of the libraries. I think this method is fine for simple setups but it is not scalable. For instance: I currently have 1.175 libraries installed in my test environment of which 4 deal with SSD1306. Looking for the right one (taking into account the 2 library specifications) is going to take to long. As you can see below this library is the only one deviating from the convention* nice lib name->nice_lib_name->nice_lib_name.h Adafruit SSD1306->Adafruit_SSD1306->Adafruit_SSD1306.h ssd1306->ssd1306->ssd1306.h ACROBOTIC SSD1306->ACROBOTIC_SSD1306->ACROBOTIC_SSD1306.h ESP8266 Oled Driver for SSD1306 display->ESP8266_Oled_Driver_for_SSD1306_display->SSD1306.h

I propose to rename SSD1306.h to ESP8266_Oled_Driver_for_SSD1306_display.h and create a new file called SSD1306.h with following content

#include "ESP8266_Oled_Driver_for_SSD1306_display.h"
#warning This file is deprecated.
#warning Please include ESP8266_Oled_Driver_for_SSD1306_display.h instead of SSD1306.h

This should take care of downwards compatibility. Tell me what you think. Jantje

• I mean the old C/C++ developers way of working convention not the Arduino convention.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.