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.
Dependencies: MaximInterface mbed
Display Class Reference
Interface to the Newhaven Display NHD-C0220BiZ-FS(RGB)-FBW-3VM LCD module and MAX7306 PWM LED driver for backlight color selection. More...
#include <Display.hpp>
Data Structures | |
| struct | Color |
| 24-bit RGB color for the backlight. More... | |
Public Types | |
| enum | Line |
Display line referenced from top. More... | |
Public Member Functions | |
| Display (mbed::I2C &I2C_intf, uint8_t LCD_I2C_addr, uint8_t LED_driver_I2C_addr) | |
| void | initialize () |
| Initialize display components. | |
| void | clearDisplay () |
| Clear all display lines. | |
| void | clearLine (Line line) |
| Clear a specific display line. | |
| void | writeCharacter (uint8_t character) |
| Write a single character to the display at the current cursor position. | |
| void | writeText (const std::string &text) |
| Write text to the display at the current cursor position. | |
| void | setCursorPosition (Line line, size_t position=0) |
| Set cursor to a certain line and zero-index position within the line. | |
| void | writeLine (const std::string &text, Line line) |
| Writes text to the display starting at the beginning of the line. | |
| void | writeCompleteLine (const std::string &text, Line line) |
| Writes text to the display starting at the beginning of the line and clears the remainder of the line. | |
| void | writeMessage (const std::string &text) |
| Writes a message to the display with text wrapping allowed at spaces. | |
| void | setBackLightColor (const Color &color) |
| Set the display backlight to a certain color. | |
Static Public Attributes | |
| static const size_t | lineLength = 20 |
| Length in character os a display line. | |
Detailed Description
Interface to the Newhaven Display NHD-C0220BiZ-FS(RGB)-FBW-3VM LCD module and MAX7306 PWM LED driver for backlight color selection.
Definition at line 44 of file Display.hpp.
Member Enumeration Documentation
| enum Line |
Display line referenced from top.
Definition at line 47 of file Display.hpp.
Constructor & Destructor Documentation
| Display | ( | mbed::I2C & | I2C_intf, |
| uint8_t | LCD_I2C_addr, | ||
| uint8_t | LED_driver_I2C_addr | ||
| ) |
- Parameters:
-
I2C_interface A configured I2C interface to use for communication. LCD_I2C_address LCD module bus address in mbed format. LED_driver_I2C_addr PWM LED driver (MAX7306) bus address in mbed format.
Definition at line 100 of file Display.cpp.
Member Function Documentation
| void clearDisplay | ( | ) |
Clear all display lines.
Definition at line 162 of file Display.cpp.
| void clearLine | ( | Line | line ) |
Clear a specific display line.
Definition at line 157 of file Display.cpp.
| void initialize | ( | ) |
Initialize display components.
Definition at line 105 of file Display.cpp.
| void setBackLightColor | ( | const Color & | color ) |
Set the display backlight to a certain color.
Definition at line 134 of file Display.cpp.
| void setCursorPosition | ( | Line | line, |
| size_t | position = 0 |
||
| ) |
Set cursor to a certain line and zero-index position within the line.
Definition at line 223 of file Display.cpp.
| void writeCharacter | ( | uint8_t | character ) |
Write a single character to the display at the current cursor position.
Definition at line 195 of file Display.cpp.
| void writeCompleteLine | ( | const std::string & | text, |
| Line | line | ||
| ) |
Writes text to the display starting at the beginning of the line and clears the remainder of the line.
Definition at line 242 of file Display.cpp.
| void writeLine | ( | const std::string & | text, |
| Line | line | ||
| ) |
Writes text to the display starting at the beginning of the line.
Definition at line 237 of file Display.cpp.
| void writeMessage | ( | const std::string & | text ) |
Writes a message to the display with text wrapping allowed at spaces.
Definition at line 251 of file Display.cpp.
| void writeText | ( | const std::string & | text ) |
Write text to the display at the current cursor position.
Definition at line 203 of file Display.cpp.
Field Documentation
const size_t lineLength = 20 [static] |
Length in character os a display line.
Definition at line 55 of file Display.hpp.
Generated on Wed Jul 13 2022 21:31:03 by
1.7.2
MAXREFDES143#: DeepCover Embedded Security in IoT Authenticated Sensing & Notification