Console

Attributes 

struct Attributes

Attributes for the BooleanStateConfigurationTrait.

  • 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.BooleanStateConfigurationTrait.Attributes, rhs: Matter.BooleanStateConfigurationTrait.Attributes) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

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

    Nullable: false.

    Declaration

    Swift

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

  • Indicates which specific alarm modes are currently active. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var alarmsActive: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap? { get }

  • The alarm modes that will be emitted if the sensor is triggered. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var alarmsEnabled: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap? { get }

  • The alarms supported by the sensor. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var alarmsSupported: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap? { get }

  • Indicates which specific alarm modes are currently suppressed. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var alarmsSuppressed: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap? { get }

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

    Declaration

    Swift

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

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

    Declaration

    Swift

    @TraitAttribute
var clusterRevision: UInt16? { get }

  • The currently selected sensitivity level. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var currentSensitivityLevel: UInt8? { get }

  • The default sensitivity level selected by the manufacturer. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var defaultSensitivityLevel: UInt8? { 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

  • 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.BooleanStateConfigurationTrait.Feature? { 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 }

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

  • The trait identifier.

    Declaration

    Swift

    static var identifier: String { get }

  • Indicates any faults registered by the device. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var sensorFault: Matter.BooleanStateConfigurationTrait.SensorFaultBitmap? { get }

  • Indicates the number of sensitivity levels supported by the device. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var supportedSensitivityLevels: UInt8? { get }