home-assistant.io/source/_components/media_player.songpal.markdown
Paulus Schoutsen 41955dc31a
Remove url prefix pt 2 (#5014)
* Migrate the non blog posts to use no domain

* Update demo links

* Remove Zanzito references from owntracks docs
2018-03-24 22:14:34 -07:00

2.9 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_iot_class, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_iot_class ha_release
page Sony SongPal compatible devices Instructions on how to integrate Sony Songpal devices into Home Assistant. 2018-02-03 09:00 true false true true sony.png Media Player Local Polling 0.65

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 services!

{% linkable_title Configuration %}

The platform will be loaded automatically by discovery component. If you want to manually configure it, add the following to your configuration.yaml file:

media_player:
  - platform: songpal
    name: my soundbar
    endpoint: http://IP_ADDRESS:10000/sony

{% configuration %} name: description: The name to display for this device. required: false type: string endpoint: description: API endpoint of the device. required: true type: string {% endconfiguration %}

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

{% linkable_title Services %}

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

{% linkable_title Service media_player/songpal_set_sound_setting %}

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

Service data attribute Optional Description
entity_id yes Target entity, leave unset for all devices
name no Configuration variable, e.g., nightmode
value no New configuration value, e.g., on