Attributes

struct Attributes

Attributes for the ValveConfigurationAndControlTrait.

  • A list of the attribute IDs of the attributes supported by the cluster instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var attributeList: [UInt32]? { get }
  • The total duration, in seconds, for which the valve will remain open for the current opening. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var openDuration: UInt32? { get }
  • The default duration, in seconds, for which the valve will remain open, if a value for the openDuration parameter is not present in the Open command. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var defaultOpenDuration: UInt32? { get }
  • The UTC time when the valve will close, depending on value of the openDuration attribute. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var autoCloseTime: UInt64? { get }
  • The remaining duration, in seconds, until the valve closes. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var remainingDuration: UInt32? { get }
  • The current state of the valve. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var currentState: Matter.ValveConfigurationAndControlTrait.ValveStateEnum? { get }
  • The target state, while changing the state, of the valve. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var targetState: Matter.ValveConfigurationAndControlTrait.ValveStateEnum? { get }
  • The current level of the valve as a percentage value, between fully closed and fully open. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var currentLevel: UInt8? { get }
  • The target level of the valve as a percentage value, between fully closed and fully open. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var targetLevel: UInt8? { get }
  • The default value used for the targetLevel attribute, when a valve transitions from the closed to the open state, caused by an Open command, if a value for the targetLevel parameter isn’t present in the Open command. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var defaultOpenLevel: UInt8? { get }
  • Any faults registered by the valve. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var valveFault: Matter.ValveConfigurationAndControlTrait.ValveFaultBitmap? { get }
  • The step size supported by the valve. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var levelStep: UInt8? { get }
  • A list of server-generated commands (server to client) which are supported by this cluster server instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var generatedCommandList: [UInt32]? { get }
  • A list of client-generated commands which are supported by this cluster server instance.

    Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var acceptedCommandList: [UInt32]? { get }
  • Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero). Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var featureMap: Matter.ValveConfigurationAndControlTrait.Feature? { get }
  • The revision of the server cluster specification supported by the cluster instance. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var clusterRevision: UInt16? { get }
  • The trait identifier.

    Declaration

    Swift

    static var identifier: String { get }
  • 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
  • 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.ValveConfigurationAndControlTrait.Attributes, rhs: Matter.ValveConfigurationAndControlTrait.Attributes) -> 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)