lcd: Renamed 'i2clcd' library to 'lcd'

All other upm library directories match their corresponding library
name, the i2clcd was an outlier which caused problems for CMake and
testing.

    * Replaced usage of i2clcd with lcd
    * Renamed source files and examples
    * Updated examples to use correct class
    * Updated documentation where necessary (left changelog sections)

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck
2018-01-23 14:02:48 -08:00
parent f64060b9d2
commit 3cfea676e2
30 changed files with 47 additions and 47 deletions

View File

@ -1,4 +1,4 @@
set (libname "i2clcd")
set (libname "lcd")
set (libdescription "OLED Display Library")
set (module_src lcd.cxx ssd1308.cxx eboled.cxx ssd1327.cxx ssd1306.cxx)
set (module_hpp lcd.hpp ssd1308.hpp eboled.hpp ssd1327.hpp ssd.hpp ssd1306.hpp)

View File

@ -54,7 +54,7 @@ namespace upm
const int BUFFER_SIZE = 192;
/**
* @library i2clcd
* @library lcd
* @sensor eboled
* @comname SparkFun Block for Intel Edison - OLED
* @altname ssd1306
@ -79,7 +79,7 @@ namespace upm
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
* @snippet i2clcd-eboled.cxx Interesting
* @snippet lcd-eboled.cxx Interesting
*/
class EBOLED : public LCD
{

View File

@ -1,4 +1,4 @@
%module javaupm_i2clcd
%module javaupm_lcd
%include "../upm.i"
%include "stdint.i"
%include "typemaps.i"

View File

@ -1,4 +1,4 @@
%module jsupm_i2clcd
%module jsupm_lcd
%include "../upm.i"
%include "../carrays_uint8_t.i"

View File

@ -31,7 +31,7 @@ namespace upm
{
/**
* @brief I2C LCD Display library
* @defgroup i2clcd libupm-i2clcd
* @defgroup lcd libupm-lcd
* @ingroup dfrobot sainsmart seeed sparkfun adafruit i2c gpio display gsk
*/
class LCD

View File

@ -1,6 +1,6 @@
// Include doxygen-generated documentation
%include "pyupm_doxy2swig.i"
%module pyupm_i2clcd
%module pyupm_lcd
%include "../upm.i"
%include "../carrays_uint8_t.i"

View File

@ -85,7 +85,7 @@ const uint8_t SSD1306_LCDWIDTH = 128;
const uint8_t SSD1306_LCDHEIGHT = 64;
/**
* @library i2clcd
* @library lcd
* @sensor ssd1306
* @comname OLED Display
* @altname Adafruit SSD1306 OLED Display 0.96"
@ -103,7 +103,7 @@ const uint8_t SSD1306_LCDHEIGHT = 64;
* SSD1306 device from eBay.
*
* @image html ssd1306.jpeg
* @snippet i2clcd-ssd1306-oled.cxx Interesting
* @snippet lcd-ssd1306-oled.cxx Interesting
*/
class SSD1306 : public LCD
{

View File

@ -34,7 +34,7 @@ namespace upm
const uint8_t DISPLAY_CMD_SET_NORMAL_1308 = 0xA6;
/**
* @library i2clcd
* @library lcd
* @sensor ssd1308
* @comname OLED Display
* @altname Grove OLED Display 0.96"
@ -51,7 +51,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL_1308 = 0xA6;
* Display module, which is an OLED monochrome display.
*
* @image html ssd1308.jpeg
* @snippet i2clcd-ssd1308-oled.cxx Interesting
* @snippet lcd-ssd1308-oled.cxx Interesting
*/
class SSD1308 : public LCD
{

View File

@ -34,7 +34,7 @@ namespace upm
const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4;
/**
* @library i2clcd
* @library lcd
* @sensor ssd1327
* @comname OLED Display
* @altname Grove OLED Display 1.12"
@ -50,7 +50,7 @@ const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4;
* which is an OLED monochrome display.
*
* @image html ssd1327.jpeg
* @snippet i2clcd-ssd1327-oled.cxx Interesting
* @snippet lcd-ssd1327-oled.cxx Interesting
*/
class SSD1327 : public LCD
{