Class Fan

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Class representing information about an attached fan

public class Fan : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

Fan

Implements

INotifyPropertyChanging

IStaticModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Inherited Members

ModelObject.SetPropertyValue<T>(ref T, T, string)

ModelObject.PropertyChanging

ModelObject.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Fan()

public Fan()

Properties

ActualValue

Value of this fan (0..1 or -1 if unknown)

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

Property Value

float

Blip

Blip value indicating how long the fan is supposed to run at 100% when turning it on to get it started (in s)

public float Blip { get; set; }

Property Value

float

Frequency

Configured frequency of this fan (in Hz)

public float Frequency { get; set; }

Property Value

float

Max

Maximum value of this fan (0..1)

public float Max { get; set; }

Property Value

float

Min

Minimum value of this fan (0..1)

public float Min { get; set; }

Property Value

float

Name

Name of the fan

public string Name { get; set; }

Property Value

string

RequestedValue

Requested value for this fan on a scale between 0 to 1

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

Property Value

float

Rpm

Current RPM of this fan or -1 if unknown/unset

[Live]
public int Rpm { get; set; }

Property Value

int

TachoPpr

Pulses per tacho revolution

public float TachoPpr { get; set; }

Property Value

float

Thermostatic

Thermostatic control parameters

public FanThermostaticControl Thermostatic { get; }

Property Value

FanThermostaticControl

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