SDK Download

Overview

The Zephyr SDK for Realtek Ameba-IoT series products adopts a multi-repository management approach, with the manifest repository hosted on GitHub: https://github.com/Ameba-AIoT/nuwa.

The SDK consists of multiple Git repositories managed uniformly using the west tool; the west.yml file in the manifest repository records the commit version for each sub-repository.

Installing the west Tool

To use this manifest repository, the west tool must be installed first. west is written in Python 3 and distributed via PyPI. Please use pip3 to install or upgrade west:

Linux:
$ pip3 install --user -U west

Note

The command above installs west directly into your system Python environment. If you’d like to keep west and the Python dependencies installed later isolated from the system environment, see the virtual-environment-based setup steps in Get Zephyr and Install Python Dependencies.

Download Ameba NUWA Project SDK

  1. Clone the manifest repository:

    mkdir nuwa && cd nuwa
    west init -m https://github.com/Ameba-AIoT/nuwa.git
    

Note

The command above downloads via an https:// URL, which does not require adding a public key on GitHub. If you need to submit code later, you will need to add a public key and switch to an ssh:// URL.

  1. Run the following command to clone all project repositories. The complete set of Git repositories and their directory structure is defined in the manifest file:

    west update
    
  2. Create a symbolic link to nuwa.py. This Python script wraps the west commands. For more information about west commands, refer to the Zephyr official documentation: West (Zephyr’s meta-tool)

    ln -sf tools/meta_tools/nuwa.py nuwa.py
    

Note

west update only updates the projects listed in west.yml and does not update the manifest repository that contains west.yml. To update everything, you can use either of the following two methods:

  • Navigate into the manifest repository, perform a Git update (e.g., git pull), then run west update to fetch the updated west.yml and synchronize all other projects accordingly.

  • Use the wrapped command: ./nuwa.py update