Componente de porta serial para Delphi no Windows, Linux e macOS
Um único componente não visual para portas COM, adaptadores seriais USB e barramentos RS-485. Receba com um evento ou com uma leitura bloqueante, grave a partir de qualquer thread e execute o mesmo código no Windows, Linux e macOS.
Incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, ou no pacote independente sgcIndustrial.
Um componente de porta serial que se comporta igual em qualquer lugar
Leitores de código de barras, balanças, receptores GPS, modems, instrumentos de laboratório e barramentos de campo RS-485, a partir de uma única classe Pascal.
Um componente de porta serial para Delphi precisa lidar com três sistemas operacionais que fazem E/S serial de formas diferentes: E/S sobreposta e configurações DCB no Windows, termios e descritores de arquivo no Linux e macOS. O TsgcSerialPort esconde tudo isso atrás de um único conjunto de propriedades (Port, BaudRate, DataBits, Parity, StopBits, FlowControl, RtsControl) e de um único conjunto de chamadas, de modo que uma aplicação VCL, FMX, serviço ou console abre COM3 no Windows e /dev/ttyUSB0 no Linux com o mesmo código.
Os dados chegam em uma thread de leitura em segundo plano. Atribua OnData para receber cada bloco como um evento, ou deixe-o vazio e os bytes vão para um buffer de recepção de 64 KB que você lê com Read, com um timeout para o primeiro byte e um timeout entre caracteres que encerra a mensagem. As gravações são serializadas pelo componente, então qualquer thread pode enviar.
Classe de componente
TsgcSerialPort, na unit sgcIndustrial
Nomes de porta
COM3, \\.\COM12, /dev/ttyUSB0 ou apenas ttyUSB0
Parâmetros da linha
5 a 8 bits de dados; paridade nenhuma, ímpar, par, mark ou space; 1, 1,5 ou 2 stop bits; controle de fluxo RTS/CTS, DTR/DSR ou XON/XOFF
Plataformas
Delphi 7 a Delphi 13 e C++Builder; Windows 32 e 64 bits, Linux 64 bits e macOS
QuickStart
Abra uma porta, envie um comando, leia a resposta
Três formas de usar o componente. Todos os exemplos compilam com Delphi 7 e 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;
Recursos
Os detalhes que tornam o código serial confiável
Threads, timeouts, buffers e adaptadores desconectados, tratados dentro do componente.
Evento ou leitura bloqueante
Com OnData atribuído, cada bloco recebido pela thread de leitura é entregue como um evento. Sem ele, Read(Data, MaxCount, Timeout, InterCharTimeout) espera pelo primeiro byte e retorna quando chegam MaxCount bytes ou quando a linha fica em silêncio pelo tempo entre caracteres: a forma natural de ler uma resposta com enquadramento.
Eventos na thread que você escolher
NotifyEvents enfileira OnData, OnOpen, OnClose e OnError para a thread principal por padrão, pode sincronizá-los ou pode dispará-los diretamente na thread de leitura para a menor latência.
Grave a partir de qualquer thread
Write e WriteString são serializados por um lock interno. Write retorna os bytes gravados, WriteTimeout limita quanto tempo ele espera, e WriteString envia os bytes UTF-8 de uma string e gera uma exceção se nem todos puderem ser gravados.
Feche de qualquer lugar
Close é seguro em qualquer thread, até mesmo dentro de um handler de OnData. Ele acorda um Read bloqueado, cancela uma gravação bloqueada e para a thread de leitura, usando cancelamento de E/S sobreposta no Windows e um flag de cancelamento com poll no Linux e macOS.
Controle de direção RS-485
RtsControl := srcToggle sobe o RTS enquanto a porta transmite e o derruba depois, de modo que um transceptor RS-485 libera o barramento para a resposta. O Windows usa o modo de RTS toggle do driver, o Linux usa o modo RS-485 do kernel no driver serial.
Linhas de modem
SetDTR e SetRTS controlam as linhas de saída; ModemStatus retorna o conjunto de entradas ativas: smsCTS, smsDSR, smsRI e smsDCD.
Descoberta de portas
TsgcSerialPort.ListPorts adiciona os nomes das portas a qualquer TStrings em ordem natural (COM2 antes de COM10): do registro no Windows, /dev/ttyS*, /dev/ttyUSB* e /dev/ttyACM* no Linux, e /dev/cu.* no macOS.
Buffers sob controle
BufferCount informa quantos bytes aguardam no buffer de recepção de 64 KB e Purge o esvazia junto com os buffers do sistema operacional. Se o buffer transbordar, os bytes mais antigos são descartados e OnError é disparado uma vez.
Erros com o código do SO
Toda falha gera EsgcSerialError, cujo ErrorCode contém o erro do Windows ou o errno POSIX. Quando um adaptador USB é desconectado, OnError é disparado uma vez e a porta aguarda Close. No Linux e no macOS a porta é aberta em modo exclusivo.
Plataformas
O que cada sistema operacional oferece
Uma configuração que a plataforma não suporta gera EsgcSerialError em Open em vez de ser ignorada.
Recurso
Windows
Linux
macOS
Baud rates
Qualquer taxa que o driver aceite
Taxas padrão, de 50 a 4.000.000
Taxas padrão, de 50 a 230.400
Paridade mark e space
Sim
Sim
Não
Controle de fluxo RTS/CTS e XON/XOFF
Sim
Sim
Sim
Controle de fluxo DTR/DSR
Sim
Não
Não
RTS toggle para RS-485
Sim, modo toggle do driver
Sim, modo RS-485 do kernel (requer suporte do driver)
Não
Lista de portas
Registro
/dev/ttyS*, ttyUSB*, ttyACM*
/dev/cu.*
O componente é testado em uma porta COM real no Windows (32 e 64 bits) e em pseudo terminais no Linux 64 bits; o mesmo código compila para macOS. Android e iOS não são suportados.
Modbus RTU
O transporte do Modbus RTU
O TsgcSerialPort também é a linha serial por baixo dos componentes Modbus RTU para Delphi. Atribua uma porta aberta à propriedade SerialPort de TsgcModbusRTUClient para consultar escravos em um barramento RS-485, ou de TsgcModbusRTUServer para responder como escravo. Os componentes Modbus cuidam do intervalo de quadro de 3,5 caracteres, do CRC e do endereço do escravo; a porta só precisa das configurações de linha do barramento, normalmente 19200 baud, 8 bits de dados, paridade par e 1 stop bit.
FAQ
Perguntas sobre porta serial em Delphi
Crie um TsgcSerialPort, defina Port (por exemplo COM3), BaudRate, DataBits, Parity e StopBits, e defina Active := True ou chame Open. Portas acima de COM9 também funcionam com o nome simples; o componente adiciona o prefixo \\.\ que o Windows exige.
Deixe OnData sem atribuição e chame Read(Data, MaxCount, Timeout, InterCharTimeout). Ele espera até Timeout milissegundos pelo primeiro byte e então retorna quando chegaram MaxCount bytes ou nenhum byte veio por InterCharTimeout milissegundos. O resultado é o número de bytes lidos, e 0 significa timeout. Apenas uma thread deve chamar Read por vez.
Sim, com qualquer adaptador que o sistema operacional exponha como porta serial: uma porta COM no Windows, /dev/ttyUSB* ou /dev/ttyACM* no Linux, /dev/cu.* no macOS. Se o adaptador for desconectado com a porta aberta, OnError é disparado uma vez; chame Close e abra a porta novamente quando o adaptador voltar.
Conversores com controle automático de direção não precisam de configuração. Para conversores acionados por RTS, defina RtsControl := srcToggle: o RTS sobe enquanto a porta transmite e cai quando o último byte sai. O Windows faz isso no driver serial e o Linux no modo RS-485 do kernel, que o driver serial precisa suportar; caso contrário Open gera um EsgcSerialError claro.
As gravações podem vir de qualquer thread e são serializadas pelo componente. Close pode ser chamado de qualquer thread, inclusive da thread de leitura dentro de um handler de evento. As leituras são pensadas para um chamador por vez, que é como um protocolo de requisição e resposta usa uma linha serial de qualquer maneira.
Delphi 7 a Delphi 13 e C++Builder, no Windows 32 e 64 bits, Linux 64 bits e macOS. Android e iOS não são suportados.
O TsgcSerialPort está incluído no sgcWebSockets Enterprise (Delphi e .NET) e All-Access, ou no pacote independente sgcIndustrial, junto com os componentes Modbus.