alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-03 10:21:19 +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

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();