bosesoundtouchapi.models.simpleconfig

@export
class SimpleConfig(bosesoundtouchapi.soundtouchmodelrequest.SoundTouchModelRequest):

SoundTouch device SimpleConfig configuration object.

This class contains the attributes and sub-items that represent a single-node xml-response item configuration of the device.

SimpleConfig( configName: str = None, value: str = None, attribute: str = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • configName (str): The configuration name (or XML tag name when initializing the instance).
  • value (str): The stored text value.
  • attribute (str): The stored attributes.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Attribute: dict

Stored attributes.

ConfigName: str

Configuration name (or XML tag name when initializing the instance).

Value: str

Stored text value from the XML-Element.

def ToElement(self, isRequestBody: bool = False) -> xml.etree.ElementTree.Element:

Overridden.
Returns an xmltree Element node representation of the class.

Arguments:
  • isRequestBody (bool): True if the element should only return attributes needed for a POST request body; otherwise, False to return all attributes.
def ToString(self) -> str:

Returns a displayable string representation of the class.