mirror of
				https://github.com/eclipse/upm.git
				synced 2025-11-04 09:05:34 +03:00 
			
		
		
		
	i2clcd: updated headers with tags
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
		@@ -78,6 +78,7 @@ namespace upm {
 | 
				
			|||||||
/**
 | 
					/**
 | 
				
			||||||
 * @brief i2c LCD display library
 | 
					 * @brief i2c LCD display library
 | 
				
			||||||
 * @defgroup i2clcd libupm-i2clcd
 | 
					 * @defgroup i2clcd libupm-i2clcd
 | 
				
			||||||
 | 
					 * @ingroup seeed sparkfun adafruit i2c display gsk
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
class I2CLcd {
 | 
					class I2CLcd {
 | 
				
			||||||
    public:
 | 
					    public:
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -29,19 +29,26 @@
 | 
				
			|||||||
namespace upm {
 | 
					namespace upm {
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 | 
					 * @library i2clcd
 | 
				
			||||||
 | 
					 * @sensor jhd1313m1
 | 
				
			||||||
 | 
					 * @comname JHD1313M1 Display
 | 
				
			||||||
 | 
					 * @altname Grove RGB LCD
 | 
				
			||||||
 | 
					 * @type display
 | 
				
			||||||
 | 
					 * @man seeed adafruit sparkfun
 | 
				
			||||||
 | 
					 * @web http://www.seeedstudio.com/depot/Grove-LCD-RGB-Backlight-p-1643.html?cPath=34_36
 | 
				
			||||||
 | 
					 * @con i2c
 | 
				
			||||||
 | 
					 * @kit gsk
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 * @brief C++ API for Jhd1313m1 i2c controller for HD44780 based displays with
 | 
					 * @brief C++ API for Jhd1313m1 i2c controller for HD44780 based displays with
 | 
				
			||||||
 * an RGB backlight such as the Grove RGB i2c LCD display
 | 
					 * an RGB backlight such as the Grove RGB i2c LCD display
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * The Jhd1313m1 has two i2c addreses, one belongs to a controller very similar
 | 
					 * The Jhd1313m1 has two i2c addreses, one belongs to a controller very similar
 | 
				
			||||||
 * to the upm::Lcm1602 LCD driver which controls the HD44780 based display and the
 | 
					 * to the upm::Lcm1602 LCD driver which controls the HD44780 based display and the
 | 
				
			||||||
 * other controls solely the backlight. This module was tested with the Seed
 | 
					 * other controls solely the backlight. This module was tested with the Seed
 | 
				
			||||||
 * [Grove LCD RGB Backlight v2.0 display]
 | 
					 * Grove LCD RGB Backlight v2.0 display which requires 5V to operate.
 | 
				
			||||||
 * (http://www.seeedstudio.com/depot/Grove-LCD-RGB-Backlight-p-1643.html?cPath=34_36),
 | 
					 | 
				
			||||||
 * which requires 5V to operate.
 | 
					 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * @ingroup i2clcd i2c
 | 
					 | 
				
			||||||
 * @snippet jhd1313m1-lcd.cxx Interesting
 | 
					 | 
				
			||||||
 * @image html grovergblcd.jpeg
 | 
					 * @image html grovergblcd.jpeg
 | 
				
			||||||
 | 
					 * @snippet jhd1313m1-lcd.cxx Interesting
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
class Jhd1313m1 : public I2CLcd {
 | 
					class Jhd1313m1 : public I2CLcd {
 | 
				
			||||||
    public:
 | 
					    public:
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -31,20 +31,25 @@
 | 
				
			|||||||
#include "i2clcd.h"
 | 
					#include "i2clcd.h"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
namespace upm {
 | 
					namespace upm {
 | 
				
			||||||
 | 
					 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 | 
					 * @library i2clcd
 | 
				
			||||||
 | 
					 * @sensor lcm1602
 | 
				
			||||||
 | 
					 * @comname LCM1602 Display
 | 
				
			||||||
 | 
					 * @type display
 | 
				
			||||||
 | 
					 * @man adafruit sparkfun
 | 
				
			||||||
 | 
					 * @web https://www.adafruit.com/datasheets/TC1602A-01T.pdf
 | 
				
			||||||
 | 
					 * @con i2c
 | 
				
			||||||
 | 
					 * 
 | 
				
			||||||
 * @brief C++ API for LCM1602 i2c controller for HD44780 based displays
 | 
					 * @brief C++ API for LCM1602 i2c controller for HD44780 based displays
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * This supports all sizes of HD44780 displays from 16x2 to 4x20, the
 | 
					 * This supports all sizes of HD44780 displays from 16x2 to 4x20, the
 | 
				
			||||||
 * controller has no idea of the actual display hardware so will let you write
 | 
					 * controller has no idea of the actual display hardware so will let you write
 | 
				
			||||||
 * further than you can see. These displays with such controllers are available
 | 
					 * further than you can see. These displays with such controllers are available
 | 
				
			||||||
 * from various manufacturers with different i2c addresses. The adafruit
 | 
					 * from various manufacturers with different i2c addresses. The adafruit
 | 
				
			||||||
 * [TC1602A-01T](https://www.adafruit.com/datasheets/TC1602A-01T.pdf) seems to
 | 
					 * TC1602A-01T seems to be a well documented example.
 | 
				
			||||||
 * the best documented example.
 | 
					 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * @ingroup i2clcd i2c
 | 
					 | 
				
			||||||
 * @snippet lcm1602-lcd.cxx Interesting
 | 
					 | 
				
			||||||
 * @image html lcm1602.jpeg
 | 
					 * @image html lcm1602.jpeg
 | 
				
			||||||
 | 
					 * @snippet lcm1602-lcd.cxx Interesting
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
class Lcm1602 : public I2CLcd {
 | 
					class Lcm1602 : public I2CLcd {
 | 
				
			||||||
    public:
 | 
					    public:
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -33,18 +33,24 @@ namespace upm {
 | 
				
			|||||||
#define DISPLAY_CMD_SET_NORMAL_1308      0xA6
 | 
					#define DISPLAY_CMD_SET_NORMAL_1308      0xA6
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 | 
					 * @library i2clcd
 | 
				
			||||||
 | 
					 * @sensor ssd1308
 | 
				
			||||||
 | 
					 * @comname SSD1308 OLED Display
 | 
				
			||||||
 | 
					 * @altname Grove OLED Display 0.96"
 | 
				
			||||||
 | 
					 * @type display
 | 
				
			||||||
 | 
					 * @man seeed adafruit
 | 
				
			||||||
 | 
					 * @web http://garden.seeedstudio.com/images/4/46/SSD1308_1.0.pdf
 | 
				
			||||||
 | 
					 * @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_0.96%22
 | 
				
			||||||
 | 
					 * @con i2c
 | 
				
			||||||
 | 
					 * 
 | 
				
			||||||
 * @brief C++ API for SSD1308 i2c controlled OLED displays
 | 
					 * @brief C++ API for SSD1308 i2c controlled OLED displays
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * The [SSD1308](http://garden.seeedstudio.com/images/4/46/SSD1308_1.0.pdf) is
 | 
					 * The SSD1308 is a 128x64 Dot matrix OLED/PLED segment driver with
 | 
				
			||||||
 * a 128x64 Dot matrix OLED/PLED segment driver with controller. This
 | 
					 * controller. This implementation was tested using the Grove LED 128×64
 | 
				
			||||||
 * implementation was tested using the
 | 
					 * Display module which is an OLED monochrome display.
 | 
				
			||||||
 * [Grove LED 128×64 Display module]
 | 
					 | 
				
			||||||
 * (http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_0.96%22)
 | 
					 | 
				
			||||||
 * which is an OLED monochrome display
 | 
					 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * @ingroup i2clcd i2c
 | 
					 | 
				
			||||||
 * @snippet ssd1308-oled.cxx Interesting
 | 
					 | 
				
			||||||
 * @image html ssd1308.jpeg
 | 
					 * @image html ssd1308.jpeg
 | 
				
			||||||
 | 
					 * @snippet ssd1308-oled.cxx Interesting
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
class SSD1308 : public I2CLcd {
 | 
					class SSD1308 : public I2CLcd {
 | 
				
			||||||
    public:
 | 
					    public:
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -33,18 +33,24 @@ namespace upm {
 | 
				
			|||||||
#define DISPLAY_CMD_SET_NORMAL      0xA4
 | 
					#define DISPLAY_CMD_SET_NORMAL      0xA4
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 | 
					 * @library i2clcd
 | 
				
			||||||
 | 
					 * @sensor ssd1327
 | 
				
			||||||
 | 
					 * @comname SSD1327 OLED Display
 | 
				
			||||||
 | 
					 * @altname Grove OLED Display 1.12"
 | 
				
			||||||
 | 
					 * @type display
 | 
				
			||||||
 | 
					 * @man seeed adafruit
 | 
				
			||||||
 | 
					 * @web http://garden.seeedstudio.com/images/8/82/SSD1327_datasheet.pdf
 | 
				
			||||||
 | 
					 * @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_1.12%22
 | 
				
			||||||
 | 
					 * @con i2c
 | 
				
			||||||
 | 
					 * 
 | 
				
			||||||
 * @brief C++ API for SSD1327 i2c controlled OLED displays
 | 
					 * @brief C++ API for SSD1327 i2c controlled OLED displays
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * The [SSD1327](http://garden.seeedstudio.com/images/8/82/SSD1327_datasheet.pdf)
 | 
					 * The SSD1327 is a 96x96 Dot matrix OLED/PLED segment driver with controller.
 | 
				
			||||||
 * is a 96x96 Dot matrix OLED/PLED segment driver with controller. This
 | 
					 * This implementation was tested using the Grove LED 96×96 Display module
 | 
				
			||||||
 * implementation was tested using the
 | 
					 * which is an OLED monochrome display.
 | 
				
			||||||
 * [Grove LED 96×96 Display module]
 | 
					 | 
				
			||||||
 * (http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_1.12%22)
 | 
					 | 
				
			||||||
 * which is an OLED monochrome display
 | 
					 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * @ingroup i2clcd i2c
 | 
					 | 
				
			||||||
 * @snippet ssd1327-oled.cxx Interesting
 | 
					 | 
				
			||||||
 * @image html ssd1327.jpeg
 | 
					 * @image html ssd1327.jpeg
 | 
				
			||||||
 | 
					 * @snippet ssd1327-oled.cxx Interesting
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
class SSD1327 : public I2CLcd {
 | 
					class SSD1327 : public I2CLcd {
 | 
				
			||||||
    public:
 | 
					    public:
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user