Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: mbed_ssd1306 USB_meter_SD_file_number_filtro_for EscanerRf escaner_RTOS ... more
Revision 5:4f7cdc2ee49a, committed 2017-11-01
- Comitter:
- rodriguj
- Date:
- Wed Nov 01 16:32:22 2017 +0000
- Parent:
- 4:35757c8b7625
- Child:
- 6:cff0e772910f
- Commit message:
- Fixing Javadox tags...
Changed in this revision
| ssd1306.h | Show annotated file Show diff for this revision Revisions of this file |
--- a/ssd1306.h Wed Nov 01 16:19:50 2017 +0000
+++ b/ssd1306.h Wed Nov 01 16:32:22 2017 +0000
@@ -82,7 +82,6 @@
/** Creates an instance of a SSD1306 driver, specifying I2C pins to use
*
* @param sda I2C data line pin
- *
* @param scl I2C clock line pin
*/
SSD1306 (PinName sda, PinName scl, char ssd1306_addr = 0x78);
@@ -90,7 +89,6 @@
/** Creates an instance of a SSD1306 driver using an existing I2C object
*
* @param busi2c I2C object
- *
* @param ssd1306_addr I2C addr of SSD1306 controller
*/
SSD1306 (I2C &busi2c, char ssd1306_addr = 0x78);
@@ -114,7 +112,6 @@
/** Print a character at the current text position. Updates the text position and forces a scroll if at the end of the screen
*
* @param c ASCII code of the character to print (8-bit ASCII code, use original IBM code page 437. No control codes.
- *
* @param refresh (optional) Force an actual screen redraw after scrolling
*/
void putchar (char c, bool refresh=false);
@@ -122,7 +119,6 @@
/** Prints a NUL terminated string
*
* @param s C-style string (NUL terminated) to print.
- *
* @param refresh (optional) Force an actual screen redraw after scrolling
*/
void puts (char *s, bool refresh=false);
@@ -136,7 +132,6 @@
/** Change the text position
*
* @param row Text row (0-7) to print the next character
- *
* @param column Text column (0-15) to print the next character
*/
void locate (char row, char column);
@@ -154,7 +149,6 @@
/** Clear screen and optionally, fills it with a predefined picture (in 128x64 OLED format, see display datasheet). Also resets the text position.
*
* @param bkground If not NULL, should point to a 1024 byte buffer with the image to load to the display
- *
* @param refresh (optional) Force an actual screen redraw after scrolling
*/
void cls (char *bkground=NULL, bool refresh=false);
@@ -162,11 +156,8 @@
/** Plots a pixel.
*
* @param x x-coordinate (0-127) of the pixel. X coordinates go left to right.
- *
* @param y y-coordinate (0-63) of the pixel. Y coordinates go up to down.
- *
* @param mode. Plot style mode: Normal (pixel is drawn), Inverse (pixel is erased), or Xor (pixel is erased if background position is already set, otherwise is drawn)
- *
* @param refresh (optional) Force an actual screen redraw after scrolling
*/
void plot (char x, char y, PlotStyle mode, bool refresh=false);
@@ -174,9 +165,7 @@
/** Returns the state of a pixel coordinate from screen
*
* @param x x-coordinate (0-127) of the pixel. X coordinates go left to right.
- *
* @param y y-coordinate (0-63) of the pixel. Y coordinates go up to down.
- *
* @return true if the pixel was set, or false otherwise
*/
bool point (char x, char y);
@@ -184,15 +173,10 @@
/** Draws a line using the Bresenham algorithm
*
* @param x0 x-coordinate (0-127) of the starting point
- *
* @param y0 y-coordinate (0-63) of the starting point
- *
* @param x1 x-coordinate (0-127) of the ending point
- *
* @param y1 y-coordinate (0-63) of the ending point
- *
* @param mode. Plot style mode: Normal (pixel is drawn), Inverse (pixel is erased), or Xor (pixel is erased if background position is already set, otherwise is drawn)
- *
* @param refresh (optional) Force an actual screen redraw after scrolling
*/
void line (char x0, char y0, char x1, char y1, PlotStyle mode, bool refresh=false);
@@ -200,13 +184,9 @@
/** Draws a circle
*
* @param x0 x-coordinate (0-127) of the center point
- *
* @param y0 y-coordinate (0-63) of the center point
- *
* @param r radius of the circle
- *
* @param mode. Plot style mode: Normal (pixel is drawn), Inverse (pixel is erased), or Xor (pixel is erased if background position is already set, otherwise is drawn)
- *
* @param refresh (optional) Force an actual screen redraw after scrolling
*/
void circle (char x0, char y0, char r, PlotStyle mode, bool refresh=false);