Console

BooleanStateConfigurationTrait 

struct BooleanStateConfigurationTrait

This trait provides an interface for configuring a boolean sensor, including optional state change alarm features and configuration of the sensor’s sensitivity level.

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

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • The modes supported by the alarm.

    Declaration

    Swift

    struct AlarmModeBitmap

  • Generated after any bits in the alarmsActive or alarmsSuppressed attributes change.

    Declaration

    Swift

    struct AlarmsStateChangedEvent

  • Attributes for the BooleanStateConfigurationTrait.

    Declaration

    Swift

    struct Attributes

  • BooleanStateConfiguration Trait FeatureMap.

    Declaration

    Swift

    struct Feature

  • Type of sensor fault.

    Declaration

    Swift

    struct SensorFaultBitmap

  • The device registered or cleared a fault.

    Declaration

    Swift

    struct SensorFaultEvent

  • List of attributes for the BooleanStateConfigurationTrait.

    Declaration

    Swift

    let attributes: Matter.BooleanStateConfigurationTrait.Attributes

  • Enable or disable one or more alarm modes.

    Declaration

    Swift

    func enableDisableAlarm(alarmsToEnableDisable: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap) async throws

    Parameters

    alarmsToEnableDisable

    The alarm modes to enable or disable.

  • The batchable version of enableDisableAlarm command above.

    See also

    enableDisableAlarm

    Declaration

    Swift

    func enableDisableAlarmBatchable(alarmsToEnableDisable: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap) throws -> BatchableCommand<Void>

  • 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

  • List of the commands that are supported by BooleanStateConfigurationTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

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

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

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

    Declaration

    Swift

    var supportsEnableDisableAlarmCommand: Bool { get }

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

    Declaration

    Swift

    var supportsSuppressAlarmCommand: Bool { get }

  • Suppress one or more alarm modes.

    Declaration

    Swift

    func suppressAlarm(alarmsToSuppress: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap) async throws

    Parameters

    alarmsToSuppress

    The alarm modes to suppress.

  • The batchable version of suppressAlarm command above.

    See also

    suppressAlarm

    Declaration

    Swift

    func suppressAlarmBatchable(alarmsToSuppress: Matter.BooleanStateConfigurationTrait.AlarmModeBitmap) throws -> BatchableCommand<Void>