OptionsBitmap

struct OptionsBitmap

Flags for LevelControl options.

  • 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: UInt8
  • 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: UInt8)

    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.

  • Indicates a dependency on the OnOff cluster. A LevelControl command does not continue past options processing if all of the following are true:

    • The command is Move, MoveToLevel, Step, or Stop.
    • The OnOff cluster exists on the same endpoint as this cluster.
    • The onOff attribute of the OnOff cluster on this endpoint is false.
    • The value of this bit (`executeIfOff`) is `0`.

    Declaration

    Swift

    static let executeIfOff: Matter.LevelControlTrait.OptionsBitmap
  • Couple changes to the LevelControlTrait/Attributes/currentlevel attribute with the color temperature set in the ColorControl/Attributes/colorTemperatureMireds attribute of the LevelControl cluster. This bit is ignored if the lighting feature is not supported.

    Declaration

    Swift

    static let coupleColorTempToLevel: Matter.LevelControlTrait.OptionsBitmap