pyradio-client(1)

🎀 Name 🎀

Hey bestie, welcome to the pyradio-client(1) page in the General Commands Manual — it’s literally the Remote Control Client for PyRadio. 💖

pyradio-client — a Remote Control Client for PyRadio. Periodt. ✨

---

💅 Remote Control Client 💅

Okay so PyRadio comes with a client that you use together with the Remote Control Server the program provides, and it speaks the server’s text command set. 🫶

The client was built with maximum ease in mind; the user does not even have to provide the IP and PORT. Iconic, honestly. ✨

---

🔥 Command line parameters 🔥

Bestie, here’s literally the output of the pyradio-client -h command:

Usage: pyradio-client [-h] [--address] [-s SERVER_AND_PORT] [-r]
                      [-t TIMEOUT] [command]

PyRadio Remote Control Client

General options:
  -h, --help            Show this help message and exit
  --address             List available servers

Server Parameters:
  -s SERVER_AND_PORT, --server_and_port SERVER_AND_PORT
                        Set the servers's IP and PORT (format: IP:PORT)
  -r, --reverse-detection
                        Reverse server detection (when no server IP and PORT
                        specified); detect headless server last, instead of
                        headless server first
  -t TIMEOUT, --timeout TIMEOUT
                        Set the timeout (default = 1.0)
  command               The command to send to the server

🌸 General options: 🌸

• -h, --help — shows this help message and exits, slay. 👑
• --address — lists available servers. 💌

🦋 Server Parameters: 🦋

• -s SERVER_AND_PORT, --server_and_port SERVER_AND_PORT — sets the server’s IP and PORT; the format is IP:PORT. 🛰️
• -r, --reverse-detection — reverses server detection: when no server IP and PORT are specified, it detects the headless server last instead of headless server first. 🔄
• -t TIMEOUT, --timeout TIMEOUT — sets the timeout; default = 1.0. ⏱️
• command — the command to send to the server. 💅

---

🧚 How it works 🧚

The client will auto-detect the PyRadio Servers running on the system when the -s command line parameter is not used. No cap. ✨

The auto-detection functionality is based on parsing the “server files” (residing in the STATE directory). 🗂️

If both a headless and a normal instance of PyRadio are detected, the headless server will be used to send the requested command, unless the -r (--reverse-detection) command line parameter is used. ⚡

Note: A normal server is a server started by a PyRadio instance which is executed on a real terminal, without the --headless command line parameter. 💡

A list of available commands will be displayed when no command has been specified. 📜

A list of detected servers (and their address) can be obtained using the command:

$ pyradio-client --addr

PyRadio Remote Control Server
  Headless server: 127.0.0.1:11111
  Server: 127.0.0.1:9998

Then, the address reported can be used to contact a specific server:

pyradio-client -s 127.0.0.1:9998 i

The previous command will get the info page of the normal instance of a server. 🥳

---

🌈 See also 🌈

• pyradio_server(1)
• pyradio(1)

💖 That’s the pyradio-client(1) page from the pyradio manual, dated June 2024 — mwah, bestie, bye! 💅