Rod Coleman / TextOLED20x4

Driver for Text OLED display - 20x4 Winstar or Newhaven, with Winstar WS0010 driver IC

Embed: (wiki syntax)

« Back to documentation index

TextOLED20x4 Class Reference
Public Types | Public Member Functions

TextOLED20x4 Class Reference

A TextOLED20x4 interface for driving 4-bit HD44780-based LCDs. More...

#include <TextOLED20x4.h>

Public Types

enum  LCDType { LCD16x2, LCD16x2B, LCD20x2, LCD20x4 }
 

LCD panel format.

More...

Public Member Functions

 TextOLED20x4 (PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type=LCD16x2)
 Create a TextOLED20x4 interface.
int putc (int c)
 Write a character to the LCD.
int printf (const char *format,...)
 Write a formated string to the LCD.
void locate (int column, int row)
 Locate to a screen column and row.
void cls ()
 Clear the screen and locate to 0,0.

Detailed Description

A TextOLED20x4 interface for driving 4-bit HD44780-based LCDs.

Currently supports 16x2, 20x2 and 20x4 panels

 #include "mbed.h"
 #include "TextOLED20x4.h"
 
 TextOLED20x4 lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7
 
 int main() {
     lcd.printf("Hello World!\n");
 }

Definition at line 46 of file TextOLED20x4.h.

Member Enumeration Documentation

enum LCDType

LCD panel format.

Enumerator:
LCD16x2 

16x2 LCD panel (default)

LCD16x2B 

16x2 LCD panel alternate addressing

LCD20x2 

20x2 LCD panel

LCD20x4 

20x4 LCD panel

Definition at line 50 of file TextOLED20x4.h.

Constructor & Destructor Documentation

TextOLED20x4 ( PinName  rs,
PinName  e,
PinName  d4,
PinName  d5,
PinName  d6,
PinName  d7,
LCDType  type = LCD16x2 
)

Create a TextOLED20x4 interface.

Parameters:
rsInstruction/data control line
eEnable line (clock)
d4-d7Data lines for using as a 4-bit interface
typeSets the panel size/addressing mode (default = LCD16x2)

Definition at line 27 of file TextOLED20x4.cpp.

Member Function Documentation

void cls (  )

Clear the screen and locate to 0,0.

Definition at line 83 of file TextOLED20x4.cpp.

void locate ( int  column,
int  row 
)

Locate to a screen column and row.

Parameters:
columnThe horizontal position from the left, indexed from 0
rowThe vertical position from the top, indexed from 0

Definition at line 89 of file TextOLED20x4.cpp.

int printf ( const char *  format,
  ... 
)

Write a formated string to the LCD.

Parameters:
formatA printf-style format string, followed by the variables to use in formating the string.
int putc ( int  c )

Write a character to the LCD.

Parameters:
cThe character to write to the display
Generated on Tue Jul 12 2022 17:29:58 by  doxygen 1.7.2