Noiasca Liquid Crystal
A light weight LCD Library to print UTF-8 and special characters easily.
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LiquidCrystal_4bit_base Class Reference

#include <lcd_4bit.h>

Inheritance diagram for LiquidCrystal_4bit_base:
LiquidCrystal_dummy LiquidCrystal_4bit LiquidCrystal_4bit_4004_base LiquidCrystal_4bit_4004

Public Member Functions

 LiquidCrystal_4bit_base (uint8_t rsPin, uint8_t enPin, uint8_t d4Pin, uint8_t d5Pin, uint8_t d6Pin, uint8_t d7Pin, uint8_t blPin, uint8_t cols, uint8_t rows)
 
 LiquidCrystal_4bit_base (uint8_t rsPin, uint8_t enPin, uint8_t d4Pin, uint8_t d5Pin, uint8_t d6Pin, uint8_t d7Pin, uint8_t blPin, t_backlightPol blType, uint8_t cols, uint8_t rows)
 
 LiquidCrystal_4bit_base (uint8_t rsPin, uint8_t enPin, uint8_t en2Pin, uint8_t d4Pin, uint8_t d5Pin, uint8_t d6Pin, uint8_t d7Pin, uint8_t blPin, t_backlightPol blType, uint8_t cols, uint8_t rows)
 
size_t write (uint8_t value)
 writes a character to the LCD More...
 
virtual void hwInit ()
 
void begin ()
 
void init ()
 
void backlight (void)
 
void noBacklight (void)
 
void setBacklight (uint8_t new_val)
 
- Public Member Functions inherited from LiquidCrystal_dummy
 LiquidCrystal_dummy (uint8_t, uint8_t)
 
void setDelay (uint8_t, char)
 
size_t writeOld (uint8_t)
 unmodified version of write More...
 
void command (uint8_t)
 Send a command to the display, for commands not supported by the library (LCD API) More...
 
void clear ()
 Clear the display and place cursor at 0,0 (LCD API) More...
 
void home ()
 Home the cursor to 0,0 and leave displayed characters (LCD API) More...
 
void setCursor (uint8_t, uint8_t)
 Where Row 0-MAXLINEs, and Col 0-MAXCOLUMNS. More...
 
void cursor ()
 Turn the block cursor on. More...
 
void cursor_on ()
 
void noCursor ()
 Turn the block cursor off. More...
 
void cursor_off ()
 
void blink ()
 Turn on the blinking underline cursor (LCD API blink_on) More...
 
void blink_on ()
 
void noBlink ()
 Turn off the blinking underline cursor (LCD blink_off) More...
 
void blink_off ()
 
void setContrast (int)
 
void on ()
 Turn the LCD display on (LCD API optional) More...
 
void off ()
 Turn the LCD display off (LCD API optional) More...
 
void createChar (const uint8_t, const uint8_t[])
 Load up a custom character (LCD API extend) More...
 
void load_custom_character (const uint8_t Char_Num, const uint8_t Rows[])
 
void createChar_P (const uint8_t, const uint8_t *)
 Load up a custom character from PROGMEM. More...
 
void createUml ()
 creates 3 German Umlauts using special characters 5, 6, and 7 More...
 
void setFont (uint8_t value=0)
 sets the used font More...
 

Protected Member Functions

void send (uint8_t value, uint8_t rs, uint8_t rw=rwWrite)
 
void write4bits (uint8_t value, uint8_t rs=rsIR, uint8_t rw=rwWrite)
 
virtual void pulseEnable (void)
 
void digitalWriteFast (uint8_t pin, uint8_t val)
 
virtual void send (uint8_t, uint8_t, uint8_t=rwWrite)
 

Protected Attributes

const uint8_t rsPin
 
const uint8_t enPin
 
const uint8_t en2Pin
 
const uint8_t blPin
 
const t_backlightPol blType
 
const uint8_t dataPin [4]
 
- Protected Attributes inherited from LiquidCrystal_dummy
const uint8_t waitshort = 37
 
const uint16_t waitlong = 1500
 
uint8_t rowStartingAddress [4] {0x00, 0x40, 0x14, 0x54}
 
const uint8_t cols
 
const uint8_t rows
 
uint8_t currentRow = 255
 
uint8_t entrymodesetFlag
 
uint8_t displaycontrolFlag = displaycontrol_on
 
uint32_t special = 0
 

Additional Inherited Members

- Static Protected Attributes inherited from LiquidCrystal_dummy
static const uint8_t cleardisplay = 0x01
 
static const uint8_t returnhome = 0x02
 
static const uint8_t entrymodeset = 0x04
 
static const uint8_t displaycontrol = 0x08
 
static const uint8_t cursorshift = 0x10
 
static const uint8_t functionset = 0x20
 
static const uint8_t setcgramaddress = 0x40
 
static const uint8_t setddramaddress = 0x80
 
static const uint8_t entrymode_shift = 0x01
 
static const uint8_t entrymode_increment = 0x02
 
static const uint8_t displaycontrol_blink = 0x01
 
static const uint8_t displaycontrol_cursor = 0x02
 
static const uint8_t displaycontrol_on = 0x04
 
static const uint8_t cursorshift_right = 0x04
 
static const uint8_t cursorshift_displayshift = 0x08
 
static const uint8_t functionset_font = 0x04
 
static const uint8_t functionset_lines = 0x08
 
static const uint8_t functionset_8bit = 0x10
 
static const byte rsIR = 0
 
static const byte rsDR = 1
 
static const byte rwWrite = 0
 
static const byte rwRead = 1
 

Constructor & Destructor Documentation

◆ LiquidCrystal_4bit_base() [1/3]

LiquidCrystal_4bit_base::LiquidCrystal_4bit_base ( uint8_t  rsPin,
uint8_t  enPin,
uint8_t  d4Pin,
uint8_t  d5Pin,
uint8_t  d6Pin,
uint8_t  d7Pin,
uint8_t  blPin,
uint8_t  cols,
uint8_t  rows 
)
inline

◆ LiquidCrystal_4bit_base() [2/3]

LiquidCrystal_4bit_base::LiquidCrystal_4bit_base ( uint8_t  rsPin,
uint8_t  enPin,
uint8_t  d4Pin,
uint8_t  d5Pin,
uint8_t  d6Pin,
uint8_t  d7Pin,
uint8_t  blPin,
t_backlightPol  blType,
uint8_t  cols,
uint8_t  rows 
)
inline

◆ LiquidCrystal_4bit_base() [3/3]

LiquidCrystal_4bit_base::LiquidCrystal_4bit_base ( uint8_t  rsPin,
uint8_t  enPin,
uint8_t  en2Pin,
uint8_t  d4Pin,
uint8_t  d5Pin,
uint8_t  d6Pin,
uint8_t  d7Pin,
uint8_t  blPin,
t_backlightPol  blType,
uint8_t  cols,
uint8_t  rows 
)
inline

Member Function Documentation

◆ write()

size_t LiquidCrystal_4bit_base::write ( uint8_t  value)
inline

writes a character to the LCD

◆ hwInit()

virtual void LiquidCrystal_4bit_base::hwInit ( )
inlinevirtual

Reimplemented in LiquidCrystal_4bit_4004_base.

◆ begin()

void LiquidCrystal_4bit_base::begin ( )
inline

◆ init()

void LiquidCrystal_4bit_base::init ( )
inline

◆ backlight()

void LiquidCrystal_4bit_base::backlight ( void  )
inline

◆ noBacklight()

void LiquidCrystal_4bit_base::noBacklight ( void  )
inline

◆ setBacklight()

void LiquidCrystal_4bit_base::setBacklight ( uint8_t  new_val)
inline

◆ send()

void LiquidCrystal_4bit_base::send ( uint8_t  value,
uint8_t  rs,
uint8_t  rw = rwWrite 
)
inlineprotectedvirtual

Reimplemented from LiquidCrystal_dummy.

◆ write4bits()

void LiquidCrystal_4bit_base::write4bits ( uint8_t  value,
uint8_t  rs = rsIR,
uint8_t  rw = rwWrite 
)
inlineprotected

◆ pulseEnable()

virtual void LiquidCrystal_4bit_base::pulseEnable ( void  )
inlineprotectedvirtual

Reimplemented in LiquidCrystal_4bit_4004_base.

◆ digitalWriteFast()

void LiquidCrystal_4bit_base::digitalWriteFast ( uint8_t  pin,
uint8_t  val 
)
inlineprotected

Member Data Documentation

◆ rsPin

const uint8_t LiquidCrystal_4bit_base::rsPin
protected

◆ enPin

const uint8_t LiquidCrystal_4bit_base::enPin
protected

◆ en2Pin

const uint8_t LiquidCrystal_4bit_base::en2Pin
protected

◆ blPin

const uint8_t LiquidCrystal_4bit_base::blPin
protected

◆ blType

const t_backlightPol LiquidCrystal_4bit_base::blType
protected

◆ dataPin

const uint8_t LiquidCrystal_4bit_base::dataPin[4]
protected