Skip to content

Commit 7a6fce6

Browse files
authored
Add a short README describing the driver
1 parent 2303223 commit 7a6fce6

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,15 @@
1-
# PmodClsArduino
2-
PmodCLS driver for Arduino
1+
# PmodCLS driver for Arduino
2+
3+
This is a simple Arduino driver for the Digilent [PmodCLS](http://store.digilentinc.com/pmodcls-character-lcd-with-serial-interface/) LCD module.
4+
It is meant to be as much as a drop-in replacement for [LiquidCrystal](https://www.arduino.cc/en/Reference/LiquidCrystal) as possible.
5+
However, the following incompatibilities currently exist:
6+
- The autoscroll feature is not present on the PmodCLS.
7+
This could be implemented in software but currently is not;
8+
- The right-to-left feature is not present either.
9+
This is probably impossible to emulate in software;
10+
- Defining custom characters *is* supported by the hardware but not implemented yet;
11+
- The constructors are completely different.
12+
13+
Since there are different ways to communicate with the PmdCLS (UART, SPI and I²C), this driver does not talk to the hardware directly.
14+
Instead, it writes a command stream to a user-provided function which is responsible of communicating with the hardware.
15+
See the [HelloWorld](examples/HelloWorld/HelloWorld.ino) example for a simple way to communicate over UART.

0 commit comments

Comments
 (0)