Componente porta seriale Delphi per Windows, Linux e macOS
Un unico componente non visuale per porte COM, adattatori seriali USB e bus RS-485. Ricevi i dati con un evento o con una lettura bloccante, scrivi da qualsiasi thread ed esegui lo stesso codice su Windows, Linux e macOS.
Incluso in sgcWebSockets Enterprise (Delphi e .NET) e All-Access, oppure nel pacchetto standalone sgcIndustrial.
Un componente per la porta seriale che si comporta allo stesso modo ovunque
Lettori di codici a barre, bilance, ricevitori GPS, modem, strumenti di laboratorio e bus di campo RS-485, da un'unica classe Pascal.
Un componente porta seriale per Delphi deve gestire tre sistemi operativi che eseguono l'I/O seriale in modi diversi: I/O overlapped e impostazioni DCB su Windows, termios e file descriptor su Linux e macOS. TsgcSerialPort nasconde tutto dietro un unico insieme di proprietà (Port, BaudRate, DataBits, Parity, StopBits, FlowControl, RtsControl) e un unico insieme di chiamate, così un'applicazione VCL, FMX, un servizio o una console apre COM3 su Windows e /dev/ttyUSB0 su Linux con lo stesso codice.
I dati arrivano in un thread di lettura in background. Assegna OnData per ricevere ogni blocco come evento, oppure lascialo vuoto e i byte finiscono in un buffer di ricezione da 64 KB che si legge con Read, con un timeout per il primo byte e un timeout tra caratteri che chiude il messaggio. Le scritture sono serializzate dal componente, quindi qualsiasi thread può inviare.
Classe del componente
TsgcSerialPort, nell'unit sgcIndustrial
Nomi delle porte
COM3, \\.\COM12, /dev/ttyUSB0 o semplicemente ttyUSB0
Impostazioni della linea
Da 5 a 8 bit di dati; parità nessuna, dispari, pari, mark o space; 1, 1,5 o 2 bit di stop; controllo di flusso RTS/CTS, DTR/DSR o XON/XOFF
Piattaforme
Da Delphi 7 a Delphi 13 e C++Builder; Windows a 32 e 64 bit, Linux a 64 bit e macOS
QuickStart
Apri una porta, invia un comando, leggi la risposta
Tre modi di usare il componente. Ogni esempio si compila con 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;
Funzionalità
I dettagli che rendono affidabile il codice seriale
Thread, timeout, buffer e adattatori scollegati, gestiti all'interno del componente.
Evento o lettura bloccante
Con OnData assegnato, ogni blocco ricevuto dal thread di lettura viene consegnato come evento. Senza, Read(Data, MaxCount, Timeout, InterCharTimeout) attende il primo byte, poi termina quando sono arrivati MaxCount byte o la linea è rimasta in silenzio per il tempo tra caratteri: il modo naturale per leggere una risposta strutturata in un frame.
Eventi sul thread che scegli
NotifyEvents accoda OnData, OnOpen, OnClose e OnError al thread principale per impostazione predefinita, può sincronizzarli oppure sollevarli direttamente nel thread di lettura per la latenza minima.
Scrivi da qualsiasi thread
Write e WriteString sono serializzati da un lock interno. Write restituisce i byte scritti, WriteTimeout limita il tempo di attesa e WriteString invia i byte UTF-8 di una stringa e solleva un'eccezione se non è stato possibile scriverli tutti.
Chiudi da ovunque
Close è sicuro da qualsiasi thread, anche dall'interno di un gestore OnData. Risveglia una Read bloccata, annulla una scrittura bloccata e ferma il thread di lettura, usando l'annullamento dell'I/O overlapped su Windows e un flag di annullamento con poll su Linux e macOS.
Controllo della direzione RS-485
RtsControl := srcToggle alza RTS mentre la porta trasmette e lo abbassa subito dopo, così un transceiver RS-485 libera il bus per la risposta. Windows usa la modalità RTS toggle del driver, Linux la modalità RS-485 del kernel nel driver seriale.
Linee modem
SetDTR e SetRTS pilotano le linee di uscita; ModemStatus restituisce l'insieme degli ingressi attivi: smsCTS, smsDSR, smsRI e smsDCD.
Rilevamento delle porte
TsgcSerialPort.ListPorts aggiunge i nomi delle porte a qualsiasi TStrings in ordine naturale (COM2 prima di COM10): dal registro su Windows, /dev/ttyS*, /dev/ttyUSB* e /dev/ttyACM* su Linux e /dev/cu.* su macOS.
Buffer sotto controllo
BufferCount indica quanti byte attendono nel buffer di ricezione da 64 KB e Purge lo svuota insieme ai buffer del sistema operativo. Se il buffer va in overflow, i byte più vecchi vengono scartati e OnError scatta una sola volta.
Errori con il codice del sistema operativo
Ogni errore solleva EsgcSerialError, il cui ErrorCode contiene l'errore di Windows o l'errno POSIX. Quando un adattatore USB viene scollegato, OnError scatta una sola volta e la porta attende Close. Su Linux e macOS la porta viene aperta in modalità esclusiva.
Piattaforme
Cosa supporta ciascun sistema operativo
Un'impostazione che la piattaforma non può eseguire solleva EsgcSerialError in Open invece di essere ignorata.
Funzionalità
Windows
Linux
macOS
Baud rate
Qualsiasi velocità accettata dal driver
Velocità standard, da 50 a 4.000.000
Velocità standard, da 50 a 230.400
Parità mark e space
Sì
Sì
No
Controllo di flusso RTS/CTS e XON/XOFF
Sì
Sì
Sì
Controllo di flusso DTR/DSR
Sì
No
No
RTS toggle RS-485
Sì, modalità toggle del driver
Sì, modalità RS-485 del kernel (richiede il supporto del driver)
No
Elenco delle porte
Registro
/dev/ttyS*, ttyUSB*, ttyACM*
/dev/cu.*
Il componente è testato su una porta COM reale su Windows (32 e 64 bit) e su pseudo terminali su Linux a 64 bit; lo stesso codice si compila per macOS. Android e iOS non sono supportati.
Modbus RTU
Il trasporto per Modbus RTU
TsgcSerialPort è anche la linea seriale sotto i componenti Modbus RTU per Delphi. Assegna una porta aperta alla proprietà SerialPort di TsgcModbusRTUClient per interrogare gli slave su un bus RS-485, oppure di TsgcModbusRTUServer per rispondere come slave. I componenti Modbus gestiscono l'intervallo di 3,5 caratteri tra i frame, il CRC e l'indirizzo dello slave; alla porta servono solo le impostazioni di linea del bus, in genere 19200 baud, 8 bit di dati, parità pari e 1 bit di stop.
FAQ
Domande sulla porta seriale Delphi
Crea un TsgcSerialPort, imposta Port (per esempio COM3), BaudRate, DataBits, Parity e StopBits, quindi imposta Active := True oppure chiama Open. Anche le porte oltre COM9 funzionano con il nome semplice; il componente aggiunge il prefisso \\.\ richiesto da Windows.
Lascia OnData non assegnato e chiama Read(Data, MaxCount, Timeout, InterCharTimeout). Attende fino a Timeout millisecondi il primo byte, poi termina quando sono arrivati MaxCount byte o non è arrivato nessun byte per InterCharTimeout millisecondi. Il risultato è il numero di byte letti, e 0 indica un timeout. Solo un thread alla volta dovrebbe chiamare Read.
Sì, con qualsiasi adattatore che il sistema operativo espone come porta seriale: una porta COM su Windows, /dev/ttyUSB* o /dev/ttyACM* su Linux, /dev/cu.* su macOS. Se l'adattatore viene scollegato mentre la porta è aperta, OnError scatta una sola volta; chiama Close e riapri la porta quando l'adattatore è di nuovo collegato.
I convertitori con controllo automatico della direzione non richiedono alcuna impostazione. Per i convertitori comandati da RTS, imposta RtsControl := srcToggle: RTS viene alzato mentre la porta trasmette e abbassato quando l'ultimo byte è uscito. Windows lo fa nel driver seriale e Linux nella modalità RS-485 del kernel, che il driver seriale deve supportare; altrimenti Open solleva un chiaro EsgcSerialError.
Le scritture possono arrivare da qualsiasi thread e sono serializzate dal componente. Close può essere chiamato da qualsiasi thread, compreso il thread di lettura all'interno di un gestore di eventi. Le letture sono pensate per un chiamante alla volta, che è comunque il modo in cui un protocollo richiesta e risposta usa una linea seriale.
Da Delphi 7 a Delphi 13 e C++Builder, su Windows a 32 e 64 bit, Linux a 64 bit e macOS. Android e iOS non sono supportati.
TsgcSerialPort è incluso in sgcWebSockets Enterprise (Delphi e .NET) e All-Access, oppure nel pacchetto standalone sgcIndustrial, insieme ai componenti Modbus.