Installation

Option 1 Follow The Official Zephyr Documentation (macOS, Linux)

Follow the instructions from the official Zephyr documentation on setting up the tooling for your host operating system.

Creating a Workspace

Use west init and west update to create an Atmosic SDK workspace as follows:

west init -m https://github.com/Atmosic/openair.git zephyrproject
cd zephyrproject
west update

Option 2 Using Atmosic OpenAir Utility (Linux, Windows)

Atmosic provides OpenAir Utility (atmoautil) to manage the Zephyr development environment by command line. The following steps install Atmosic OpenAir SDK source code and toolchain. This includes everything that is required by Zephyr’s Getting Started Guide together with additional tools and Python dependencies that Atmosic OpenAir SDK uses.

Install Prerequisites

Depending on your preferred development environment, install the following software tools:

• The latest version of atmoautil, a unified command-line utility for the Atmosic OpenAir SDK, is required. Please refer to the list of supported operating systems and download the appropriate installer.

• Download SEGGER J-Link from the J-Link Software and Documentation Pack page.

Note

If you encounter permission issues when running atmoautil:

• On Linux, navigate to the directory containing the file and run chmod +x atmoautil to grant the file execute permission.

• On Windows, simply right‑click atmoautil and select Run as administrator to open it with elevated privileges.

Download

• Windows 10/11

• Linux - Ubuntu 22.04 LTS

Install Atmosic OpenAir SDK toolchain

Note

OpenAir 26.06.0 or later is required to use toolchain version 26.05.0 or later.

1. Open a terminal window and execute atmoautil command.

atmoautil

2. Run the following command to install the toolchain.

(atmoautil) manager> toolchain_list
╔════════════════════════╗
║ Toolchain Version List ║
╚════════════════════════╝
...
<toolchain_version>
(atmoautil) manager> toolchain_install -v <toolchain_version>
╔════════════════════════╗
║ Download Toolchain     ║
╚════════════════════════╝
Downloading ════════════════════════════════════════════════ 100% 0:00:00
╔════════════════════════╗
║ Install Toolchain      ║
╚════════════════════════╝
Installing ════════════════════════════════════════════════ 100% 0:00:00
(atmoautil) manager> toolchain_list
╔════════════════════════╗
║ Toolchain Version List ║
╚════════════════════════╝
...
<toolchain_version> [Installed]

With the default location to install the toolchain (C:/atmoa/toolchains on Windows, ~/atmoa/toolchains on Linux), your directory structure now looks similar to this:

atmoa
└─── toolchains
      └───<toolchain-installation>

In this simplified structure preview, toolchain-installation corresponds to the version name you installed.

3. Download the OpenAir SDK source code from GitHub. Use openair_list to check available versions, then openair_install to download.

(atmoautil) manager> openair_list
╔══════════════════════════╗
║ OpenAir SDK Version List ║
╚══════════════════════════╝
[GitHub]
  <github_version>
(atmoautil) manager> openair_install -v <github_version>
╔══════════════════════════════════════╗
║ Install OpenAir SDK <github_version> ║
╚══════════════════════════════════════╝
Running: west init -m https://github.com/Atmosic/openair.git OpenAir-<github_version>
Install path: ~/atmoa/OpenAir-<github_version>
OpenAir SDK installed successfully at ~/atmoa/OpenAir-<github_version>.

4. Launch development environment through atmoautil by toolchain_launch command. It will pop-up a new Windows command prompt which the title of the window shows “Atmosic Zephyr” for Windows user. Subsequently, go to the installed zephyrproject directory and run west update.

toolchain_launch -v <toolchain_version>

Then in the new terminal:

cd OpenAir-<github_version>
west update

5. Build sample - hello_world in Atmosic OpenAir SDK.

west build -p always -b <BOARD> openair/samples/sysbuild/hello_world --sysbuild -T samples.sysbuild.hello_world.atm

6. [Windows] If RDI driver is not already installed, install RDI driver by following the instructions in install_rdi).

7. Program firmware to Atmosic device

west flash --no-rebuild --device <DEVICE_ID> --jlink --fast_load

For Example:

(<toolchain_version>) d:\atmoa\zephyrproject>west flash --no-rebuild --device 900036842 --jlink --fast_load
WARNING: Specifying runner options for multiple domains is experimental.
If problems are experienced, please specify a single domain using '--domain '
-- west flash: using runner atmisp
-- runners.atmisp:  program address: 0x10000
Open On-Chip Debugger 0.12.0-00020-gaf2e30d6d (2024-04-23-16:10)
Licensed under GNU GPL v2
For bug reports, read
      http://openocd.org/doc/doxygen/bugs.html
Using JLINK
JLINK serial 900036842
Info : J-Link OB-K22-Cortex-M compiled Oct  9 2024 11:01:11
Info : Hardware version: 1.00
Info : GPIO supported
Info : VTarget = 3.300 V
Info : clock speed 100 kHz
Warn : gdb services need one or more targets defined
Open On-Chip Debugger 0.12.0-00020-gaf2e30d6d (2024-04-23-16:10)
Licensed under GNU GPL v2
For bug reports, read