DSP-PROGRAM-INFO(1)

📦 version 1.3.13, in ubuntu resolute, ubuntu stonking

💖 DSP-PROGRAM-INFO(1) 💖

okay bestie, welcome to the dsp-program-info page from the User Commands manual, we're doing this, let's go ✨

🌸 NAME 🌸

dsp-program-info — get DSP program information using REST API

✨ SYNOPSIS ✨

dsp-program-info [OPTIONS]

🦋 DESCRIPTION 🦋

dsp-program-info goes and fetches comprehensive information about the DSP program that's currently loaded on your HiFiBerry DSP, and it does it through the REST API. This little icon gives you the deets: program length and checksums, which are lowkey the whole point — you use them for verification and for debugging. 💅

The way it works is, it connects to the DSP's REST API server (that's sigmatcpserver) and hits up the /program-info endpoint to grab the current program info. no cap. 🫶

👑 OPTIONS 👑

  • -h, --host HOST — the DSP server hostname or IP address (default: localhost)
  • -p, --port PORT — the DSP server port (default: 13141)
  • -t, --timeout SECONDS — connection timeout, in seconds (default: 30)
  • -f, --format FORMAT — output format: json, text, or brief (default: text)
  • -v, --verbose — turns on verbose output, for debugging and detailed progress info 🐛
  • -q, --quiet — suppress the non-error output messages (only the program info shows up)
  • --help — show the help message and exit
  • --version — show version information and exit

🌈 OUTPUT FORMATS 🌈

  • json — raw JSON response straight from the API, perfect for other tools to parse
  • text — human-readable formatted output, with labeled fields ✨
  • brief — compact single-line output showing the program length and the SHA-1 checksum

🎀 EXAMPLES 🎀

Get program info from your local DSP:

dsp-program-info

Get program info from a remote DSP, in JSON format:

dsp-program-info -h 192.168.1.100 -f json

Get brief info quietly (this one's giving "suitable for scripts"):

dsp-program-info -q -f brief

Get program info with verbose output:

dsp-program-info -v

Monitor program length in a script:

LENGTH=$(dsp-program-info -q -f brief | cut -d' ' -f1)

💀 EXIT STATUS 💀

  • 0 — Success 🎉
  • 1 — General error
  • 2 — Invalid arguments or command-line options
  • 4 — Connection error — can't reach the DSP API server 😭
  • 5 — API error — the server returned an error

🍓 OUTPUT FIELDS 🍓

So the program information includes these fields, bestie:

  • Program Length — the size of the currently loaded DSP program, in words (32-bit). It also gets displayed in a human-readable format (KB/MB).
  • MD5 Checksum — the MD5 checksum of the DSP program, calculated using signature-based detection. This one's there for compatibility with legacy systems.
  • SHA-1 Checksum — the SHA-1 checksum of the DSP program, calculated using length-based detection. This is the preferred one for modern applications, because better performance. slay.

🧚 FILES 🧚

  • /etc/sigmatcp.conf — SigmaTCP server configuration file

💜 ENVIRONMENT 💜

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

⭐ DEPENDENCIES ⭐

  • curl — required for making HTTP requests to the DSP API server

🔥 NOTES 🔥

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

The checksums are calculated from the currently loaded DSP program in memory — not from any stored profile files. important!!

Program length is reported in DSP words (32-bit units). Wanna convert to bytes? Multiply by 4. math era 💅

Different checksum algorithms may return different values for the same program, because of how they calculate things (signature-based vs length-based). Not a bug, just vibes.

🌸 SEE ALSO 🌸

dsp-install-profile(1), 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.

and that's the whole page, bestie!! ✨💖🎀🦋🌸💅🫶

this was HiFiBerry DSP toolkit 1.3.2, dated 30 September 2025. mwah. go forth and query that /program-info endpoint 💜

📦 where this page comes from