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.

Command	Explanation
Basic
?, help	Show this help message and exit.
-s, --show_log	Display detailed log information. (For debug)
--default_cmd	Execute multiple commands at once.
Manager
?, help	List 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. (Windows Only)
uninstall_rdi	Uninstall RDI driver. (Windows Only)
exit	Exit Atmosic OpenAir Utility CLI.

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.

   $ 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

   $ 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

   (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

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

3. exit

   Exit Atmosic OpenAir Utility CLI.

   Syntax

   exit

   Example

   (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

   (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

   (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.

   ╔═══════════════════════════════════════════╗
   ║     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

   (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

   (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

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