Console

Attributes 

struct Attributes

Attributes for the OnOffTrait.

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

    Declaration

    Swift

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

  • Whether the device type implemented on the endpoint is turned off (false) or turned on (true). Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var onOff: Bool? { get }

  • When set to true, prevents the global scene from being destroyed by subsequent off or on commands. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var globalSceneControl: Bool? { get }

  • The length of time (in 0.1 seconds) that the onOff attribute is true before changing to false when using the OnWithTimedOff command. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var onTime: UInt16? { get }

  • The length of time (in 0.1 seconds) that the onOff attribute is false before allowing another OnWithTimedOff command to turn the device back on. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var offWaitTime: UInt16? { get }

  • The desired startup behavior of a device when supplied with power. If not set, the onOff attribute is set to its previous value. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
var startUpOnOff: Matter.OnOffTrait.StartUpOnOffEnum? { 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.OnOffTrait.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.OnOffTrait.Attributes, rhs: Matter.OnOffTrait.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)