新機能

Delphi Modbus TCP と RTU: クライアントとサーバーコンポーネント

Delphi と C++Builder 向けのネイティブな Modbus TCP と Modbus RTU コンポーネントです。PLC、ドライブ、電力量計、ゲートウェイをポーリングしたり、Modbus サーバーとして独自のデータを公開したりでき、任意のワード順序に対応した Float32、Int32、文字列の型付きヘルパーを備えています。

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

2 つのクライアント、2 つのサーバー、1 つの Modbus API

Modbus TCP と Modbus RTU のマスターとスレーブを、Pascal で書かれアプリケーションにコンパイルされる非ビジュアルコンポーネントとして提供します。

Delphi Modbus ライブラリを使うと、VCL、FMX、サービス、コンソールアプリケーションが、あらゆる工場にある PLC、周波数ドライブ、電力量計、温度コントローラー、プロトコルゲートウェイなどのデバイスと通信できます。sgcWebSockets は 4 つのコンポーネントとして提供します。TsgcModbusTCPClient と TsgcModbusRTUClient はデバイスをポーリングし、TsgcModbusTCPServer と TsgcModbusRTUServer は独自のデータを SCADA システム、HMI、その他の Modbus マスターに公開します。

どちらのクライアントも TsgcModbusClient_Base を継承しているため、イーサネット経由でレジスタを読むコードは RS-485 経由でも同じように読めます。呼び出しではなくコンポーネントを入れ替えるだけです。各呼び出しは応答が届くか Timeout が切れるまでブロックし、値を Delphi の配列として返し、デバイスがエラーを報告したときは型付き例外を発生させます。uses sgcIndustrial; の 1 行ですべてのクラスが使えます。

コンポーネントクラス

TsgcModbusTCPClient, TsgcModbusRTUClient, TsgcModbusTCPServer, TsgcModbusRTUServer, TsgcModbusDataModel

トランスポート

オプションの TLS とプロキシを備えたポート 502 の Modbus TCP。TsgcSerialPort を通じた RS-232 と RS-485 上の Modbus RTU

ファンクションコード

01 から 08、15、16、22、23、43/14 (デバイス識別の読み取り)

プラットフォーム

Delphi 7 から Delphi 13 と C++Builder。Windows、Linux、macOS

一般的な Modbus ファンクションをすべて、1 つずつメソッドで提供

クライアントは何かを送信する前に数量を仕様と照合します。サーバーはこの表のすべてのコードに応答します。

FCファンクションクライアントメソッド
01Read CoilsReadCoils
02Read Discrete InputsReadDiscreteInputs
03Read Holding RegistersReadHoldingRegisters, ReadInt32, ReadUInt32, ReadFloat32, ReadString
04Read Input RegistersReadInputRegisters, ReadInputInt32, ReadInputUInt32, ReadInputFloat32
05Write Single CoilWriteSingleCoil
06Write Single RegisterWriteSingleRegister
07Read Exception Status (シリアル回線)RTU クライアントの ReadExceptionStatus
08Diagnostics (シリアル回線)RTU クライアントの Diagnostics
15Write Multiple CoilsWriteMultipleCoils
16Write Multiple RegistersWriteMultipleRegisters, WriteInt32, WriteUInt32, WriteFloat32, WriteString
22Mask Write RegisterMaskWriteRegister
23Read/Write Multiple RegistersReadWriteMultipleRegisters
43/14Read Device IdentificationReadDeviceIdentification (basic、regular、extended、単一オブジェクト)

数行の Delphi で PLC を読み取る

コンポーネントを作成し、アドレスを設定して、メソッドを呼び出します。このページのすべてのサンプルは Delphi 7 と Delphi 13 でコンパイルできます。

uses
  sgcIndustrial;

procedure TForm1.FormCreate(Sender: TObject);
begin
  Modbus := TsgcModbusTCPClient.Create(Self);
  Modbus.Host := '192.168.1.50';
  Modbus.Port := 502;
  Modbus.UnitId := 1;
  Modbus.Timeout := 2000;          // ms per attempt
  Modbus.Retries := 2;             // extra attempts after a timeout
  Modbus.WatchDog.Enabled := True; // reconnect after a network drop
  Modbus.OnConnect := ModbusConnect;
  Modbus.OnError := ModbusError;
  Modbus.Active := True;
end;

procedure TForm1.ModbusConnect(Sender: TObject);
begin
  Memo1.Lines.Add('connected');
end;

procedure TForm1.ModbusError(Sender: TObject; const aError: string);
begin
  Memo1.Lines.Add('error: ' + aError);
end;

procedure TForm1.btnReadClick(Sender: TObject);
var
  vRegisters: TsgcModbusRegisters;
  vCoils: TsgcModbusBits;
  i: Integer;
begin
  vRegisters := Modbus.ReadHoldingRegisters(0, 10); // FC 03
  for i := 0 to Length(vRegisters) - 1 do
    Memo1.Lines.Add(Format('HR%d = %d', [i, vRegisters[i]]));

  vCoils := Modbus.ReadCoils(0, 8);                 // FC 01
  if vCoils[0] then
    Memo1.Lines.Add('coil 0 is on');

  Modbus.WriteSingleRegister(100, 1234);            // FC 06
  Modbus.WriteSingleCoil(5, True);                  // FC 05
end;
procedure TForm1.btnTypedClick(Sender: TObject);
var
  vTemperature: Single;
  vCounter: Integer;
  vName: TsgcModbusAnsiString;
begin
  Modbus.WordOrder := mwoCDAB;              // low word first
  vTemperature := Modbus.ReadFloat32(200);  // 2 holding registers
  vCounter := Modbus.ReadInt32(202);
  vName := Modbus.ReadString(300, 8);       // 8 registers, 16 characters
  Memo1.Lines.Add(Format('%s: %.1f C, %d cycles',
    [string(vName), vTemperature, vCounter]));

  Modbus.WriteFloat32(210, 21.5);
  Modbus.WriteUInt32(212, 3000000000);

  // explicit unit id, for a gateway with several devices behind it
  Memo1.Lines.Add(FloatToStr(Modbus.ReadInputFloat32(7, 0))); // unit 7, FC 04

  try
    Modbus.ReadHoldingRegisters(9000, 4);
  except
    on E: EsgcModbusException do // the device answered with an exception
      Memo1.Lines.Add(Format('exception %d, function %d',
        [E.ExceptionCode, E.FunctionCode]));
    on E: EsgcModbusTimeout do   // no answer after Retries + 1 attempts
      Memo1.Lines.Add(E.Message);
  end;
end;
procedure TForm1.FormCreate(Sender: TObject);
begin
  Serial := TsgcSerialPort.Create(Self);
  Serial.Port := 'COM3';          // '/dev/ttyUSB0' on Linux
  Serial.BaudRate := 19200;
  Serial.Parity := spEven;        // 8E1, the Modbus RTU default
  Serial.RtsControl := srcToggle; // RS-485: RTS switches the transmitter
  Serial.Active := True;

  RTU := TsgcModbusRTUClient.Create(Self);
  RTU.SerialPort := Serial;
  RTU.UnitId := 17;               // slave address
  RTU.Timeout := 500;
  RTU.Retries := 1;
end;

procedure TForm1.btnPollClick(Sender: TObject);
var
  vValues: TsgcModbusRegisters;
begin
  vValues := RTU.ReadInputRegisters(0, 4);                      // FC 04
  Memo1.Lines.Add(Format('IR0 = %d', [vValues[0]]));
  Memo1.Lines.Add(Format('status = %d', [RTU.ReadExceptionStatus])); // FC 07
  RTU.WriteSingleRegister(0, 10, 500); // unit 0: broadcast to every slave, no reply
end;
procedure TForm1.FormCreate(Sender: TObject);
begin
  Server := TsgcModbusTCPServer.Create(Self);
  Server.Port := 502;
  Server.UnitId := 0;                          // answer every unit id
  Server.DataModel.HoldingRegisterCount := 1000;
  Server.DataModel.SetHoldingRegister(0, 42);
  Server.DataModel.SetCoil(0, True);
  Server.DataModel.VendorName := 'My Company'; // FC 43/14 identification
  Server.DataModel.ProductCode := 'GW-100';
  Server.OnReadRequest := ServerReadRequest;
  Server.OnWriteRequest := ServerWriteRequest;
  Server.Active := True;
end;

// runs in the connection thread, before the table is read
procedure TForm1.ServerReadRequest(Sender: TObject; aUnitId, aFunctionCode: Byte;
  aAddress, aCount: Word; var aExceptionCode: Byte);
begin
  if aFunctionCode = CS_MODBUS_FC_READ_INPUT_REGISTERS then
    Server.DataModel.SetInputRegister(0, Random(1000)); // fresh value
end;

// registers 0..9 are read only
procedure TForm1.ServerWriteRequest(Sender: TObject; aUnitId, aFunctionCode: Byte;
  aAddress, aCount: Word; var aBits: TsgcModbusBits;
  var aRegisters: TsgcModbusRegisters; var aExceptionCode: Byte);
begin
  if (Length(aRegisters) > 0) and (aAddress < 10) then
    aExceptionCode := CS_MODBUS_EX_ILLEGAL_DATA_ADDRESS;
end;

任意のスレッドから呼び出せる Modbus マスター

TCP でもシリアル回線でも、ブロッキング呼び出し、型付き値、明確なエラーを提供します。

型付きの 32 ビット値と文字列

ReadFloat32、ReadInt32、ReadUInt32 とそれらの書き込み用および入力レジスタ用メソッドは、2 つのレジスタを 1 つの値にまとめます。WordOrder はデバイスが使う 4 つのレイアウトに対応しています。mwoABCD (ビッグエンディアン、Modbus のデフォルト)、mwoCDAB、mwoBADC、mwoDCBA です。ReadString と WriteString は 1 レジスタに 2 文字を格納します。

スレッドセーフなブロッキング呼び出し

クライアントごとに一度に実行されるリクエストは 1 つで、すべてのリトライを含めてロックで保護されるため、複数のスレッドが 1 つの接続を共有できます。TCP では受信スレッドが応答を対応付けるので、メインスレッドからの呼び出しでもデッドロックしません。

タイムアウトとリトライ

Timeout は 1 回の試行あたりの待機時間、Retries は追加の試行回数です。TCP のリトライは新しいトランザクション ID を使い、遅れて届いた応答や重複した応答は、次の応答と取り違えられることなく破棄されます。

型付き例外

EsgcModbusException はデバイスの ExceptionCode と FunctionCode を保持し、EsgcModbusTimeout は応答がないことを報告し、EsgcModbusError は接続が閉じられた場合から CRC が不正な RTU フレームまで、その他すべてを扱います。

呼び出しごとのユニット ID

すべてのメソッドには先頭にユニット ID を取るオーバーロードもあり、ゲートウェイへの 1 つの接続でその先にあるすべてのデバイスにアクセスできます。UnitId は、ユニット ID なしの呼び出しで使われるデフォルト値です。

TCP での TLS、プロキシ、再接続

TLS と TLSOptions は Modbus TCP ストリームを TLS で包み、Proxy は HTTP または SOCKS プロキシ経由でデバイスに到達し、WatchDog はネットワーク切断後に再接続します。この 3 つはすべて、コンポーネントの基盤である sgcWebSockets の TCP クライアントから提供されます。

RTU フレーミングを正しく処理

RTU クライアントは、送信前に 3.5 文字分の無通信時間を待ち、期待される長さで応答を読み取り (USB アダプターはバイトをバースト状に届けます)、すべてのフレームの CRC を確認し、他のスレーブアドレスのフレームを無視します。

RS-485 とブロードキャスト

シリアルポートに RtsControl := srcToggle を設定すると、書き込みのたびに RTS が RS-485 トランスミッターを切り替えます。Windows ではドライバー経由、Linux ではカーネルの RS-485 モードで動作します。ユニット ID 0 は全スレーブへのブロードキャスト書き込みを送信し、応答の代わりに TurnaroundDelay の間待機します。

好きな場所でイベントを受け取る

OnConnect、OnDisconnect、OnError は NotifyEvents で配信方法を選べます。デフォルトではメインスレッドにキューイングされ、同期させることも、受信スレッドで直接発生させることもできます。

ライブデータモデルを備えた Modbus TCP と RTU サーバー

Delphi アプリケーションを Modbus スレーブにできます。データベースや REST API の値を公開するゲートウェイ、HMI 画面をテストするデバイスシミュレーター、独自のコントローラーの Modbus インターフェースなどが作れます。各サーバーは TsgcModbusDataModel を持ち、4 つの Modbus テーブル (コイル、ディスクリート入力、ホールディングレジスタ、入力レジスタ。デフォルトでそれぞれ 10,000 エントリ、最大 65,536)、FC 43/14 で応答するデバイス識別文字列、FC 07 で応答する例外ステータスを保持します。

データモデルはスレッドセーフです。1 つのロックがすべてのテーブルを保護するため、クライアントが読み取っている間にコードから値を更新できます。リクエストの経路にコードを挿入する 2 つのフックがあります。OnReadRequest はテーブルが読み取られる前に実行されるため、値をその場で更新したり、例外コードでリクエストを拒否したりできます。OnWriteRequest は値が保存される前に受け取るため、検証、変更、または書き込みの拒否ができ、拒否した場合テーブルは変更されません。

TsgcModbusTCPServer

多数の同時接続を、それぞれ専用のスレッドで処理します。1 つのパケットにまとめて届いたリクエストには順番に応答し、複数のパケットに分割されたリクエストは再構成され、不正なヘッダーはその接続を閉じて OnError を発生させます。UnitId = 0 はすべてのユニット ID に応答し、他の値はその ID にだけ応答します。Bindings でインターフェースとポートを選択し、OnClientConnect と OnClientDisconnect が接続相手を通知します。

TsgcModbusRTUServer

TsgcSerialPort でスレーブ UnitId (1 から 247) として待ち受けます。期待される長さと 3.5 文字分の無通信時間でリクエストをフレーム化し、CRC が不正なフレームや他のアドレスのフレームを無視し、シリアル回線の仕様どおり、ユニット ID 0 からのブロードキャスト書き込みは応答せずに実行します。

接続スレッド内のフック

サーバーイベントは接続スレッド (TCP) またはフレームスレッド (RTU) で実行され、結果を同期的に返します。処理は短く保ってください。データモデルのメソッドは自由に呼び出せます。フックはロックを保持しない状態で実行されるためです。

独立した Modbus スタックを相手にテスト済み

Modbus クライアントとサーバーは、独立したオープンソース実装である pymodbus を相手に、Modbus TCP の通信上でテストされています。ファンクションコード 01 から 06、15、16、22、23、43/14、例外応答、Float32 値、デバイス識別が対象です。型付きヘルパーは、4 つのワード順序すべてで既知のバイト列と照合して確認しています。Delphi コンポーネントは sgcWebSockets .NET の Modbus コンポーネントとも、クライアントからサーバー、サーバーからクライアントの両方向でテストされ、それぞれ 35 項目中 35 項目に合格しています。

シリアルポートは、Windows では実際の COM ポート、Linux では疑似端末でテストされており、読み取りの待機中にポートを閉じるケースも含まれます。Modbus RTU クライアントとサーバーは、シミュレートしたスレーブとマスターでテストされています。分割されたフレーム、CRC エラー、他のスレーブアドレス、ブロードキャストが対象です。同じコードは macOS でもコンパイルできます。

Delphi Modbus に関するよくある質問

TsgcModbusTCPClient を作成し、Host、Port (デフォルトは 502)、UnitId を設定して Active := True とし、ReadHoldingRegisters(Address, Count) を呼び出します。レジスタごとに 1 つの Word を持つ TsgcModbusRegisters 配列が返されます。アドレスは通信上の値と同じく 0 から始まります。

2 つのレジスタのうち最初のレジスタのアドレスを指定して ReadFloat32、ReadInt32、ReadUInt32 を呼び出します。入力レジスタには ReadInput... 系のメソッドを使います。値がおかしい場合は、デバイスが別のワード順序を使っています。デフォルトの mwoABCD ではなく、WordOrder を mwoCDAB、mwoBADC、mwoDCBA に設定してください。

はい。アダプターで TsgcSerialPort を開き、TsgcModbusRTUClient または TsgcModbusRTUServer の SerialPort プロパティに割り当てます。方向を自動で制御するアダプターには、他の設定は不要です。RTS でトランスミッターを切り替えるアダプターでは RtsControl := srcToggle を設定します。Windows ではドライバーの RTS トグルモード、Linux ではカーネルの RS-485 モードが使われます。

はい。クライアントは一度に 1 つのトランザクションを実行し、リトライを含むリクエスト全体の間ロックを保持するため、複数のスレッドからの呼び出しは順番に処理され、それぞれが自分の応答を受け取ります。メインスレッドからの呼び出しでもデッドロックしません。TCP では応答を別のスレッドが受信するためです。

TsgcModbusTCPServer (シリアルポートを使う場合は TsgcModbusRTUServer) を配置し、SetHoldingRegister、SetCoil などのセッターで DataModel に値を設定して、Active := True とします。OnReadRequest と OnWriteRequest を使うと、値をオンデマンドで計算したり、Modbus 例外コードで書き込みを拒否したりできます。

Delphi 7 から Delphi 13 と C++Builder、Windows (32 ビットと 64 ビット)、Linux 64 ビット、macOS に対応しています。シリアルポート、したがって Modbus RTU は、Android と iOS では利用できません。

Modbus とシリアルポートのコンポーネントは、sgcWebSockets Enterprise (Delphi と .NET) および All-Access、または単体の sgcIndustrial パックに含まれています。

sgcWebSockets のその他の産業用コンポーネント

産業用コンポーネント

シリアルポート、Modbus、OPC UA クライアントを 1 つのセクションにまとめ、完全なコンポーネントリファレンスを提供します。

Modbus クライアントリファレンス

TsgcModbusTCPClient と TsgcModbusRTUClient のプロパティ、メソッド、イベントです。

Modbus サーバーリファレンス

TsgcModbusTCPServer、TsgcModbusRTUServer、TsgcModbusDataModel のフックです。

Delphi シリアルポート

Windows、Linux、macOS 向けの TsgcSerialPort。Modbus RTU のトランスポートであり、単独のシリアルコンポーネントとしても使えます。

Delphi MQTT クライアント

Modbus の値を MQTT ブローカーにパブリッシュします。工場のデータをクラウドへ届ける定番の方法です。

C# と .NET にも対応

同じクラス名を持つ同じ Modbus クライアントとサーバーを、.NET 8、9、10、.NET Standard 2.0 向けに提供します。

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

Delphi から最初の PLC と通信する

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