bosesoundtouchapi.models.clockconfig

@export
class ClockConfig:

SoundTouch device ClockConfig configuration object.

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

ClockConfig(root: xml.etree.ElementTree.Element)

Initializes a new instance of the class.

Arguments:
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
BrightnessLevel: int

The brightness level of the clock display.

TimeFormat: str

The time format with the following form: TIME_FORMAT_xxHOUR_ID (e.g.
"TIME_FORMAT_12HOUR_ID", "TIME_FORMAT_24HOUR_ID", etc).

TimeZoneInfo: str

The device's timezone.

UserEnable: bool

A value indicating whether the timezone can be altered by a user.

UserOffsetMinute: int

The offset in relation to the utc time.

UserUtcTime: int

The current utc time.

def ToString(self) -> str:

Returns a displayable string representation of the class.