Console

DishwasherAlarmTrait 

struct DishwasherAlarmTrait

This trait provides an interface for dishwasher alarms.

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

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Bitmap indicating which alarms are supported.

    Declaration

    Swift

    struct AlarmBitmap

  • Attributes for the DishwasherAlarmTrait.

    Declaration

    Swift

    struct Attributes

  • DishwasherAlarm cluster FeatureMap.

    Declaration

    Swift

    struct Feature

  • Generated when one or more alarms change state.

    Declaration

    Swift

    struct NotifyEvent

  • List of attributes for the DishwasherAlarmTrait.

    Declaration

    Swift

    let attributes: Matter.DishwasherAlarmTrait.Attributes

  • 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

  • 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 let identifier: String

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

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • The details of a request to modify an enabled alarm.

    Declaration

    Swift

    func modifyEnabledAlarms(mask: Matter.DishwasherAlarmTrait.AlarmBitmap) async throws

    Parameters

    mask

    A bitmap indicating an alarm that should be enabled or suppressed. Valid values are defined in AlarmBitmap.

  • The batchable version of modifyEnabledAlarms command above.

    See also

    modifyEnabledAlarms

    Declaration

    Swift

    func modifyEnabledAlarmsBatchable(mask: Matter.DishwasherAlarmTrait.AlarmBitmap) throws -> BatchableCommand<Void>

  • The details of a request to reset active and, if possible, latched alarms.

    Declaration

    Swift

    func reset(alarms: Matter.DishwasherAlarmTrait.AlarmBitmap) async throws

    Parameters

    alarms

    A bitmap indicating an alarm that will be reset unless manual intervention is required. Valid values are defined in AlarmBitmap.

  • The batchable version of reset command above.

    See also

    reset

    Declaration

    Swift

    func resetBatchable(alarms: Matter.DishwasherAlarmTrait.AlarmBitmap) throws -> BatchableCommand<Void>

  • List of the commands that are supported by DishwasherAlarmTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

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

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

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

    Declaration

    Swift

    var supportsModifyEnabledAlarmsCommand: Bool { get }

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

    Declaration

    Swift

    var supportsResetCommand: Bool { get }