unilcd.h

Go to the documentation of this file.

 
#ifndef __UNI_LCD_LIB_HEADER__
#define __UNI_LCD_LIB_HEADER__
 
#if defined(ARDUINO_AVR_MEGA2560) || defined(ARDUINO_AVR_UNO) || defined(ARDUINO_SAM_DUE)
// Arduino
#include "arduino-conf.h"
#elif __PICC__
// MPLAB XC C for PIC.
#include "xc8-pic-conf.h"
#elif STM32_LIBOPENCM3
// STM32 with LibOpenCM3.
#include "stm32-libopencm3-conf.h"
#include "stm32_delay.h"
#elif ESP8266_FREERTOS
// ESP8266 FreeRTOS SDK.
#include <unistd.h>
#include "driver/gpio.h"
#include "esp8266-conf.h"
#else
#error "Unsupported board or microcontroller."
#endif
 
#define LCD_CMD_CLEAR   0x01
#define LCD_CMD_HOME    0x02
 
#define LCD_CMD_ENTRY_MODE          0x04
#define LCD_CMD_ENTRY_INC_ADDRESS   0x02
#define LCD_CMD_ENTRY_SHIFT_LEFT    0x01
 
#define LCD_CMD_DISPLAY               0x08
#define LCD_CMD_DISPLAY_ON            0x04
#define LCD_CMD_DISPLAY_CUSROR        0x02
#define LCD_CMD_DISPLAY_CURSOR_BLINK  0x01
 
#define LCD_CMD_SHIFT           0x10
#define LCD_CMD_SHIFT_RIGHT     0x04
#define LCD_CMD_SHIFT_DISPLAY   0x08
 
#define LCD_CMD_FUNCTION          0x20
#define LCD_CMD_FUNC_8BIT_LENGTH  0x10
#define LCD_CMD_FUNC_LINES        0x04
#define LCD_CMD_FUNC_FONT         0x08
 
#define LCD_CMD_CG_RAM    0x40
#define LCD_CMD_DDRAM     0x80
 
// Instruction modes.
 
#define INSTRUCTION_MODE_CMD  0x00
#define INSTRUCTION_MODE_CHAR 0x01
 
#define sendLCDData(d)    sendLCDInstruction(d, INSTRUCTION_MODE_CHAR)
#define sendLCDCommand(c) sendLCDInstruction(c, INSTRUCTION_MODE_CMD)
 
VOID initLCDInterface(VOID);
VOID sendLCDInstruction(UCHAR data, UCHAR mode);
 
VOID initLCD(VOID);
VOID printStringLen(const CHAR *str, UCHAR maxLength);
VOID gotoLCDPosition(UCHAR x, UCHAR y);
VOID setDisplayState(UCHAR onState);  
VOID setCursorState(UCHAR cursorState);
VOID setCursorBlinkState(UCHAR blinkState);
VOID setCustomChar(UCHAR addr, UCHAR *buffer);
 
VOID setBacklightState(UCHAR backLightState);
 
#define clearLCD()      sendLCDCommand(LCD_CMD_CLEAR)
#define returnToHome()  sendLCDCommand(LCD_CMD_HOME)
 
#define printChar(c)    sendLCDData(c)
#define printString(s)  printStringLen(s, MAX_STR_LEN)
 
#endif /* __UNI_LCD_LIB_HEADER__ */