Class MachineModel

Representation of the full machine model as maintained by DCS

Inheritance

System.Object

ModelObject

MachineModel

Implements

System.ICloneable

System.ComponentModel.INotifyPropertyChanging

System.ComponentModel.INotifyPropertyChanged

Inherited Members

ModelObject.JsonProperties

ModelObject.PropertyChanging

ModelObject.PropertyChanged

ModelObject.SetPropertyValue<T>(T, T, String)

ModelObject.Assign(ModelObject)

ModelObject.Clone()

ModelObject.UpdateFromJson(JsonElement)

ModelObject.MakeUtf8Patch(ModelObject)

ModelObject.MakeStringPatch(ModelObject)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: DuetAPI.Machine

Assembly: DuetAPI.dll

Syntax

public sealed class MachineModel : ModelObject, ICloneable, INotifyPropertyChanging, INotifyPropertyChanged

Properties

Boards

List of connected boards

Declaration

public ModelCollection<Board> Boards { get; }

Property Value

Type	Description
ModelCollection<Board>

Remarks

The first item represents the main board

See Also

Board

Directories

Information about the individual directories

Declaration

public Directories Directories { get; }

Property Value

Type	Description
Directories

Remarks

This may not be available in RepRapFirmware if no mass storages are available

Fans

List of configured fans

Declaration

public ModelCollection<Fan> Fans { get; }

Property Value

Type	Description
ModelCollection<Fan>

See Also

Fan

Heat

Information about the heat subsystem

Declaration

public Heat Heat { get; }

Property Value

Type	Description
Heat

HttpEndpoints

List of registered third-party HTTP endpoints

Declaration

public ModelCollection<HttpEndpoint> HttpEndpoints { get; }

Property Value

Type	Description
ModelCollection<HttpEndpoint>

Inputs

Information about every available G/M/T-code channel

Declaration

public Inputs Inputs { get; }

Property Value

Type	Description
Inputs

Job

Information about the current job

Declaration

public Job Job { get; }

Property Value

Type	Description
Job

Limits

Machine configuration limits

Declaration

public Limits Limits { get; }

Property Value

Type	Description
Limits

Messages

Generic messages that do not belong explicitly to codes being executed. This includes status messages, generic errors and outputs generated by M118

Declaration

public ModelGrowingCollection<Message> Messages { get; }

Property Value

Type	Description
ModelGrowingCollection<Message>

See Also

Message

Move

Information about the move subsystem

Declaration

public Move Move { get; }

Property Value

Type	Description
Move

Network

Information about connected network adapters

Declaration

public Network Network { get; }

Property Value

Type	Description
Network

Scanner

Information about the 3D scanner subsystem

Declaration

public Scanner Scanner { get; }

Property Value

Type	Description
Scanner

Sensors

Information about connected sensors including Z-probes and endstops

Declaration

public Sensors Sensors { get; }

Property Value

Type	Description
Sensors

Spindles

List of configured CNC spindles

Declaration

public ModelCollection<Spindle> Spindles { get; }

Property Value

Type	Description
ModelCollection<Spindle>

See Also

Spindle

State

Information about the machine state

Declaration

public State State { get; }

Property Value

Type	Description
State

Tools

List of configured tools

Declaration

public ModelCollection<Tool> Tools { get; }

Property Value

Type	Description
ModelCollection<Tool>

See Also

Tool

UserSessions

List of user sessions

Declaration

public ModelCollection<UserSession> UserSessions { get; }

Property Value

Type	Description
ModelCollection<UserSession>

UserVariables

List of user-defined variables

Declaration

public ModelCollection<UserVariable> UserVariables { get; }

Property Value

Type	Description
ModelCollection<UserVariable>

See Also

UserVariable

Volumes

List of available mass storages

Declaration

public ModelCollection<Volume> Volumes { get; }

Property Value

Type	Description
ModelCollection<Volume>

See Also

Volume

Methods

ToString()

Convert this instance to a JSON text

Declaration

public override string ToString()

Returns

Type	Description
System.String	JSON object

Overrides

System.Object.ToString()

ToUtf8Json()

Serialize this instance to a UTF-8 string

Declaration

public byte[] ToUtf8Json()

Returns

Type	Description
System.Byte[]

UpdateFromFirmwareModel(String, JsonElement)

Update a specific key of this instance from a given JSON element as provided by the firmware

Declaration

public bool UpdateFromFirmwareModel(string key, JsonElement jsonElement)

Parameters

Type	Name	Description
System.String	key	Property name to update
System.Text.Json.JsonElement	jsonElement	Element to update this intance from

Returns

Type	Description
System.Boolean	Whether the key could be updated

Implements

System.ICloneable

System.ComponentModel.INotifyPropertyChanging

System.ComponentModel.INotifyPropertyChanged