See :download:`Download the extension for macOS/Windows here <_downloads/openair-vscode-ext-0.0.3.vsix>`.

Vscode Plugin
#############

Installation
************

1. Select View->Extensions

.. figure::  readme_images/init_1.png
     :align: center

.. raw:: html

   <br><br>
2. Click on 3 dots to the right and select “Install from VSIX…”

.. figure::  readme_images/init_2.png
     :align: center

.. raw:: html

   <br><br>

Environment Setup for New Starter
*********************************
1. Open a folder in VS Code to use as the root workspace for the Zephyr project.

2. Locate the OpenAir extension in the extension view

.. figure::  readme_images/openairext_locate.png
     :align: center

.. raw:: html

   <br><br>

3. In the Setup view, click Zephyr IDE Configuration to check the environment status

.. figure::  readme_images/openairext_env_status.png
     :align: center

.. raw:: html

   <br><br>

4. In the Zephyr IDE Configuration, follow the setup steps to prepare the environment for Zephyr development prerequisites.

.. note::
   The time required depends on your internet quality.

.. figure::  readme_images/openairext_env_update.png
     :align: center

.. raw:: html

   <br><br>

Use existing virtual environment
********************************

1. Open an existing Zephyr project workspace.
You can reuse the existing virtual environment and SDK on your computer by
specifying their paths in the Setup view, avoiding the need to repeat earlier
steps in Zephyr IDE Configuration.

.. figure::  readme_images/openairext_env_reuse.png
     :align: center
.. raw:: html

   <br><br>

.. note::
   The virtual environment folder must be named ``.venv`` for proper integration with the VS Code extension.

Build OpenAir applications
**************************

1. In the West Build view, select applications supported by OpenAir from "App Source".

.. figure::  readme_images/openairext_appsource.png
     :align: center

.. raw:: html

   <br><br>

2. Choose from several predefined configurable combinations in Sysbuild Test Case.
Boards are also selectable.

.. figure::  readme_images/openairext_sysbuildcase.png
     :align: center

.. raw:: html

   <br><br>

.. note::
   For experienced users, select Pristine Build Opts defined by Zephyr and add Extra Build Opts.

3. Press the upper green triangle button to start the build. The progress appears in Output view.

.. figure::  readme_images/openairext_build_progress.png
     :align: center

.. raw:: html

   <br><br>


Flash the application to the board
**********************************

1. In West Flash view, select the target serial number foreach Atmosic
reference design interface auto-detected by the extension. For experienced users,
you can choose which storage to erase and which application domain to program.

.. figure::  readme_images/openairext_flash_serial.png
     :align: center

.. raw:: html

   <br><br>

Press the upper green triangle button to start flashing. Progress appears in the Output view.

.. note::
   Windows users new to Atmosic reference design interfaces may see a dialog asking
   to grant permission to install the RDI driver.
   Please grant to install to continue the process.

.. figure::  readme_images/openairext_windows_rdi.png
     :align: center

.. raw:: html

   <br><br>

.. note::
   After installation, switch windows using Alt+Tab and click OK on the pop-up message to continue.

.. figure::  readme_images/openairext_post_windows_rdi.png
     :align: center

.. raw:: html

   <br><br>