Console

ExtendedOperationalStateTrait 

struct ExtendedOperationalStateTrait

This trait represents any device that supports operating in specific zones, and has an ongoing duration for its operation which can be queried.

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

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ExtendedOperationalStateTrait.

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

    Declaration

    Swift

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

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

  • Follow-up event for start and stop commands.

    Declaration

    Swift

    struct StartStopFollowUpEvent

  • Follow-up event for pause/unpause commands.

    Declaration

    Swift

    struct PauseUnpauseFollowUpEvent

  • Follow-up event for generic command errors.

    Declaration

    Swift

    struct StartStopErrorFollowUpEvent

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

    Declaration

    Swift

    var supportsStartWithOperationZonesCommand: Bool { get }

  • Start the device in one or more operation zones.

    Declaration

    Swift

    func startWithOperationZones(operationZones: [String]) async throws

    Parameters

    operationZones

    Indicates one or more zones in which to start running.

  • The batchable version of startWithOperationZones command above.

    See also

    startWithOperationZones

    Declaration

    Swift

    func startWithOperationZonesBatchable(operationZones: [String]) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsStartWithDurationCommand: Bool { get }

  • Start the device in one or more operation zones for the specified duration.

    Declaration

    Swift

    func startWithDuration(operationZones: [String], durationSeconds: UInt32) async throws

    Parameters

    operationZones

    Indicates one or more zones in which to start running.
    durationSeconds

    Indicates how long the action should run, in seconds. Must be between minimum and maximum operation duration supported by the device.

  • The batchable version of startWithDuration command above.

    See also

    startWithDuration

    Declaration

    Swift

    func startWithDurationBatchable(operationZones: [String], durationSeconds: UInt32) throws -> BatchableCommand<Void>

  • Status of the initial command and follow up response.

    Declaration

    Swift

    enum StatusEnum

  • ExtendedOperationalState cluster FeatureMap.

    Declaration

    Swift

    struct OperationalStateFeature