DSP-INSTALL-PROFILE(1)

📦 version 1.3.13, in ubuntu resolute, ubuntu stonking

💖 dsp-install-profile — the manual page, but make it slay 💖

okay bestie, welcome to the dsp-install-profile(1) page — it lives in the User Commands section of the manual, and it's literally your little shortcut to shoving a DSP profile onto a HiFiBerry DSP without touching SigmaStudio. no cap. let's get into it 🎀

✨ NAME ✨

dsp-install-profile — install a DSP profile using the REST API 🦋

✨ SYNOPSIS ✨

dsp-install-profile [OPTIONS] PROFILE_FILE

✨ DESCRIPTION ✨

so here's the vibe: dsp-install-profile installs a DSP profile XML file onto a HiFiBerry DSP, and it does it through the REST API. it's a whole simple command-line interface for uploading and activating DSP profiles — no direct SigmaStudio access needed, no messy complex API calls, none of that. 💅

the way this works is: the tool connects to the DSP's REST API server (that's sigmatcpserver, hi bestie 👋), uploads the XML profile file you gave it, and then verifies the installation. the profile gets written to the DSP's EEPROM, and it becomes active immediately. like, instantly instantly. periodt. 🔥

✨ ARGUMENTS ✨

  • PROFILE_FILE — the path to the XML profile file you want to install. it's gotta be a valid SigmaStudio-exported XML profile, and it's gotta be compatible with the target DSP hardware. no random XMLs, bestie, this isn't a vibe check you want to fail 🙈

✨ OPTIONS ✨

  • -h, --host HOST — the DSP server's hostname or IP address. default is localhost 💻
  • -p, --port PORT — the DSP server's port. default is 13141 🔌
  • -t, --timeout SECONDS — connection timeout, in seconds. default is 30 ⏳
  • -v, --verbose — turns on verbose output, so you get debugging info and detailed progress updates. it's giving narrator voice 🗣️
  • -q, --quiet — suppresses non-error output messages. silent mode, main character energy, no commentary 🤫
  • --help — shows the help message and exits 👋
  • --version — shows version information and exits 🏷️

✨ EXAMPLES ✨

install a profile on your local DSP:

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

install a profile on a remote DSP:

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

install with a custom port and verbose output (the full glam):

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

quiet install with a timeout, for when you're feeling lowkey:

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

✨ EXIT STATUS ✨

  • 0 — success 🎉 slay
  • 1 — general error 😭
  • 2 — invalid arguments or command-line options 💀
  • 3 — profile file not found or not readable 👻
  • 4 — connection error — can't reach the DSP API server 📡
  • 5 — API error — the server rejected the profile or returned an error 🚫

✨ FILES ✨

  • /usr/share/hifiberry/dspprofiles/ — the default location for DSP profile XML files 📁
  • /etc/sigmatcp.conf — the SigmaTCP server configuration file ⚙️

✨ ENVIRONMENT ✨

  • HTTP_PROXY, HTTPS_PROXY — proxy settings for curl, if you need them for network access 🌐

✨ DEPENDENCIES ✨

  • curl — required, because it's the one making HTTP requests to the DSP API server. no curl, no install, fr fr 🫶

✨ NOTES ✨

this tool needs sigmatcpserver to actually be running on the target DSP system, with the REST API enabled. the default config listens on localhost:13141. don't forget that part, bestie, it's important 🎀

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

profile installation writes to the DSP's EEPROM, which means the change is persistent across reboots. and the new profile becomes active immediately once installation succeeds. 🔥

for security reasons, make sure the DSP API server is properly configured and access-controlled in production environments. seriously. lock it down, queen 👑

✨ 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 © 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.

ok so that last bit means: NO warranty, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. read it and weep (or read it and install responsibly) 😭

and that's the whole page, bestie!! 🌈 this was HiFiBerry DSP toolkit 1.3.2, dated 30 September 2025, and it's the dsp-install-profile(1) manual. go forth and install some profiles, you absolute icon 👑💅

📦 where this page comes from