bosesoundtouchapi.models.setuprequest

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

SoundTouch device Setup Request configuration object.

This class contains the attributes and sub-items that represent setup request criteria.

SetupRequest( requestState: bosesoundtouchapi.models.setuprequeststates.SetupRequestStates, timeoutMS: int = None)

Initializes a new instance of the class.

Arguments:
  • requestState (SetupRequestStates): Setup request state to process.
  • timeoutMS (int): Timeout value (in milliseconds); only used for some setup states.
Raises:
  • SoundTouchError: startItem argument was not of type int.
State: str

Setup state to request.

See SetupRequestStates enum for more details.

TimeoutMS: str

Setup timeout value.

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.