Console

Attributes 

struct Attributes

Attributes for the ArmDisarmTrait.

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

    Declaration

    Swift

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

  • The supported security levels of the device. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var availableArmLevels: Google.ArmDisarmTrait.AvailableArmLevels? { get }

  • Indicates if the device is currently armed. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var isArmed: Bool? { get }

  • The current security level. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var currentArmLevel: String? { get }

  • Number of seconds before the currentArmLevel takes effect. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var exitAllowanceSeconds: UInt32? { get }

  • Current arm state of the device. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var armState: Google.ArmDisarmTrait.ArmState? { get }

  • The level from availableArmLevels that the device will enter after an exit countdown completes. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var targetArmLevel: String? { get }

  • The Epoch Unix timestamp of when an active exit allowance expires, before which the user must leave the house if the device is arming. The timestamp is a long integer, such as 1710825433. Once the exact time represented by the timestamp has been reached, the alarm sounds. The user may cancel arming or disarming while this countdown is active. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var exitAllowanceEndTimeSeconds: Int64? { get }

  • The Epoch Unix timestamp of when an active entry allowance expires, before which the user must enter a pin to prevent the alarm from sounding. The timestamp is a long integer, such as 1710825433. Once the exact time represented by the timestamp has been reached, the alarm sounds. In the meantime, the device provides a time countdown to the user. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
var entryAllowanceEndTimeSeconds: Int64? { 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: UInt32? { 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: Google.ArmDisarmTrait.Attributes, rhs: Google.ArmDisarmTrait.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)