Console

ScheduleStruct 

struct ScheduleStruct

A schedule.

  • A device generated identifier for this schedule.

    Declaration

    Swift

    let scheduleHandle: Data?

  • The default thermostat system mode for transitions in this schedule.

    Declaration

    Swift

    let systemMode: Matter.ThermostatTrait.SystemModeEnum

  • The name for the schedule.

    Declaration

    Swift

    let name: String?

  • The default preset handle for transitions in this schedule.

    Declaration

    Swift

    let presetHandle: Data?

  • A list of transitions for the schedule.

    Declaration

    Swift

    let transitions: [Matter.ThermostatTrait.ScheduleTransitionStruct]

  • Indicates whether or not the schedule is built-in, meaning that it can be modified but not deleted.

    Declaration

    Swift

    let builtIn: Bool?

  • Creates a new Struct instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder) throws

    Parameters

    decoder

    The raw data representing this Struct.

  • Writes this Struct to the given TraitEncoder. Throws HomeError.parseError if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • Returns the field corresponding to the given field ID.

    Declaration

    Swift

    static func structField(id: UInt32) -> (any Field)?