# LcdDisplay

[![Hex.pm](https://img.shields.io/hexpm/v/lcd_display.svg?style=flat-square)](https://hex.pm/packages/lcd_display)
[![API docs](https://img.shields.io/hexpm/v/lcd_display.svg?style=flat-square)](https://hexdocs.pm/lcd_display/LcdDisplay.html)

`LcdDisplay` is a simple [Elixir](https://elixir-lang.org/) library that allows you to control an [Liquid-crystal display (LCD)](https://en.wikipedia.org/wiki/Liquid-crystal_display) like [Hitachi HD44780](https://en.wikipedia.org/wiki/Hitachi_HD44780_LCD_controller).

[See the documentation](https://hexdocs.pm/lcd_display/LcdDisplay.html) for more information.

## Installation

You can install `LcdDisplay` by adding `lcd_display` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:lcd_display, "~> 0.0.1"}
  ]
end
```

## Examples

As an example, if you want to control a Hitachi HD44780 type display through
[I²C](https://en.wikipedia.org/wiki/I%C2%B2C), you can use `LcdDisplay.HD44780.I2C` module as a
display driver.

```elixir
alias LcdDisplay.HD44780

# Start the LCD driver and get the initial display state.
{:ok, display} = HD44780.I2C.start()

# Run a command and the display state will be updated.
{:ok, display} = HD44780.I2C.execute(display, {:print, "Hello world"})
{:ok, display} = HD44780.I2C.execute(display, :clear)
```

## Thanks

- [`ExLcd`](https://github.com/cthree/ex_lcd) for inspiration