C# SerialPort 类

最新推荐文章于 2024-08-01 07:45:00 发布

keith_cheung

最新推荐文章于 2024-08-01 07:45:00 发布

阅读量1.7k

点赞数

C# 同时被 3 个专栏收录

9 篇文章 0 订阅

订阅专栏

COM

2 篇文章 0 订阅

订阅专栏

Port

1 篇文章 0 订阅

订阅专栏

SerialPort 类

表示串行端口资源

继承层次结构

--------------------------------------------------------------------------------

System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.IO.Ports.SerialPort

命名空间： System.IO.Ports
程序集： System（在 System.dll 中）

语法

--------------------------------------------------------------------------------

public class SerialPort : Component

SerialPort 类型公开以下成员。

构造函数

--------------------------------------------------------------------------------
名称

说明

SerialPort()

初始化 SerialPort 类的新实例。

SerialPort(IContainer)

使用指定的 IContainer 对象初始化 SerialPort 类的新实例。

SerialPort(String)

使用指定的端口名称初始化 SerialPort 类的新实例。

SerialPort(String, Int32)

使用指定的端口名称和波特率初始化 SerialPort 类的新实例。

SerialPort(String, Int32, Parity)

使用指定的端口名称、波特率和奇偶校验位初始化 SerialPort 类的新实例。

SerialPort(String, Int32, Parity, Int32)

使用指定的端口名称、波特率、校验位和数据位初始化 SerialPort 类的新实例。

SerialPort(String, Int32, Parity, Int32, StopBits)

使用指定的端口名称、波特率、奇偶校验位、数据位和停止位初始化 SerialPort 类的新实例。

属性

--------------------------------------------------------------------------------

名称说明

BaseStream

获取 SerialPort 对象的基础 Stream 对象。

BaudRate

获取或设置串行波特率。

BreakState

获取或设置中断信号状态。

BytesToRead

获取接收缓冲区中数据的字节数。

BytesToWrite

获取发送缓冲区中数据的字节数。

CanRaiseEvents

获取一个指示组件是否可以引发事件的值。
（继承自 Component。）

CDHolding

获取端口的载波检测行的状态。

Container

获取 IContainer，它包含 Component。
（继承自 Component。）

CtsHolding

获取“可以发送”行的状态。

DataBits

获取或设置每个字节的标准数据位长度。

DesignMode

获取一个值，用以指示 Component 当前是否处于设计模式。（继承自 Component。）

DiscardNull

获取或设置一个值，该值指示 Null 字节在端口和接收缓冲区之间传输时是否被忽略。

DsrHolding

获取数据设置就绪 (DSR) 信号的状态。

DtrEnable

获取或设置一个值，该值在串行通信过程中启用数据终端就绪 (DTR) 信号。

Encoding

取或设置传输前后文本转换的字节编码。

Events

获取附加到此 Component 的事件处理程序的列表。（继承自 Component。）

Handshake

获取或设置串行端口数据传输的握手协议。

IsOpen

获取一个值，该值指示 SerialPort 对象的打开或关闭状态。

NewLine

获取或设置用于解释 ReadLine 和 WriteLine 方法调用结束的值。

Parity

获取或设置奇偶校验检查协议。

ParityReplace

获取或设置一个字节，该字节在发生奇偶校验错误时替换数据流中的无效字节。

PortName

获取或设置通信端口，包括但不限于所有可用的 COM 端口。

ReadBufferSize

获取或设置 SerialPort 输入缓冲区的大小。

ReadTimeout 获取或设置读取操作未完成时发生超时之前的毫秒数。

ReceivedBytesThreshold

获取或设置 DataReceived 事件发生前内部输入缓冲区中的字节数。

RtsEnable

获取或设置一个值，该值指示在串行通信中是否启用请求发送 (RTS) 信号。

Site

获取或设置 Component 的 ISite。（继承自 Component。）

StopBits

获取或设置每个字节的标准停止位数。

WriteBufferSize

获取或设置串行端口输出缓冲区的大小。

WriteTimeout

获取或设置写入操作未完成时发生超时之前的毫秒数。

方法

--------------------------------------------------------------------------------

名称说明

关闭端口连接，将 IsOpen 属性设置为 false，并释放内部 Stream 对象。

CreateObjRef

创建一个对象，该对象包含生成用于与远程对象进行通信的代理所需的全部相关信息。（继承自 MarshalByRefObject。）

DiscardInBuffer

丢弃来自串行驱动程序的接收缓冲区的数据。

DiscardOutBuffer

弃来自串行驱动程序的传输缓冲区的数据。

Dispose()

放由 Component 使用的所有资源。（继承自 Component。）

Dispose(Boolean)

放由 SerialPort 占用的非托管资源，还可以另外再释放托管资源。（重写 Component.Dispose(Boolean)。）

Equals(Object)

定指定的对象是否等于当前对象。（继承自 Object。）

Finalize

通过垃圾回收将 Component 回收之前，释放非托管资源并执行其他清理操作。（继承自 Component。）

GetHashCode

作特定类型的哈希函数。（继承自 Object。）

GetLifetimeService

索控制此实例的生存期策略的当前生存期服务对象。（继承自 MarshalByRefObject。）

GetPortNames

取当前计算机的串行端口名称数组。

GetService

回一个对象，该对象表示由 Component 或它的 Container 提供的服务。（继承自 Component。）

GetType

取当前实例的 Type。（继承自 Object。）

InitializeLifetimeService

取控制此实例的生存期策略的生存期服务对象。（继承自 MarshalByRefObject。）

MemberwiseClone()

建当前 Object 的浅表副本。（继承自 Object。）

MemberwiseClone(Boolean)

建当前 MarshalByRefObject 对象的浅表副本。（继承自 MarshalByRefObject。）

Open

开一个新的串行端口连接。

Read(Byte[], Int32, Int32)

SerialPort 输入缓冲区读取一些字节并将那些字节写入字节数组中指定的偏移量处。

Read(Char[], Int32, Int32)

SerialPort 输入缓冲区中读取大量字符，然后将这些字符写入到一个字符数组中指定的偏移量处。

ReadByte

从 SerialPort 输入缓冲区中同步读取一个字节。

ReadChar

SerialPort 输入缓冲区中同步读取一个字符。

ReadExisting

编码的基础上，读取 SerialPort 对象的流和输入缓冲区中所有立即可用的字节。

ReadLine

直读取到输入缓冲区中的 NewLine 值。

ReadTo

直读取到输入缓冲区中的指定 value 的字符串。

ToString

返回包含 Component 的名称的 String（如果有）。不应重写此方法。（继承自 Component。）

Write(String)

将指定的字符串写入串行端口。

Write(Byte[], Int32, Int32)

用缓冲区的数据将指定数量的字节写入串行端口。

Write(Char[], Int32, Int32)

用缓冲区的数据将指定数量的字符写入串行端口。

WriteLine

指定的字符串和 NewLine 值写入输出缓冲区。

事件

--------------------------------------------------------------------------------

名称说明

DataReceived

表示将处理 SerialPort 对象的数据接收事件的方法。

Disposed

当通过调用 Dispose 方法释放组件时发生。（继承自 Component。）

ErrorReceived

表示处理 SerialPort 对象的错误事件的方法。

PinChanged

表示将处理 SerialPort 对象的串行管脚更改事件的方法。

字段

--------------------------------------------------------------------------------

名称说明

InfiniteTimeout

指示不应该发生超时。

备注

--------------------------------------------------------------------------------

此类用于控制串行端口文件资源。此类提供同步 I/O 和事件驱动的 I/O、对管脚和中断状态的访问以及对串行驱动程序属性的访问。另外，此类的功能可以包装在内部 Stream 对象中，可通过 BaseStream 属性访问，并且可以传递给包装或使用流的类。

SerialPort 类支持以下编码：ASCIIEncoding、UTF8Encoding、UnicodeEncoding、UTF32Encoding，以及 mscorlib.dll 中定义的、代码页小于 50000 或者为 54936 的所有编码。可以使用备用编码，但必须使用 ReadByte 或 Write 方法并自己执行编码。

使用 GetPortNames 方法检索当前计算机的有效的端口。

如果 SerialPort 对象被阻止在一次读取操作时，不要中止线程。相反，或者关闭基础流或进程 SerialPort 对象。

示例

--------------------------------------------------------------------------------

下面的代码示例演示如何使用 SerialPort 类以允许两位用户分别在两台通过 NULL 调制解调器电缆连接的独立计算机上聊天。本示例中，在聊天之前将提示用户输入端口设置和用户名。这两台计算机必须同时执行该程序才能实现本示例的全部功能。

using System;
using System.IO.Ports;
using System.Threading;

public class PortChat
{
static bool _continue;
static SerialPort _serialPort;

    public static void Main()
    {
        string name;
        string message;
        StringComparer stringComparer = StringComparer.OrdinalIgnoreCase;
        Thread readThread = new Thread(Read);

// Create a new SerialPort object with default settings.
_serialPort = new SerialPort();

        // Allow the user to set the appropriate properties.
        _serialPort.PortName = SetPortName(_serialPort.PortName);
        _serialPort.BaudRate = SetPortBaudRate(_serialPort.BaudRate);
        _serialPort.Parity = SetPortParity(_serialPort.Parity);
        _serialPort.DataBits = SetPortDataBits(_serialPort.DataBits);
        _serialPort.StopBits = SetPortStopBits(_serialPort.StopBits);
        _serialPort.Handshake = SetPortHandshake(_serialPort.Handshake);

        // Set the read/write timeouts
        _serialPort.ReadTimeout = 500;
        _serialPort.WriteTimeout = 500;

        _serialPort.Open();
        _continue = true;
        readThread.Start();

Console.Write("Name: ");
name = Console.ReadLine();

Console.WriteLine("Type QUIT to exit");

        while (_continue)
        {
            message = Console.ReadLine();

            if (stringComparer.Equals("quit", message))
            {
                _continue = false;
            }
            else
            {
                _serialPort.WriteLine(
                    String.Format("<{0}>: {1}", name, message) );
            }
        }

        readThread.Join();
        _serialPort.Close();
    }

    public static void Read()
    {
        while (_continue)
        {
            try
            {
                string message = _serialPort.ReadLine();
                Console.WriteLine(message);
            }
            catch (TimeoutException) { }
        }
    }

    public static string SetPortName(string defaultPortName)
    {
        string portName;

        Console.WriteLine("Available Ports:");
        foreach (string s in SerialPort.GetPortNames())
        {
            Console.WriteLine("   {0}", s);
        }

Console.Write("COM port({0}): ", defaultPortName);
portName = Console.ReadLine();

        if (portName == "")
        {
            portName = defaultPortName;
        }
        return portName;
    }

    public static int SetPortBaudRate(int defaultPortBaudRate)
    {
        string baudRate;

Console.Write("Baud Rate({0}): ", defaultPortBaudRate);
baudRate = Console.ReadLine();

        if (baudRate == "")
        {
            baudRate = defaultPortBaudRate.ToString();
        }

return int.Parse(baudRate);
}

    public static Parity SetPortParity(Parity defaultPortParity)
    {
        string parity;

        Console.WriteLine("Available Parity options:");
        foreach (string s in Enum.GetNames(typeof(Parity)))
        {
            Console.WriteLine("   {0}", s);
        }

Console.Write("Parity({0}):", defaultPortParity.ToString());
parity = Console.ReadLine();

        if (parity == "")
        {
            parity = defaultPortParity.ToString();
        }

return (Parity)Enum.Parse(typeof(Parity), parity);
}

    public static int SetPortDataBits(int defaultPortDataBits)
    {
        string dataBits;

Console.Write("Data Bits({0}): ", defaultPortDataBits);
dataBits = Console.ReadLine();

        if (dataBits == "")
        {
            dataBits = defaultPortDataBits.ToString();
        }

return int.Parse(dataBits);
}

    public static StopBits SetPortStopBits(StopBits defaultPortStopBits)
    {
        string stopBits;

        Console.WriteLine("Available Stop Bits options:");
        foreach (string s in Enum.GetNames(typeof(StopBits)))
        {
            Console.WriteLine("   {0}", s);
        }

Console.Write("Stop Bits({0}):", defaultPortStopBits.ToString());
stopBits = Console.ReadLine();

        if (stopBits == "")
        {
            stopBits = defaultPortStopBits.ToString();
        }

return (StopBits)Enum.Parse(typeof(StopBits), stopBits);
}

    public static Handshake SetPortHandshake(Handshake defaultPortHandshake)
    {
        string handshake;

        Console.WriteLine("Available Handshake options:");
        foreach (string s in Enum.GetNames(typeof(Handshake)))
        {
            Console.WriteLine("   {0}", s);
        }

Console.Write("Handshake({0}):", defaultPortHandshake.ToString());
handshake = Console.ReadLine();

        if (handshake == "")
        {
            handshake = defaultPortHandshake.ToString();
        }

return (Handshake)Enum.Parse(typeof(Handshake), handshake);
}
}