Attributes

struct Attributes

Attributes for the PumpConfigurationAndControlTrait.

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

    Declaration

    Swift

    @TraitAttribute
    var attributeList: [UInt32]? { get }
  • The maximum pressure the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxPressure: Int16? { get }
  • The maximum speed the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode. The valid range is 0 to 65,534 RPM, in steps of 1 RPM. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxSpeed: UInt16? { get }
  • The maximum flow the pump can achieve. It is a physical limit, and does not apply to any specific control mode or operation mode. The valid range is 0 m3/h to 6,553.4 m3/h, in steps of 0.1 m3/h. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxFlow: UInt16? { get }
  • The minimum pressure the pump can achieve when it is working with the controlMode attribute set to ConstantPressure. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var minConstPressure: Int16? { get }
  • The maximum pressure the pump can achieve when it is working with the controlMode attribute set to ConstantPressure. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxConstPressure: Int16? { get }
  • The minimum compensated pressure the pump can achieve when it is working with the controlMode attribute set to ProportionalPressure. The valid range is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var minCompPressure: Int16? { get }
  • The maximum compensated pressure the pump can achieve when it is working with the controlMode attribute set to ProportionalPressure. The valid range for this attribute is -3,276.7 kPa to 3,276.7 kPa, in steps of 0.1 kPa. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxCompPressure: Int16? { get }
  • The minimum speed the pump can achieve when it is working with the controlMode attribute set to ConstantSpeed. The valid range is 0 to 65,534 RPM, in steps of 1 RPM. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var minConstSpeed: UInt16? { get }
  • The maximum speed the pump can achieve when it is working with the controlMode attribute set to ConstantSpeed. The valid range is 0 to 65,534 RPM, in steps of 1 RPM. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxConstSpeed: UInt16? { get }
  • The minimum flow the pump can achieve when it is working with the controlMode attribute set to ConstantFlow. The valid range is 0 m3/h to 6,553.4 m3/h, in steps of 0.1 m3/h. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var minConstFlow: UInt16? { get }
  • The maximum flow the pump can achieve when it is working with the controlMode attribute set to ConstantFlow. The valid range is 0 m3/h to 6,553.4 m3/h, insteps of 0.1 m3/h. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxConstFlow: UInt16? { get }
  • The minimum temperature the pump can maintain in the system when it is working with the controlMode attribute set to ConstantTemperature. The valid range is -273.15 °C to 327.67 °C, in steps of 0.01 °C. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var minConstTemp: Int16? { get }
  • The maximum temperature the pump can maintain in the system when it is working with the controlMode attribute set to ConstantTemperature. The valid range is -273.15 °C to 327.67 °C, in steps of 0.01 °C. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var maxConstTemp: Int16? { get }
  • The activity status of the pump functions as listed in PumpStatusBitmap. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var pumpStatus: Matter.PumpConfigurationAndControlTrait.PumpStatusBitmap? { get }
  • The current effective operation mode of the pump as defined in OperationModeEnum. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var effectiveOperationMode: Matter.PumpConfigurationAndControlTrait.OperationModeEnum? { get }
  • The current effective control mode of the pump as defined in ControlModeEnum. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var effectiveControlMode: Matter.PumpConfigurationAndControlTrait.ControlModeEnum? { get }
  • The actual capacity of the pump as a percentage of the effective maximum setpoint value. It is updated dynamically as the speed of the pump changes. The valid range is 0 % to 163.835%, with 0.005 % granularity. Although this attribute is a signed value, values less than zero have no physical meaning. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var capacity: Int16? { get }
  • The actual speed of the pump measured in RPM. It is updated dynamically as the speed of the pump changes. The valid range is 0 to 65.534 RPM. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var speed: UInt16? { get }
  • Specifies the accumulated number of hours that the pump has been powered and the motor has been running. It is updated dynamically as it increases. It is preserved over power cycles of the pump. If lifeTimeRunningHours rises above maximum value, it rolls over and starts again at 0. This attribute is writeable, in order to allow setting to an appropriate value after maintenance. The valid range is 0 to 16,777,214 hrs. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var lifetimeRunningHours: UInt32? { get }
  • The actual power consumption of the pump in watts. The value of this attribute is updated dynamically as the power consumption of the pump changes. The valid range is 0 to 16,777,214 watts. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var power: UInt32? { get }
  • The accumulated energy consumption through the entire lifetime of the pump in kWh. The value of this attribute is updated dynamically as the energy consumption of the pump increases. If it rises above the maximum value, it rolls over and starts again at 0. This attribute is writeable, in order to allow setting to an appropriate value after maintenance. The valid range is 0 kWh to 4,294,967,294 kWh. Nullable: true.

    Declaration

    Swift

    @TraitAttribute
    var lifetimeEnergyConsumed: UInt32? { get }
  • The operation mode of the pump as defined in OperationModeEnum. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var operationMode: Matter.PumpConfigurationAndControlTrait.OperationModeEnum? { get }
  • The control mode of the pump as defined in ControlModeEnum. Nullable: false.

    Declaration

    Swift

    @TraitAttribute
    var controlMode: Matter.PumpConfigurationAndControlTrait.ControlModeEnum? { 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.PumpConfigurationAndControlTrait.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.PumpConfigurationAndControlTrait.Attributes, rhs: Matter.PumpConfigurationAndControlTrait.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)