SerialPort Classe

Definição

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Pacote:

System.IO.Ports v8.0.0

Origem:

SerialPort.cs

Representa um recurso de porta serial.

public ref class SerialPort : System::ComponentModel::Component

public class SerialPort : System.ComponentModel.Component

type SerialPort = class
    inherit Component

Public Class SerialPort
Inherits Component

Herança

Object

MarshalByRefObject

Component

SerialPort

Exemplos

O exemplo de código a seguir demonstra o uso da SerialPort classe para permitir que dois usuários conversem de dois computadores separados conectados por um cabo modem nulo. Neste exemplo, os usuários são solicitados a fornecer as configurações de porta e um nome de usuário antes de conversar. Ambos os computadores devem estar executando o programa para obter a funcionalidade completa deste exemplo.

#using <System.dll>

using namespace System;
using namespace System::IO::Ports;
using namespace System::Threading;

public ref class PortChat
{
private:
    static bool _continue;
    static SerialPort^ _serialPort;

public:
    static void Main()
    {
        String^ name;
        String^ message;
        StringComparer^ stringComparer = StringComparer::OrdinalIgnoreCase;
        Thread^ readThread = gcnew Thread(gcnew ThreadStart(PortChat::Read));

        // Create a new SerialPort object with default settings.
        _serialPort = gcnew 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();
    }

    static void Read()
    {
        while (_continue)
        {
            try
            {
                String^ message = _serialPort->ReadLine();
                Console::WriteLine(message);
            }
            catch (TimeoutException ^) { }
        }
    }

    static String^ SetPortName(String^ defaultPortName)
    {
        String^ portName;

        Console::WriteLine("Available Ports:");
        for each (String^ s in SerialPort::GetPortNames())
        {
            Console::WriteLine("   {0}", s);
        }

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

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

    static Int32 SetPortBaudRate(Int32 defaultPortBaudRate)
    {
        String^ baudRate;

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

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

        return Int32::Parse(baudRate);
    }

    static Parity SetPortParity(Parity defaultPortParity)
    {
        String^ parity;

        Console::WriteLine("Available Parity options:");
        for each (String^ s in Enum::GetNames(Parity::typeid))
        {
            Console::WriteLine("   {0}", s);
        }
        
        Console::Write("Enter Parity value (Default: {0}):", defaultPortParity.ToString());
        parity = Console::ReadLine();

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

        return (Parity)Enum::Parse(Parity::typeid, parity);
    }

    static Int32 SetPortDataBits(Int32 defaultPortDataBits)
    {
        String^ dataBits;

        Console::Write("Enter DataBits value (Default: {0}): ", defaultPortDataBits);
        dataBits = Console::ReadLine();

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

        return Int32::Parse(dataBits);
    }

    static StopBits SetPortStopBits(StopBits defaultPortStopBits)
    {
        String^ stopBits;

        Console::WriteLine("Available Stop Bits options:");
        for each (String^ s in Enum::GetNames(StopBits::typeid))
        {
            Console::WriteLine("   {0}", s);
        }

        Console::Write("Enter StopBits value (None is not supported and \n" +
            "raises an ArgumentOutOfRangeException. \n (Default: {0}):", defaultPortStopBits.ToString());
        stopBits = Console::ReadLine();

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

        return (StopBits)Enum::Parse(StopBits::typeid, stopBits);
    }

    static Handshake SetPortHandshake(Handshake defaultPortHandshake)
    {
        String^ handshake;

        Console::WriteLine("Available Handshake options:");
        for each (String^ s in Enum::GetNames(Handshake::typeid))
        {
            Console::WriteLine("   {0}", s);
        }

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

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

        return (Handshake)Enum::Parse(Handshake::typeid, handshake);
    }
};

int main()
{
    PortChat::Main();
}

// Use this code inside a project created with the Visual C# > Windows Desktop > Console Application template.
// Replace the code in Program.cs with this code.

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) { }
        }
    }

    // Display Port values and prompt user to enter a port.
    public static string SetPortName(string defaultPortName)
    {
        string portName;

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

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

        if (portName == "" || !(portName.ToLower()).StartsWith("com"))
        {
            portName = defaultPortName;
        }
        return portName;
    }
    // Display BaudRate values and prompt user to enter a value.
    public static int SetPortBaudRate(int defaultPortBaudRate)
    {
        string baudRate;

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

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

        return int.Parse(baudRate);
    }

    // Display PortParity values and prompt user to enter a value.
    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("Enter Parity value (Default: {0}):", defaultPortParity.ToString(), true);
        parity = Console.ReadLine();

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

        return (Parity)Enum.Parse(typeof(Parity), parity, true);
    }
    // Display DataBits values and prompt user to enter a value.
    public static int SetPortDataBits(int defaultPortDataBits)
    {
        string dataBits;

        Console.Write("Enter DataBits value (Default: {0}): ", defaultPortDataBits);
        dataBits = Console.ReadLine();

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

        return int.Parse(dataBits.ToUpperInvariant());
    }

    // Display StopBits values and prompt user to enter a value.
    public static StopBits SetPortStopBits(StopBits defaultPortStopBits)
    {
        string stopBits;

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

        Console.Write("Enter StopBits value (None is not supported and \n" +
         "raises an ArgumentOutOfRangeException. \n (Default: {0}):", defaultPortStopBits.ToString());
        stopBits = Console.ReadLine();

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

        return (StopBits)Enum.Parse(typeof(StopBits), stopBits, true);
    }
    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("Enter Handshake value (Default: {0}):", defaultPortHandshake.ToString());
        handshake = Console.ReadLine();

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

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

' Use this code inside a project created with the Visual Basic > Windows Desktop > Console Application template.
' Replace the default code in Module1.vb with this code. Then right click the project in Solution Explorer,
' select Properties, and set the Startup Object to PortChat.

Imports System.IO.Ports
Imports System.Threading

Public Class PortChat
    Shared _continue As Boolean
    Shared _serialPort As SerialPort

    Public Shared Sub Main()
        Dim name As String
        Dim message As String
        Dim stringComparer__1 As StringComparer = StringComparer.OrdinalIgnoreCase
        Dim readThread As New Thread(AddressOf 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__1.Equals("quit", message) Then
                _continue = False
            Else
                _serialPort.WriteLine([String].Format("<{0}>: {1}", name, message))
            End If
        End While

        readThread.Join()
        _serialPort.Close()
    End Sub

    Public Shared Sub Read()
        While _continue
            Try
                Dim message As String = _serialPort.ReadLine()
                Console.WriteLine(message)
            Catch generatedExceptionName As TimeoutException
            End Try
        End While
    End Sub

    ' Display Port values and prompt user to enter a port.
    Public Shared Function SetPortName(defaultPortName As String) As String
        Dim portName As String

        Console.WriteLine("Available Ports:")
        For Each s As String In SerialPort.GetPortNames()
            Console.WriteLine("   {0}", s)
        Next

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

        If portName = "" OrElse Not (portName.ToLower()).StartsWith("com") Then
            portName = defaultPortName
        End If
        Return portName
    End Function
    ' Display BaudRate values and prompt user to enter a value.
    Public Shared Function SetPortBaudRate(defaultPortBaudRate As Integer) As Integer
        Dim baudRate As String

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

        If baudRate = "" Then
            baudRate = defaultPortBaudRate.ToString()
        End If

        Return Integer.Parse(baudRate)
    End Function

    ' Display PortParity values and prompt user to enter a value.
    Public Shared Function SetPortParity(defaultPortParity As Parity) As Parity
        Dim parity As String

        Console.WriteLine("Available Parity options:")
        For Each s As String In [Enum].GetNames(GetType(Parity))
            Console.WriteLine("   {0}", s)
        Next

        Console.Write("Enter Parity value (Default: {0}):", defaultPortParity.ToString(), True)
        parity = Console.ReadLine()

        If parity = "" Then
            parity = defaultPortParity.ToString()
        End If

        Return CType([Enum].Parse(GetType(Parity), parity, True), Parity)
    End Function
    ' Display DataBits values and prompt user to enter a value.
    Public Shared Function SetPortDataBits(defaultPortDataBits As Integer) As Integer
        Dim dataBits As String

        Console.Write("Enter DataBits value (Default: {0}): ", defaultPortDataBits)
        dataBits = Console.ReadLine()

        If dataBits = "" Then
            dataBits = defaultPortDataBits.ToString()
        End If

        Return Integer.Parse(dataBits.ToUpperInvariant())
    End Function
    ' Display StopBits values and prompt user to enter a value.

    Public Shared Function SetPortStopBits(defaultPortStopBits As StopBits) As StopBits
        Dim stopBits As String

        Console.WriteLine("Available StopBits options:")
        For Each s As String In [Enum].GetNames(GetType(StopBits))
            Console.WriteLine("   {0}", s)
        Next

        Console.Write("Enter StopBits value (None is not supported and " &
                      vbLf & "raises an ArgumentOutOfRangeException. " &
                      vbLf & " (Default: {0}):", defaultPortStopBits.ToString())
        stopBits = Console.ReadLine()

        If stopBits = "" Then
            stopBits = defaultPortStopBits.ToString()
        End If

        Return CType([Enum].Parse(GetType(StopBits), stopBits, True), StopBits)
    End Function
    Public Shared Function SetPortHandshake(defaultPortHandshake As Handshake) As Handshake
        Dim handshake As String

        Console.WriteLine("Available Handshake options:")
        For Each s As String In [Enum].GetNames(GetType(Handshake))
            Console.WriteLine("   {0}", s)
        Next

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

        If handshake = "" Then
            handshake = defaultPortHandshake.ToString()
        End If

        Return CType([Enum].Parse(GetType(Handshake), handshake, True), Handshake)
    End Function
End Class

Comentários

Use essa classe para controlar um recurso de arquivo de porta serial. Essa classe fornece E/S síncrona e controlada por eventos, acesso a estados de fixação e interrupção e acesso às propriedades do driver serial. Além disso, a funcionalidade dessa classe pode ser encapsulada em um objeto interno Stream , acessível por meio da BaseStream propriedade e passada para classes que encapsulam ou usam fluxos.

A SerialPort classe dá suporte às seguintes codificações: ASCIIEncoding, UTF8Encoding, UnicodeEncoding, UTF32Encodinge qualquer codificação definida em mscorlib.dll em que a página de código é menor que 50000 ou a página de código é 54936. Você pode usar codificações alternativas, mas deve usar o ReadByte método ou Write e executar a codificação por conta própria.

Use o GetPortNames método para recuperar as portas válidas para o computador atual.

Se um SerialPort objeto for bloqueado durante uma operação de leitura, não anule o thread. Em vez disso, feche o fluxo base ou descarte o SerialPort objeto .

Construtores

SerialPort()	Inicializa uma nova instância da classe SerialPort.
SerialPort(IContainer)	Inicializa uma nova instância da classe SerialPort usando o objeto IContainer especificado.
SerialPort(String)	Inicializa uma nova instância da classe SerialPort, usando o nome da porta especificado.
SerialPort(String, Int32)	Inicializa uma nova instância da classe SerialPort usando a taxa de transmissão e o nome da porta especificadas.
SerialPort(String, Int32, Parity)	Inicializa uma nova instância da classe SerialPort usando o nome da porta, a taxa de transmissão e o bit de paridade especificados.
SerialPort(String, Int32, Parity, Int32)	Inicializa uma nova instância da classe SerialPort usando o nome da porta, a taxa de transmissão, o bit de paridade e os bits de dados especificados.
SerialPort(String, Int32, Parity, Int32, StopBits)	Inicializa uma nova instância da classe SerialPort usando o nome da porta especificado, a taxa de transmissão, o bit de paridade, o bits de dados e o bit de parada.

Campos

InfiniteTimeout

Indica que nenhum tempo limite deve ocorrer.

Propriedades

BaseStream	Obtém o objeto Stream subjacente para um objeto SerialPort.
BaudRate	Obtém ou define a taxa de transmissão serial.
BreakState	Obtém ou define o estado do sinal de interrupção.
BytesToRead	Obtém o número de bytes de dados no buffer de recepção.
BytesToWrite	Obtém o número de bytes de dados no buffer de envio.
CanRaiseEvents	Obtém um valor que indica se o componente pode acionar um evento. (Herdado de Component)
CDHolding	Obtém o estado da linha da Carrier Detectada da porta.
Container	Obtém o IContainer que contém o Component. (Herdado de Component)
CtsHolding	Obtém o estado da linha Clear to Send.
DataBits	Obtém ou define o tamanho padrão de bits de dados por byte.
DesignMode	Obtém um valor que indica se o Component está no modo de design no momento. (Herdado de Component)
DiscardNull	Obtém ou define um valor que indica se os bytes nulos são ignorados quando transmitidos entre a porta e o buffer de recepção.
DsrHolding	Obtém o estado do sinal DSR (Data Set Ready).
DtrEnable	Obtém ou define um valor que habilita o sinal DTR (Data Terminal Ready) durante a comunicação serial.
Encoding	Obtém ou define a codificação de bytes para conversão de pré e pós-transmissão de texto.
Events	Obtém a lista de manipuladores de eventos que estão anexados a este Component. (Herdado de Component)
Handshake	Obtém ou define o protocolo de handshake para transmissão da porta serial de dados usando um valor de Handshake.
IsOpen	Obtém um valor que indica o status aberto ou fechado do objeto SerialPort.
NewLine	Obtém ou define o valor usado para interpretar o final de uma chamada para os métodos ReadLine() e WriteLine(String).
Parity	Obtém ou define o protocolo de verificação de paridade.
ParityReplace	Obtém ou define o byte que substitui bytes inválidos em um fluxo de dados quando ocorre um erro de paridade.
PortName	Obtém ou define a porta de comunicação, incluindo, sem limitação, todas as portas COM disponíveis.
ReadBufferSize	Obtém ou define o tamanho do buffer de entrada do SerialPort.
ReadTimeout	Obtém ou define o número de milissegundos antes que o tempo limite ocorra quando uma operação de leitura não for concluída.
ReceivedBytesThreshold	Obtém ou define o número de bytes no buffer de entrada interno antes que um evento DataReceived ocorra.
RtsEnable	Obtém ou define um valor que indica se o sinal RTS (solicitação de envio) está habilitado durante a comunicação serial.
Site	Obtém ou define o ISite do Component. (Herdado de Component)
StopBits	Obtém ou define o número padrão de stopbits por byte.
WriteBufferSize	Obtém ou define o tamanho do buffer de saída de porta serial.
WriteTimeout	Obtém ou define o número de milissegundos antes que o tempo limite ocorra quando uma operação de gravação não for concluída.

Métodos

Close()	Fecha a conexão de porta, define a propriedade IsOpen como false e descarta o objeto Stream interno.
CreateObjRef(Type)	Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto. (Herdado de MarshalByRefObject)
DiscardInBuffer()	Descarta dados do buffer de recebimento do driver serial.
DiscardOutBuffer()	Descarta dados do buffer de transmissão do driver serial.
Dispose()	Libera todos os recursos usados pelo Component. (Herdado de Component)
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo SerialPort e opcionalmente libera os recursos gerenciados.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetLifetimeService()	Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância. (Herdado de MarshalByRefObject)
GetPortNames()	Obtém uma matriz de nomes de porta de série para o computador atual.
GetService(Type)	Retorna um objeto que representa um serviço fornecido pelo Component ou pelo seu Container. (Herdado de Component)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
InitializeLifetimeService()	Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância. (Herdado de MarshalByRefObject)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto MarshalByRefObject atual. (Herdado de MarshalByRefObject)
Open()	Abre uma nova conexão de porta serial.
Read(Byte[], Int32, Int32)	Lê um número de bytes por meio do buffer de entrada SerialPort e grava esses bytes em uma matriz de bytes no deslocamento especificado.
Read(Char[], Int32, Int32)	Lê um número de caracteres do buffer de entrada SerialPort e grava-os em uma matriz de caracteres em um deslocamento especificado.
ReadByte()	Lê um byte do buffer de entrada SerialPort sincronicamente.
ReadChar()	Lê um caractere do buffer de entrada SerialPort de maneira síncrona.
ReadExisting()	Lê todos os bytes imediatamente disponíveis, baseado na codificação, no fluxo e no buffer de entrada do objeto SerialPort.
ReadLine()	Lê até o valor NewLine no buffer de entrada.
ReadTo(String)	Lê uma cadeia de caracteres até o value especificado no buffer de entrada.
ToString()	Retorna um String que contém o nome do Component, se houver. Esse método não deve ser substituído. (Herdado de Component)
Write(Byte[], Int32, Int32)	Grava um número especificado de bytes na porta serial usando dados de um buffer.
Write(Char[], Int32, Int32)	Grava um número especificado de caracteres na porta serial usando dados de um buffer.
Write(String)	Grava a cadeia de caracteres especificada para a porta serial.
WriteLine(String)	Grava a cadeia de caracteres especificada e o valor de NewLine no buffer de saída.

Eventos

DataReceived	Indica que os dados foram recebidos por meio de uma porta representada pelo objeto SerialPort.
Disposed	Ocorre quando o componente é disposto por uma chamada ao método Dispose(). (Herdado de Component)
ErrorReceived	Indica que ocorreu um erro com uma porta representada por um objeto SerialPort.
PinChanged	Indica que ocorreu um evento de sinal sem dados na porta representada pelo objeto SerialPort.