DSP-GET-PROFILE(1)

📦 version 1.3.13, in ubuntu resolute, ubuntu stonking

💖 DSP-GET-PROFILE — the grab-your-profile girly 💖

okay so bestie, welcome to dsp-get-profile(1) from the HiFiBerry DSP Tools lineup ✨ this is the little icon that goes and fetches your DSP profile off a HiFiBerry DSP device. think of it as a lil errand runner for your config, except the errand runner is a command and the config is XML 💅

🌸 NAME 🌸

dsp-get-profile — retrieve DSP profile from HiFiBerry DSP using REST API

like, that's literally the whole job. go get the profile. bring it back. slay.

✨ SYNOPSIS ✨

dsp-get-profile [OPTIONS] [output_file]

🦋 DESCRIPTION 🦋

so dsp-get-profile pulls the current DSP profile off a HiFiBerry DSP device using the REST API, no cap. the profile comes back in XML format and you can either save it to a file or just let it spill onto stdout like a main character monologue 🎀

it's giving... backup tool. it's giving... inspector of vibes. fr fr, this is what you reach for when you wanna back up your current DSP configurations or just peek at whatever profile is currently active.

here's the tea on how it works: the tool connects to the DSP through the REST API server (sigmatcpserver) and retrieves the currently active DSP profile. and that profile? oh she's rich, she contains all the DSP configuration data — filters, parameters, and metadata. the whole package 💖

🎀 ARGUMENTS 🎀

  • output_file — optional file path where the retrieved profile should get saved. if you don't specify one, the profile just goes straight to stdout instead. and whichever way you go, the output file will contain the complete XML profile data. complete. all of it. no crumbs left behind 👑

💅 OPTIONS 💅

  • -h, --host HOST — tell it the DSP server hostname or IP address. default: localhost
  • -p, --port PORT — pick the DSP server port number. default: 13141
  • -t, --timeout SECONDS — set the connection timeout, in seconds. default: 30
  • -v, --verbose* — turn on verbose output so you get all the detailed operation info. she's chatty and we love her for it.
  • -q, --quiet* — suppress all non-error output. only error messages will show up. silent but deadly, periodt.
  • --help — display the help message and exit. the classic.
  • --version — display version information and exit.

🌈 EXIT STATUS 🌈

the program dips out with one of these status codes, so pay attention bestie:

  • 0 — Success ✨ profile retrieved successfully
  • 1 — General error — unexpected failure 😭
  • 2 — Invalid arguments — go check your 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
lowkey memorize these, because when something goes wrong the exit code is the only one who will tell you the truth 🙈

🔥 EXAMPLES 🔥

get the current profile and save it to current-profile.xml:

dsp-get-profile current-profile.xml

grab a profile from a remote DSP at IP 192.168.1.100 and save it to backup.xml:

dsp-get-profile -h 192.168.1.100 backup.xml

just get the current profile and show it on stdout:

dsp-get-profile

quietly get the profile and save it to profile-backup.xml with minimal output:

dsp-get-profile -q profile-backup.xml

get the profile with verbose output and filter for metadata lines:

dsp-get-profile -v | grep metadata

🧚 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 make sure 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 make sure you have write permissions to the output directory. bestie, the directory said no. respect the boundary 🙈

👑 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.

This is free software; see the source for copying conditions.

and that's the whole page, bestie!! this was HiFiBerry DSP 1.3.2, dated September 2025 — go forth and retrieve those profiles, you absolute legend 💖✨🎀🦋🌸💅🫶

📦 where this page comes from