新增

适用于 Windows、Linux 和 macOS 的 Delphi 串口组件

一个非可视组件,用于 COM 端口、USB 串口适配器和 RS-485 总线。可通过事件或阻塞读取接收数据,可在任意线程写入,并在 Windows、Linux 和 macOS 上运行同一份代码。

包含在 sgcWebSockets Enterprise(Delphi 和 .NET)和 All-Access 或独立的 sgcIndustrial 软件包中。

在所有平台上行为一致的串口组件

条码扫描器、电子秤、GPS 接收器、调制解调器、实验室仪器和 RS-485 现场总线,都可以通过一个 Pascal 类来访问。

一个 Delphi 串口组件需要应对三种操作系统各自不同的串口 I/O 方式:Windows 上的重叠 I/O 和 DCB 设置,Linux 和 macOS 上的 termios 和文件描述符。TsgcSerialPort 把这些都封装在同一组属性(Port、BaudRate、DataBits、Parity、StopBits、FlowControl、RtsControl)和同一组调用之后,因此 VCL、FMX、服务或控制台应用程序可以用相同的代码在 Windows 上打开 COM3,在 Linux 上打开 /dev/ttyUSB0。

数据由后台读取线程接收。为 OnData 赋值即可把每个数据块作为事件接收;若不赋值,字节会进入 64 KB 接收缓冲区,由 Read 读取,可设置首字节超时和用于结束消息的字符间超时。写入由组件串行化,因此任何线程都可以发送。

组件类

TsgcSerialPort,位于 sgcIndustrial 单元

端口名称

COM3、\\.\COM12、/dev/ttyUSB0,或直接写 ttyUSB0

线路参数

5 到 8 位数据位;无、奇、偶、标记或空格校验;1、1.5 或 2 位停止位;RTS/CTS、DTR/DSR 或 XON/XOFF 流控

平台

Delphi 7 到 Delphi 13 和 C++Builder;Windows 32 位和 64 位、Linux 64 位以及 macOS

打开端口,发送命令,读取应答

三种使用组件的方式。每个示例都可以在 Delphi 7 和 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 = 0 then
    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;

让串口代码可靠运行的细节

线程、超时、缓冲区和被拔出的适配器,都在组件内部处理。

事件或阻塞读取

为 OnData 赋值后,读取线程收到的每个数据块都会作为事件传递。不赋值时,Read(Data, MaxCount, Timeout, InterCharTimeout) 会等待首字节,然后在收到 MaxCount 个字节或线路在字符间时间内保持静默时返回:这是读取一帧应答的自然方式。

在您选择的线程上触发事件

NotifyEvents 默认把 OnData、OnOpen、OnClose 和 OnError 排队到主线程,也可以同步触发,或直接在读取线程中触发以获得最低延迟。

在任意线程写入

Write 和 WriteString 由内部锁串行化。Write 返回已写入的字节数,WriteTimeout 限制等待时间,WriteString 发送字符串的 UTF-8 字节,如果未能全部写出则抛出异常。

可在任何位置关闭

Close 可以在任意线程中安全调用,甚至可以在 OnData 处理程序内部调用。它会唤醒被阻塞的 Read,取消被阻塞的写入并停止读取线程,在 Windows 上使用重叠 I/O 取消,在 Linux 和 macOS 上使用取消标志加 poll。

RS-485 方向控制

RtsControl := srcToggle 在端口发送期间拉高 RTS,发送完成后拉低,使 RS-485 收发器释放总线以接收应答。Windows 使用驱动程序的 RTS 切换模式,Linux 使用串口驱动的内核 RS-485 模式。

调制解调器信号线

SetDTR 和 SetRTS 驱动输出线路;ModemStatus 返回当前有效输入的集合:smsCTS、smsDSR、smsRI 和 smsDCD。

端口发现

TsgcSerialPort.ListPorts 按自然顺序(COM2 在 COM10 之前)把端口名称添加到任意 TStrings:在 Windows 上来自注册表,在 Linux 上为 /dev/ttyS*、/dev/ttyUSB* 和 /dev/ttyACM*,在 macOS 上为 /dev/cu.*。

可控的缓冲区

BufferCount 返回 64 KB 接收缓冲区中等待读取的字节数,Purge 会清空它以及操作系统缓冲区。缓冲区溢出时,最旧的字节会被丢弃,并触发一次 OnError。

附带操作系统错误码的错误

每次失败都会抛出 EsgcSerialError,其 ErrorCode 保存 Windows 错误码或 POSIX errno。USB 适配器被拔出时,OnError 触发一次,端口等待 Close。在 Linux 和 macOS 上,端口以独占模式打开。

各操作系统支持的功能

平台不支持的设置会在 Open 时抛出 EsgcSerialError,而不是被忽略。

功能WindowsLinuxmacOS
波特率驱动程序接受的任意速率标准速率,50 到 4,000,000标准速率,50 到 230,400
标记和空格校验是是否
RTS/CTS 和 XON/XOFF 流控是是是
DTR/DSR 流控是否否
RS-485 RTS 切换是,驱动程序切换模式是,内核 RS-485 模式(需要驱动程序支持)否
端口列表注册表/dev/ttyS*, ttyUSB*, ttyACM*/dev/cu.*

该组件已在 Windows(32 位和 64 位)的真实 COM 端口上以及 Linux 64 位的伪终端上测试;同一份代码可在 macOS 上编译。不支持 Android 和 iOS。

Modbus RTU 的传输层

TsgcSerialPort 同时也是 Delphi Modbus RTU 组件的串行线路。把已打开的端口赋给 TsgcModbusRTUClient 的 SerialPort 属性,即可轮询 RS-485 总线上的从站;赋给 TsgcModbusRTUServer,则可作为从站应答。Modbus 组件负责处理 3.5 字符帧间隔、CRC 和从站地址;端口只需要总线的线路设置,通常为 19200 波特、8 位数据位、偶校验和 1 位停止位。

Delphi 串口常见问题

创建 TsgcSerialPort,设置 Port(例如 COM3)、BaudRate、DataBits、Parity 和 StopBits,然后设置 Active := True 或调用 Open。COM9 以上的端口直接使用普通名称即可,组件会自动添加 Windows 所需的 \\.\ 前缀。

不为 OnData 赋值,直接调用 Read(Data, MaxCount, Timeout, InterCharTimeout)。它最多等待 Timeout 毫秒以获取首字节,然后在收到 MaxCount 个字节或 InterCharTimeout 毫秒内没有新字节时返回。返回值为读取的字节数,0 表示超时。同一时间只应有一个线程调用 Read。

支持,任何被操作系统识别为串口的适配器都可以:Windows 上为 COM 端口,Linux 上为 /dev/ttyUSB* 或 /dev/ttyACM*,macOS 上为 /dev/cu.*。如果端口打开时适配器被拔出,OnError 触发一次;请调用 Close,待适配器重新插入后再次打开端口。

具有自动方向控制的转换器无需任何设置。对于由 RTS 控制的转换器,请设置 RtsControl := srcToggle:端口发送时拉高 RTS,最后一个字节发出后拉低。Windows 在串口驱动中完成这一操作,Linux 使用内核 RS-485 模式(需要串口驱动支持),否则 Open 会抛出明确的 EsgcSerialError。

写入可以来自任意线程,由组件串行化。Close 可以从任意线程调用,包括事件处理程序中的读取线程。读取设计为同一时间只由一个调用方执行,这也正是请求和应答协议使用串行线路的方式。

Delphi 7 到 Delphi 13 和 C++Builder,支持 Windows 32 位和 64 位、Linux 64 位以及 macOS。不支持 Android 和 iOS。

TsgcSerialPort 与 Modbus 组件一起包含在 sgcWebSockets Enterprise(Delphi 和 .NET)和 All-Access 或独立的 sgcIndustrial 软件包中。

sgcWebSockets 中更多的工业组件

串口参考

TsgcSerialPort 的所有属性、方法和事件。

工业组件

串口、Modbus 和 OPC UA,集中在 sgcWebSockets 的同一个栏目中。

Delphi Modbus TCP 和 RTU

使用本组件作为串行线路的 Modbus 客户端和服务器。

适用于 .NET 的 C# Modbus

.NET 版本同样提供 TsgcSerialPort,与 Modbus 组件配合使用。

超值之选:All-AccesseSeGeCe 全部产品,含高级支持,每年 €1,059 起。
查看 All-Access 价格

从 Delphi 连接您的第一个串口设备

包含在 sgcWebSockets Enterprise(Delphi 和 .NET)和 All-Access 或独立的 sgcIndustrial 软件包中。