| DSP-GET-PROFILE(1) | HiFiBerry DSP Tools | DSP-GET-PROFILE(1) |
NAME¶
dsp-get-profile - retrieve DSP profile from HiFiBerry DSP using REST API
SYNOPSIS¶
dsp-get-profile [OPTIONS] [output_file]
DESCRIPTION¶
dsp-get-profile retrieves the current DSP profile from a HiFiBerry DSP device using the REST API. The profile is returned in XML format and can be saved to a file or displayed on stdout. This tool is useful for backing up current DSP configurations or examining the active profile.
The tool connects to the DSP via the REST API server (sigmatcpserver) and retrieves the currently active DSP profile. The profile contains all DSP configuration data including filters, parameters, and metadata.
ARGUMENTS¶
- output_file
- Optional file path where the retrieved profile should be saved. If not specified, the profile is written to stdout. The output file will contain the complete XML profile data.
OPTIONS¶
- -h, --host HOST
- Specify the DSP server hostname or IP address.
Default: localhost - -p, --port PORT
- Specify the DSP server port number.
Default: 13141 - -t, --timeout SECONDS
- Set the connection timeout in seconds.
Default: 30 - -v, --verbose
- Enable verbose output showing detailed operation information.
- -q, --quiet
- Suppress all non-error output. Only error messages will be displayed.
- --help
- Display help message and exit.
- --version
- Display version information and exit.
EXIT STATUS¶
The program exits with one of the following status codes:
- 0
- Success - profile retrieved successfully
- 1
- General error - unexpected failure
- 2
- Invalid arguments - check command line parameters
- 3
- File I/O error - cannot write to output file
- 4
- Connection error - cannot connect to DSP API server
- 5
- API error - server error or no profile found
EXAMPLES¶
- dsp-get-profile current-profile.xml
- Retrieve the current profile and save it to 'current-profile.xml'.
- dsp-get-profile -h 192.168.1.100 backup.xml
- Retrieve profile from a remote DSP at IP 192.168.1.100 and save to 'backup.xml'.
- dsp-get-profile
- Retrieve the current profile and display it on stdout.
- dsp-get-profile -q profile-backup.xml
- Quietly retrieve the profile and save to 'profile-backup.xml' with minimal output.
- dsp-get-profile -v | grep metadata
- Retrieve profile with verbose output and filter for metadata lines.
DEPENDENCIES¶
This tool requires:
- curl
- Used for HTTP communication with the REST API server
- sigmatcpserver
- The HiFiBerry DSP REST API server must be running and accessible
FILES¶
The tool retrieves profiles from the DSP via the REST API. The profile data is typically stored at:
- /var/lib/hifiberry/dspprogram.xml
- Default location for the active DSP profile (server-side)
TROUBLESHOOTING¶
- Connection refused
- Ensure sigmatcpserver is running:
sudo systemctl status sigmatcpserver - No profile found (exit code 5)
- The DSP may not have a profile loaded, or the profile file may be missing.
Check the server logs:
journalctl -u sigmatcpserver - Permission denied writing file
- Ensure you have write permissions to the output directory.
SEE ALSO¶
dsp-install-profile(1), dsp-program-info(1), sigmatcpserver(1)
AUTHOR¶
Written by the HiFiBerry team.
REPORTING BUGS¶
Report bugs to the HiFiBerry support team or GitHub issues.
COPYRIGHT¶
This is free software; see the source for copying conditions.
| September 2025 | HiFiBerry DSP 1.3.2 |