Console

Attributes 

struct Attributes

Attributes for the ClosureControlTrait.

  • A list of the attribute IDs of the attributes supported by the cluster instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var attributeList: [UInt32]? { get }

  • The estimated time remaining, in seconds, before the operation is complete. A value of 0 means that the operation has completed. A value of null means that there is no time defined until the operation is complete. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
var countdownTime: UInt32? { get }

  • The current operational state of the closure. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var mainState: Matter.ClosureControlTrait.MainStateEnum? { get }

  • A list of active errors. An empty list indicates that there are no active errors. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var currentErrorList: [Matter.ClosureControlTrait.ClosureErrorEnum]? { get }

  • The current Position, Latch, and Speed states, whichever are applicable based on the feature flags set. A null value means that the states are not known. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
var overallCurrentState: Matter.ClosureControlTrait.OverallCurrentStateStruct? { get }

  • The TargetPosition, TargetLatch, TargetSpeed values, whichever are applicable according to the feature flags set. A null value means that the values are not known. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
var overallTargetState: Matter.ClosureControlTrait.OverallTargetStateStruct? { get }

  • Whether the latch mechanism can be latched or unlatched remotely. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var latchControlModes: Matter.ClosureControlTrait.LatchControlModesBitmap? { get }

  • A list of server-generated commands (server to client) which are supported by this cluster server instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var generatedCommandList: [UInt32]? { get }

  • A list of client-generated commands which are supported by this cluster server instance.

    Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var acceptedCommandList: [UInt32]? { get }

  • Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero). Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var featureMap: Matter.ClosureControlTrait.Feature? { get }

  • The revision of the server cluster specification supported by the cluster instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var clusterRevision: UInt16? { get }

  • The trait identifier.

    Declaration

    Swift

    static var identifier: String { get }

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

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Matter.ClosureControlTrait.Attributes, rhs: Matter.ClosureControlTrait.Attributes) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)