新機能

Windows、Linux、macOS 対応の Delphi シリアルポートコンポーネント

COM ポート、USB シリアルアダプタ、RS-485 バス向けの 1 つのビジュアルではないコンポーネントです。イベントまたはブロッキング読み取りで受信し、任意のスレッドから送信でき、Windows、Linux、macOS で同じコードが動作します。

sgcWebSockets Enterprise (Delphi と .NET) および All-Access、または単体の sgcIndustrial パックに含まれています。

どの環境でも同じように動作するシリアルポートコンポーネント

バーコードスキャナ、はかり、GPS 受信機、モデム、実験機器、RS-485 フィールドバスを、1 つの Pascal クラスで扱えます。

Delphi シリアルポートコンポーネントは、シリアル I/O の方式が異なる 3 つのオペレーティングシステムに対応する必要があります。Windows ではオーバーラップ I/O と DCB 設定、Linux と macOS では termios とファイルディスクリプタです。TsgcSerialPort はそのすべてを 1 組のプロパティ (Port、BaudRate、DataBits、Parity、StopBits、FlowControl、RtsControl) と 1 組の呼び出しの背後に隠すため、VCL、FMX、サービス、コンソールのいずれのアプリケーションでも、Windows では COM3、Linux では /dev/ttyUSB0 を同じコードで開けます。

データはバックグラウンドのリーダースレッドで受信されます。OnData を割り当てると、受信したチャンクごとにイベントとして通知されます。割り当てない場合、バイトは 64 KB の受信バッファに格納され、Read で読み取れます。最初のバイトを待つタイムアウトと、メッセージの終端を判断する文字間タイムアウトを指定できます。書き込みはコンポーネントが直列化するため、どのスレッドからでも送信できます。

コンポーネントクラス

sgcIndustrial ユニットの TsgcSerialPort

ポート名

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

ポートを開き、コマンドを送り、応答を読む

コンポーネントの 3 つの使い方です。すべてのサンプルは 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 バイトが届くか、回線が文字間時間のあいだ無音になった時点で戻ります。フレーム化された 1 つの応答を読むのに自然な方法です。

選択したスレッドでイベントを受け取る

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 が 1 回発生します。

OS のエラーコード付きのエラー

すべての失敗で EsgcSerialError が発生し、その ErrorCode には Windows のエラーまたは POSIX の errno が入ります。USB アダプタが取り外されると、OnError が 1 回発生し、ポートは 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 に割り当てるとスレーブとして応答できます。3.5 文字のフレーム間隔、CRC、スレーブアドレスは Modbus コンポーネントが処理するため、ポートにはバスの回線設定 (通常は 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 を同時に呼び出せるスレッドは 1 つだけです。

はい。オペレーティングシステムがシリアルポートとして認識するアダプタであれば動作します。Windows では COM ポート、Linux では /dev/ttyUSB* または /dev/ttyACM*、macOS では /dev/cu.* です。ポートを開いている間にアダプタが取り外されると OnError が 1 回発生します。Close を呼び出し、アダプタが戻ったらポートを開き直してください。

自動方向制御付きのコンバータには設定は不要です。RTS で制御するコンバータでは、RtsControl := srcToggle を設定してください。ポートが送信している間 RTS が上がり、最後のバイトが出ていった時点で下がります。Windows ではシリアルドライバ、Linux ではカーネルの RS-485 モードで処理され、シリアルドライバがこれに対応している必要があります。対応していない場合、Open は分かりやすい EsgcSerialError を発生させます。

書き込みは任意のスレッドから行え、コンポーネントが直列化します。Close は、イベントハンドラ内のリーダースレッドを含め、どのスレッドからでも呼び出せます。読み取りは一度に 1 つの呼び出し元を想定しており、リクエストとレスポンスのプロトコルがシリアル回線を使う方法とも一致します。

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 の 1 つのセクションにまとめています。

Delphi Modbus TCP と RTU

シリアル回線にこのコンポーネントを使用する Modbus クライアントとサーバー。

.NET 向け C# Modbus

.NET 版にも、Modbus コンポーネントと並んで TsgcSerialPort があります。

最もお得な選択: All-AccesseSeGeCe の全製品にプレミアムサポートが付いて、年間 €1,059 からご利用いただけます。
All-Access の価格を見る

Delphi で最初のシリアルデバイスに接続する

sgcWebSockets Enterprise (Delphi と .NET) および All-Access、または単体の sgcIndustrial パックに含まれています。