Class NetworkInterface

Information about a network interface

Inheritance

object

ModelObject

NetworkInterface

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 NetworkInterface : ModelObject, IModelObject, ICloneable, INotifyPropertyChanged, INotifyPropertyChanging

Properties

ActiveProtocols

List of active protocols

Declaration

[SbcProperty(false)]
public ModelCollection<NetworkProtocol> ActiveProtocols { get; }

Property Value

Type	Description
ModelCollection<NetworkProtocol>

ActualIP

Actual IPv4 address of the network adapter or null if unknown

Declaration

public string? ActualIP { get; set; }

Property Value

Type	Description
string

ConfiguredIP

Configured IPv4 address of the network adapter or null if unknown

Declaration

[SbcProperty(false)]
public string? ConfiguredIP { get; set; }

Property Value

Type	Description
string

DnsServer

Configured IPv4 DNS server of the network adapter or null if unknown

Declaration

[SbcProperty(false)]
public string? DnsServer { get; set; }

Property Value

Type	Description
string

FirmwareVersion

Version of the network interface or null if unknown. This is only reported by ESP-based boards in standalone mode

Declaration

public string? FirmwareVersion { get; set; }

Property Value

Type	Description
string

Gateway

IPv4 gateway of the network adapter or null if unknown

Declaration

public string? Gateway { get; set; }

Property Value

Type	Description
string

Mac

Physical address of the network adapter or null if unknown

Declaration

public string? Mac { get; set; }

Property Value

Type	Description
string

NumReconnects

Number of reconnect attempts or null if unknown. This is only reported by ESP-based boards in standalone mode

Declaration

public int? NumReconnects { get; set; }

Property Value

Type	Description
int?

SSID

SSID of the WiFi network or null if not applicable

Declaration

[SbcProperty(true)]
public string? SSID { get; set; }

Property Value

Type	Description
string

Signal

Signal of the WiFi adapter (only WiFi, in dBm, or null if unknown)

Declaration

[SbcProperty(false)]
public int? Signal { get; set; }

Property Value

Type	Description
int?

Speed

Speed of the network interface (in MBit, null if unknown, 0 if not connected)

Declaration

[SbcProperty(false)]
public int? Speed { get; set; }

Property Value

Type	Description
int?

State

State of this network interface or null if unknown

Declaration

public NetworkState? State { get; set; }

Property Value

Type	Description
NetworkState?

Subnet

Subnet of the network adapter or null if unknown

Declaration

public string? Subnet { get; set; }

Property Value

Type	Description
string

Type

Type of this network interface

Declaration

public NetworkInterfaceType Type { get; set; }

Property Value

Type	Description
NetworkInterfaceType

WifiCountry

WiFi country code if this is a WiFi adapter and if the country code can be determined

Declaration

[SbcProperty(false)]
public string? WifiCountry { get; set; }

Property Value

Type	Description
string

Remarks

For this setting to be populated in SBC mode it is required to have the DuetPiManagementPlugin running. This is required due to missing Linux permissions of the control server.

Implements

IModelObject

ICloneable

INotifyPropertyChanged

INotifyPropertyChanging