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 services!
Supported devices will be automatically discovered and can be set up through UI. If you want to manually configure it in YAML configuration, add the following to your
songpal: - name: my soundbar endpoint: http://IP_ADDRESS:10000/sony
See python-songpal’s documentation how to get your API endpoint.
In addition to the general media player services, the following services are provided:
For a list of available settings and their values use
songpal sound command.
|Service data attribute||Optional||Description|
||yes||Target entity. To target all songpal devices, use
||no||Configuration variable, e.g.,
||no||New configuration value, e.g.,