The AudioworX Starter Kit Utility GUI Tool (SKUtilityGUI.exe) is a graphical application designed to simplify remote management of Starter Kit hardware. With an intuitive user interface, the SKUtilityGUI simplifies essential operations—such as running system diagnostics, rebooting the Raspberry Pi, resetting the AWX Amp application, and configuring audio hardware. This application is a graphical front-end for the SKUtility command-line tool (described in detail in SKUtility Tool – Command-Line Interface) and communicates over a local network using Ethernet or Wi-Fi to perform remote operations of the Starter Kit.

The SKUtilityGUI is installed along with GTT and can be accessed from the start-menu by pressing the “windows” key and typing “SKUtilityGUI” as shown below.

The SKUtilityGUI has the following panes:

1. Login Pane (top pane): Login credentials and button for connecting remotely to the Starter Kit. Also has a button for running diagnostics.
2. Function Pane (left-side pane): User functions for remotely operating the Starter Kit.
3. Output Pane (right-side pane): Output log prints.

To remotely login to a Starter Kit hardware that is available on the same network as the PC, users must specify the login credentials in the login pane and click the Connect button.
The default login credentials for the Starter Kit are pre-filled. Upon changing the login credentials, the SKUtilityGUI saves the details and recalls them on subsequent launch.

The following sections explain the key functions of the SKUtilityGUI in detail.

1. Running Starter Kit Diagnostics
2. Starter Kit Remote Control
3. Starter Kit Configuration

Running Starter Kit Diagnostics

---

The Run Diagnostics (right-most button on the Login pane) function runs a series of checks to verify if the Starter Kit hardware is configured and is functioning as expected. On running diagnostics, a detailed report will be generated and printed in the output pane on the right-side of the SKUtilityGUI.

The diagnostics only identifies issues in the configurations of the hardware that may be preventing proper operation of the AWX Amp application. If the Starter Kit is not functioning properly despite the diagnostics report showing no issues, refer to the log files fetched during the diagnostics to debug. The details on debugging using the Amp log file are given in the “AWX Amp Application Logs” section of Starter Kit Troubleshooting.

The “SKUtility Diagnostics Report” section in Starter Kit Troubleshooting describes the steps in the diagnostics in detail and highlights troubleshooting steps for resolving issues detected.

The SKUtilityGUI has a tab-pane on the left-side of the window with 2 tabs, namely, Remote and Configuration. The following sections describe the functions of the two tabs in detail.

Starter Kit Remote Control

---

The first tab in the Function pane is the Remote tab, which provides actions pertaining to remote operations on the Starter Kit, such as rebooting the Raspberry Pi, stopping and resetting the AWX Amp application, fetching log files and taking a snapshot of the Starter Kit data files. The below figure shows a screenshot of this tab.

The following are the options available to a user in the Remote tab:

1. 1. Reset: To reset the AWX Amp application (required when updating the device definition on GTT).
   2. Stop: To stop the AWX Amp application.
   3. Reboot: To reboot the Raspberry Pi remotely. The GUI utility tool will trigger reboot and disconnect automatically. Upon reboot, the user must click the Connect button to reconnect to the Starter Kit. The reboot operation may take some time.
   4. Fetch Logs: To fetch the log files from target. This will open the location of the saved log files on the PC in a File Explorer window.
      This will fetch two log files from the target Starter Kit hardware:
      • awx_log.txt: This file contains logs related to booting up of the Starter Kit hardware and running of the AWX Amp application.
      • VirtualAmpLog.txt: This file contains logs from the xAF framework that include initialization of the audio core, core AO, xAF instances, etc.,
        based on the signal flow flashed on the Starter Kit hardware from GTT.
   5. Snapshot: To take a Snapshot of the Data Files on the Starter Kit Hardware. This will open the location of the saved snapshot file on the PC in a File Explorer window.
      This function allows users to take a back-up of the Starter Kit directory in the Raspberry Pi either as a safety mechanism or to help Harman AudioworX provide debug support.

Starter Kit Configuration

---

The second tab in the Function pane of the SKUtilityGUI is the Configuration tab. This tab provides configuration actions for the user to modify the behavior of the Starter Kit hardware, and the audio interface connected.

The following sections explain in detail the actions that can be performed on this tab.

• Send Device File
• Factory Reset
• Flash Files
• Audio Config
• Wi-Fi Config

Send Device File

The “device.flash” has the necessary information about the device’s capabilities for the AWX Amp application to setup and run an audio processing pipeline. The steps for generating the “device.flash” file on GTT are illustrated in “Configuring a Custom Device Compatible with the AudioworX Starter Kit” in the “Adding a Device to the Project” section of Creating a New Project on GTT.

On clicking the Send Device Config button, a file explorer will open, prompting the user to select the device.flash file as shown below.

On completion of the action, a status log will be displayed in the output pane as shown below.

Factory Reset

This function will reset the Starter Kit hardware to its default state. On user confirmation, all files related to the AWX Amp application will be deleted from the Starter Kit hardware and restored to the default state associated with the installation of GTT.

This function can also be used to upgrade/downgrade the Starter Kit to the version of GTT installed on the PC.

On completion of the action, a status log will be displayed in the output window as shown below.

Flash Files

The AWX Amp application uses flash files for setting up and running audio processing pipelines, which contain information about the device capabilities (audio inputs and outputs, core-type, number of virtual cores, etc.), the SFD, presets, wav files, to name a few. On flashing a new project from GTT, the flash files in the Starter Kit may need to be removed manually for smoothly setting up and running the new audio processing pipeline.

Clicking the Flash Files button opens a window that lists all the flash files that are currently present in the Starter Kit. Users may select one or more files (or all files using the Select All button) listed in the window to remove from the Starter Kit and click the Delete button to continue.

On user confirmation, the selected files will be removed from the Starter Kit (see logs in the output pane).

Audio Config

This function allows users to configure the audio device settings to be used by the AWX Amp application. By default, the Starter Kit is configured to use the HiFiBerry DAC8x and ADC8x Add-on combo as the audio interface, at 48000 Hz sample rate and 2048 sample block length.

Users can configure the following:

1. Sample Rate: Currently, the only supported sample rate by the AWX Amp application is 48 kHz. More sample rates will be enabled in future releases.
2. Block Length: This parameter is the number of samples that the AWX Amp application will fetch and write to the audio device in one cycle. This block length is different from the block length of an Xaf Instance in the SFD, which is variable and can be configured in GTT.
3. Input Audio Device: Users can choose from one of the available (connected) audio devices for the AWX Amp application to fetch input audio samples from. Note that only audio devices that can capture audio samples will be listed.
4. Output Audio Device: Users can choose from one of the available (connected) audio devices for the AWX Amp application to output audio samples. Note that only audio devices that can play back audio will be listed.
5. Mode: Users can choose from one of 2 modes for the Starter Kit to boot into:
   1. Amp Mode – In this mode, the AWX Amp application is automatically started the Raspberry Pi boots up. Users must ensure that the selected audio devices (both input and output) are connected while powering on.
   2. Dev Mode – In this mode, the auto start of the AWX Amp application is disabled and is only meant for developers to debug the audio processing pipeline.
6. Input Channel Offset and Output Channel Offset: These parameters are used to specify the starting index of the audio channels on the sound card that the amplifier should use. These parameters are useful when using only a sub-set of the available audio input and output channels in the audio interface. For example, when only using the back-side input ports (channels 11 to 16) and output ports (channels 3 to 8) on the TASCAM 16×8 audio interface, users can set the offsets as 11 and 3 for the input and output channels, respectively, and the AWX Amp application will only use the channels from the specified indices, up to the specified number of channels (Input and Output Channel Counts).
7. Input Channel Count and Output Channel Count: These parameters are used to specify the maximum number of supported audio channels for audio input and output, respectively. While this information is typically retrieved using ALSA APIs, some audio interfaces, like the TASCAM 16×8 audio interface, do not always report the correct channel counts. In such cases, it is necessary to manually specify these values.

Additionally, users can save and restore audio device configurations using the Export and Import buttons on the top-ribbon bar of the Audio Config window.

Click the Apply button to send the configuration to Starter Kit (see the status message in the output pane). Once the configuration is complete, reset the AWX Amp application using Remote > Reset.

Wi-Fi Config

This function allows users to configure the wireless network settings of the Starter Kit.

The following are the configuration options available:

1. Turn On Wi-Fi: This action is used to turn on the Wi-Fi or hotspot module of the Raspberry Pi.
2. Turn Off Wi-Fi: This action is used to turn off the Wi-Fi or hotspot module of the Raspberry Pi.
3. Mode: This drop-down menu can be used to select the wireless communication mode of the Starter Kit (Wi-Fi or Access Point/Hotspot).
4. SSID: This drop-down menu lists all the known Wi-Fi connections to connect to.
   • To add a new connection, users can select the “Add New” option, specify the Name, Password and Priority (optional) of the connection, and click the CreateConnection button to connect to the new Wi-Fi network. The optional Priority parameter can be used to set the priority of the Wi-Fi  or Access Point connection for the Starter Kit to auto-connect on boot-up (range: -999, 999, where higher the number, higher the priority). By default, the priority is set to 0 for Wi-Fi mode and -100 for Access Point (hotspot) mode.
   • To connect to a known network, users can select the SSID from the drop-down menu and click the Connect button.
   • To remove a known network from the list, users can select the SSID in the drop-down menu and click the Delete button.

The Starter Kit is configured by default to start up a Wi-Fi hotspot named “AP_AWXStarterKit” with the password “starterkithotspot” to enable direct wireless connection from a PC when wired connection is not possible. Users can connect to this hotspot on first-time use from a PC and reconfigure the Starter Kit using the Wi-Fi Config option in the SKUtilityGUI to connect to a different Wi-Fi network.

The following table lists some useful commands:

No.	Function	Command
1	Run Starter Kit hardware diagnostics	python3 SKUtility.py diag
2	Reboot the Starter Kit hardware	python3 SKUtility.py rmt -rbt
3	Kill and restart the AWX Amp application	python3 SKUtility.py rmt -rst
4	Take a snapshot of the AWX related files on the Starter Kit hardware	python3 SKUtility.py rmt -snp
5	Start the interactive audio device configuration wizard	python3 SKUtility.py conf -i
6	Send a pre-made audio device configuration to the Starter Kit hardware	python3 SKUtility.py conf -sndCfg <config file path>
7	Send device file (device.flash) generated from GTT to the Starter Kit hardware	python3 SKUtility.py conf -df <device file path>
8	List the data files stored in the Starter Kit hardware	python3 SKUtility.py conf -ls
9	Remove selected data files from the Starter Kit hardware	python3 SKUtility.py conf -rm <list of files to remove or wildcards>
10	Remove all data files from the Starter Kit hardware	python3 SKUtility.py conf -rm a
11	Reset all configurations and data files to original	python3 SKUtility.py conf -rstAll

 

The SKUtility Tool has a command-line interface (CLI) that is included in the GTT installation. It is a Python script (SKUtility.py) that enables users to programmatically control the Starter Kit for advanced use-cases that may require rebooting, resetting, etc., without human intervention. This page describes the CLI tool and its usage in detail. Common useful commands are given in Useful SKUtility Commands.

• Installing the Python Pre-Requisite Packages
• SKUtility.py Usage
• SKUtility Diagnostics
• SKUtility Remote Control
• SKUtility Configuration

The SKUtility.py script is not “installed” in the PC environment along with GTT and requires to be run from the GTT installation directory where it is stored.

 

Installing the Python Pre-Requisite Packages

---

The SKUtility.py is a Python script and requires Python 3.12 to be installed on the PC to be able to run. Download Python 3.12 and install it on the PC before proceeding.

The SKUtility.py script can be found in the default GTT installation directory “C:\Program Files\Harman\HarmanAudioworX\StarterKit\StarterKitUtility”. This directory has a requirements.txt file that lists all the python dependencies needed to run the script and remotely operate the Starter Kit hardware. To install the Python dependencies:

1. Open a Command Prompt window (or any terminal of choice of the user, for example, PowerShell, MSYS2 or git bash) from the start-menu,
2. Change directory to the location of the SKUtility.py script in the GTT installation directory as follows:

   cd C:\Program Files\Harman\HarmanAudioworX\StarterKit\StarterKitUtility

3. Run the following command to install the python pre-requisites as shown below:

   python3 -m pip install -r requirements.txt

 

SKUtility.py Usage

---

The “SKUtility.py” script takes command-line arguments as shown in the help text, which can be displayed by running the following command:

python3 SKUtility.py -h

The script, by default, connects to a target with the hostname “raspberrypi.local” and the username and password as “awx” (default credentials for the Starter Kit). This can be changed using the “-hname” argument for the hostname, “-u” argument for the username and “-pwd” argument for the password, if they are different from the default.

The Utility tool supports operations/actions that are classified into 3 functions or sub-commands:

Sub-command	Function	Description
diag	Diagnostics	Verify if the target device is connected and is functioning as expected
rmt	Remote Control	Perform actions such as rebooting the Raspberry Pi, resetting the AWX amp application, etc.
conf	Configuration	Configure the audio device to use and Wi-Fi to connect to

The following sub-sections describe each function in detail along with the usage.

 

SKUtility Diagnostics

---

This function runs a series of checks to verify if the Starter Kit hardware is functioning as expected. The diagnostics report can be generated by running the command:

python3 SKUtility.py diag

Following is an example report that shows a working Starter Kit setup.

The diagnostics only finds issues in the configurations of the hardware that may be preventing proper operation of the AWX Amp application. If the Starter Kit is not functioning properly despite the diagnostics report showing no issues, refer to the log files fetched during the diagnostics to debug. The details on debugging using the Amp log file are given in the “AWX Amp Application Logs” section of Starter Kit Troubleshooting.

The “SKUtility Diagnostics Report” section in Starter Kit Troubleshooting describes the steps in the diagnostics in detail and highlights troubleshooting steps for resolving issues detected.

 

SKUtility Remote Control

---

This function/sub-command provides actions such as rebooting the Raspberry Pi, resetting the AWX Amp application, fetching log files and taking a snapshot of the Starter Kit data files.

The following image shows the help text for this function.

The following are the actions that can be executed under the Remote-Control function:

Remote-Control Function	Command
Reboot the Raspberry Pi	To reboot the Raspberry Pi remotely, run the command python3 SKUtility.py rmt -rbt The utility tool will then trigger reboot and wait until the Raspberry Pi is booted up and reachable by the PC. This command may take about a minute.
Reset the AWX Amp Application running in the Starter Kit Hardware	To reset the AWX Amp application (needed when updating the device definition on GTT), run the command python3 SKUtility.py rmt -rst
Stop the AWX Amp Application	To stop the AWX Amp application, run the command python3 SKUtility.py rmt -s
Fetch Log Files	To fetch the log files from target, run the command python3 SKUtility.py rmt -flog This will fetch two log files from the target Starter Kit hardware and open the file location with the following files: awx_log.txt: This file contains logs related to booting up of the Starter Kit hardware and running of the AWX Amp application. VirtualAmpLog.txt: This file contains logs from the xAF framework that include initialization of the audio core, core AO, xAF instances, etc., based on the signal flow flashed on the Starter Kit hardware from GTT.
Take a Snapshot of the Data Files on the Starter Kit Hardware	The SKUtility.py can be used to take a snapshot of the data files in the Starter Kit hardware, either for saving the state of the Starter Kit or to send Harman AudioworX support for debugging, run the command: python3 SKUtility.py rmt -snp This will take a snapshot, fetch a .zip file from the Starter Kit, and open the file location.

 

SKUtility Configuration

---

This function provides configuration options for the user to configure the behavior of the Starter Kit hardware, and the audio interface connected. The following is the help text for this function.

The following are the actions that can be executed under the Configuration function:

SKUtility Configuration	Descriptions
Interactive Audio Device Configuration	The utility tool provides an interactive setup wizard for configuring the audio device to be used by the AWX Amp application. This is necessary when using a different audio interface than the Creative Sound Blaster X4. To start the interactive setup wizard, run the command python3 SKUtility.py conf -i The wizard takes the user through the following steps: Specify the name of the .json file to save the configuration locally. This is useful to avoid going through the interactive menu if the user wants to revert to a known configuration. Type the file name (default file name is if no input is provided is “config.json”) when prompted. Set the start-up mode for the Starter Kit hardware. The Starter Kit can be set to boot up in one of 2 modes. Amp Mode – In this mode AWX Amp application is automatically started on when the Raspberry Pi is booted up. Dev Mode – In this mode, the auto start of the AWX Amp application is disabled. This mode is only meant for developers. If no input is provided by the user, the default mode chosen in the “Amp” mode. Select the device for capture and playback from the displayed list of connected audio devices with their audio capabilities. Type the IDs for capture and playback devices when prompted. Set the selected configuration on the Starter Kit hardware by sending the saved config.json file to the target hardware. The below figure shows the interactive configuration menu where the no input is provided for the filename and the Starter Kit modes, and the sound card named “X4” (Creative Sound Blaster X4) is chosen as the device for both input and output.
Send a Previously Saved Audio Device Configuration	This is used to send a previously saved audio device configuration file generated by the interactive wizard. run the command: python3 SKUtility.py conf -sndCfg
List Audio Devices Connected to Raspberry Pi	To list the audio device connected to Raspberry Pi, run the command. python3 SKUtility.py conf -laThis command will display all the connected audio capable devices along with their capture and playback capabilities.
Set a Wi-Fi for Raspberry Pi to Connect	This command is used to configure a new Wi-Fi for the Starter Kit to connect to, by specifying the ssid (Wi-Fi name), password and optionally, the auto-connect priority for the Wi-Fi. Run the command: python3 SKUtility.py conf -wifiConf new <SSID> <password> <priority>The below figure shows how to configure a Wi-Fi named “awx_wifi” with the password “awx_wifi_password” and an auto-connect priority of 10. The optional “priority” parameter can be used to set the priority of the Wi-Fi connection for the Starter Kit to auto-connect on boot-up in the range (-999, 999), where higher the number, higher the priority. By default, the priority is set to 0. This parameter is useful when there are multiple Wi-Fi connections available and to prioritize them as required. The user can choose to reboot the Starter Kit to save changes and connect to the Wi-Fi network based on priority. The above figure shows that the Starter Kit has successfully connected to the new Wi-Fi on reboot. The user can also configure the Raspberry Pi 5 to behave as a Wi-Fi hotspot for the PC to connect to, using the following command: python3 SKUtility.py conf -wifiConf hotspot <SSID> <password> <priority> To turn off the Wi-Fi on Raspberry Pi, use below command:python3 SKUtility.py conf -wifiConf off To turn on the Wi-Fi on Raspberry Pi, use below command: python3 SKUtility.py conf -wifiConf on
Flash a Device File	To flash a device file generated from GTT on to the Starter Kit hardware, run the command: python3 SKUtility.py conf -df <device file path> The “device.flash” is necessary for a signal flow to run on the AWX Amp application. The steps for generating the “device.flash” file on GTT are illustrated in “Configuring a Custom Device Compatible with the AudioworX Starter Kit” in the “Adding a Device to the Project” section of Creating a New Project on GTT.
List Data Files on the Starter Kit	To list the data files that are currently stored in the Starter Kit, run the command: python3 SKUtility.py conf -ls The AWX Amp application makes use of data files with the extensions “.flash”, “.set” or “.info” sent from GTT for initializing the device, signal flow, presets, etc.
Remove Data Files from the Starter Kit	To delete data files (“.flash”, “.set”, “.info”) from the Starter Kit hardware, run the command: python3 SKUtility.py conf -rm <list of files to be deleted or wildcards> It may be required by a user to delete some or all the data files to roll back actions or start afresh before flashing a new project with device definition being different than the project that the Starter Kit hardware is currently flashed with. For example, the new project may have a different number of audio inputs, outputs, xAF instances, virtual cores, etc. In such cases, the user may need to wipe out the data files from the Starter Kit and flash new data files from GTT. The files that are stored in the Starter Kit hardware can be listed by using the “-ls” argument. Alternatively, to remove all data files from the Starter Kit hardware, run the command: python3 SKUtility.py conf -rm a Running the “conf -rm a” command will all data files command will also delete the “device.flash” file which will have to be restored as directed in Flash a Device File or by resetting configuration (given below).
Reset All Configurations to Default	To reset the Starter Kit hardware to its default state, run the command: python3 SKUtility.py conf -rstAll The reset all action goes through the following steps: Get confirmation from the user to reset all configurations. If confirmed, all files related to AudioworX will be removed from the Starter Kit hardware and restored to their default states, effectively re-installing the version that is included in the GTT installation. Go through the interactive audio device configuration step if required by the user. For complete details of this step refer to Interactive Audio Device Configuration. Reboot the Starter Kit if required by the user.

 

The AWX Starter Kit has two mechanisms for diagnosing and debugging issues.

• SKUtility Diagnostics Report
• The AWX Amp Application logs
• Reporting Issues

The following sections explains them and how to troubleshoot problems.

SKUtility Diagnostics Report

---

The Starter Kit diagnostics, goes through a series of steps to verify the hardware connections and configuration of the Starter Kit.

Following are the different stages:

1. Verify that the Starter Kit hardware is reachable by the PC over the LAN.
2. Verify that the configuration files and AWX Amp application are present in the target Starter Kit hardware.
3. Verify that the audio hardware required by the set audio configuration are connected and verify their playback and capture capabilities.
4. Verify that the AWX Amp application is running if the Starter Kit hardware is set to “Amp” mode.
5. Fetch log files for further diagnosis.

The diagnostics only verifies and flags issues related to connectivity between the PC and the Starter Kit, configuration files on the Starter Kit, audio hardware connected and configured for the AWX Amp application and the status of the amp application. Harman AudioworX Support can be contacted to diagnose issues outside of these.

The following sub-sections provide instructions on how to fix the issues identified in the diagnostics report.

Issues in Connectivity

If there is a connectivity issue between the PC and the Starter Kit, it will be identified in the very first step of the diagnostics. In such cases, the diagnostics will exit soon after as shown below:

To fix this issue, ensure that the Starter Kit and the PC are both on the same network. As mentioned in Hardware Components Setup of this document, direct connection between the PC and the Starter Kit over ethernet is preferred due to zero network traffic. However, there may be situations where a direct connection is not possible, for example, if the PC’s ethernet port is already in use or the PC does not have an ethernet port at all.

In such cases, the Starter Kit’s hotspot feature may be used to establish connection between the PC and the Starter Kit. The Starter Kit is configured to automatically start a Wi-Fi hotspot with the following login credentials, when it is not connected to any known Wi-Fi network:

• SSID: AP_AWXStarterKit
• Password: starterkithotspot

Connect to this hotspot from the PC to first establish direct Wi-Fi connection to the Starter Kit and then run the diagnostics again. Step one of the diagnostics should be successful, indicating that the Starter Kit is accessible from the PC.

The IP address of the Starter Kit starts with a number other than ”192“or ”169“, which indicates that the PC is connected to the Starter Kit’s Wi-Fi hotspot. The user must be warned that in this setup, the PC will no longer have access to the internet via Wi-Fi. For convenience, it is recommended that the Starter Kit is configured to connect to a common Wi-Fi network using the instructions in “Starter Kit Configuration > Wi-Fi Config” in SKUtility Tool – Graphical Application after connecting to the Starter Kit hotspot.

Issues with Configuration Files

The second step of the diagnostics verifies if all the files that are required for functioning of the Starter Kit are present in the file system of the Starter Kit. If the diagnostic report indicates missing files, a simple brute-force solution would be to reset all files to their original states using the Configuration > Factory Reset button in the Starter Kit Utility, which is described in SKUtility Tool – Graphical Application.

All the data files in the Starter Kit will also be restored to their original states (corresponding to the example project), which means that any changes made to the audio hardware configurations or the signal flow flashed on the device (.flash files) will be lost, and need to be reconfigured.
It is recommended to take a snapshot for back up using the SKUtility UI Tool before resetting all the configurations.

The following table shows the solution to restore individual files:

Missing File	Solution
/home/<user>/HarmanAudioworX/config.json	Reconfigure the audio device using Audio Config in SK Utility tool.
/home/<user>/HarmanAudioworX/device.flash	Export device file and send it to the device (refer to Configuring a Custom Device) using the Send Device File option in the SKUtility tool.
All other files	Restore all files using Factory Reset option in the SK Utility tool.

Issues with the Audio Device

The Starter Kit diagnostics verifies if the audio input and output devices set in the audio device configuration are connected. Below is an example diagnostic report showing an error with the audio device:

If such an error is shown, verify if the required audio device is physically connected is powered on.

Two separate audio devices, one for input and the other for output, may be used simultaneously. If the input or output device is not capable of capture or playback, respectively, the diagnostic report will show a warning (in yellow).

If this is not intended, reconfigure the audio device using the SKUtility Tool.

Issues in the AWX Amp Application

The AWX Starter Kit has two start up modes set via the interactive config menu described under “Configuration > Audio Config” in SKUtility Tool – Graphical Application.

• Amp mode
• Dev mode

Step 4 in the diagnostics verifies the status of the AWX Amp application based on the mode that is configured. If the Starter Kit hardware is set to “Amp” mode, the AWX Amp application is expected to be running.

An error may be reported in this step for the following reasons:

• Failure in any of the previous steps.
• The expected audio interface is not available at the time of amp start-up. Ensure that the audio device is plugged in and powered on (if the interface has dedicated power) before powering-on the Raspberry Pi 5 (not required for the HiFiBerry HATs).
• Problem in starting the AWX Amp application due to audio device setup or framework initialization, refer to AWX Amp Application Logs section.

Once the issues detected are rectified, reset the AWX Amp application from Remote > Reset in the SKUtilityGUI, or using the python3 SKUtility.py rmt -rst command and re-run the diagnostics. If problems persist, contact Harman AudioworX support by following the information given in Reporting Issues section.

AWX Amp Application Logs

---

The Starter Kit produces logs at different points showing information on boot times, the AWX Amp application start and stop times and includes logs from the AWX Amp application showing initialization and configuration statuses during the audio driver setup and writes them into a file named awx_log.txt in the Starter Kit. This file can be fetched from the Starter Kit using Remote > Fetch Logs in the SKUtilityGUI, or by running the command python3 SKUtility.py rmt -flog.

Following figure shows an example log file in the Starter Kit.

The above figure shows 4 parts in a log:

1. Start Time: This part of the log shows the boot time and date if the log was generated at boot time, or the start time and date of the AWX Amp application if the amp was reset or started using the Starter Kit Utility. The first half (highlighted text) shows logs generated on boot, and the second half shows logs generated at amp reset by the user (notice the text “AWX Amp starter by user”).
2. Amp Mode: This part shows the mode in which the Starter Kit is configured. This text is only shown at boot time and not when the amp is started using the Start Kit Utility, as shown in the second half of the figure.
3. AWX Amp Application Logs: This part of the log shows logs generated by the AWX Amp application, which includes logs from the amp front-end, audio driver, etc. Logs related to SFD initialization from the xAF framework can be found in the other log file (VirtualAmpLog.txt), which is downloaded along with the awx_log.txt file.
4. AWX Amp Stop Time: Finally, the last part of the log indicates the stop time of the AWX Amp application. Note that this part of the log will not be printed if the Starter Kit is abruptly powered off or shutdown while the AWX Amp application is still running.

The latest logs are written to the end of the file. The above figure shows that the amp may be running since the end of the log file has logs from the AWX Amp application and not the stop time.

Running the “Reset All Configurations” command will remove all log files on the Starter Kit hardware. Before resetting configurations, it is recommended that a snapshot is taken using Remote > Snapshot in the SKUtilityGUI or fetch the log files using Remote > Fetch Logs.

Reporting Issues

---

For reporting issues related to the AudioworX Starter Kit, write to AudioworXSupport@harman.com with the following information:

1. Subject line — “AudioworX Starter Kit – short description of the issue faced”
2. Detailed description of the issue.
3. Attach the following files (if any).
   1. The GTT project file (.gttd) used, which can be exported from GTT (File > Export Project).
   2. Snapshot of the flash files on the Starter Kit hardware which can be generated using Remote > Snapshot in the SKUtilityGUI, or the command python3 SKUtility.py rmt -snp. The snapshot will be downloaded to “C:\ProgramData\Harman\StarterKit”.
4. Steps for reproducing the issue.