pifacecad.h

Go to the documentation of this file.

#ifndef _PIFACECAD_H
#define _PIFACECAD_H

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define DELAY_PULSE_NS 1000 // 1us
#define DELAY_SETTLE_NS 40000 // 40us
#define DELAY_SETUP_0_NS 15000000L // 15ms
#define DELAY_SETUP_1_NS 5000000L // 5ms
#define DELAY_SETUP_2_NS 1000000L // 1ms

// mcp23s17 GPIOB to HD44780 pin map
#define PIN_D4 0
#define PIN_D5 1
#define PIN_D6 2
#define PIN_D7 3
#define PIN_ENABLE 4
#define PIN_RW 5
#define PIN_RS 6
#define PIN_BACKLIGHT 7

// commands
#define LCD_CLEARDISPLAY 0x01
#define LCD_RETURNHOME 0x02
#define LCD_ENTRYMODESET 0x04
#define LCD_DISPLAYCONTROL 0x08
#define LCD_CURSORSHIFT 0x10
#define LCD_FUNCTIONSET 0x20
#define LCD_SETCGRAMADDR 0x40
#define LCD_SETDDRAMADDR 0x80
#define LCD_NEWLINE 0xC0

// flags for display entry mode
#define LCD_ENTRYRIGHT 0x00
#define LCD_ENTRYLEFT 0x02
#define LCD_ENTRYSHIFTINCREMENT 0x01
#define LCD_ENTRYSHIFTDECREMENT 0x00

// flags for display on/off control
#define LCD_DISPLAYON 0x04
#define LCD_DISPLAYOFF 0x00
#define LCD_CURSORON 0x02
#define LCD_CURSOROFF 0x00
#define LCD_BLINKON 0x01
#define LCD_BLINKOFF 0x00

// flags for display/cursor shift
#define LCD_DISPLAYMOVE 0x08
#define LCD_CURSORMOVE 0x00
#define LCD_MOVERIGHT 0x04
#define LCD_MOVELEFT 0x00

// flags for function set
#define LCD_8BITMODE 0x10
#define LCD_4BITMODE 0x00
#define LCD_2LINE 0x08
#define LCD_1LINE 0x00
#define LCD_5X10DOTS 0x04
#define LCD_5X8DOTS 0x00

#define LCD_MAX_LINES 2
#define LCD_WIDTH 16
#define LCD_RAM_WIDTH 80 // RAM is 80 wide, split over two lines

static const uint8_t ROW_OFFSETS[] = {0, 0x40};

int pifacecad_open(void);

int pifacecad_open_noinit(void);

void pifacecad_close(void);

void pifacecad_lcd_init(void);

uint8_t pifacecad_read_switches(void);

uint8_t pifacecad_read_switch(uint8_t switch_num);

uint8_t pifacecad_lcd_write(const char * message);

uint8_t pifacecad_lcd_set_cursor(uint8_t col, uint8_t row);

void pifacecad_lcd_set_cursor_address(uint8_t address);

uint8_t pifacecad_lcd_get_cursor_address(void);

void pifacecad_lcd_clear(void);

void pifacecad_lcd_home(void);

void pifacecad_lcd_display_on(void);

void pifacecad_lcd_display_off(void);

void pifacecad_lcd_blink_on(void);

void pifacecad_lcd_blink_off(void);

void pifacecad_lcd_cursor_on(void);

void pifacecad_lcd_cursor_off(void);

void pifacecad_lcd_backlight_on(void);

void pifacecad_lcd_backlight_off(void);

void pifacecad_lcd_move_left(void);

void pifacecad_lcd_move_right(void);

void pifacecad_lcd_left_to_right(void);

void pifacecad_lcd_right_to_left(void);

void pifacecad_lcd_autoscroll_on(void);

void pifacecad_lcd_autoscroll_off(void);

void pifacecad_lcd_write_custom_bitmap(uint8_t location);

void pifacecad_lcd_store_custom_bitmap(uint8_t location, uint8_t bitmap[]);

void pifacecad_lcd_send_command(uint8_t command);

void pifacecad_lcd_send_data(uint8_t data);

void pifacecad_lcd_send_byte(uint8_t byte);

void pifacecad_lcd_set_rs(uint8_t state);

void pifacecad_lcd_set_rw(uint8_t state);

void pifacecad_lcd_set_enable(uint8_t state);

void pifacecad_lcd_set_backlight(uint8_t state);

void pifacecad_lcd_pulse_enable(void);

uint8_t colrow2address(uint8_t col, uint8_t row);

uint8_t address2col(uint8_t address);

uint8_t address2row(uint8_t address);

// int pifacecad_lcd_set_viewport_corner(int col);
// int pifacecad_lcd_see_cursor(int col);

#ifdef __cplusplus
}
#endif

#endif