Class DSF

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about Duet Software Framework

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

Inheritance

object

ModelObject

DSF

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

DSF()

public DSF()

Properties

BuildDateTime

Datetime when DSF was built

public string BuildDateTime { get; set; }

Property Value

string

CommunicationMethod

Communication method used to talk to the firmware

public CommunicationMethod CommunicationMethod { get; set; }

Property Value

CommunicationMethod

HttpEndpoints

List of registered third-party HTTP endpoints

public StaticModelCollection<HttpEndpoint> HttpEndpoints { get; }

Property Value

StaticModelCollection<HttpEndpoint>

Is64Bit

Indicates if the process is 64-bit

public bool Is64Bit { get; set; }

Property Value

bool

PluginSupport

Indicates if DSF allows the installation and usage of third-party plugins

public bool PluginSupport { get; set; }

Property Value

bool

RootPluginSupport

Indicates if DSF allows the installation and usage of third-party root plugins (potentially dangerous, disabled by default)

public bool RootPluginSupport { get; set; }

Property Value

bool

Remarks

Requires PluginSupport to be true

UserSessions

List of user sessions

public StaticModelCollection<UserSession> UserSessions { get; }

Property Value

StaticModelCollection<UserSession>

Version

Version of Duet Software Framework (provided by Duet Control Server)

public string Version { get; set; }

Property Value

string

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