2024.10.4
Home ▸ Integrations ▸

Sony Songpal

The songpal platform allows you to control Sony’s Songpal (”Audio Control API”) compatible devices such as soundbars, AV receivers and wireless speakers from Home Assistant.

Even when the API officially supports only a few devices (HT-ST5000, HT-MT500, HT-CT800, SRS-ZR5 and STR-DN1080), it has also been confirmed to work on others. The list of supported devices from Sony’s Songpal website lists devices which are likely to be compatible with this platform.

If the platform works with your non-listed device, or you encounter bugs, please feel free to report them upstream.

A few notes:

  • The quick start-up mode has to be enabled in order to turn the device on.
  • Supports currently only one output terminal, i.e., the volume control works only on the first volume controller as reported by the backend library.
  • Some devices, e.g., HT-XT3, do not support decreasing the volume step-by-step correctly.
  • Feel free to improve the available actions!

Configuration

To add the Sony Songpal integration to your Home Assistant instance, use this My button:

Sony Songpal can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

Manual configuration steps

If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Sony Songpal.

  • Follow the instructions on screen to complete the setup.

See python-songpal’s documentation how to get your API endpoint.

Actions

In addition to the general media player actions, the following actions are provided:

Action songpal/set_sound_setting

For a list of available settings and their values use songpal sound command.

Data attribute Optional Description
entity_id yes Target entity. To target all songpal devices, use all
name no Configuration variable, e.g., nightmode
value no New configuration value, e.g., on