python-songpal 0.0.4.1

Supported devices

The library has been tested for now with following devices:

• Sony HT-XT3

• SRS-X88

Getting started

$ pip install python-songpal

$ songpal discover

Discovering for 3 seconds
Found HT-XT3 - BAR-2015
* API version: 1.0
* Endpoint: http://192.168.1.1:10000/sony
* Services:
  - Service: guide
  - Service: system
  - Service: audio
  - Service: avContent

$ songpal bluetooth mode off

Status

$ songpal status

will display some basic information about the device, such as whether it is powered on and what are its volume settings.

Power Control

power command can be used to both turning the device on and off, and change its power settings.

$ songpal power

$ songpal power settings

$ songpal power

$ songpal power set quickStartMode on

Volume Control

$ songpal volume [<value>|mute|unmute]

$ songpal volume 20

$ songpal volume +5

$ songpal volume -10

Sound Settings

Your device may support various sound-related settings, such as night mode or adjusting the subwoofer volume.

$ songpal sound

$ songpal sound nightMode off

$ songpal sound subwooferLevel 4

Output Control

$ songpal output

Outputs:
  * TV (uri: extInput:tv)
  * HDMI1 (uri: extInput:hdmi?port=1)
  * HDMI2 (uri: extInput:hdmi?port=2) (active)
  * HDMI3 (uri: extInput:hdmi?port=3)
  * Bluetooth Audio (uri: extInput:btAudio)
  * Analog (uri: extInput:line)

$ songpal output HDMI1

Device Settings

To list available settings, use settings command.

$ songpal settings

Do note that some settings (e.g. bluetooth settings) are not listed in the global settings tree, but have to be separatedly accessed using the bluetooth command.

Executing custom commands

For experimenting it can be useful to execute arbitrary commands against the endpoint. You can access the available methods by calling songpal list_all.

command can be used for that as follows:

$ songpal command system getSystemInformation

Notification support

The protocol supports subscribing to notifications on subsystem basis. Executing songpal notifications without any parameters will list available notifications.

Every notification can be listened to separately, or alternatively all notifications from a single subsystem can be subscribed to.

$ songpal notifications --listen-all avContent

Contributing

Home assistant support

A preliminary Home Assistant can be found under custom_components/media_player/songpal.py.

To install it copy (or link) the file into your custom components directory (~/.homeassistant/custom_components/media_player/), and add the following configuration to your media player configuration file.

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

Enabling debug for songpal in ~/.homeassistant/configuration.yaml can provide useful information when trying to debug the platform:

logger:
  logs:
    songpal: debug