Class Board

Information about a connected board

Inheritance

object

ModelObject

Board

Implements

IModelObject

ICloneable

INotifyPropertyChanged

INotifyPropertyChanging

Inherited Members

ModelObject.PropertyChanging

ModelObject.PropertyChanged

ModelObject.JsonProperties

ModelObject.Assign(object)

ModelObject.Clone()

ModelObject.FindDifferences(IModelObject)

ModelObject.MakeUtf8Patch(ModelObject)

ModelObject.MakeStringPatch(ModelObject)

ModelObject.UpdateFromJson(JsonElement, bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetAPI.ObjectModel

Assembly: DuetAPI.dll

Syntax

public sealed class Board : ModelObject, IModelObject, ICloneable, INotifyPropertyChanged, INotifyPropertyChanging

Properties

Accelerometer

Accelerometer of this board or null if unknown

Declaration

public Accelerometer? Accelerometer { get; set; }

Property Value

Type	Description
Accelerometer

BootloaderFileName

Filename of the bootloader binary or null if unknown

Declaration

public string? BootloaderFileName { get; set; }

Property Value

Type	Description
string

CanAddress

CAN address of this board or null if not applicable

Declaration

public int? CanAddress { get; set; }

Property Value

Type	Description
int?

ClosedLoop

Closed loop data of this board or null if unknown

Declaration

public BoardClosedLoop? ClosedLoop { get; set; }

Property Value

Type	Description
BoardClosedLoop

DirectDisplay

Details about a connected display or null if none is connected

Declaration

public DirectDisplay? DirectDisplay { get; set; }

Property Value

Type	Description
DirectDisplay

Drivers

Drivers of this board

Declaration

public ModelCollection<Driver>? Drivers { get; set; }

Property Value

Type	Description
ModelCollection<Driver>

FirmwareDate

Date of the firmware build

Declaration

public string FirmwareDate { get; set; }

Property Value

Type	Description
string

FirmwareFileName

Filename of the firmware binary or null if unknown

Declaration

public string? FirmwareFileName { get; set; }

Property Value

Type	Description
string

FirmwareName

Name of the firmware build

Declaration

public string FirmwareName { get; set; }

Property Value

Type	Description
string

FirmwareVersion

Version of the firmware build

Declaration

public string FirmwareVersion { get; set; }

Property Value

Type	Description
string

FreeRam

Amount of free RAM on this board (in bytes or null if unknown)

Declaration

public int? FreeRam { get; set; }

Property Value

Type	Description
int?

IapFileNameSBC

Filename of the IAP binary that is used for updates from the SBC or null if unsupported

Declaration

public string? IapFileNameSBC { get; set; }

Property Value

Type	Description
string

Remarks

This is only available for the mainboard (first board item)

IapFileNameSD

Filename of the IAP binary that is used for updates from the SD card or null if unsupported

Declaration

public string? IapFileNameSD { get; set; }

Property Value

Type	Description
string

Remarks

This is only available for the mainboard (first board item)

InductiveSensor

Information about an inductive sensor or null if not present

Declaration

public InductiveSensor? InductiveSensor { get; set; }

Property Value

Type	Description
InductiveSensor

MaxHeaters

Maximum number of heaters this board can control

Declaration

public int MaxHeaters { get; set; }

Property Value

Type	Description
int

MaxMotors

Maximum number of motors this board can drive

Declaration

public int MaxMotors { get; set; }

Property Value

Type	Description
int

McuTemp

Minimum, maximum, and current temperatures of the MCU or null if unknown

Declaration

public MinMaxCurrent<float>? McuTemp { get; set; }

Property Value

Type	Description
MinMaxCurrent<float>

Name

Full name of the board

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

ShortName

Short name of this board

Declaration

public string ShortName { get; set; }

Property Value

Type	Description
string

State

State of this board

Declaration

public BoardState State { get; set; }

Property Value

Type	Description
BoardState

Supports12864

Indicates if this board supports external 12864 displays

Declaration

[Obsolete("Replaced with SupportsDirectDisplay")]
public bool Supports12864 { get; set; }

Property Value

Type	Description
bool

SupportsDirectDisplay

Indicates if this board supports external displays

Declaration

public bool SupportsDirectDisplay { get; set; }

Property Value

Type	Description
bool

UniqueId

Unique identifier of the board or null if unknown

Declaration

public string? UniqueId { get; set; }

Property Value

Type	Description
string

V12

Minimum, maximum, and current voltages on the 12V rail or null if unknown

Declaration

public MinMaxCurrent<float>? V12 { get; set; }

Property Value

Type	Description
MinMaxCurrent<float>

VIn

Minimum, maximum, and current voltages on the input rail or null if unknown

Declaration

public MinMaxCurrent<float>? VIn { get; set; }

Property Value

Type	Description
MinMaxCurrent<float>

WifiFirmwareFileName

Filename of the on-board WiFi chip or null if not present

Declaration

public string? WifiFirmwareFileName { get; set; }

Property Value

Type	Description
string

Implements

IModelObject

ICloneable

INotifyPropertyChanged

INotifyPropertyChanging