Table of Contents

Class InputChannel

Namespace
DuetAPI.ObjectModel
Assembly
DuetAPI.dll

Information about a G/M/T-code channel

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

Constructors

InputChannel() 

public InputChannel()

Properties

Active

True if the input is is in active mode i.e. executing commands for its assigned motion system, false if it is assigned to a motion system other than the current one

public bool Active { get; set; }

Property Value

bool

Remarks

This will always be true except for the File and File2 inputs

AxesRelative

Whether relative positioning is being used

public bool AxesRelative { get; set; }

Property Value

bool

Compatibility

Emulation used on this channel

public Compatibility Compatibility { get; set; }

Property Value

Compatibility

DistanceUnit

Whether inches are being used instead of mm

public DistanceUnit DistanceUnit { get; set; }

Property Value

DistanceUnit

DrivesRelative

Whether relative extrusion is being used

public bool DrivesRelative { get; set; }

Property Value

bool

FeedRate

Current feedrate as passed by the last G0/G1 F... command

public float FeedRate { get; set; }

Property Value

float

InMacro

Whether a macro file is being processed

public bool InMacro { get; set; }

Property Value

bool

InverseTimeMode

Indicates if inverse time mode (G73) is active

public bool InverseTimeMode { get; set; }

Property Value

bool

LineNumber

Number of the current line

public long LineNumber { get; set; }

Property Value

long

MacroRestartable

Indicates if the current macro file can be restarted after a pause

public bool MacroRestartable { get; set; }

Property Value

bool

MotionSystem

Active motion system index

public int MotionSystem { get; set; }

Property Value

int

Name

Name of this channel

public CodeChannel Name { get; set; }

Property Value

CodeChannel

SelectedPlane

Index of the selected plane

public int SelectedPlane { get; set; }

Property Value

int

StackDepth

Depth of the stack

public byte StackDepth { get; set; }

Property Value

byte

State

State of this input channel

public InputChannelState State { get; set; }

Property Value

InputChannelState

Volumetric

Whether volumetric extrusion is being used

public bool Volumetric { get; set; }

Property Value

bool

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