Puerto serie para Delphi: componente para Windows, Linux y macOS
Un componente no visual para puertos COM, adaptadores USB serie y buses RS-485. Recibe con un evento o con una lectura bloqueante, escribe desde cualquier hilo y ejecuta el mismo código en Windows, Linux y macOS.
Incluido en sgcWebSockets Enterprise (Delphi y .NET) y All-Access, o en el pack independiente sgcIndustrial.
Un componente de puerto serie que se comporta igual en todas partes
Lectores de códigos de barras, básculas, receptores GPS, módems, instrumentos de laboratorio y buses de campo RS-485, desde una sola clase Pascal.
Un componente de puerto serie para Delphi tiene que lidiar con tres sistemas operativos que hacen la E/S serie de formas distintas: E/S solapada y ajustes DCB en Windows, termios y descriptores de archivo en Linux y macOS. TsgcSerialPort lo oculta todo tras un único conjunto de propiedades (Port, BaudRate, DataBits, Parity, StopBits, FlowControl, RtsControl) y un único conjunto de llamadas, de modo que una aplicación VCL, FMX, servicio o consola abre COM3 en Windows y /dev/ttyUSB0 en Linux con el mismo código.
Los datos llegan en un hilo lector en segundo plano. Asigna OnData para recibir cada bloque como un evento, o déjalo vacío y los bytes van a un búfer de recepción de 64 KB que lees con Read, con un timeout para el primer byte y un timeout entre caracteres que da por terminado el mensaje. El componente serializa las escrituras, así que cualquier hilo puede enviar.
Clase de componente
TsgcSerialPort, en la unidad sgcIndustrial
Nombres de puerto
COM3, \\.\COM12, /dev/ttyUSB0 o simplemente ttyUSB0
Ajustes de la línea
De 5 a 8 bits de datos; paridad ninguna, impar, par, marca o espacio; 1, 1.5 o 2 bits de parada; control de flujo RTS/CTS, DTR/DSR o XON/XOFF
Plataformas
Delphi 7 a Delphi 13 y C++Builder; Windows de 32 y 64 bits, Linux de 64 bits y macOS
QuickStart
Abre un puerto, envía un comando, lee la respuesta
Tres formas de usar el componente. Todos los ejemplos compilan con Delphi 7 y Delphi 13.
uses
SysUtils, sgcIndustrial; // Delphi 7 to 2006: add sgcBase_Helpers (TBytes)procedure TForm1.FormCreate(Sender: TObject);
begin
Serial := TsgcSerialPort.Create(Self);
Serial.Port := 'COM3'; // '/dev/ttyUSB0' on Linux, '/dev/cu.usbserial-10' on macOS
Serial.BaudRate := 115200;
Serial.DataBits := 8;
Serial.Parity := spNone;
Serial.StopBits := ssOne;
Serial.FlowControl := sfcNone;
Serial.OnData := SerialData; // a reader thread receives, the event is queued
Serial.OnError := SerialError; // to the main thread (NotifyEvents)
Serial.Active := True;
Serial.WriteString('AT' + #13);
end;
procedure TForm1.SerialData(Sender: TObject; const aData: TBytes);
begin
Memo1.Lines.Add(Format('%d bytes received', [Length(aData)]));
end;
procedure TForm1.SerialError(Sender: TObject; const aError: string);
begin
Memo1.Lines.Add('error: ' + aError);
end;
procedure TForm1.btnQueryClick(Sender: TObject);
var
vData: TBytes;
vCount: Integer;
begin
Serial.OnData := nil; // without OnData, bytes go to the 64 KB receive buffer
Serial.Port := 'COM5';
Serial.BaudRate := 9600;
Serial.Active := True;
Serial.Purge;
Serial.WriteString('MEAS?' + #13#10);
// wait up to 1 s for the first byte, then return after 50 ms of silence// or when 256 bytes have arrived
vCount := Serial.Read(vData, 256, 1000, 50);
if vCount = 0then
Memo1.Lines.Add('timeout')
else
Memo1.Lines.Add(Format('%d bytes', [vCount]));
Serial.Active := False;
end;
procedure TForm1.FormCreate(Sender: TObject);
begin// COM1, COM3, ... on Windows; /dev/ttyUSB0, /dev/ttyACM0, ... on Linux
TsgcSerialPort.ListPorts(ComboBox1.Items);
Serial := TsgcSerialPort.Create(Self);
Serial.Port := 'COM4';
Serial.BaudRate := 38400;
Serial.Parity := spEven;
Serial.RtsControl := srcToggle; // RS-485 half duplex: RTS on while sending
Serial.WriteTimeout := 500;
Serial.Active := True;
Serial.SetDTR(True);
if smsCTS in Serial.ModemStatus then
Memo1.Lines.Add('CTS is on');
end;
Funciones
Los detalles que hacen fiable el código serie
Hilos, timeouts, búferes y adaptadores desconectados, resueltos dentro del componente.
Evento o lectura bloqueante
Con OnData asignado, cada bloque que recibe el hilo lector se entrega como un evento. Sin él, Read(Data, MaxCount, Timeout, InterCharTimeout) espera el primer byte y devuelve cuando han llegado MaxCount bytes o la línea ha permanecido en silencio durante el tiempo entre caracteres: la forma natural de leer una respuesta con tramas.
Eventos en el hilo que elijas
NotifyEvents encola OnData, OnOpen, OnClose y OnError en el hilo principal por defecto, puede sincronizarlos o puede lanzarlos directamente en el hilo lector para obtener la latencia más baja.
Escribe desde cualquier hilo
Write y WriteString se serializan mediante un bloqueo interno. Write devuelve los bytes escritos, WriteTimeout limita cuánto espera y WriteString envía los bytes UTF-8 de una cadena y lanza una excepción si no se pudieron escribir todos.
Cierra desde cualquier sitio
Close es seguro desde cualquier hilo, incluso desde dentro de un manejador de OnData. Despierta un Read bloqueado, cancela una escritura bloqueada y detiene el hilo lector, usando la cancelación de E/S solapada en Windows y un indicador de cancelación con poll en Linux y macOS.
Control de dirección RS-485
RtsControl := srcToggle activa RTS mientras el puerto transmite y lo desactiva después, de modo que un transceptor RS-485 libera el bus para la respuesta. Windows usa el modo de conmutación RTS del controlador y Linux el modo RS-485 del kernel en el controlador serie.
Líneas de módem
SetDTR y SetRTS controlan las líneas de salida; ModemStatus devuelve el conjunto de entradas activas: smsCTS, smsDSR, smsRI y smsDCD.
Detección de puertos
TsgcSerialPort.ListPorts añade los nombres de puerto a cualquier TStrings en orden natural (COM2 antes que COM10): desde el registro en Windows, /dev/ttyS*, /dev/ttyUSB* y /dev/ttyACM* en Linux, y /dev/cu.* en macOS.
Búferes bajo control
BufferCount indica cuántos bytes esperan en el búfer de recepción de 64 KB y Purge lo vacía junto con los búferes del sistema operativo. Si el búfer se desborda, se descartan los bytes más antiguos y OnError se dispara una vez.
Errores con el código del SO
Cada fallo lanza EsgcSerialError, cuyo ErrorCode contiene el error de Windows o el errno POSIX. Cuando se desconecta un adaptador USB, OnError se dispara una vez y el puerto espera a Close. En Linux y macOS el puerto se abre en modo exclusivo.
Plataformas
Qué admite cada sistema operativo
Un ajuste que la plataforma no puede realizar lanza EsgcSerialError en Open en lugar de ignorarse.
Característica
Windows
Linux
macOS
Velocidades en baudios
Cualquier velocidad que acepte el controlador
Velocidades estándar, de 50 a 4,000,000
Velocidades estándar, de 50 a 230,400
Paridad de marca y de espacio
Sí
Sí
No
Control de flujo RTS/CTS y XON/XOFF
Sí
Sí
Sí
Control de flujo DTR/DSR
Sí
No
No
Conmutación RTS para RS-485
Sí, modo de conmutación del controlador
Sí, modo RS-485 del kernel (requiere compatibilidad del controlador)
No
Lista de puertos
Registro
/dev/ttyS*, ttyUSB*, ttyACM*
/dev/cu.*
El componente está probado en un puerto COM real en Windows (32 y 64 bits) y en pseudoterminales en Linux de 64 bits; el mismo código compila para macOS. Android e iOS no son compatibles.
Modbus RTU
El transporte para Modbus RTU
TsgcSerialPort es también la línea serie de los componentes Modbus RTU para Delphi. Asigna un puerto abierto a la propiedad SerialPort de TsgcModbusRTUClient para sondear esclavos en un bus RS-485, o de TsgcModbusRTUServer para responder como esclavo. Los componentes Modbus se encargan del intervalo de trama de 3.5 caracteres, del CRC y de la dirección del esclavo; al puerto solo le hacen falta los ajustes de línea del bus, normalmente 19200 baudios, 8 bits de datos, paridad par y 1 bit de parada.
FAQ
Preguntas sobre el puerto serie en Delphi
Crea un TsgcSerialPort, establece Port (por ejemplo COM3), BaudRate, DataBits, Parity y StopBits, y asigna Active := True o llama a Open. Los puertos por encima de COM9 también funcionan con el nombre simple; el componente añade el prefijo \\.\ que necesita Windows.
Deja OnData sin asignar y llama a Read(Data, MaxCount, Timeout, InterCharTimeout). Espera hasta Timeout milisegundos el primer byte y devuelve cuando han llegado MaxCount bytes o no ha llegado ningún byte durante InterCharTimeout milisegundos. El resultado es el número de bytes leídos, y 0 significa que se agotó el tiempo. Solo un hilo debe llamar a Read a la vez.
Sí, con cualquier adaptador que el sistema operativo exponga como puerto serie: un puerto COM en Windows, /dev/ttyUSB* o /dev/ttyACM* en Linux, /dev/cu.* en macOS. Si el adaptador se desconecta con el puerto abierto, OnError se dispara una vez; llama a Close y abre el puerto de nuevo cuando el adaptador vuelva.
Los conversores con control automático de dirección no necesitan ningún ajuste. Para los conversores controlados por RTS, establece RtsControl := srcToggle: RTS se activa mientras el puerto transmite y se desactiva cuando el último byte ha salido. Windows lo hace en el controlador serie y Linux en el modo RS-485 del kernel, que el controlador serie debe admitir; de lo contrario, Open lanza un EsgcSerialError claro.
Las escrituras pueden venir de cualquier hilo y el componente las serializa. Close se puede llamar desde cualquier hilo, incluido el hilo lector dentro de un manejador de eventos. Las lecturas están pensadas para un solo llamador a la vez, que es como de todos modos usa una línea serie un protocolo de petición y respuesta.
Delphi 7 a Delphi 13 y C++Builder, en Windows de 32 y 64 bits, Linux de 64 bits y macOS. Android e iOS no son compatibles.
TsgcSerialPort está incluido en sgcWebSockets Enterprise (Delphi y .NET) y All-Access, o en el pack independiente sgcIndustrial, junto con los componentes Modbus.