NAME¶

dsp-install-profile - install DSP profile using REST API

SYNOPSIS¶

dsp-install-profile [OPTIONS] PROFILE_FILE

DESCRIPTION¶

dsp-install-profile installs a DSP profile XML file to a HiFiBerry DSP using the REST API. This tool provides a simple command-line interface to upload and activate DSP profiles without requiring direct access to SigmaStudio or complex API calls.

The tool connects to the DSP's REST API server (sigmatcpserver), uploads the specified XML profile file, and verifies the installation. The profile is written to the DSP's EEPROM and becomes active immediately.

ARGUMENTS¶

PROFILE_FILE

Path to the XML profile file to install. The file must be a valid SigmaStudio-exported XML profile compatible with the target DSP hardware.

OPTIONS¶

-h, --host HOST

DSP server hostname or IP address (default: localhost)

-p, --port PORT

DSP server port (default: 13141)

-t, --timeout SECONDS

Connection timeout in seconds (default: 30)

-v, --verbose

Enable verbose output for debugging and detailed progress information

-q, --quiet

Suppress non-error output messages

--help

Show help message and exit

--version

Show version information and exit

EXAMPLES¶

Install profile to local DSP:

dsp-install-profile /path/to/profile.xml

Install profile to remote DSP:

dsp-install-profile -h 192.168.1.100 /path/to/profile.xml

Install with custom port and verbose output:

dsp-install-profile -h dsp.local -p 8080 -v /path/to/profile.xml

Quiet installation with timeout:

dsp-install-profile -q -t 60 /usr/share/profiles/my-profile.xml

EXIT STATUS¶

0

Success

1

General error

2

Invalid arguments or command-line options

3

Profile file not found or not readable

4

Connection error - cannot reach DSP API server

5

API error - server rejected the profile or returned an error

FILES¶

/usr/share/hifiberry/dspprofiles/

Default location for DSP profile XML files

/etc/sigmatcp.conf

SigmaTCP server configuration file

ENVIRONMENT¶

HTTP_PROXY, HTTPS_PROXY

Proxy settings for curl (if needed for network access)

DEPENDENCIES¶

curl

Required for making HTTP requests to the DSP API server

NOTES¶

This tool requires the sigmatcpserver to be running on the target DSP system with the REST API enabled. The default configuration listens on localhost:13141.

The XML profile file should be exported from SigmaStudio and be compatible with the target DSP hardware (typically ADAU145x series).

Profile installation writes to the DSP's EEPROM, making the change persistent across reboots. The new profile becomes active immediately upon successful installation.

For security reasons, ensure that the DSP API server is properly configured and access-controlled in production environments.

SEE ALSO¶

dsptoolkit(1), sigmatcpserver(1), curl(1)

HiFiBerry DSP documentation: https://www.hifiberry.com/docs/

REST API documentation: /usr/share/doc/hifiberry-dsp/restapi.md

BUGS¶

Report bugs to: https://github.com/hifiberry/hifiberry-dsp/issues

AUTHOR¶

HiFiBerry team <info@hifiberry.com>

COPYRIGHT¶

Copyright © 2025 HiFiBerry. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.