doc: scripts: display_harness: update document on installation

==============

===============================

Display capture Twister harness

==============

===============================

Configuration example

---------------------

         edge_ratio_weight: 0.1

         gradient_hist_weight: 0.1

Installation Guide

------------------

.. code-block:: powershell

   # Create virtual environment

   python -m venv .venv

.. code-block:: powershell

   # Activate environment

   .venv\Scripts\activate

.. code-block:: powershell

   # Install dependencies

   uv pip install -r requirements.txt

.. code-block:: bash

   # add video to user group

   sudo usermod -a -G video $USER

.. code-block:: bash

   # need log out and login to effective or run

   newgrp video

If you are in Ubuntu 24.04 with XWayland do the following:

.. code-block:: bash

   export DISPLAY=:0

   cp /run/user/1000/.mutter-Xwaylandauth.AIT2A3 ~/.Xauthority

or

.. code-block:: bash

   export QT_QPA_PLATFORM=xcb

If your server does not have display please do the following:

.. code-block:: bash

   pip uninstall opencv-python

.. code-block:: bash

   pip install opencv-python-headless

.. code-block:: bash

   export QT_QPA_PLATFORM=offscreen

example zephyr display tests

----------------------------

2. Generate video fingerprints

 - build and flash the known-to-work display app to DUT

    e.g.

```

   - build and flash the known-to-work display app to DUT e.g.

     ::

        west build -b frdm_mcxn947/mcxn947/cpu0 tests/drivers/display/display_check

        west flash

```

   - clone code

```bash

git clone https://github.com/hakehuang/camera_shield

```

     ::

        git clone https://github.com/hakehuang/camera_shield

   - follow the instructions in the repo's README.

   - set the signature capture mode as below in config.yaml

```yaml

     ::

        - name: signature

          module: .plugins.signature_plugin

          class: VideoSignaturePlugin

              name: "tests.drivers.display.check.shield" # finger-print stored metadata

              platform: "frdm_mcxn947"

            directory: "./fingerprints" # fingerprints directory to compare with not used in generate mode

```

   - Run generate fingerprints program outside the camera_shield folder

    Note:

      On Ubuntu 24.04, you may need to do ```export QT_QPA_PLATFORM=xcb``` to resolve below error

```bash

qt.qpa.plugin: Could not find the Qt platform plugin "wayland" in "~/camera_shield/.ven/lib/python3.12/site-packages/cv2/qt/plugins"

```

     ::

```bash

        python -m camera_shield.main --config camera_shield/config.yaml

```

     video fingerprint for captured screenshots will be recorded in directory './fingerprints' by default

   - set environment variable to "DISPLAY_TEST_DIR"

```bash

     ::

        DISPLAY_TEST_DIR=~/camera_shield/

```

3. Run test

```bash

   ::

      # export the fingerprints path

      export DISPLAY_TEST_DIR=<path to "fingerprints" parent-folder>

      # Twister hardware map file settings:

      # Ensure your map file has the required fixture

      # in the example below, you need to have "fixture_display"

      # Ensure you have installed the required Python packages for tests in scripts/requirements-run-test.txt

      # Run detection program

      scripts/twister --device-testing --hardware-map map.yml -T tests/drivers/display/display_check/

```

Notes

-----

1. When generating the fingerprints, they will be stored in folder "name" as defined in "metadata" from ``config.yaml``.

2. The DUT testcase name shall match the value in the metadata 'name' field of the captured fingerprint's config.

3. You can put multiple fingerprints in one folder, it will increase compare time,

   but will help to check other defects.

3. You can put multiple fingerprints in one folder, it will increase compare time, but will help to check other defects.