Characteristic Locus
Inheritance object > SerialPortName
Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString()
Namespace Meadow.Hardware
Assembly Meadow.Contracts.dll

Syntax

public class SerialPortName

Constructors

SerialPortName(string, string, object)

Creates a SerialPortName with the given FriendlyName and SystemName

Declaration
public SerialPortName(string friendlyName, string systemName, object controller)

Parameters

Type Name Description
string friendlyName

The port's user-friendly name

string systemName

The port's system name

object controller

The port's hardware controller

Properties

FriendlyName

The common name used for the port in documentation

Declaration
public string FriendlyName { get; set; }

Property Value

Type Description
string

SerialController

Gets or sets the serial controller associated with this serial port name.

Declaration
public ISerialController? SerialController { get; }

Property Value

Type Description
ISerialController

SerialMessageController

Gets or sets the serial message controller associated with this serial port name.

Declaration
public ISerialMessageController? SerialMessageController { get; }

Property Value

Type Description
ISerialMessageController

SystemName

The assigned driver name for the port

Declaration
public string SystemName { get; set; }

Property Value

Type Description
string

Methods

Create(string, object)

Creates a SerialPortName with the given SystemName

Declaration
public static SerialPortName Create(string systemName, object controller)

Parameters

Type Name Description
string systemName

The port's system name

object controller

The port's hardware controller

Returns

Type Description
SerialPortName

Extension Methods