nz_lcd2s.h

Go to the documentation of this file.

#ifndef _LCD2S_H_
#define _LCD2S_H_

#if defined(NZ_LCD2S_ENABLED)

//Global defines
#ifndef LCD2S_I2C_ADR
#define LCD2S_I2C_ADR  80ul  //LCD2S I2C Address
#endif

//Default is a single LCD2S display on I2C bus
#ifndef LCD2S_MAX_NUMBER
#define LCD2S_MAX_NUMBER 1
#endif

//Default buffer of 8 for each LCD2S keypad buffer
#ifndef KPAD_BUF_SIZE
#define KPAD_BUF_SIZE  8ul
#endif

//Use I2C bus 1 by default
#ifndef LCD2S_USE_I2C_BUS
#define LCD2S_USE_I2C_BUS  1
#endif


//LCD2S Commands
#define LCD2S_CMD_CURSOR_MOVES_BACKWARDS    0x01

#define LCD2S_CMD_CURSOR_MOVES_FORWARD      0x09

#define LCD2S_CMD_BLINK_BLOCK_CURSOR_OFF    0x10

#define LCD2S_CMD_UNDERLINE_CURSOR_ON       0x19

#define LCD2S_CMD_DISPLAY_ON                0x1A

#define LCD2S_CMD_DISPLAY_OFF               0x12

#define LCD2S_CMD_INTERRUPT_PIN_PUSH_PULL   0x22

#define LCD2S_CMD_BACKLIGHT_ON              0x28

#define LCD2S_CMD_BACKLIGHT_OFF             0x20

#define LCD2S_CMD_OUT1_OFF                  0x30

#define LCD2S_CMD_OUT2_OFF                  0x31

#define LCD2S_CMD_OUT1_ON                   0x38

#define LCD2S_CMD_OUT2_ON                   0x39

#define LCD2S_CMD_GPIO1_OFF                 0x40

#define LCD2S_CMD_GPIO2_OFF                 0x41

#define LCD2S_CMD_GPIO1_ON                  0x48

#define LCD2S_CMD_GPIO2_ON                  0x49

#define LCD2S_CMD_WRITE_STRING              0x80

#define LCD2S_CMD_SET_BACKLIGHT             0x81

#define LCD2S_CMD_SET_CONTRAST              0x82

#define LCD2S_CMD_MOVE_CURSOR_RIGHT         0x83

#define LCD2S_CMD_MOVE_CURSOR_LEFT          0x84

#define LCD2S_CMD_SHIFT_DISPLAY_RIGHT       0x85

#define LCD2S_CMD_SHIFT_DISPLAY_LEFT        0x86

#define LCD2S_CMD_SHIFT_DISPLAY_UP          0x85

#define LCD2S_CMD_SHIFT_DISPLAY_DOWN        0x86

#define LCD2S_CMD_SET_CURSOR_ADDRESS        0x89 

#define LCD2S_CMD_SET_CURSOR_POSITION       0x8A

#define LCD2S_CMD_CLEAR_DISPLAY             0x8C

#define LCD2S_CMD_REMEMBER                  0x8D

#define LCD2S_CMD_LOAD_CUSTOM_CHAR_SET      0x8E

#define LCD2S_CMD_WRITE_LARGE_NUM_STING     0x8F

#define LCD2S_CMD_SET_STARTUP_SCREEN        0x90

#define LCD2S_CMD_SET_I2C_BASE_ADR          0x91

#define LCD2S_CMD_DEFINE_CUSTOM_CHAR        0x92

#define LCD2S_CMD_DRAW_VERT_BAR_GRAPH       0x93

#define LCD2S_CMD_DRAW_TALL_VERT_BAR_GRAPH  0x94

#define LCD2S_CMD_CONFIG_DEVICE             0x95

#define LCD2S_CMD_SET_KEYPAD_REPEAT_DELAY   0xA0

#define LCD2S_CMD_SET_KEYPAD_REPEAT_RATE    0xA1

#define LCD2S_CMD_SET_KEYPAD_BUZZER_PERIOD  0xA2

#define LCD2S_CMD_MAX_BACKLIGHT             0xA3    

#define LCD2S_CMD_GET_STATUS                0xD0

#define LCD2S_CMD_GET_KEY                   0xD1

#define LCD2S_CMD_GET_GPIO1_TO_GPIO3        0xD3

#define LCD2S_CMD_CONFIG_KEYPAD_AND_IO      0xE0

#define LCD2S_CMD_SET_KEYPAD_DEBOUNCE_TIME  0xE1

#define LCD2S_CMD_SET_OUT1_AND_OUT2         0xE2

#define LCD2S_CMD_CONFIG_GPIO1              0xE3

#define LCD2S_CMD_CONFIG_GPIO2              0xE4



//Global data
extern BYTE kpadBufGet[LCD2S_MAX_NUMBER];    //get index
extern BYTE kpadBufPut[LCD2S_MAX_NUMBER];    //put index


//Function prototypes


void lcdInit(void);


void lcd2sTask(void);


#define kpadHasKeys(kpadNum) (kpadBufPut[kpadNum] != kpadBufGet[kpadNum])


BYTE kpadGetKey(BYTE kpadNum);


INT8 lcdPutCmd(BYTE lcdNum, BYTE cmd);


INT8 lcdPutCmd1Param(BYTE lcdNum, BYTE cmd, BYTE param1);


INT8 lcdPutCmd2Param(BYTE lcdNum, BYTE cmd, BYTE param1, BYTE param2);


INT8 lcdPutArray(BYTE lcdNum, BYTE* buf, BYTE len);


INT8 lcdDisplayChar(BYTE lcdNum, char c);


INT8 lcdDisplayCharHex(BYTE lcdNum, BYTE c);


INT8 lcdDisplayString(BYTE lcdNum, char* s);


INT8 lcdSetStartupScreen(BYTE lcdNum, BYTE row, char* string);


INT8 lcdDrawVertBargraph(BYTE lcdNum, BYTE row, BYTE col, BYTE height);


#define lcdSetCursorPosition(lcdNum, row, col) lcdPutCmd2Param(lcdNum, LCD2S_CMD_SET_CURSOR_POSITION, row, col)

#define lcdSetBacklight(lcdNum, value) lcdPutCmd1Param(lcdNum, LCD2S_CMD_SET_BACKLIGHT, value)

#define lcdSetContrast(lcdNum, value) lcdPutCmd1Param(lcdNum, LCD2S_CMD_SET_CONTRAST, value)

#define lcdLoadCustomCharSet(lcdNum, value) lcdPutCmd1Param(lcdNum, LCD2S_CMD_LOAD_CUSTOM_CHAR_SET, value)

#define lcdDefineCustomChar(lcdNum, buf) lcdPutArray(lcdNum, buf, 10)

#endif  //#if defined(NZ_LCD2S_ENABLED)
#endif  //_LCD2S_H_