Console

ArmDisarmTrait 

struct ArmDisarmTrait

This trait supports arming and disarming, as used in security systems.

  • List of the event types that are supported by ArmDisarmTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ArmDisarmTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the ArmDisarmTrait.

    Declaration

    Swift

    let attributes: Google.ArmDisarmTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • 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

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the ArmDisarmTrait.

    Declaration

    Swift

    struct Attributes

  • 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, rhs: Google.ArmDisarmTrait) -> 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)

  • Contains a user-friendly name for the levels as well as the language code.

    Declaration

    Swift

    struct LevelValues

  • Information about security-level names.

    Declaration

    Swift

    struct Levels

  • The supported security levels of the device. If this attribute is not reported, the device supports only one level.

    Declaration

    Swift

    struct AvailableArmLevels

  • Follow up response to the armDisarm command.

    Declaration

    Swift

    struct ArmDisarmFollowUpEvent

  • Proactive notification when the device enters a specific arm state.

    Declaration

    Swift

    struct ArmDisarmArmStateEvent

  • Whether the device supports the armDisarm command for this trait.

    Declaration

    Swift

    var supportsArmDisarmCommand: Bool { get }

  • Sets the alarm level of the device.

    Declaration

    Swift

    func armDisarm(arm: Bool, optionalArgsProvider: ((Google.ArmDisarmTrait.ArmDisarmCommand.OptionalArgs) -> Void)? = nil) async throws

    Parameters

    arm

    Starts the arming or disarming operation.

  • The batchable version of armDisarm command above.

    See also

    armDisarm

    Declaration

    Swift

    func armDisarmBatchable(arm: Bool, optionalArgsProvider: ((Google.ArmDisarmTrait.ArmDisarmCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<Void>

  • The security-level category, which influences how the level is displayed on devices with screens.

    Declaration

    Swift

    enum LevelCategory

  • The current arm state of the device.

    Declaration

    Swift

    enum ArmState

  • The result status of the ArmDisarm command.

    Declaration

    Swift

    enum StatusEnum

  • The error encountered when processing the ArmDisarm command.

    Declaration

    Swift

    enum ErrorCode