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

Wire/I2C Display with RGB Backlight PCA9633. More...

#include <lcd_wire.h>

Inherits LiquidCrystal_Wire_base.

Public Member Functions

 LiquidCrystal_Wire_RGB (uint8_t lcdAddr, uint8_t cols, uint8_t rows)
 constructor for a native I2C LCD with RGB chip More...
 
 LiquidCrystal_Wire_RGB (uint8_t lcdAddr, uint8_t cols, uint8_t rows, CallBack funcPtr)
 constructor for a native I2C LCD with RGB chip More...
 
 LiquidCrystal_Wire_RGB (uint8_t lcdAddr, uint8_t rgbAddr, uint8_t cols, uint8_t rows)
 constructor for a native I2C LCD with RGB chip More...
 
 LiquidCrystal_Wire_RGB (uint8_t lcdAddr, uint8_t rgbAddr, uint8_t cols, uint8_t rows, CallBack funcPtr)
 constructor for a native I2C LCD with RGB chip More...
 
 LiquidCrystal_Wire_RGB (TwoWire &i2cPort, uint8_t lcdAddr, uint8_t cols, uint8_t rows)
 constructor for a native I2C LCD with RGB chip More...
 
 LiquidCrystal_Wire_RGB (TwoWire &i2cPort, uint8_t lcdAddr, uint8_t cols, uint8_t rows, CallBack funcPtr)
 constructor for a native I2C LCD with RGB chip More...
 
void backlight (void)
 
void noBacklight (void)
 
void setBacklight (uint8_t new_val)
 
void blinkBacklight (void)
 
void noBlinkBacklight (void)
 
void setRGB (uint8_t r, uint8_t g, uint8_t b)
 set all three backlight colors More...
 
void setRGB (uint32_t newColor)
 set backlight color More...
 

Detailed Description

Wire/I2C Display with RGB Backlight PCA9633.

Some LCD come with a dedicated RGB IC PCA9633. This class combines the native I2C display an the RGB IC. These displays are sold by Sureeno or Grove

Constructor & Destructor Documentation

◆ LiquidCrystal_Wire_RGB() [1/6]

LiquidCrystal_Wire_RGB::LiquidCrystal_Wire_RGB ( uint8_t  lcdAddr,
uint8_t  cols,
uint8_t  rows 
)
inline

constructor for a native I2C LCD with RGB chip

This constructor uses the custom converter

Parameters
lcdAddrthe I2C address
colsthe columns 8, 16, 20, 24 or 40
rowsthe rows: 1, 2 or 4

◆ LiquidCrystal_Wire_RGB() [2/6]

LiquidCrystal_Wire_RGB::LiquidCrystal_Wire_RGB ( uint8_t  lcdAddr,
uint8_t  cols,
uint8_t  rows,
CallBack  funcPtr 
)
inline

constructor for a native I2C LCD with RGB chip

This constructor accepts an individual the custom converter

Parameters
lcdAddrthe I2C address
colsthe columns 8, 16, 20, 24 or 40
rowsthe rows: 1, 2 or 4
funcPtra callback to the converter function

◆ LiquidCrystal_Wire_RGB() [3/6]

LiquidCrystal_Wire_RGB::LiquidCrystal_Wire_RGB ( uint8_t  lcdAddr,
uint8_t  rgbAddr,
uint8_t  cols,
uint8_t  rows 
)
inline

constructor for a native I2C LCD with RGB chip

This constructor accepts an address for the RGB chip and uses the custom converter

Parameters
lcdAddrthe I2C address
rgbAddrthe I2C address of the RGB chip
colsthe columns 8, 16, 20, 24 or 40
rowsthe rows: 1, 2 or 4

◆ LiquidCrystal_Wire_RGB() [4/6]

LiquidCrystal_Wire_RGB::LiquidCrystal_Wire_RGB ( uint8_t  lcdAddr,
uint8_t  rgbAddr,
uint8_t  cols,
uint8_t  rows,
CallBack  funcPtr 
)
inline

constructor for a native I2C LCD with RGB chip

This constructor accepts a Wire interface and uses the custom converter

Parameters
lcdAddrthe I2C address
rgbAddrthe I2C address of the RGB chip
colsthe columns 8, 16, 20, 24 or 40
rowsthe rows: 1, 2 or 4
funcPtra callback to the converter function

◆ LiquidCrystal_Wire_RGB() [5/6]

LiquidCrystal_Wire_RGB::LiquidCrystal_Wire_RGB ( TwoWire &  i2cPort,
uint8_t  lcdAddr,
uint8_t  cols,
uint8_t  rows 
)
inline

constructor for a native I2C LCD with RGB chip

This constructor accepts a Wire interface and uses the custom converter

Parameters
i2cPorta Wire interface
lcdAddrthe I2C address
colsthe columns 8, 16, 20, 24 or 40
rowsthe rows: 1, 2 or 4

◆ LiquidCrystal_Wire_RGB() [6/6]

LiquidCrystal_Wire_RGB::LiquidCrystal_Wire_RGB ( TwoWire &  i2cPort,
uint8_t  lcdAddr,
uint8_t  cols,
uint8_t  rows,
CallBack  funcPtr 
)
inline

constructor for a native I2C LCD with RGB chip

This constructor accepts a Wire interface and uses the custom converter

Parameters
i2cPorta Wire interface
lcdAddrthe I2C address
colsthe columns 8, 16, 20, 24 or 40
rowsthe rows: 1, 2 or 4
funcPtra callback to the converter function

Member Function Documentation

◆ backlight()

void LiquidCrystal_Wire_RGB::backlight ( void  )
inline

Turn the (optional) backlight on for these displays it's done by hardware with the RGB chip

◆ noBacklight()

void LiquidCrystal_Wire_RGB::noBacklight ( void  )
inline

switch on the backlight for these displays it's done by hardware with the RGB chip

◆ setBacklight()

void LiquidCrystal_Wire_RGB::setBacklight ( uint8_t  new_val)
inline

set brightness of LED backlight

◆ blinkBacklight()

void LiquidCrystal_Wire_RGB::blinkBacklight ( void  )
inline

switch on the backlight - LED blinking

◆ noBlinkBacklight()

void LiquidCrystal_Wire_RGB::noBlinkBacklight ( void  )
inline

switch off the backlight - LED blinking

◆ setRGB() [1/2]

void LiquidCrystal_Wire_RGB::setRGB ( uint8_t  r,
uint8_t  g,
uint8_t  b 
)
inline

set all three backlight colors

Sends data with autoincrement, which should be faster but needs 32 bytes more than the former version

Parameters
rred color
ggreen color
bblue color

◆ setRGB() [2/2]

void LiquidCrystal_Wire_RGB::setRGB ( uint32_t  newColor)
inline

set backlight color

Sets the backlight the given RGB value

Parameters
newColorcombined color as RGB value in the common 0xRRGGBB format