Console

TimerTrait 

struct TimerTrait

This trait can be used to control a built-in timer on a device, such as starting a new timer on a sprinkler, and pausing and canceling the timer.

  • No supported events for TimerTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by TimerTrait.

    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 TimerTrait.

    Declaration

    Swift

    let attributes: Google.TimerTrait.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 TimerTrait.

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

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

    Declaration

    Swift

    var supportsTimerStartCommand: Bool { get }

  • Starts a new device timer.

    Declaration

    Swift

    func timerStart(timerTimeSeconds: Int32) async throws

    Parameters

    timerTimeSeconds

    Duration of the timer in seconds, which must be in the range of 1 to maxTimerLimitSeconds.

  • The batchable version of timerStart command above.

    See also

    timerStart

    Declaration

    Swift

    func timerStartBatchable(timerTimeSeconds: Int32) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsTimerAdjustCommand: Bool { get }

  • Adjusts the device timer duration.

    Declaration

    Swift

    func timerAdjust(adjustmentTimeSeconds: Int32) async throws

    Parameters

    adjustmentTimeSeconds

    Positive or negative adjustment of the timer in seconds, which must be in the range of -maxTimerLimitSeconds to maxTimerLimitSeconds.

  • The batchable version of timerAdjust command above.

    See also

    timerAdjust

    Declaration

    Swift

    func timerAdjustBatchable(adjustmentTimeSeconds: Int32) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsTimerPauseCommand: Bool { get }

  • Pauses the device timer.

    Declaration

    Swift

    func timerPause() async throws

  • The batchable version of timerPause command above.

    See also

    timerPause

    Declaration

    Swift

    func timerPauseBatchable() throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsTimerResumeCommand: Bool { get }

  • Resumes the device timer.

    Declaration

    Swift

    func timerResume() async throws

  • The batchable version of timerResume command above.

    See also

    timerResume

    Declaration

    Swift

    func timerResumeBatchable() throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsTimerCancelCommand: Bool { get }

  • Cancels the device timer.

    Declaration

    Swift

    func timerCancel() async throws

  • The batchable version of timerCancel command above.

    See also

    timerCancel

    Declaration

    Swift

    func timerCancelBatchable() throws -> BatchableCommand<Void>