Class Heater

Information about a heater

Inheritance

object

ModelObject

Heater

Implements

IModelObject

ICloneable

INotifyPropertyChanged

INotifyPropertyChanging

Inherited Members

ModelObject.PropertyChanging

ModelObject.PropertyChanged

ModelObject.JsonProperties

ModelObject.Assign(object)

ModelObject.Clone()

ModelObject.FindDifferences(IModelObject)

ModelObject.MakeUtf8Patch(ModelObject)

ModelObject.MakeStringPatch(ModelObject)

ModelObject.UpdateFromJson(JsonElement, bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetAPI.ObjectModel

Assembly: DuetAPI.dll

Syntax

public sealed class Heater : ModelObject, IModelObject, ICloneable, INotifyPropertyChanged, INotifyPropertyChanging

Properties

Active

Active temperature of the heater (in C)

Declaration

public float Active { get; set; }

Property Value

Type	Description
float

AvgPwm

Average heater PWM value (0..1)

Declaration

public float AvgPwm { get; set; }

Property Value

Type	Description
float

Current

Current temperature of the heater (in C)

Declaration

public float Current { get; set; }

Property Value

Type	Description
float

Max

Maximum temperature allowed for this heater (in C)

Declaration

public float Max { get; set; }

Property Value

Type	Description
float

Remarks

This is only temporary and should be replaced by a representation of the heater protection as in RRF

MaxBadReadings

Maximum number of consecutive temperature reading failures before a heater fault is raised

Declaration

public int MaxBadReadings { get; set; }

Property Value

Type	Description
int

MaxHeatingFaultTime

Time for which a temperature anomaly must persist on this heater before raising a heater fault (in s)

Declaration

public float MaxHeatingFaultTime { get; set; }

Property Value

Type	Description
float

MaxTempExcursion

Permitted temperature excursion from the setpoint for this heater (in K)

Declaration

public float MaxTempExcursion { get; set; }

Property Value

Type	Description
float

Min

Minimum temperature allowed for this heater (in C)

Declaration

public float Min { get; set; }

Property Value

Type	Description
float

Remarks

This is only temporary and should be replaced by a representation of the heater protection as in RRF

Model

Information about the heater model

Declaration

public HeaterModel Model { get; }

Property Value

Type	Description
HeaterModel

Monitors

Monitors of this heater

Declaration

public ModelCollection<HeaterMonitor> Monitors { get; }

Property Value

Type	Description
ModelCollection<HeaterMonitor>

Sensor

Sensor number of this heater or -1 if not configured

Declaration

public int Sensor { get; set; }

Property Value

Type	Description
int

Standby

Standby temperature of the heater (in C)

Declaration

public float Standby { get; set; }

Property Value

Type	Description
float

State

State of the heater

Declaration

public HeaterState State { get; set; }

Property Value

Type	Description
HeaterState

Implements

IModelObject

ICloneable

INotifyPropertyChanged

INotifyPropertyChanging