https://github.com/nicholascok/ard-ps2

ps/2 library for arduino
https://github.com/nicholascok/ard-ps2

Last synced: about 2 months ago
JSON representation

ps/2 library for arduino

• Host: GitHub
• URL: https://github.com/nicholascok/ard-ps2
• Owner: nicholascok
• Created: 2021-09-09T20:52:16.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-01T04:25:31.000Z (almost 3 years ago)
• Last Synced: 2024-03-16T12:53:26.460Z (10 months ago)
• Language: C
• Homepage:
• Size: 42 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Arduino PS/2 Keyboard Interface

### Usage

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);

ps2_init_host(HOST_DATA_PIN, HOST_CLOCK_PIN); /* for now only one input is possible */

```

### 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 input device (keyboard).

| FUNCTION | DESCRIPTION |

| -------- | ----------- |

| `int hread(BYTE* )` | reads a byte of data from a keyboard |

| `int hwrite(BYTE )` | writes a byte of data to a keyboard |

| `int dwrite(struct ps2_device , BYTE )` | writes a byte of data to an endpoint |

| `int dsend_key_make(struct ps2_device , int )` | sends a key's make code to an endpoint |

| `int dsend_key_break(struct ps2_device , int )` | sends a key's break code to an endpoint |

| `int dsend_key_press(struct ps2_device , int , int )` | triggers a key press event (make, delay, break) on an endpoint |

| `int init_keyboard(struct ps2_device )` | signals a BAT pass to an endpoint (necessary within 500ms after poweron) |

| `bool probe_status(void)` | requests a keyboard readminister its BAT and returns true if successful |

| `bool hsend_echo(void)` | sends an echo request to a keyboard and returns true if it responds |

  

The value of `` can be any of the following:  

  

| K         | E         | Y         | S         |

| --------- | --------- | --------- | --------- |

| KEY_ESC   | KEY_6     | KEY_CAPLK | KEY_M     |

| KEY_F1    | KEY_7     | KEY_A     | KEY_COMMA |

| KEY_F2    | KEY_8     | KEY_S     | KEY_DOT   |

| KEY_F3    | KEY_9     | KEY_D     | KEY_FWSLH |

| KEY_F4    | KEY_0     | KEY_F     | KEY_RSHFT |

| KEY_F5    | KEY_BKSPC | KEY_G     | KEY_LCTRL |

| KEY_F6    | KEY_TAB   | KEY_H     | KEY_LALT  |

| KEY_F7    | KEY_Q     | KEY_J     | KEY_SPACE |

| KEY_F8    | KEY_W     | KEY_K     | KEY_NUMLK |

| KEY_F9    | KEY_E     | KEY_L     | KEY_KPMUL |

| KEY_F10   | KEY_R     | KEY_COLON | KEY_KPSUB |

| KEY_F11   | KEY_T     | KEY_QUOTE | KEY_KP7   |

| KEY_F12   | KEY_Y     | KEY_ENTER | KEY_KP8   |

| KEY_SCRLK | KEY_U     | KEY_LSHFT | KEY_KP9   |

| KEY_GRAVE | KEY_I     | KEY_Z     | KEY_KPADD |

| KEY_1     | KEY_O     | KEY_X     | KEY_KP4   |

| KEY_2     | KEY_P     | KEY_C     | KEY_KP5   |

| KEY_3     | KEY_LSQR  | KEY_V     | KEY_KP6   |

| KEY_4     | KEY_RSQR  | KEY_B     | KEY_KP1   |

| KEY_5     | KEY_BKSLH | KEY_N     | KEY_KP2   |

| KEY_BREAK | KEY_KP3   | KEY_KP0   | KEY_KPDOT |

| KEY_LWIN  | KEY_RALT  | KEY_RWIN  | KEY_MENUS |

| KEY_RCTRL | KEY_INS   | KEY_HOME  | KEY_PGUP  |

| KEY_DEL   | KEY_END   | KEY_PGDN  | KEY_UP    |

| KEY_LEFT  | KEY_DOWN  | KEY_RIGHT | KEY_KPDIV |

| KEY_PRINT |           |           |           |