Feature

struct Feature

BooleanStateConfiguration Trait FeatureMap.

  • The corresponding value of the raw type.

    A new instance initialized with rawValue will be equivalent to this instance. For example:

    enum PaperSize: String {
        case A4, A5, Letter, Legal
    }
    
    let selectedSize = PaperSize.Letter
    print(selectedSize.rawValue)
    // Prints "Letter"
    
    print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!)
    // Prints "true"
    

    Declaration

    Swift

    let rawValue: UInt32
  • Creates a new option set from the given raw value.

    This initializer always succeeds, even if the value passed as rawValue exceeds the static properties declared as part of the option set. This example creates an instance of ShippingOptions with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members.

    let extraOptions = ShippingOptions(rawValue: 255)
    print(extraOptions.isStrictSuperset(of: .all))
    // Prints "true"
    

    Declaration

    Swift

    init(rawValue: UInt32)

    Parameters

    rawValue

    The raw value of the option set to create. Each bit of rawValue potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the OptionSet type.

  • Supports visible alarms.

    Declaration

    Swift

    static let visual: Matter.BooleanStateConfigurationTrait.Feature
  • Supports audible alarms.

    Declaration

    Swift

    static let audible: Matter.BooleanStateConfigurationTrait.Feature
  • The device is able to suppress the supported alarm modes once the user acknowledges the alarm. This is intended for situations where the user is aware that the sensor is triggered, but doesn’t want the alarm to emit anymore, such as when:

    • The triggering cause is resolved by the user, but the sensor still detects the triggering cause.
    • The user can’t address the triggering cause, but is aware of the alarm and wants the alarm to stop emitting.

    Declaration

    Swift

    static let alarmSuppress: Matter.BooleanStateConfigurationTrait.Feature
  • Supports ability to set sensor sensitivity.

    Declaration

    Swift

    static let sensitivityLevel: Matter.BooleanStateConfigurationTrait.Feature