Class Board

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about a connected board

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

Inheritance

object

ModelObject

Board

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

Board()

public Board()

Properties

Accelerometer

Accelerometer of this board or null if unknown

public Accelerometer? Accelerometer { get; set; }

Property Value

Accelerometer

BootloaderFileName

Filename of the bootloader binary or null if unknown

public string? BootloaderFileName { get; set; }

Property Value

string

CanAddress

CAN address of this board or null if not applicable

public int? CanAddress { get; set; }

Property Value

int?

ClosedLoop

Closed loop data of this board or null if unknown

public BoardClosedLoop? ClosedLoop { get; set; }

Property Value

BoardClosedLoop

DirectDisplay

Details about a connected display or null if none is connected

public DirectDisplay? DirectDisplay { get; set; }

Property Value

DirectDisplay

Drivers

Drivers of this board

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

Property Value

StaticModelCollection<Driver>

FirmwareDate

Date of the firmware build

public string FirmwareDate { get; set; }

Property Value

string

FirmwareFileName

Filename of the firmware binary or null if unknown

public string? FirmwareFileName { get; set; }

Property Value

string

FirmwareName

Name of the firmware build

public string FirmwareName { get; set; }

Property Value

string

FirmwareVersion

Version of the firmware build

public string FirmwareVersion { get; set; }

Property Value

string

FreeRam

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

public int? FreeRam { get; set; }

Property Value

int?

IapFileNameSBC

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

public string? IapFileNameSBC { get; set; }

Property Value

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

public string? IapFileNameSD { get; set; }

Property Value

string

Remarks

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

InductiveSensor

Information about an inductive sensor or null if not present

public InductiveSensor? InductiveSensor { get; set; }

Property Value

InductiveSensor

MaxHeaters

Maximum number of heaters this board can control

public int MaxHeaters { get; set; }

Property Value

int

MaxMotors

Maximum number of motors this board can drive

public int MaxMotors { get; set; }

Property Value

int

McuTemp

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

public MinMaxCurrent? McuTemp { get; set; }

Property Value

MinMaxCurrent

Name

Full name of the board

public string Name { get; set; }

Property Value

string

ShortName

Short name of this board

public string ShortName { get; set; }

Property Value

string

State

State of this board

public BoardState State { get; set; }

Property Value

BoardState

SupportsDirectDisplay

Indicates if this board supports external displays

public bool SupportsDirectDisplay { get; set; }

Property Value

bool

UniqueId

Unique identifier of the board or null if unknown

public string? UniqueId { get; set; }

Property Value

string

V12

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

public MinMaxCurrent? V12 { get; set; }

Property Value

MinMaxCurrent

VIn

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

public MinMaxCurrent? VIn { get; set; }

Property Value

MinMaxCurrent

WifiFirmwareFileName

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

public string? WifiFirmwareFileName { 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