シリアルポートコンポーネント

Delphi、C++Builder、.NET から RS-232 と RS-485 ポートを開きます。回線を設定し、データを書き込み、Windows、Linux、macOS 上でイベントまたはブロッキング読み取りで受信します。

新機能

TsgcSerialPort

バックグラウンドの読み取りスレッドと 64 KB の受信バッファを備えたシリアルポートで、Delphi、C++Builder、C# で同じ API を使えます。Modbus RTU クライアントとサーバーのトランスポートでもあります。

コンポーネントクラス

TsgcSerialPort

インターフェース

RS-232、RS-485、USB シリアルアダプター

プラットフォーム

Windows、Linux、macOS (Android と iOS は非対応)

エディション

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

ポートを開いてデータを受信する

ポート名と回線設定を指定し、イベントを割り当てて Open を呼び出します。OnData は到着したバイトのブロックごとにデータを受け取ります。

uses
  sgcIndustrial;

procedure TForm1.OpenPort;
begin
  FPort := TsgcSerialPort.Create(Self);
  FPort.Port := 'COM3';
  FPort.BaudRate := 19200;
  FPort.DataBits := 8;
  FPort.Parity := spEven;
  FPort.StopBits := ssOne;
  FPort.OnData := OnSerialData;
  FPort.OnError := OnSerialError;
  FPort.Open;
  FPort.WriteString('AT' + #13);
end;

procedure TForm1.OnSerialData(Sender: TObject; const aData: TBytes);
begin
  // queued to the main thread by default (NotifyEvents = neAsynchronous)
  Memo1.Lines.Add(IntToStr(Length(aData)) + ' bytes received');
end;

procedure TForm1.OnSerialError(Sender: TObject; const aError: string);
begin
  Memo1.Lines.Add('Error: ' + aError);
end;
#include "sgcIndustrial.hpp"

void __fastcall TForm1::OpenPort()
{
  FPort = new TsgcSerialPort(this);
  FPort->Port = "COM3";
  FPort->BaudRate = 19200;
  FPort->DataBits = 8;
  FPort->Parity = spEven;
  FPort->StopBits = ssOne;
  FPort->OnData = OnSerialData;
  FPort->OnError = OnSerialError;
  FPort->Open();
  FPort->WriteString("AT\r");
}

void __fastcall TForm1::OnSerialData(TObject *Sender, const TBytes aData)
{
  // queued to the main thread by default (NotifyEvents = neAsynchronous)
  Memo1->Lines->Add(IntToStr(aData.Length) + " bytes received");
}

void __fastcall TForm1::OnSerialError(TObject *Sender, const String aError)
{
  Memo1->Lines->Add("Error: " + aError);
}
using System;
using esegece.sgcWebSockets;

class SerialTerminal
{
    TsgcSerialPort FPort = new TsgcSerialPort();

    public void OpenPort()
    {
        FPort.Port = "COM3";
        FPort.BaudRate = 19200;
        FPort.DataBits = 8;
        FPort.Parity = TsgcSerialParity.spEven;
        FPort.StopBits = TsgcSerialStopBits.ssOne;
        FPort.OnData += OnSerialData;
        FPort.OnError += OnSerialError;
        FPort.Open();
        FPort.WriteString("AT\r");
    }

    void OnSerialData(object Sender, byte[] aData)
    {
        Console.WriteLine(aData.Length + " bytes received");
    }

    void OnSerialError(object Sender, string aError)
    {
        Console.WriteLine("Error: " + aError);
    }
}

主な機能

計測器、モデム、バーコードリーダー、はかり、フィールドバス向けの完全なシリアルポートです。

回線設定

BaudRate、DataBits (5 から 8)、Parity (none、odd、even、mark、space)、StopBits (1、1.5、2)、FlowControl (RTS/CTS または XON/XOFF)。無効な組み合わせは、ポートを開くときに EsgcSerialError を発生させます。

イベントまたはブロッキング読み取り

OnData を割り当てると、バイトのブロックはすべてイベントに渡されます。割り当てない場合、バイトは 64 KB のバッファに蓄えられ、Read が応答全体を返します。最初のバイトを待ち、指定した無通信時間の後に終了します。

RS-485 方向制御

RTS で方向を切り替えるアダプターには、RtsControl を srcToggle に設定します。Windows ではドライバーが送信中に RTS をアサートし、Linux ではカーネルの RS-485 モードが有効になります。.NET ではコンポーネントがトグルのタイミングを制御します。

ポートとモデムライン

TsgcSerialPort.ListPorts は、ポートを自然順 (COM2 が COM10 より前) で一覧表示します。SetDTR、SetRTS、ModemStatus でモデムラインを操作し、状態を読み取ります。

スレッドセーフ

Write は任意のスレッドから呼び出せます。Close は任意のスレッドから、イベントハンドラーからでも動作し、ブロック中の Read を起こします。Delphi と C++Builder ではイベントはデフォルトでメインスレッドにキューイングされ、NotifyEvents で変更できます。

明確なエラー

すべての失敗は EsgcSerialError を発生させ、オペレーティングシステムがエラーコードを報告した場合は ErrorCode にそのコードが格納されます。ポートを開いたままデバイスが取り外された場合や受信バッファがいっぱいになった場合は、OnError が発生します。

コマンドを送り、応答を読む

OnData を空のままにし、コマンドを書き込んで Read を呼び出します。最初のバイトを最大 1000 ms 待ち、デバイスが 50 ms 無通信になると戻ります。

procedure TForm1.QueryDevice;
var
  vData: TBytes;
  vCount: Integer;
begin
  // OnData is not assigned: the bytes wait in the receive buffer for Read
  FPort.Purge;
  FPort.WriteString('*IDN?' + #10);
  // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
  vCount := FPort.Read(vData, 256, 1000, 50);
  if vCount = 0 then
    Memo1.Lines.Add('No reply')
  else
    Memo1.Lines.Add(IntToStr(vCount) + ' bytes read');
end;
void __fastcall TForm1::QueryDevice()
{
  // OnData is not assigned: the bytes wait in the receive buffer for Read
  FPort->Purge();
  FPort->WriteString("*IDN?\n");
  // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
  TBytes vData;
  int vCount = FPort->Read(vData, 256, 1000, 50);
  if (vCount == 0)
    Memo1->Lines->Add("No reply");
  else
    Memo1->Lines->Add(IntToStr(vCount) + " bytes read");
}
using System;
using esegece.sgcWebSockets;

class SerialQuery
{
    TsgcSerialPort FPort = new TsgcSerialPort();

    public void QueryDevice()
    {
        // OnData is not assigned: the bytes wait in the receive buffer for Read
        FPort.Port = "COM3";
        FPort.Open();
        FPort.Purge();
        FPort.WriteString("*IDN?\n");
        // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
        byte[] vData = FPort.Read(256, 1000, 50);
        if (vData.Length == 0)
            Console.WriteLine("No reply");
        else
            Console.WriteLine(vData.Length + " bytes read");
    }
}

仕様・参考資料

このコンポーネントが基盤とするオペレーティングシステムのインターフェースです。

シリアルポートに関するよくある質問

Delphi と C++Builder では、Windows (Win32 と Win64) で Win32 通信 API、Linux64 と macOS で POSIX termios を使って動作します。Android と iOS では利用できません。.NET 版は System.IO.Ports をベースにしています。

バーコードリーダーやはかりのように、デバイスが自発的にデータを送る場合は OnData を使います。リクエストと応答のプロトコルでは Read を使います。コマンドを送り、デバイスが送信を止めるまで読みます。この 2 つは排他的です。OnData が割り当てられている間は Read が EsgcSerialError を発生させ、同時に Read を呼び出せるスレッドは 1 つだけです。

方向を自動で切り替えるアダプターには設定は不要です。RTS ラインで方向を切り替えるアダプターは、RtsControl を srcToggle に設定する必要があります。Linux ではコンポーネントがドライバーの RS-485 モードを有効にし、ドライバーが対応していない場合は EsgcSerialError を発生させます。macOS は srcToggle に対応していません。

sgcIndustrial パックの一部として sgcWebSockets Enterprise (Delphi と .NET) および All-Access に含まれています。Delphi では uses 句に sgcIndustrial を追加します。

ドキュメント・デモ

コンポーネントリファレンスへ直接移動し、デモプロジェクトを開いて、技術ドキュメントを読めます。

Online Help: TsgcSerialPort このコンポーネントのプロパティ、メソッド、イベントの完全なリファレンスです。
デモプロジェクト: Industrial\01.Serial_Port Delphi、C++Builder、.NET 向けのシリアルターミナルです。sgcWebSockets パッケージに同梱されています。
技術ドキュメント (PDF) このコンポーネントだけの機能、クイックスタート、コードサンプル、一次情報へのリファレンスです。
ユーザーマニュアル (PDF) ライブラリのすべてのコンポーネントを網羅した総合マニュアルです。
最もお得な選択: All-AccesseSeGeCe の全製品にプレミアムサポートが付いて、年間 €1,059 からご利用いただけます。
All-Access の価格を見る

sgcWebSockets Enterprise に含まれています

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