__init__

Bose SoundTouch API Python3 Library

Overview

This API provides Python programmers the ability to control Bose SoundTouch speakers from any program written in Python 3.

It utilizes the Bose SoundTouch Webservices API, which is hosted on each SoundTouch device.

More information about Bose SoundTouch speakers can be found on the Bose SoundTouch Family page.

Features

The following features are supported by this API.

  • Media Player controls (play pause, resume, next track, prev track, repeat, shuffle, etc)
  • Media Content (streaming radio, play http or https url, Google TTS)
  • Media Volume control (set / retrieve, tick up / down, mute, smart mute)
  • Select Sources (Aux, Bluetooth, Airplay, Deezer, Spotify, iHeart, SiriusXm, etc)
  • Multi-room Zone functions (create zone, add / remove zone members, syncronized play)
  • Power functions (smart power on / off, power toggle, power to standby)
  • Audio mode switching (Normal, Dialog, etc)
  • Audio Tone Controls for Bass and Treble Levels (set, retrieve, supported min / max values)
  • Audio Product CEC HDMI Control support (set, retrieve, supported values)
  • Presets (store, remove, remove all, select)
  • Recent Media History (list recent content that was played, select recent item for play)
  • Favorites (add, remove, thumbs up, thumbs down)
  • Snapshot device settings (store, restore)
  • Change Device Name
  • Configuration data (clock time, clock, timezone, capabilities, bass capabilities)
  • Notifications (receive real-time status updates from the device)
  • Wireless configuration options (available networks in range, set last wifi source)
  • Firmware update configuration (query software update status, check configuration)
  • Zeroconf (aka MDNS) discovery of SoundTouch devices on the network
  • ID3 tag support for media content played from a url
  • ... and more

Requirements and Dependencies

The following requirements must be met in order to utilize this API:

  • Bose SoundTouch Speaker(s) that support the SoundTouch Webservices API.
    • SoundTouch 10
    • SoundTouch 300
    • I have only tested with the above (what can I say; Bose products are expensive, and I can only afford the two! :D )
    • Other SoundTouch devices should be compatible.
    • Note that the newer line of Bose Speakers (Home Speaker 500, 700, etc) are NOT supported as they do not utilize the Bose WebServices API.

The following Python-related requirements must be met in order to utilize this API:

  • Python 3.4 or greater (Python 2 not supported).
  • smartinspectPython package (>= 3.0.21) - for diagnostics and logging support.
  • websocket-client package (>= 2.0).
  • urllib3 package (>= 1.2.0).

Documentation

Documentation is located in the package library under the 'docs' folder; use the index.html as your starting point. You can also view the latest docs on the readthedocs web-site.

Installation

This module can be easily installed via pip:

$ python3 -m pip install bosesoundtouchapi

Quick-Start Sample Code

Almost every method is documented with sample code; just click on the "Sample Code" links under the method, and use the "Copy to Clipboard" functionality to copy / paste.

Check out the following classes to get you started:

Licensing

This project is licensed and distributed under the terms of the MIT End-User License Agreement (EULA) license.

Portions of this code and the overall "flow" were taken from contributions made by MatrixEditor. My original intent was to fork his repository and add some changes, but there were just too many and I wanted to change some things that would have broken backward compatibility so I continued with my own repository.

Logging / Tracing Support

The SmartInspectPython package (installed with this package) can be used to easily debug your applications that utilize this API.

The following topics and code samples will get you started on how to enable logging support.
Note that logging support can be turned on and off without changing code or restarting the application.
Click on the topics below to expand the section and reveal more information.

Configure Logging Support Settings File
Add the following lines to a new file (e.g. "smartinspect.cfg") in your application startup / test directory.
Note the file name can be whatever you like, just specify it on the call to SiAuto.Si.LoadConfiguration() when initializing the logger.

; smartinspect.cfg

; SmartInspect Logging Configuration General settings.
; - "Enabled" parameter to turn logging on (True) or off (False).
; - "Level" parameter to control the logging level (Debug|Verbose|Message|Warning|Error).
; - "AppName" parameter to control the application name.
Enabled = False 
Level = Verbose
DefaultLevel = Debug
AppName = My Application Name

; SmartInspect Logging Configuration Output settings.
; - Log to SmartInspect Console Viewer running on the specified network address.
Connections = tcp(host=192.168.1.1,port=4228,timeout=5000,reconnect=true,reconnect.interval=10s,async.enabled=true)
; - Log to a file, keeping 14 days worth of logs.
;Connections = "file(filename=\"./tests/logfiles/logfile.log\", rotate=daily, maxparts=14, append=true)"
; - Log to an encrypted file, keeping 14 days worth of logs.
;Connections = "file(filename=\"./tests/logfiles/logfileEncrypted.sil\", encrypt=true, key=""1234567890123456"", rotate=daily, maxparts=14, append=true)"

; set defaults for new sessions
; note that session defaults do not apply to the SiAuto.Main session, since
; this session was already added before a configuration file can be loaded. 
; session defaults only apply to newly added sessions and do not affect existing sessions.
SessionDefaults.Active = True
SessionDefaults.Level = Message
SessionDefaults.ColorBG = 0xFFFFFF

; configure some individual session properties.
; note that this does not add the session to the sessionmanager; it simply
; sets the property values IF the session name already exists.
Session.Main.Active = True
Session.Main.ColorBG = 0xFFFFFF

Initialize Logging Support, MAIN module
Add the following lines to your program startup module.
This will import the necessary package modules, and initialize logging support.
NOTE - This code should only be executed one time! 

# load SmartInspect settings from a configuration settings file.
from smartinspectpython.siauto import *
siConfigPath:str = "./tests/smartinspect.cfg"
SIAuto.Si.LoadConfiguration(siConfigPath)

# start monitoring the configuration file for changes, and reload it when it changes.
# this will check the file for changes every 60 seconds.
siConfig:SIConfigurationTimer = SIConfigurationTimer(SIAuto.Si, siConfigPath, 60)

# get smartinspect logger reference.
_logsi:SISession = SIAuto.Main

# log system environment and application startup parameters.
_logsi.LogSeparator(SILevel.Fatal)
_logsi.LogAppDomain(SILevel.Verbose)
_logsi.LogSystem(SILevel.Verbose)

Initialize Logging Support, CLASS or sub-modules
Add the following lines to your program supporting modules.
This will import the necessary package modules, and initialize the shared logging session. 

# get smartinspect logger reference.
from smartinspectpython.siauto import *
_logsi:SISession = SIAuto.Main

More Information on SmartInspect
You can use SmartInspectPython by itself to create log files for your own applications.
Use the following PIP command to install the SmartInspectPython package from PyPi.org: 
$ python3 -m pip install smartinspectpython

The SmarrtInspect Redistributable Console Viewer (free) is required to view SmartInspect Log (.sil) formatted log files, as well capture packets via the TcpProtocol or PipeProtocol connections. The Redistributable Console Viewer can be downloaded from the Code-Partners Software Downloads Page. Note that the "Redistributable Console Viewer" is a free product, while the "SmartInspect Full Setup" is the Professional level viewer that adds a few more bells and whistles for a fee. Also note that a Console Viewer is NOT required to view plain text (non .sil) formatted log files.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch git checkout -b feature/AmazingFeature
  3. Commit your Changes git commit -m 'Add some AmazingFeature'
  4. Push to the Branch git push origin feature/AmazingFeature
  5. Open a Pull Request

View Change Log

Change Log

All notable changes to this project are listed here.

Change are listed in reverse chronological order (newest to oldest).

[ 1.0.18 ] - 2023/11/15
  • Added method to SoundTouchClient: AddMusicServiceSources - Adds any servers in the MediaServerList to the sources list if they do not exist in the sources list as a "STORED_MUSIC" source.
  • Added method to SoundTouchClient: RemoveMusicServiceAccount - Removes an existing music service account from the sources list.
  • Added method to SoundTouchClient: SetMusicServiceAccount - Adds a music service account to the sources list.
  • Updated model PlayInfo: ToXmlRequestBody method - changed default encoding value from 'unicode' to 'utf-8', which is what the ST webservices API expects.
  • Updated model SourceItem: UserName property - changed to FriendlyName, as the value is a display name.
  • Updated model MusicServiceAccount: UserName property - changed to UserAccount, as the value is an account name and not a user name.
  • Updated model MusicServiceAccount: DisplayName property - changed to FriendlyName, to use the same naming standards for UI display fields.
  • Updated any classes that did not have a __str__ or __repr__ method to call their ToString method.
[ 1.0.18 ] - 2023/11/15
  • Updated model AudioDspControls.ToSupportedAudioModesArray method to return a sorted list of supported audio modes.
  • Added method ToMinMaxString to model ControlLevelInfo to retrieve a description of the allowed Min / Max range values.
  • Added new method to SoundTouchClient: PlayNotificationBeep - Plays a quick beep notification sound on devices that support it.
  • Added new method to SoundTouchClient: GetSoftwareUpdateCheckInfo - Gets the latest available software update release version information for the device.
  • Added new method to SoundTouchClient: GetSoftwareUpdateStatus - Gets the status of a SoundTouch software update for the device.
  • Added new method to SoundTouchClient: GetWirelessSiteSurvey - Gets a list of wireless networks that can be detected by the device.
  • Added new method to SoundTouchClient: SelectLastWiFiSource - Selects the last wifi source that was selected.
[ 1.0.17 ] - 2023/11/15
  • Add sort support to model MediaServerList, to allow sorting on any column.
  • Add sort support to model PresetList, to allow sorting on any column.
  • Add sort support to model RecentList, to allow sorting on any column.
  • Add sort support to model ServiceAvailability, to allow sorting on any column.
  • Add sort support to model SourceList, to allow sorting on any column.
  • Updated SoundTouchClient: GetMediaServerList method - automatically sorts the returned list objects by FriendlyName.
  • Updated SoundTouchClient: GetServiceAvailability method - automatically sorts the returned list objects by ServiceType.
  • Updated SoundTouchClient: GetSourceList method - automatically sorts the returned list objects by Source.
[ 1.0.16 ] - 2023/11/15
  • Changed Zeroconf dependency, as it was interfering with Home Assistant dependencies.
[ 1.0.15 ] - 2023/11/14
  • Added new class SoundTouchDiscovery to support discovery of SoundTouch devices on the network using Zeroconf MDNS.
  • Added new method to SoundTouchClient: GetServiceAvailability - Gets the current service availability configuration of the device.
  • Added new method to SoundTouchClient: GetSoundTouchConfigurationStatus - Gets the current SoundTouch configuration status of the device.
[ 1.0.14 ] - 2023/11/13
  • Added new method to SoundTouchClient: GetAudioSpeakerAttributeAndSetting - allows speaker attribute and settings to be retrieved (Rear, SubWoofer01, SubWoofer02).
  • Added new method to SoundTouchClient: GetAudioProductLevelControls - allows speaker levels to be retrieved (FrontCenterSpeakerLevel, RearSurroundSpeakersLevel).
  • Added new method to SoundTouchClient: SetAudioProductLevelControls - allows speaker levels to be adjusted (FrontCenterSpeakerLevel, RearSurroundSpeakersLevel).
  • Added new method to SoundTouchClient: SetAudioDspControls - allows audio dsp controls to be adjusted (AudioMode, VideoSyncAudioDelay, SupportedAudioModes).
  • Removed method from SoundTouchClient: SetAudioDspControlsAudioMode - replaced this with the more robust SetAudioDspControls method.
  • Added class SoundTouchHdmiCecModes to define HDMI CEC Mode values.
  • Added class SoundTouchAudioModes to define Audio Mode values.
  • Updated documentation for various classes and sample code snippets.
[ 1.0.13 ] - 2023/11/12
  • Added new method to SoundTouchClient: SetProductCecHdmiControl - allows HDMI CEC mode to be turned ON/OFF.
  • Updated documentation for various classes and sample code snippets.
[ 1.0.12 ] - 2023/11/11
  • Added new methods to SoundTouchClient: GetAudioProductToneControls, SetAudioProductToneControls.
  • Updated SoundTouchClient methods GetAudioDspControls, GetBlueToothInfo, GetProductCecHdmiControl, GetProductHdmiAssignmentControls, GetRebroadcastLatencyMode, and SetAudioDspControlAudioMode to check device capabilities prior to executing the request. A SoundTouchError will be thrown if the device does not support the capability.
[ 1.0.11 ] - 2023/11/11
  • Added several new methods to SoundTouchClient: GetAudioDspControls, GetBlueToothInfo, GetProductCecHdmiControl, GetProductHdmiAssignmentControls, GetRebroadcastLatencyMode, SetAudioDspControlAudioMode.
[ 1.0.10 ] - 2023/11/10
  • Added several new methods to SoundTouchClient: SelectLastSoundTouchSource(), SelectLastSource(), SelectLocalSource().
[ 1.0.9 ] - 2023/11/08
  • Accidentally changed the GetrSourceList() method to GetCapabilities() method while testing and pushed the change to PyPi.org. Changed it back, but hda to update the release to 1.0.9.
[ 1.0.8 ] - 2023/11/08
  • Added SoundTouchWebSocket.ClearListeners() method to allow all listeners to be removed with one call.
  • Changed classifier to "Development Status 5 - Production/Stable".
[ 1.0.7 ] - 2023/11/08
  • Added SourceList.ToSourceArray() method that returns an array of available source list items.
[ 1.0.6 ] - 2023/11/04
  • Added Ping and Pong functionality to the SoundTouchWebSocket class. This allows 'keep-alive' ping send requests and pong responses to be tracked by the websocket. PingInterval is also configurable, and can also be disabled (default setting) if configured to do so.
[ 1.0.5 ] - 2023/11/03
  • Updated Firmware namespace classes to more closely resemble the index.xml output (e.g. changed property names, fixed PROTOCOL processing, etc). Also added sample code to the SoundTouchFirmware class.
[ 1.0.4 ] - 2023/11/01
  • Updated SoundTouchWebSocket OnClose event processing to only pass 2 parameters instead of 3. There is no message argument when a connection is closed. I also added an OnOpen event to allow the user to listen for when a connection is opened.
[ 1.0.3 ] - 2023/10/30
  • Updated SoundTouchClient PlayUrl method to handle metadata retrieval errors more gracefully.
[ 1.0.2 ] - 2023/10/28
  • Updated documentation link for PyPi.org.
[ 1.0.1 ] - 2023/10/28
  • Added support for ReadtheDocs documentation hosting.
[ 1.0.0 ] - 2023/10/05
  • Version 1 initial release.