alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 01:11:10 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/lcd/jhd1313m1.h
View File

@ -41,13 +41,13 @@ namespace upm
* @con i2c
* @kit gsk
*
* @brief API for Jhd1313m1 i2c controller for HD44780 based displays with
* an RGB backlight such as the Grove RGB i2c LCD display
* @brief API for the JHD1313M1 I2C controller for HD44780-based displays with
* an RGB backlight, such as a Grove RGB I2C LCD display
*
* 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
* other controls solely the backlight. This module was tested with the Seed
* Grove LCD RGB Backlight v2.0 display which requires 5V to operate.
* JHD1313M1 has two I2C addreses: one belongs to a controller, very similar
* to the upm::Lcm1602 LCD driver, that controls the HD44780-based display, and the
* other controls only the backlight. This module was tested with the Seeed
* Grove LCD RGB Backlight v2.0 display that requires 5V to operate.
*
* @image html grovergblcd.jpg
* @snippet jhd1313m1-lcd.cxx Interesting
@ -58,9 +58,9 @@ class Jhd1313m1 : public Lcm1602
/**
* Jhd1313m1 constructor
*
* @param bus i2c bus to use
* @param address the slave address the lcd is registered on
* @param address the slave address the rgb backlight is on
* @param bus I2C bus to use
* @param address Slave address the LCD is registered on
* @param address Slave address the RGB backlight is registered on
*/
Jhd1313m1(int bus, int lcdAddress = 0x3E, int rgbAddress = 0x62);
/**
@ -68,19 +68,19 @@ class Jhd1313m1 : public Lcm1602
*/
~Jhd1313m1();
/**
* Make the LCD scroll text
* Makes the LCD scroll text
*
* @param direction, true is typical scrolling to the right
* @return Result of operation
* @param direction True if scrolling to the right
* @return Result of the operation
*/
mraa_result_t scroll(bool direction);
/**
* Set the color of the backlight
* Sets the color of the backlight
*
* @param r 0-255 value for red
* @param g 0-255 value for green
* @param b 0-255 value for blue
* @return Result of operation
* @return Result of the operation
*/
mraa_result_t setColor(uint8_t r, uint8_t g, uint8_t b);

2
src/lcd/lcd.h
View File

@ -29,7 +29,7 @@
namespace upm
{
/**
* @brief I2C LCD display library
* @brief I2C LCD Display library
* @defgroup i2clcd libupm-i2clcd
* @ingroup seeed sparkfun adafruit i2c display gsk
*/

58
src/lcd/lcm1602.h
View File

@ -48,13 +48,13 @@ namespace upm
* @web https://www.adafruit.com/datasheets/TC1602A-01T.pdf
* @con i2c
*
* @brief API for LCM1602 i2c controller for HD44780 based displays
* @brief API for the LCM1602 I2C controller for HD44780-based displays
*
* 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
* further than you can see. These displays with such controllers are available
* from various manufacturers with different i2c addresses. The adafruit
* TC1602A-01T seems to be a well documented example.
* This supports all sizes of HD44780 displays, from 16x2 to 4x20. The
* controller has no idea of the actual display hardware, so it lets you write
* farther than you can see. These displays with such controllers are available
* from various manufacturers with different I2C addresses. Adafruit*
* TC1602A-01T seems to be a well-documented example.
*
* @image html lcm1602.jpeg
* @snippet lcm1602-lcd.cxx Interesting
@ -63,11 +63,11 @@ class Lcm1602 : public LCD
{
public:
/**
* Lcm1602 Constructor, calls libmraa initialisation functions
* Lcm1602 constructor; calls libmraa initialisation functions
*
* @param bus i2c bus to use
* @param address the slave address the lcd is registered on
* @param isExpander true if we are dealing with an I2C expander,
* @param bus I2C bus to use
* @param address Slave address the LCD is registered on
* @param isExpander True if we are dealing with an I2C expander,
* false otherwise. Default is true.
*/
Lcm1602(int bus, int address, bool isExpander=true);
@ -77,46 +77,46 @@ class Lcm1602 : public LCD
* controllers supporting RS, Enable, and 4 data pins in 4-bit
* mode.
*
* @param rs register select pin
* @param enable enable pin
* @param d0 data 0 pin
* @param d1 data 1 pin
* @param d2 data 2 pin
* @param d3 data 3 pin
* @param rs Register select pin
* @param enable Enable pin
* @param d0 Data 0 pin
* @param d1 Data 1 pin
* @param d2 Data 2 pin
* @param d3 Data 3 pin
*/
Lcm1602(uint8_t rs, uint8_t enable,
uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3);
/**
* Lcm1602 Destructor
* Lcm1602 destructor
*/
~Lcm1602();
/**
* Write a string to LCD
* Writes a string to the LCD
*
* @param msg The std::string to write to display, note only ascii
* chars are supported
* @return Result of operation
* @param msg std::string to write to the display; note: only ASCII
* characters are supported
* @return Result of the operation
*/
mraa_result_t write(std::string msg);
/**
* Set cursor to a coordinate
* Sets the cursor to specified coordinates
*
* @param row The row to set cursor to
* @param column The column to set cursor to
* @return Result of operation
* @param row Row to set the cursor to
* @param column Column to set the cursor to
* @return Result of the operation
*/
mraa_result_t setCursor(int row, int column);
/**
* Clear display from characters
* Clears the display of all characters
*
* @return Result of operation
* @return Result of the operation
*/
mraa_result_t clear();
/**
* Return to coordinate 0,0
* Returns to the original coordinates (0,0)
*
* @return Result of operation
* @return Result of the operation
*/
mraa_result_t home();

50
src/lcd/ssd1308.h
View File

@ -1,4 +1,4 @@
/*
/*
* Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
* Copyright (c) 2014 Intel Corporation.
*
@ -44,11 +44,11 @@ const uint8_t DISPLAY_CMD_SET_NORMAL_1308 = 0xA6;
* @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_0.96%22
* @con i2c
*
* @brief API for SSD1308 i2c controlled OLED displays
* @brief API for SSD1308 I2C-controlled OLED displays
*
* The SSD1308 is a 128x64 Dot matrix OLED/PLED segment driver with
* SSD1308 is a 128x64 dot-matrix OLED/PLED segment driver with a
* controller. This implementation was tested using the Grove LED 128×64
* Display module which is an OLED monochrome display.
* Display module, which is an OLED monochrome display.
*
* @image html ssd1308.jpeg
* @snippet ssd1308-oled.cxx Interesting
@ -57,51 +57,51 @@ class SSD1308 : public LCD
{
public:
/**
* SSD1308 Constructor, calls libmraa initialisation functions
* SSD1308 constructor; calls libmraa initialisation functions
*
* @param bus i2c bus to use
* @param address the slave address the lcd is registered on
* @param bus I2C bus to use
* @param address Slave address the LCD is registered on
*/
SSD1308(int bus, int address = 0x3C);
/**
* SSD1308 Destructor
* SSD1308 destructor
*/
~SSD1308();
/**
* Draw an image, see examples/python/make_oled_pic.py for an
* explanation on how the pixels are mapped to bytes
* Draws an image; see examples/python/make_oled_pic.py for an
* explanation of how pixels are mapped to bytes
*
* @param data the buffer to read
* @param bytes the amount of bytes to read from the pointer
* @return Result of operation
* @param data Buffer to read
* @param bytes Number of bytes to read from the pointer
* @return Result of the operation
*/
mraa_result_t draw(uint8_t* data, int bytes);
/**
* Write a string to LCD
* Writes a string to the LCD
*
* @param msg The std::string to write to display, note only ascii
* chars are supported
* @return Result of operation
* @param msg std::string to write to the display; note: only ASCII
* characters are supported
* @return Result of the operation
*/
mraa_result_t write(std::string msg);
/**
* Set cursor to a coordinate
* Sets the cursor to specified coordinates
*
* @param row The row to set cursor to
* @param column The column to set cursor to
* @return Result of operation
* @param row Row to set the cursor to
* @param column Column to set the cursor to
* @return Result of the operation
*/
mraa_result_t setCursor(int row, int column);
/**
* Clear display from characters
* Clears the display of all characters
*
* @return Result of operatio
* @return Result of the operation
*/
mraa_result_t clear();
/**
* Return to coordinate 0,0
* Returns to the original coordinates (0,0)
*
* @return Result of operation
* @return Result of the operation
*/
mraa_result_t home();

54
src/lcd/ssd1327.h
View File

@ -1,4 +1,4 @@
/*
/*
* Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
* Copyright (c) 2014 Intel Corporation.
*
@ -44,10 +44,10 @@ const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4;
* @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_1.12%22
* @con i2c
*
* @brief API for SSD1327 i2c controlled OLED displays
* @brief API for SSD1327 I2C-controlled OLED displays
*
* The SSD1327 is a 96x96 Dot matrix OLED/PLED segment driver with controller.
* This implementation was tested using the Grove LED 96×96 Display module
* SSD1327 is a 96x96 dot-matrix OLED/PLED segment driver with a controller.
* This implementation was tested using the Grove LED 96×96 Display module,
* which is an OLED monochrome display.
*
* @image html ssd1327.jpeg
@ -57,10 +57,10 @@ class SSD1327 : public LCD
{
public:
/**
* SSD1327 Constructor, calls libmraa initialisation functions
* SSD1327 constructor; calls libmraa initialisation functions
*
* @param bus i2c bus to use
* @param address the slave address the lcd is registered on
* @param bus I2C bus to use
* @param address Slave address the LCD is registered on
*/
SSD1327(int bus, int address = 0x3C);
/**
@ -68,47 +68,47 @@ class SSD1327 : public LCD
*/
~SSD1327();
/**
* Draw an image, see examples/python/make_oled_pic.py for an
* explanation on how the pixels are mapped to bytes
* Draws an image; see examples/python/make_oled_pic.py for an
* explanation of how pixels are mapped to bytes
*
* @param data the buffer to read
* @param bytes the amount of bytes to read from the pointer
* @return Result of operation
* @param data Buffer to read
* @param bytes Number of bytes to read from the pointer
* @return Result of the operation
*/
mraa_result_t draw(uint8_t* data, int bytes);
/**
* Set gray level for LCD panel
* Sets the gray level for the LCD panel
*
* @param gray level from 0-255
* @return Result of operation
* @param gray level from 0 to 255
* @return Result of the operation
*/
void setGrayLevel(uint8_t level);
/**
* Write a string to LCD
* Writes a string to the LCD
*
* @param msg The std::string to write to display, note only ascii
* chars are supported
* @return Result of operation
* @param msg std::string to write to the display; note: only ASCII
* characters are supported
* @return Result of the operation
*/
mraa_result_t write(std::string msg);
/**
* Set cursor to a coordinate
* Sets the cursor to specified coordinates
*
* @param row The row to set cursor to
* @param column The column to set cursor to
* @return Result of operation
* @param row Row to set the cursor to
* @param column Column to set the cursor to
* @return Result of the operation
*/
mraa_result_t setCursor(int row, int column);
/**
* Clear display from characters
* Clears the display of all characters
*
* @return Result of operatio
* @return Result of the operation
*/
mraa_result_t clear();
/**
* Return to coordinate 0,0
* Returns to the original coordinates (0,0)
*
* @return Result of operation
* @return Result of the operation
*/
mraa_result_t home();