Componente de puerto serie

Abre puertos RS-232 y RS-485 desde Delphi, C++Builder y .NET. Configura la línea, escribe datos y recíbelos en un evento o con lecturas bloqueantes, en Windows, Linux y macOS.

Novedad

TsgcSerialPort

Un puerto serie con un hilo lector en segundo plano, un búfer de recepción de 64 KB y la misma API en Delphi, C++Builder y C#. Es también el transporte del cliente y del servidor Modbus RTU.

Clase de componente

TsgcSerialPort

Interfaces

RS-232, RS-485 y adaptadores serie USB

Plataformas

Windows, Linux y macOS (no Android ni iOS)

Edición

Incluido en sgcWebSockets Enterprise (Delphi y .NET) y All-Access, o en el pack independiente sgcIndustrial

Abre un puerto y recibe datos

Indica el nombre del puerto y los ajustes de la línea, asigna los eventos y llama a Open. OnData recibe cada bloque de bytes según llega.

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

Qué incluye

Un puerto serie completo para instrumentos, módems, lectores de códigos de barras, básculas y buses de campo.

Ajustes de la línea

BaudRate, DataBits (5 a 8), Parity (ninguna, impar, par, marca, espacio), StopBits (1, 1,5, 2) y FlowControl (RTS/CTS o XON/XOFF). Las combinaciones no válidas lanzan EsgcSerialError al abrir el puerto.

Eventos o lecturas bloqueantes

Con OnData asignado, cada bloque de bytes va al evento. Sin él, los bytes esperan en un búfer de 64 KB y Read devuelve una respuesta completa: espera el primer byte y termina tras un silencio que eliges tú.

Control de dirección RS-485

Establece RtsControl en srcToggle para los adaptadores que cambian la dirección con RTS. En Windows el controlador sube RTS mientras transmite, y en Linux se activa el modo RS-485 del núcleo. En .NET el componente temporiza el cambio.

Puertos y líneas de módem

TsgcSerialPort.ListPorts lista los puertos en orden natural (COM2 antes que COM10). SetDTR, SetRTS y ModemStatus controlan y leen las líneas de módem.

Seguro para hilos

Write se puede llamar desde cualquier hilo. Close funciona desde cualquier hilo, también desde un manejador de evento, y despierta un Read bloqueado. En Delphi y C++Builder los eventos se encolan en el hilo principal por defecto, y NotifyEvents lo cambia.

Errores claros

Cada fallo lanza EsgcSerialError, cuyo ErrorCode contiene el código de error del sistema operativo cuando el sistema lo informó. Un dispositivo desconectado con el puerto abierto, o un búfer de recepción lleno, dispara OnError.

Envía un comando, lee la respuesta

Deja OnData vacío, escribe el comando y llama a Read: espera hasta 1000 ms el primer byte y vuelve cuando el dispositivo ha estado en silencio durante 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");
    }
}

Especificaciones y referencias

Las interfaces del sistema operativo sobre las que se construye este componente.

Preguntas sobre el puerto serie

En Delphi y C++Builder funciona en Windows (Win32 y Win64) con la API de comunicaciones de Win32, y en Linux64 y macOS con POSIX termios. No está disponible en Android ni en iOS. La versión .NET se basa en System.IO.Ports.

Usa OnData para los dispositivos que envían datos por su cuenta, como un lector de códigos de barras o una báscula. Usa Read para los protocolos de petición y respuesta: envía el comando y lee hasta que el dispositivo deje de enviar. Los dos son excluyentes: Read lanza EsgcSerialError mientras OnData está asignado, y solo un hilo puede llamar a Read a la vez.

Un adaptador que cambia la dirección automáticamente no necesita ningún ajuste. Un adaptador que cambia la dirección con la línea RTS necesita RtsControl en srcToggle. En Linux el componente activa entonces el modo RS-485 del controlador y lanza EsgcSerialError cuando el controlador no lo admite. macOS no admite srcToggle.

Está incluido en sgcWebSockets Enterprise (Delphi y .NET) y All-Access, como parte del paquete sgcIndustrial. En Delphi, añade sgcIndustrial a la cláusula uses.

Documentación y demos

Enlace directo a la referencia del componente, abre el proyecto de demostración y lee el documento técnico.

Online Help: TsgcSerialPort Referencia completa de propiedades, métodos y eventos de este componente.
Proyecto de demostración: Industrial\01.Serial_Port Un terminal serie para Delphi, C++Builder y .NET. Se incluye dentro del paquete sgcWebSockets.
Documento técnico (PDF) Características, inicio rápido, ejemplos de código y referencias de fuentes primarias solo para este componente.
Manual de usuario (PDF) Manual completo que cubre cada componente de la biblioteca.
La mejor opción: All-AccessTodos los productos de eSeGeCe, con Premium Support incluido, desde €1,059 al año.
Ver precios de All-Access

Incluido en sgcWebSockets Enterprise

Incluido en sgcWebSockets Enterprise (Delphi y .NET) y All-Access, o en el pack independiente sgcIndustrial.