bosesoundtouchapi.firmware.soundtouchfirmwarerelease

@export
class SoundTouchFirmwareRelease:

A Bose SoundTouch release targets a specific firmware upgrade.

The specific information can be loaded from an XML-Element (ElementTree.Element). There is a static method that implements the parsing process to save the values stored in the XML-Element.

SoundTouchFirmwareRelease( revision: str = None, httpHost: str = None, urlPath: str = None, usbPath: str = None, image: dict = None, notesUrl: str = None, features: list = None)
Arguments:
  • revision (str): The revision number of the current release.
  • httpHost (str): The http hostname of the update provider.
  • urlPath (str): The uri part of the full url linked to the downloadable update file.
  • usbPath (str): The uri part of the full url linked to the downloadable USB device update file.
  • image (dict[str, str]): The main property storing data related to the firmware image.
  • notesUrl (str): If the update file contains some release notes, the url is given within this property.
  • features (list[dict[str, str]]): If there are some features within the release, they are added to this list as a dict.
Features: list

If there are some features within the release, they are added to this list as a dict.

HttpHost: str

HTTP Hostname of the update provider.

Image: dict

Main property storing data related to the firmware image.

NotesUrl: str

If the update file contains some release notes, the URL is given within this property.

Revision: str

Revision number of the current release.

UrlPath: str

URI part of the full URL linked to the downloadable update file.

UsbPath: str

The uri part of the full url linked to the downloadable USB device update file.

@staticmethod
def LoadFromXmlElement( element: xml.etree.ElementTree.Element) -> SoundTouchFirmwareRelease:

Creates a new SoundTouchFirmwareRelease instance from an xml element that contains firmware details.

Arguments:
  • element (xmltree.Element): The root element with the tag "RELEASE".
Returns:

A SoundTouchFirmwareRelease object that contains the parsed firmware release details.

Raises:
  • SoundTouchError: If the element argument is null.
def ToString(self) -> str:

Returns a displayable string representation of the class.