Skip to main content

Class SerialPortName

Represents the name of a serial port, which consists of both a "friendly" and a system name

Assembly: Meadow.Contracts.dll​
View Source​
Declaration
public class SerialPortName

Properties​

SerialController​

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

View Source​
Declaration
public ISerialController? SerialController { get; }

SerialMessageController​

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

View Source​
Declaration
public ISerialMessageController? SerialMessageController { get; }

FriendlyName​

The common name used for the port in documentation

View Source​
Declaration
public string FriendlyName { get; set; }

SystemName​

The assigned driver name for the port

View Source​
Declaration
public string SystemName { get; set; }

Methods​

Create(string, object)​

Creates a SerialPortName with the given SystemName

View Source​
Declaration
public static SerialPortName Create(string systemName, object controller)
Returns​

Meadow.Hardware.SerialPortName

Parameters​
TypeNameDescription
System.StringsystemNameThe port's system name
System.ObjectcontrollerThe port's hardware controller

Extension Methods​

  • Meadow.Hardware.SerialPortName.Meadow.SerialPortNameExtensions.CreateSerialMessagePort(System.Byte[],System.Boolean,System.Int32,System.Int32,Meadow.Hardware.Parity,Meadow.Hardware.StopBits,System.Int32)
  • Meadow.Hardware.SerialPortName.Meadow.SerialPortNameExtensions.CreateSerialMessagePort(System.Byte[],System.Boolean,System.Int32,System.Int32,System.Int32,Meadow.Hardware.Parity,Meadow.Hardware.StopBits,System.Int32)
  • Meadow.Hardware.SerialPortName.Meadow.SerialPortNameExtensions.CreateSerialPort(System.Int32,System.Int32,Meadow.Hardware.Parity,Meadow.Hardware.StopBits,System.Int32)