README.rst
1.. zephyr:code-sample:: ps2
2 :name: PS/2 interface
3 :relevant-api: ps2_interface
4
5 Communicate with a PS/2 mouse.
6
7Overview
8********
9
10This sample demonstrates how to use the :ref:`PS/2 API <ps2_api>`.
11Callbacks are registered that will write to the console indicating PS2 events.
12These events indicate mouse configuration responses and mouse interaction.
13
14Building and Running
15********************
16
17The sample can be built and executed on boards supporting PS/2.
18It requires a correct fixture setup. Please connect a PS/2 mouse in order to
19exercise the functionality.
20For the correct execution of that sample in twister, add into boards's
21map-file next fixture settings::
22
23 - fixture: fixture_connect_mouse
24
25Sample output
26=============
27
28.. code-block:: console
29
30 PS/2 test with mouse
31 Note: You are expected to see several interrupts
32 as you configure/move the mouse!
33
