Python script volsync

HALRAD Research - Volsync - Proof Of Concept

Topic - volsync.py - A Python Script to sync Devialet Phantom Systems volume in a group using a Phantom Hardware Remote

Halrad Research - volsync.py

What is it? : A Python script to sync the volume of a Devialet Phantom System 1 to System 2 in a group

Scenario: I use a Phantom Remote connected to System1, which acts as the group leader for multiroom with two systems. The remote only changes the volume on the system the remote is paired with. I want it to change the volume on both systems in a multiroom group. To synchronize volume across both systems, you can use the provided Python script. This script listens for volume changes on System1 and applies the same changes to System2 with a specified offset. When you change the volume on System1 using the remote, the script automatically adjusts the volume on System2 to match.

The Volsync.py script:

How to use:

  1. Save the script as volsync.py
  2. Set the IP addresses of System 1 (Leader) and System 2 (Follower)
  3. Set the VOLUME_OFFSEToptionally used this to adjust the volume difference desired between the Leader and Follower system
  4. Run the script with Python
  5. Observe the volume syncing between the systems when using the Hardware Remote connected to the leader

Example output:

Using Verbose = 0 you should see something like this:

          2025-02-02 21:10:23,983 - INFO - Syncing volume: System 1 (7) -> System 2 (12)
          2025-02-02 21:11:34,134 - INFO - Syncing volume: System 1 (17) -> System 2 (22)
          2025-02-02 21:12:14,221 - INFO - Syncing volume: System 1 (20) -> System 2 (25)

or (depending on the verbose flag, it will print more info)

The remote is paired with System 1, also the GROUP leader.

Example Python script: volsync.py


import requests
import time
import logging

# Define Phantom system IPs and settings
SYSTEM_1_IP = "192.168.0.31"  # Leader system
SYSTEM_2_IP = "192.168.0.32"  # Follower system
VOLUME_OFFSET = 5  # System 2 will be 5 units louder than System 1
VOLUME_ENDPOINT = "/ipcontrol/v1/systems/current/sources/current/soundControl/volume"
VERBOSE = 0  # 0 for less output, 1 for more output

# Set up logging
logging.basicConfig(level=logging.DEBUG if VERBOSE else logging.INFO,
          format='%(asctime)s - %(levelname)s - %(message)s')

def get_volume(ip):
  """Retrieve current volume from a Phantom system."""
  try:
    response = requests.get(f"http://{ip}{VOLUME_ENDPOINT}", timeout=5)
    response.raise_for_status()
    return response.json().get("volume")
    logging.debug(f"get_volume - {ip}: {volume}")
  except requests.exceptions.RequestException as e:
    logging.error(f"Error retrieving volume from {ip}: {e}")
    return None

def set_volume(ip, volume):
  """Set the volume on a Phantom system."""
  try:
    response = requests.post(f"http://{ip}{VOLUME_ENDPOINT}", json={"volume": volume}, timeout=5)
    response.raise_for_status()
    logging.debug(f"set_volume to {volume} on {ip}")
  except requests.exceptions.RequestException as e:
    logging.error(f"Error setting volume on {ip}: {e}")

def clamp_volume(vol1, vol2, offset, min_vol=0, max_vol=100):
  """Clamp System 2's volume based on System 1's volume and the offset."""
  if vol1 == 0:
    logging.debug(f"clamp_volume found vol1 is zero return zero")
    return 0
  return max(min_vol, min(max_vol, vol1 + offset))

def sync_volume():
  """Sync volume from System 1 to System 2 with an offset."""
  last_volume = None
  polling_interval = 30

  while True:
    vol1, vol2 = get_volume(SYSTEM_1_IP), get_volume(SYSTEM_2_IP)
    if vol1 is None:
      time.sleep(polling_interval)
      continue

    if vol1 != last_volume:
      logging.debug(f"Volume changed on System 1: {vol1}")
      last_volume = vol1
      polling_interval = 10
    else:
      polling_interval = 30
    new_vol2 = clamp_volume(vol1, vol2, VOLUME_OFFSET)
    if new_vol2 != vol2:
      logging.info(f"Syncing volume: System 1 ({vol1}) -> System 2 ({new_vol2})")
      set_volume(SYSTEM_2_IP, new_vol2)

    time.sleep(polling_interval)

if __name__ == "__main__":
  sync_volume()