Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholascok authored Mar 1, 2022
1 parent 2067d41 commit 6e9381d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Arduino PS/2
# Arduino PS/2 Keyboard Interface

### Usage

A PS/2 keyboard input and a keyboard outputs can be initialised as follows:
A PS/2 keyboard input and two outputs can be initialised as follows:
```
struct ps2_device device_A = ps2_init_device(DEV1_DATA_PIN, DEV1_CLOCK_PIN);
struct ps2_device device_B = ps2_init_device(DEV2_DATA_PIN, DEV2_CLOCK_PIN);
Expand All @@ -11,7 +11,7 @@ ps2_init_host(HOST_DATA_PIN, HOST_CLOCK_PIN); /* for now only one input is possi

### Functions

**Note:** In the following descriptions, *endpoint* refers to any device that is interpreting data output from the arduino, and *keyboard* refers to any PS/2 keyboard input device.
**Note:** In the following descriptions, *endpoint* refers to any device that is interpreting data output from the arduino, and *keyboard* refers to any PS/2 input device (keyboard).

| FUNCTION | DESCRIPTION |
| -------- | ----------- |
Expand Down

0 comments on commit 6e9381d

Please sign in to comment.