Skip to content

Commit d389cf7

Browse files
authored
Update README.md
1 parent 1705dfc commit d389cf7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# PS2KeyRaw
2-
##Arduino PS2 keyboard interface light footprint all bytes from keyboard
2+
## Arduino PS2 keyboard interface light footprint all bytes from keyboard
33

44
First Public Release Version V1.0.2
55

66
Smaller footprint than any others found
77

88
For other versions that convert the up to 8 byte keycode sequences to a single integer for all keyboard types or allow you to get the full UTF-8 configurable for any LATIN keyboard with extra functions keys as simple codes see associated reporitories for PS2KeyAdvanced and PS2KeyMap libraries. Yes these libraries even provide codes for multimedia keys and Function keys F1 to F24 (yes that is F24).
99

10-
###Platforms
10+
### Platforms
1111

1212
- Arduino AVR - tested on Uno and Mega 2560
1313
- Arduino SAM - tested on DUE
1414

15-
###Test Environment
15+
### Test Environment
1616
- All platforms versions of test R3 Hardware
1717
- Arduino V1.6.7
1818
- DUE Board Manager package V1.6.6
1919

20-
##Important Hardware Notes
21-
1 Make sure you have data and clock wires connected correctly. Clock wire MUST be connected to an interrupt pin.
20+
## Important Hardware Notes
21+
1 Make sure you have data and clock wires connected correctly. Clock wire MUST be connected to an interrupt pin.
2222
- Do NOT use Pin 13 for either clock or data wires
2323
- PS2KeyRaw requires both pins specified for begin() as in keyboard.begin( data_pin, irq_pin );
2424
- Valid irq pins:
@@ -32,9 +32,9 @@ For other versions that convert the up to 8 byte keycode sequences to a single i
3232
- Teensy++ 1.0: 0, 1, 2, 3, 18, 19, 36, 37
3333
- Sanguino: 2, 10, 11
3434

35-
2 When using DUE or other boards with 3V3 I/O you *MUST* use a level translator FET or IC like Texas Instruments TXS0102 or similar as most keyboards not only operate at 5V but the two wire communications are pulled up by a resistor to 5V at the keyboard end
35+
2 When using DUE or other boards with 3V3 I/O you *MUST* use a level translator FET or IC like Texas Instruments TXS0102 or similar as most keyboards not only operate at 5V but the two wire communications are pulled up by a resistor to 5V at the keyboard end
3636

37-
###Introduction
37+
### Introduction
3838

3939
After looking round for suitable libraries I found most were lacking in functionality and high in code and data footprint, so I created a series of PS2 Keyboard libraries. The first here is the simplest one suitable for testing your keyboard hardware and understanding what keyboard protocol is.
4040

@@ -44,15 +44,15 @@ The PS2 Keyboard interface is a *Bi-directional* two wire interface with a clock
4444
- available() return count of bytes waiting
4545
- read() return next byte in keycode buffer
4646

47-
###Installation
47+
### Installation
4848

4949
Performed by standard zip file library inclusion into Arduino IDE
5050

51-
###Examples
51+
### Examples
5252

5353
This library has ONE example, SimpleTest that uses the serial port to output the codes received on every keystroke and auto-repeat, some keyboards change codes on auto-repeat; which you will be able to see for yourself.
5454

55-
####Contributor and Author Details
55+
#### Contributor and Author Details
5656

5757
Author Paul Carpenter, PC Services
5858
Web Site http://www.pcserviceselectronics.co.uk

0 commit comments

Comments
 (0)