49 lines
2.4 KiB
Markdown
49 lines
2.4 KiB
Markdown
---
|
|
title: Sony Songpal
|
|
description: Instructions on how to integrate Sony Songpal devices into Home Assistant.
|
|
ha_category:
|
|
- Media Player
|
|
ha_iot_class: Local Push
|
|
ha_release: 0.65
|
|
ha_config_flow: true
|
|
ha_quality_scale: gold
|
|
ha_codeowners:
|
|
- '@rytilahti'
|
|
- '@shenxn'
|
|
ha_domain: songpal
|
|
ha_ssdp: true
|
|
ha_platforms:
|
|
- media_player
|
|
---
|
|
|
|
The `songpal` platform allows you to control Sony's Songpal ("[Audio Control API](https://developer.sony.com/develop/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](https://vssupport.sony.net/en_ww/device.html) 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](https://github.com/rytilahti/python-songpal).
|
|
|
|
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!
|
|
|
|
{% include integrations/config_flow.md %}
|
|
|
|
See [python-songpal's documentation](https://github.com/rytilahti/python-songpal#locating-the-endpoint) how to get your API endpoint.
|
|
|
|
## Services
|
|
|
|
In addition to the general [media player services](/integrations/media_player/#services), the following services are provided:
|
|
|
|
### Service `songpal/set_sound_setting`
|
|
|
|
For a list of available settings and their values use [`songpal sound`](https://github.com/rytilahti/python-songpal#sound-settings) command.
|
|
|
|
| Service 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` |
|