.. _atmoautil:

OpenAir Utility (atmoautil)
###########################

Atmosic OpenAir Utility (atmoautil) is an unified tool for Zephyr, and the purpose is reducing the effort for developers to set up the develop environment for Atmosic OpenAir SDK.
The atmoautil could manage and download the Zephyr toolchain, Python, Git.

Commands
========

The table below lists the available commands of Atmosic OpenAir Utility (atmoautil). Detailed descriptions of each command can be found in the following section.

.. raw:: html

   <div>
      <table style="border-collapse: collapse;width:auto;;border-style:double;font-family: Arial, sans-serif">
         <tr>
            <th style="background-color: #EDEDED;color: rgb(37, 37, 37);padding: 10px;border: 1px solid white !important">Command</th>
            <th style="background-color: #EDEDED;color: rgb(37, 37, 37);padding: 10px;border: 1px solid white !important">Explanation</th>
         </tr>
         <tr>
            <td colspan="2" style="background-color: white;font-weight: bold; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important"><i>Basic</i></td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">?, help</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Show this help message and exit.</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">-s, --show_log</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Display detailed log information. (For debug)</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">--default_cmd</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Execute multiple commands at once.</td>
         </tr>
         <tr>
            <td colspan="2" style="background-color: white;font-weight: bold; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important"><i>Manager</i></td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">?, help</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">List commands.</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">toolchain_install</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Install a specific version of the toolchain.</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">toolchain_uninstall</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Uninstall the currently installed toolchain.</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">toolchain_launch</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Launch the installed toolchain.</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">toolchain_list</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">List all available and installed versions of the toolchain.</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">show_version</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Show version of the tool.</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">install_rdi</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Install RDI driver. (Windows Only)</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">uninstall_rdi</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Uninstall RDI driver. (Windows Only)</td>
         </tr>
         <tr>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">exit</td>
            <td style="background-color: white; color: rgb(37, 37, 37); padding: 10px;border: 1px solid black !important">Exit Atmosic OpenAir Utility CLI.</td>
         </tr>
      </table>
   </div><br>

Basic
-----

1. **-h, --help**

   Show information about all commands.

   **Syntax**

   atmoautil [-h | --help]

2. **--show_log**

   Command to display detailed log information. (For debug)

   **Syntax**

   atmoautil -s

   **Example**

   Enter the command in advance before launching the atmoautil.

   .. code-block:: bash

      $ atmoautil -s
      ❕❕ Disable Debug Mode ❕❕
      Welcome to Atmosic OpenAir Utility CLI. Type 'help' or '?' to list commands.

3. **--default_cmd**

   Execute multiple commands at once (Commands are separated by semicolons).

   **Syntax**

   atmoautil --default_cmd COMMAND

   **Example**

   .. code-block:: bash

      $ atmoautil --default_cmd "toolchain_install -v 25.04.0"
      Welcome to Atmosic OpenAir Utility CLI. Type 'help' or '?' to list commands.

      ╔════════════════════╗
      ║ Download Toolchain ║
      ╚════════════════════╝
      Downloading ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
      ╔═══════════════════╗
      ║ Install Toolchain ║
      ╚═══════════════════╝
      Installing ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00

Manager
-------

1. **?, help**

   List commands.

   **Syntax**

   [? | help]

   **Example**

   .. code-block:: bash

      (atmoautil) manager> ?
      ╔════════════════════╗
      ║ Available commands ║
      ╚════════════════════╝
      toolchain_install         Install a specific version of the toolchain.
      toolchain_uninstall       Uninstall the currently installed toolchain.
      toolchain_launch          Launch the installed toolchain
      toolchain_list            List all available and installed versions of the toolchain.
      show_version              Show version of the tool.
      install_rdi               Install RDI driver.
      uninstall_rdi             Uninstall RDI driver.
      exit                      Exit Atmosic OpenAir Utility CLI.

2. **show_version**

   Show the atmoautil version. The first four digits represent the tool version number, and the last digit is the Jenkins build ID.

   **Syntax**

   show_version

   **Example**

   .. code-block:: bash

      (atmoautil) manager> show_version
      ╔══════════════════════════╗
      ║ Tool Version: 1.0.0.0.56 ║
      ╚══════════════════════════╝

3. **exit**

   Exit Atmosic OpenAir Utility CLI.

   **Syntax**

   exit

   **Example**

   .. code-block:: bash

      (atmoautil) manager> exit
      Exiting Atmosic OpenAir Utility CLI.

4. **toolchain_list**

   List available toolchain(s) in the server and installed toolchain(s) on local. The atmoautil will download a configure file from server to check the available toolchain(s).

   **Example**

   .. code-block:: bash

      (atmoautil) manager> toolchain_list
      ╔════════════════════════╗
      ║ Toolchain Version List ║
      ╚════════════════════════╝
      25.02.0

5. **toolchain_install**

   Install a specific version of the toolchain.

   **Syntax**

   toolchain_install [-v | --version] VERSION
   The VERSION could get from toolchain_list command

   **Example**

   .. code-block:: bash

      (atmoautil) manager> toolchain_install -v 25.02.0
      ╔════════════════════╗
      ║ Download Toolchain ║
      ╚════════════════════╝
      Downloading ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
      ╔═══════════════════╗
      ║ Install Toolchain ║
      ╚═══════════════════╝
      Installing ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╺━━━━━  100% 0:00:00

6. **toolchain_launch**

   Launch the installed toolchain for Zephyr development.

   **Syntax**

   toolchain_launch [-v | --version] VERSION

   The VERSION could get from toolchain_List command and please specify the installed one.

   **Example**

   On Windows, it will invoke new Windows command prompt after launching.

   .. code-block:: bash

      ╔═══════════════════════════════════════════╗
      ║     Atmosic Zephyr Develop Environment    ║
      ╚═══════════════════════════════════════════╝
      Type 'exit' to quit...
      (25.02.0) C:\Temp\atmoautil>

7. **toolchain_uninstall**

   Uninstall the currently installed toolchain.
   This command only show the toolchain directory and the developer should manual remove it because the developer may install the require components by themselves.

   **Syntax**

   toolchain_uninstall [-v | --version] VERSION

   The VERSION could get from toolchain_List command and please specify the installed one.

   **Example**

   .. code-block:: bash

      (atmoautil) manager> toolchain_uninstall -v 25.02.0
      Please manually remove the toolchain directory under the C:\atmoa\toolchains path.

8. **install_rdi**

   This command only for Windows.
   Install the RDI driver.

   **Syntax**

   install_rdi

   **Example**

   .. code-block:: bash

      (atmoautil) manager> install_rdi
      ╔════════════════════╗
      ║ Install RDI driver ║
      ╚════════════════════╝
      Install RDI Done

9. **uninstall_rdi**

   This command only for Windows.
   Uninstall the RDI driver.

   **Syntax**

   uninstall_rdi

   **Example**

   .. code-block:: bash

      (atmoautil) manager> uninstall_rdi
      ╔══════════════════════╗
      ║ UnInstall RDI driver ║
      ╚══════════════════════╝
      UnInstall RDI driver failed