Console

ProgressStruct 

struct ProgressStruct

Data about the operating status of an area.

  • The identifier of the area, where the identifier is an entry in the supportedAreas attribute’s list.

    Declaration

    Swift

    let areaID: UInt32

  • The operational status of the device for the area, indicated by the areaID field.

    Declaration

    Swift

    let status: Matter.ServiceAreaTrait.OperationalStatusEnum

  • The total operational time, in seconds, from when the device started to operate at the area indicated by the areaID field until the operation finished.

    Declaration

    Swift

    let totalOperationalTime: UInt32?

  • The estimated time for the operation, in seconds, from when the device starts operating at the area indicated by the areaID field until the operation completes, excluding any time spent while not operating in the area.

    Declaration

    Swift

    let estimatedTime: UInt32?

  • 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)?