Componente de porta serial

Abra portas RS-232 e RS-485 a partir de Delphi, C++Builder e .NET. Configure a linha, grave dados e receba-os em um evento ou com leituras bloqueantes, no Windows, Linux e macOS.

Novo

TsgcSerialPort

Uma porta serial com thread de leitura em segundo plano, buffer de recepção de 64 KB e a mesma API em Delphi, C++Builder e C#. Ela também é o transporte do cliente e do servidor Modbus RTU.

Classe de componente

TsgcSerialPort

Interfaces

Adaptadores seriais RS-232, RS-485 e USB

Plataformas

Windows, Linux e macOS (não Android nem iOS)

Edição

Incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, ou no pacote independente sgcIndustrial

Abra uma porta e receba dados

Defina o nome da porta e os parâmetros da linha, atribua os eventos e chame Open. OnData recebe cada bloco de bytes assim que chega.

uses
  sgcIndustrial;

procedure TForm1.OpenPort;
begin
  FPort := TsgcSerialPort.Create(Self);
  FPort.Port := 'COM3';
  FPort.BaudRate := 19200;
  FPort.DataBits := 8;
  FPort.Parity := spEven;
  FPort.StopBits := ssOne;
  FPort.OnData := OnSerialData;
  FPort.OnError := OnSerialError;
  FPort.Open;
  FPort.WriteString('AT' + #13);
end;

procedure TForm1.OnSerialData(Sender: TObject; const aData: TBytes);
begin
  // queued to the main thread by default (NotifyEvents = neAsynchronous)
  Memo1.Lines.Add(IntToStr(Length(aData)) + ' bytes received');
end;

procedure TForm1.OnSerialError(Sender: TObject; const aError: string);
begin
  Memo1.Lines.Add('Error: ' + aError);
end;
#include "sgcIndustrial.hpp"

void __fastcall TForm1::OpenPort()
{
  FPort = new TsgcSerialPort(this);
  FPort->Port = "COM3";
  FPort->BaudRate = 19200;
  FPort->DataBits = 8;
  FPort->Parity = spEven;
  FPort->StopBits = ssOne;
  FPort->OnData = OnSerialData;
  FPort->OnError = OnSerialError;
  FPort->Open();
  FPort->WriteString("AT\r");
}

void __fastcall TForm1::OnSerialData(TObject *Sender, const TBytes aData)
{
  // queued to the main thread by default (NotifyEvents = neAsynchronous)
  Memo1->Lines->Add(IntToStr(aData.Length) + " bytes received");
}

void __fastcall TForm1::OnSerialError(TObject *Sender, const String aError)
{
  Memo1->Lines->Add("Error: " + aError);
}
using System;
using esegece.sgcWebSockets;

class SerialTerminal
{
    TsgcSerialPort FPort = new TsgcSerialPort();

    public void OpenPort()
    {
        FPort.Port = "COM3";
        FPort.BaudRate = 19200;
        FPort.DataBits = 8;
        FPort.Parity = TsgcSerialParity.spEven;
        FPort.StopBits = TsgcSerialStopBits.ssOne;
        FPort.OnData += OnSerialData;
        FPort.OnError += OnSerialError;
        FPort.Open();
        FPort.WriteString("AT\r");
    }

    void OnSerialData(object Sender, byte[] aData)
    {
        Console.WriteLine(aData.Length + " bytes received");
    }

    void OnSerialError(object Sender, string aError)
    {
        Console.WriteLine("Error: " + aError);
    }
}

O que tem por dentro

Uma porta serial completa para instrumentos, modems, leitores de código de barras, balanças e barramentos de campo.

Parâmetros da linha

BaudRate, DataBits (5 a 8), Parity (none, odd, even, mark, space), StopBits (1, 1.5, 2) e FlowControl (RTS/CTS ou XON/XOFF). Combinações inválidas levantam EsgcSerialError quando a porta é aberta.

Eventos ou leituras bloqueantes

Com OnData atribuído, cada bloco de bytes vai para o evento. Sem ele, os bytes aguardam em um buffer de 64 KB e Read retorna uma resposta completa: espera o primeiro byte e termina após um silêncio que você define.

Controle de direção RS-485

Defina RtsControl como srcToggle para adaptadores que alternam a direção com o RTS. No Windows, o driver ativa o RTS enquanto transmite e, no Linux, o modo RS-485 do kernel é habilitado. No .NET, a alternância é temporizada pelo componente.

Portas e linhas de modem

TsgcSerialPort.ListPorts lista as portas em ordem natural (COM2 antes de COM10). SetDTR, SetRTS e ModemStatus controlam e leem as linhas de modem.

Thread-safe

Write pode ser chamado de qualquer thread. Close funciona a partir de qualquer thread, inclusive de um manipulador de evento, e desbloqueia um Read em espera. No Delphi e no C++Builder, os eventos são enfileirados para a thread principal por padrão, e NotifyEvents altera isso.

Erros claros

Toda falha levanta EsgcSerialError, cujo ErrorCode contém o código de erro do sistema operacional quando o sistema o informa. Um dispositivo desconectado com a porta aberta, ou um buffer de recepção cheio, dispara OnError.

Envie um comando, leia a resposta

Deixe OnData vazio, grave o comando e chame Read: ele espera até 1000 ms pelo primeiro byte e retorna quando o dispositivo fica em silêncio por 50 ms.

procedure TForm1.QueryDevice;
var
  vData: TBytes;
  vCount: Integer;
begin
  // OnData is not assigned: the bytes wait in the receive buffer for Read
  FPort.Purge;
  FPort.WriteString('*IDN?' + #10);
  // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
  vCount := FPort.Read(vData, 256, 1000, 50);
  if vCount = 0 then
    Memo1.Lines.Add('No reply')
  else
    Memo1.Lines.Add(IntToStr(vCount) + ' bytes read');
end;
void __fastcall TForm1::QueryDevice()
{
  // OnData is not assigned: the bytes wait in the receive buffer for Read
  FPort->Purge();
  FPort->WriteString("*IDN?\n");
  // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
  TBytes vData;
  int vCount = FPort->Read(vData, 256, 1000, 50);
  if (vCount == 0)
    Memo1->Lines->Add("No reply");
  else
    Memo1->Lines->Add(IntToStr(vCount) + " bytes read");
}
using System;
using esegece.sgcWebSockets;

class SerialQuery
{
    TsgcSerialPort FPort = new TsgcSerialPort();

    public void QueryDevice()
    {
        // OnData is not assigned: the bytes wait in the receive buffer for Read
        FPort.Port = "COM3";
        FPort.Open();
        FPort.Purge();
        FPort.WriteString("*IDN?\n");
        // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
        byte[] vData = FPort.Read(256, 1000, 50);
        if (vData.Length == 0)
            Console.WriteLine("No reply");
        else
            Console.WriteLine(vData.Length + " bytes read");
    }
}

Especificações e referências

As interfaces do sistema operacional nas quais este componente se baseia.

Perguntas sobre a porta serial

No Delphi e no C++Builder, funciona no Windows (Win32 e Win64) com a API de comunicações do Win32, e no Linux64 e macOS com POSIX termios. Não está disponível para Android e iOS. A versão .NET é baseada em System.IO.Ports.

Use OnData para dispositivos que enviam dados por conta própria, como um leitor de código de barras ou uma balança. Use Read para protocolos de requisição e resposta: envie o comando e leia até o dispositivo parar de enviar. Os dois são exclusivos: Read levanta EsgcSerialError enquanto OnData está atribuído, e apenas uma thread pode chamar Read ao mesmo tempo.

Um adaptador que alterna a direção automaticamente não precisa de nenhuma configuração. Um adaptador que alterna a direção com a linha RTS precisa de RtsControl definido como srcToggle. No Linux, o componente então habilita o modo RS-485 do driver e levanta EsgcSerialError quando o driver não o suporta. O macOS não suporta srcToggle.

Ele está incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, como parte do pacote sgcIndustrial. No Delphi, adicione sgcIndustrial à cláusula uses.

Documentação e demos

Acesse diretamente a referência do componente, abra o projeto de demonstração e leia o documento técnico.

Online Help: TsgcSerialPort Referência completa de propriedades, métodos e eventos deste componente.
Projeto de demonstração: Industrial\01.Serial_Port Um terminal serial para Delphi, C++Builder e .NET. Ele acompanha o pacote sgcWebSockets.
Documento técnico (PDF) Recursos, início rápido, exemplos de código e referências de fontes primárias somente para este componente.
Manual do usuário (PDF) Manual abrangente cobrindo todos os componentes da biblioteca.
Melhor custo-benefício: All-AccessTodos os produtos da eSeGeCe, com Suporte Premium incluído, a partir de €1,059/ano.
Ver preços do All-Access

Incluído no sgcWebSockets Enterprise

Incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, ou no pacote independente sgcIndustrial.