Table of Contents

Class Heater

Namespace
DuetAPI.ObjectModel
Assembly
DuetAPI.dll

Information about a heater

public class Heater : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged
Inheritance
Heater
Implements
Inherited Members

Constructors

Heater() 

public Heater()

Properties

Active

Active temperature of the heater (in C)

[Live]
public float Active { get; set; }

Property Value

float

AvgPwm

Average heater PWM value (0..1)

[Live]
public float AvgPwm { get; set; }

Property Value

float

Current

Current temperature of the heater (in C)

[Live]
public float Current { get; set; }

Property Value

float

ExtrPwmBoost

Current feedforward PWM boost applied to the heater

public float? ExtrPwmBoost { get; set; }

Property Value

float?

ExtrTempBoost

Current temperature boost applied to the heater

public float? ExtrTempBoost { get; set; }

Property Value

float?

Max

Maximum temperature allowed for this heater (in C)

public float Max { get; set; }

Property Value

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

public int MaxBadReadings { get; set; }

Property Value

int

MaxHeatingFaultTime

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

public float MaxHeatingFaultTime { get; set; }

Property Value

float

MaxTempExcursion

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

public float MaxTempExcursion { get; set; }

Property Value

float

Min

Minimum temperature allowed for this heater (in C)

public float Min { get; set; }

Property Value

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

public HeaterModel Model { get; }

Property Value

HeaterModel

Monitors

Monitors of this heater

public StaticModelCollection<HeaterMonitor> Monitors { get; }

Property Value

StaticModelCollection<HeaterMonitor>

Sensor

Sensor number of this heater or -1 if not configured

public int Sensor { get; set; }

Property Value

int

Standby

Standby temperature of the heater (in C)

[Live]
public float Standby { get; set; }

Property Value

float

State

State of the heater

[Live]
public HeaterState State { get; set; }

Property Value

HeaterState

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data