Update the documentation

This commit is contained in:
Savanni D'Gerinel 2022-06-30 09:22:36 -04:00
parent 02e0ab5ae0
commit 3ec18f464e
1 changed files with 19 additions and 17 deletions

View File

@ -3,14 +3,20 @@ Copyright 2022, Savanni D'Gerinel <savanni@luminescent-dreams.com>
This file is part of Savanni's AVR library.
Lumeto is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This AVR library is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.
Lumeto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
Lumeto is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Lumeto. If not, see <https://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License along with
Lumeto. If not, see <https://www.gnu.org/licenses/>.
*/
/* This library covers a five-wire diagnostic display board.
/* This library covers a three-wire diagnostic display board.
*
* Hardware:
* 74HC595 shift register
@ -22,21 +28,17 @@ You should have received a copy of the GNU General Public License along with Lum
* edge. This leads to the 74HC595, pin 11 (Shift Clock).
* LS -- Latch pulse. All data in the shift register will be sent to the
* output on a rising edge. This leads to the 74HC595, pin 12 (Latch Clock);
* RS -- Register select. 0 to write an instruction to the display, 1 to write
* data to the display.
* E -- Enable. This tells the display to read the data. The display will get
* the data on the shift register outputs, so be sure to send LS before
* sending E.
*
* 74HC595 -> HD44780
* Qa -> D0
* Qb -> D1
* Qc -> D2
* Qd -> D3
* Qe -> D4
* Qf -> D5
* Qg -> D6
* Qh -> D7
* Qc -> D4
* Qd -> D5
* Qe -> D6
* Qf -> D7
* Qg -> RS
* Qh -> E
*
* I use the 4-wire protocol of the HD44780. This means that two of the shift
* register pins are used for the RS and E control pins of the LCD.
*/
#ifndef __DISPLAY_H__