stylus_garage
=============
**Source code:** `stylus_garage.py <https://chromium.googlesource.com/chromiumos/platform/factory/+/refs/heads/main/py/test/pytests/stylus_garage.py>`_

Tests stylus garage detection functionality.

Description
-----------
Verifies if stylus garage is functional by asking operator to insert and remove
the stylus.

Test Procedure
--------------
1. Operator inserts the stylus into the stylus garage.
2. Operator removes the stylus from the stylus garage.

Dependency
----------
- Based on Linux evdev.

Examples
--------
To run default test:

.. test_list::

  generic_touchscreen_examples:TouchscreenTests.StylusGarage

To test both of the stylus and the garage with a test group:

.. test_list::

  generic_touchscreen_examples:TouchscreenTests.StylusAndGarage



Test Arguments
--------------
.. list-table::
   :widths: 20 10 60
   :header-rows: 1
   :align: left

   * - Name
     - Type
     - Description

   * - timeout_secs
     - int
     - (optional; default: ``180``) Timeout value for the test.

   * - device_filter
     - int, str, None
     - (optional; default: ``None``) Event ID or name for evdev. None for auto probe.

   * - garage_is_stylus
     - bool
     - (optional; default: ``True``) Deprecated. No effect. Leave for compatibility.

   * - target_state
     - ['ejected', 'inserted'], None
     - (optional; default: ``None``) The test passes when reaches the target state. If not specified, pass after an insertion and then an ejection or an ejection and then an insertion.