docs/feature_hd44780.md

   1 # HD44780 LCD Displays
   2
   3 This is an integration of Peter Fleury's LCD library. This page will explain the basics. [For in depth documentation visit his page.](http://homepage.hispeed.ch/peterfleury/doxygen/avr-gcc-libraries/group__pfleury__lcd.html)
   4
   5 You can enable support for HD44780 Displays by setting the `HD44780_ENABLE` flag in your keyboards `rules.mk` to yes. This will use about 400 KB of extra space.
   6
   7 ## Configuration
   8
   9 You will need to configure the pins used by your display and its number of lines and collumn in your keyboards `config.h`.
  10
  11 Uncomment the section labled HD44780 and change the parameters as needed.
  12 ````
  13 /*
  14  * HD44780 LCD Display Configuration
  15  */
  16
  17 #define LCD_LINES           2     //< number of visible lines of the display
  18 #define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
  19 #define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
  20 #if LCD_IO_MODE
  21 #define LCD_PORT         PORTB        //< port for the LCD lines
  22 #define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
  23 #define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
  24 #define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
  25 #define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
  26 #define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
  27 #define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
  28 #define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
  29 #define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
  30 #define LCD_RS_PORT      LCD_PORT     //< port for RS line
  31 #define LCD_RS_PIN       3            //< pin  for RS line
  32 #define LCD_RW_PORT      LCD_PORT     //< port for RW line
  33 #define LCD_RW_PIN       2            //< pin  for RW line
  34 #define LCD_E_PORT       LCD_PORT     //< port for Enable line
  35 #define LCD_E_PIN        1            //< pin  for Enable line
  36 #endif
  37 ````
  38
  39 Should you need to configure other properties you can copy them from `quantum/hd44780.h` and set them in your `config.h`
  40
  41 ## Usage
  42
  43 To initialize your display call lcd_init() with one of these parameters:
  44 ````
  45 LCD_DISP_OFF             : display off
  46 LCD_DISP_ON              : display on, cursor off
  47 LCD_DISP_ON_CURSOR       : display on, cursor on
  48 LCD_DISP_ON_CURSOR_BLINK : display on, cursor on flashing
  49 ````
  50 This is best done in your keyboards `matrix_init_kb` or your keymaps `matrix_init_user`.
  51 It is advised to clear the display before use.
  52 To do so call `lcd_clrsrc()`.
  53
  54 To now print something to your Display you first call `lcd_gotoxy(column, line)`. To go to the start of the first line you would call `lcd_gotoxy(0, 0)` and then print a string with `lcd_puts("example string")`.
  55
  56 There are more posible methods to control the display. [For in depth documentation please visit the linked page.](http://homepage.hispeed.ch/peterfleury/doxygen/avr-gcc-libraries/group__pfleury__lcd.html)