diff --git a/docs/design/arspf_design.html b/docs/design/arspf_design.html index e0c9493..b8be6e7 100644 --- a/docs/design/arspf_design.html +++ b/docs/design/arspf_design.html @@ -1153,30 +1153,7 @@

Multi-core configurationCustomizations

Custom module

-

The custom module development workflow involves the following high-level steps:

-
    -

  1. Start custom algorithm using standard industrial tool such as Matlab and optimize the algorithm -for intended processor architecture

    2. -

  2. Develop the Common Audio Processor Interface (CAPI) wrapper for the -custom algorithm. For examples and detailed instructions, see the CAPI Module Development Guide

    3. -

  3. Develop an API header file consisting of Module ID and configuration -parameters related to the custom algorithm.

    4. -

  4. Generate an API XML file by running the h2xml conversion tool on the API -header file. The XML file provides the necessary information about configuration -interfaces, supported containers, stack size, and any other policies -that are required for the AudioReach configuration tool (ARC platform).

    5. -

  5. Compile the CAPI-wrapped module as a built-in module as part of ARE image -or standalone shared object.

    6. -

  6. Import the custom module into the ARC platform through a module -discovery workflow, and create use case graphs by placing the module -in the appropriate container and subgraphs.

    7. -

  7. Calibrate or configure the module together with an end-to-end use -case, and store the data in the file system (through the ACDB file -provided by the ARC platform).

    8. -

  8. Launch the end-to-end use case from the application, which in turn -uses the use case graph and calibration information from the ACDB -file and provides them to the ARE to realize the use case.

    9. -
+

For steps on how to add a custom module, please refer to the How to add an Audio Module guide.

Custom container

diff --git a/docs/platform/raspberry_pi4.html b/docs/platform/raspberry_pi4.html index df38794..69ec3f2 100644 --- a/docs/platform/raspberry_pi4.html +++ b/docs/platform/raspberry_pi4.html @@ -20,6 +20,7 @@ + @@ -71,6 +72,7 @@ +
  • RB3 Gen2
    • @@ -143,7 +145,7 @@

    Architecture OverviewCreate a Yocto image

    The first step is to integrate AudioReach components into a Yocto build that can be loaded onto the Raspberry Pi device. This involves syncing a Yocto build and then integrating the meta-audioreach layer, which is currently available as a Github repository.

    -

    Before following these steps, it would be helpful to learn the basics of how to use a Yocto project. To do this, please refer to the official Yocto documentation site: https://docs.yoctoproject.org/2.0/yocto-project-qs/yocto-project-qs.html

    +

    Before following these steps, it would be helpful to learn the basics of how to use a Yocto project. To do this, please refer to the official Yocto documentation site: https://docs.yoctoproject.org/5.0.12/brief-yoctoprojectqs/index.html

    Step 1: Create a Yocto build

    Follow the below steps to setup a Yocto build:

    @@ -167,7 +169,13 @@

    Step 1: Create a Yocto build
    MACHINE ?= "raspberrypi4"
+
    + + +

  • Navigate to the “build/conf/bblayers.conf” file and add the necessary meta layers by editing the file as shown:

    • @@ -192,22 +200,9 @@

    Step 1: Create a Yocto buildhttps://docs.yoctoproject.org/2.0/yocto-project-qs/yocto-project-qs.html.

    -

    If not, please download the pre-built “buildtools” for Yocto using the below steps:

    -
    -
    cd <yocto_build_root>/sources/poky
-scripts/install-buildtools
-
    -
    -
    -

    Then run the following commands to setup your build environment to use buildtools:

    -
    -
    cd <yocto_build_root>
-source ./sources/poky/oe-init-build-env
-source ./sources/poky/buildtools/environment-setup-x86_64-pokysdk-linux
-
    -
    -
    +

    Note: The AudioReach project currently uses the “scarthgap” version of Yocto. +Please ensure that all utilities required for Yocto scarthgap builds meet the minimum version numbers, which are listed on the Yocto documentation site: https://docs.yoctoproject.org/5.0.12/ref-manual/system-requirements.html#required-git-tar-python-make-and-gcc-versions.

    +

    If not, please follow the steps in section 1.5.1 at the above link to install and setup buildtools.

    Step 2: Get AudioReach Meta Layer

    @@ -244,7 +239,12 @@

    Step 3: Add AudioReach to system image

    Step 4: Compile the image

    Now the build setup is complete, and the full Yocto image can be generated. Navigate to the “build” directory -and run the command bitbake core-image-sato

    +and run the below command to generate the image:

    +
    +
    bitbake core-image-sato
+
    +
    +

    Enable Real-time Calibration Mode

    ARC (AudioReach Creator) is a tool that allows the user to perform several functionalities related to the audio usecase, including creating and editing audio usecase graphs, and editing audio configurations while running an audio usecase in real time. For more information on ARC, please refer to the AudioReach Creator Design page.

    +
    +
      +

    • Please note that at this time, AudioReach Creator is only available on Windows.

      • +
    +

    The below steps will demonstrate how to connect ARC to the Raspberry Pi so that the usecase graph can be viewed in real time.

    On the Raspberry Pi:

    @@ -395,9 +417,18 @@

    Troubleshooting

    Check the sound card

    -

    On the Raspberry Pi, open the file “/proc/asound/cards”. There should be a few -sound card entries in this list. If the file instead says “no sound cards available”, you likely -forgot to enable the sound card (see section Configure bootup settings).

    +

    On the Raspberry Pi terminal, run the below command:

    +
    cat /proc/asound/cards
+
    +
    +

    This should output the available sound cards. If the output instead says “no sound cards available”, you likely +forgot to enable the sound cards (see section Configure bootup settings).

    +
    +
    +../_images/rpi_sound_cards.png + +
    +

    Check the sound card ID

    @@ -405,7 +436,7 @@

    Check the sound card IDEnable Real-time Calibration Mode).

      -

    1. Copy the ACDB files from the Raspberry Pi to your local computer. These files +

    2. Copy the ACDB and workspace files from the Raspberry Pi to your local computer. These files can be found under the folder “/etc/acdbdata”.