bosesoundtouchapi.models.wirelessprofile

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

SoundTouch device WirelessProfile configuration object.

This class contains the attributes and sub-items that represent the wireless profile configuration of the device.

WirelessProfile( ssid: str = None, password: str = None, securityType: bosesoundtouchapi.models.wirelesssecuritytypes.WirelessSecurityTypes | str = None, timeoutSecs: int = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • ssid (str): Wifi network service set identifier (SSID).
  • password (str): Wifi network password.
  • securityType (WirelessSecurityTypes): Wifi network security type.
  • timeoutSecs (int): Time to wait (in seconds) for the request to be processed before raising an exception for taking too long.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Raises:
  • SoundTouchError: startItem argument was not of type int.
Ssid: str

Wifi network service set identifier (SSID) to connect to.

Password: str

Wifi network password.

SecurityType: str

Wifi network security type.

TimeoutSecs: str

Time to wait (in seconds) for the request to be processed before raising an exception for taking too long.

def ToDictionary(self) -> dict:

Returns a dictionary representation of the class.

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.