C# と .NET 新機能

.NET 向け C# Modbus TCP・RTU ライブラリ

イーサネットまたは RS-485 経由で、C# から PLC、ドライブ、メーターの読み書きを行ったり、Modbus スレーブとして独自のデータを提供したりできます。

Modbus TCP と Modbus RTU
クライアントとサーバー
任意のワード順に対応した Float32、Int32、文字列
スレッドセーフなブロッキング呼び出し

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

C# でデバイスを読み書きする → · Modbus のよくある質問 →

C# Modbus TCP クライアント
using esegece.sgcWebSockets;

var modbus = new TsgcModbusTCPClient();
modbus.Host = "192.168.1.50";
modbus.Port = 502;
modbus.Active = true;

ushort[] registers = modbus.ReadHoldingRegisters(0, 10);  // FC 03
float temperature = modbus.ReadFloat32(200);               // 2 registers
modbus.WriteSingleCoil(5, true);                           // FC 05

.NET 向けの Modbus クライアントとサーバー

TCP と RTU に共通の API を持つ 4 つのコンポーネントと、サーバーの背後にあるスレッドセーフなデータモデルです。

sgcWebSockets .NET の C# Modbus ライブラリは、esegece.sgcIndustrial パッケージ、名前空間 esegece.sgcWebSockets に含まれています。TsgcModbusTCPClient と TsgcModbusRTUClient はデバイスをポーリングする Modbus マスターで、TsgcModbusTCPServer と TsgcModbusRTUServer は TsgcModbusDataModel から SCADA システム、HMI、他のマスターに応答する Modbus スレーブです。シリアル回線は同じパッケージの TsgcSerialPort で、System.IO.Ports をベースにしています。

2 つのクライアントは TsgcModbusClient_Base を共有しているため、イーサネット経由でレジスタを読むメソッドは RS-485 経由でもそのまま使えます。各呼び出しは応答が届くか Timeout が経過するまでブロックし、通常の .NET 配列 (レジスタは ushort[]、コイルは bool[]) を返し、デバイスがエラーを報告すると型付きの例外をスローします。パッケージは .NET 8、.NET 9、.NET 10、.NET Standard 2.0 を対象としています。

ファンクションコード

01 から 08、15、16、22、23、43/14、それぞれ 1 つのメソッドで呼び出せます。

型付き値

ReadFloat32、ReadInt32、ReadUInt32、ReadString とそれに対応する書き込みメソッド。4 通りのレジスタ配置は WordOrder で指定します。

Modbus TCP

既定のポートは 502 で、オプションで TLS、HTTP または SOCKS プロキシ、自動再接続を使用できます。

Modbus RTU

3.5 文字のフレーミング、CRC チェック、ブロードキャスト書き込みに対応した RS-232 と RS-485。

C# での Modbus をステップごとに解説

esegece.sgcIndustrial パッケージを参照し、トランスポートを選択します。このページのすべてのサンプルは .NET 8 に対してコンパイルできます。

using esegece.sgcWebSockets;

var modbus = new TsgcModbusTCPClient();
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.OnError += (sender, error) => Console.WriteLine("#error: " + error);
modbus.Active = true;

ushort[] registers = modbus.ReadHoldingRegisters(0, 10);       // FC 03
bool[] coils = modbus.ReadCoils(0, 8);                         // FC 01
Console.WriteLine("HR0 = " + registers[0] + ", coil 0 = " + coils[0]);

modbus.WriteSingleRegister(100, 1234);                         // FC 06
modbus.WriteMultipleRegisters(110, new ushort[] { 1, 2, 3 });  // FC 16
modbus.WriteSingleCoil(5, true);                               // FC 05
modbus.WordOrder = TsgcModbusWordOrder.mwoCDAB;   // low word first
float temperature = modbus.ReadFloat32(200);       // 2 holding registers
int counter = modbus.ReadInt32(202);
string name = modbus.ReadString(300, 8);           // 8 registers, 16 characters
Console.WriteLine($"{name}: {temperature:F1} C, {counter} cycles");

modbus.WriteFloat32(210, 21.5f);
modbus.WriteUInt32(212, 3000000000);

// explicit unit id, for a gateway with several devices behind it
float flow = modbus.ReadInputFloat32(7, 0);        // unit 7, FC 04
Console.WriteLine("flow = " + flow);

try
{
    modbus.ReadHoldingRegisters(9000, 4);
}
catch (EsgcModbusException e)   // the device answered with an exception
{
    Console.WriteLine($"exception {e.ExceptionCode}, function {e.FunctionCode}");
}
catch (EsgcModbusTimeout e)     // no answer after Retries + 1 attempts
{
    Console.WriteLine(e.Message);
}
using esegece.sgcWebSockets;

var port = new TsgcSerialPort();
port.Port = "COM3";                              // "/dev/ttyUSB0" on Linux
port.BaudRate = 19200;
port.Parity = TsgcSerialParity.spEven;           // 8E1, the Modbus RTU default
port.Open();

var rtu = new TsgcModbusRTUClient();
rtu.SerialPort = port;
rtu.UnitId = 17;                                 // slave address
rtu.Timeout = 500;
rtu.Retries = 1;

ushort[] values = rtu.ReadInputRegisters(0, 4);  // FC 04
byte status = rtu.ReadExceptionStatus();         // FC 07
Console.WriteLine($"IR0 = {values[0]}, status = {status}");

rtu.WriteSingleRegister(0, 10, 500);             // unit 0: broadcast, no reply
using esegece.sgcWebSockets;

var server = new TsgcModbusTCPServer();
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";

var random = new Random();

// runs on the connection thread, before the table is read
server.OnReadRequest += (object sender, byte unitId, byte functionCode,
    ushort address, ushort count, ref byte exceptionCode) =>
{
    if (functionCode == sgcModbus_Classes.CS_MODBUS_FC_READ_INPUT_REGISTERS)
        server.DataModel.SetInputRegister(0, (ushort)random.Next(1000));
};

// registers 0..9 are read only
server.OnWriteRequest += (object sender, byte unitId, byte functionCode,
    ushort address, ushort count, ref bool[] bits, ref ushort[] registers,
    ref byte exceptionCode) =>
{
    if (registers.Length > 0 && address < 10)
        exceptionCode = sgcModbus_Classes.CS_MODBUS_EX_ILLEGAL_DATA_ADDRESS;
};

server.Active = true;
Console.ReadLine();

呼び出しは同期です。WinForms、WPF、ASP.NET アプリケーションでは、ワーカースレッドまたは Task.Run の内部でポーリングループを実行してください。クライアントはスレッドセーフなので、複数のタスクが 1 つの接続を共有できます。

対応している Modbus ファンクションコード

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

FCファンクションC# メソッド
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 と TsgcModbusDeviceIdCode (basic、regular、extended、specific)

本番運用向けに作られた Modbus マスター

ワード順

TsgcModbusWordOrder.mwoABCD はビッグエンディアンで、Modbus の既定です。mwoCDAB は下位ワードを先頭にし、mwoBADC は各レジスタ内のバイトを入れ替え、mwoDCBA は完全なリトルエンディアンです。文字列は 1 レジスタに 2 文字を格納します。

スレッドセーフ

クライアントごとに同時に実行されるトランザクションは 1 つで、すべてのリトライを含めてロックで保護されます。TCP では、応答は受信スレッドが照合して待機中の呼び出しに渡すため、UI スレッドからの呼び出しでもデッドロックしません。

タイムアウトとリトライ

Timeout は 1 回の試行あたりの待機時間、Retries は追加の試行回数です。TCP のリトライでは新しいトランザクション ID を使用し、古い応答や重複した応答は破棄されます。

型付き例外

EsgcModbusException は ExceptionCode と FunctionCode を保持し、EsgcModbusTimeout は応答がないことを報告し、EsgcModbusError は切断された接続、ポートの問題、RTU の CRC エラーを扱います。

ゲートウェイとユニット ID

すべてのメソッドに先頭の byte aUnitId を取るオーバーロードがあるため、ゲートウェイへの 1 つの TCP 接続で、その背後にあるすべてのデバイスにアクセスできます。

TLS、プロキシ、再接続

TLS、TLSOptions、Proxy、WatchDog は内部の sgcWebSockets TCP クライアントに渡されるため、Modbus TCP でもライブラリの他の部分と同じ TLS スタック、プロキシ対応、自動再接続を利用できます。

RTU フレーミング

RTU クライアントは、送信前に 3.5 文字分の無音を待ち、想定される長さで応答を読み取り、すべてのフレームの CRC を確認し、他のスレーブアドレスからのフレームを無視します。ユニット ID 0 はブロードキャスト書き込みを送信し、応答の代わりに TurnaroundDelay だけ待機します。

RS-485 の方向制御

RtsControl = TsgcSerialRtsControl.srcToggle を指定すると、シリアルポートは書き込みごとに RTS を上げ、出力バッファが空になった時点で下げます。.NET ではこれがソフトウェアでタイミング制御されるため、厳密なバスタイミングが必要な場合は、自動方向制御付きのアダプタを推奨します。

イベント

OnConnect、OnDisconnect、OnError は NotifyEvents を通じて、発生した順に通知されます。接続に失敗しても例外はスローされません。代わりに OnError が発生し、Active は false のままです。

C# の Modbus TCP・RTU サーバー

データベースやクラウドの値を SCADA システムに公開するゲートウェイ、ハードウェアなしで HMI 画面をテストするシミュレータ、自社デバイスの Modbus インターフェースを構築できます。各サーバーは、4 つのテーブル (コイル、ディスクリート入力、保持レジスタ、入力レジスタ。既定では各 10,000 エントリ、最大 65,536) と、FC 43/14 用の識別文字列、FC 07 用の例外ステータスを持つ TsgcModbusDataModel を所有します。データモデルのすべてのメンバーはスレッドセーフです。

OnReadRequest はテーブルの読み取り前に実行されるため、値を更新したり、例外コードで応答したりできます。OnWriteRequest は保存前に値を受け取り、値を変更したり書き込みを拒否したりでき、拒否した場合はテーブルは変更されません。どちらもロックを保持せず、リクエストを処理するサーバースレッド (TCP 接続または RTU フレームリーダー) で実行されます。

TsgcModbusTCPServer

多数の同時接続、到着順に応答されるリクエスト、再構成される分割リクエスト、OnError とともに接続を閉じる不正なヘッダーに対応しています。UnitId = 0 は任意のユニット ID に応答します。Bindings でエンドポイントを選択し、Port = 0 で空きポートが選ばれ、OnClientConnect と OnClientDisconnect でピアが通知されます。

TsgcModbusRTUServer

TsgcSerialPort 上でスレーブ UnitId (1 から 247) として応答し、長さと 3.5 文字の無音でリクエストをフレーム化し、不正な CRC や他のアドレスを無視し、ブロードキャスト書き込みは応答せずに実行します。

双方向でテスト済み

.NET のクライアントとサーバーは、TCP 経由の pymodbus、および sgcWebSockets の Delphi Modbus コンポーネントに対する同じ相互運用性チェックに、どちらの方向でも 35 件中 35 件合格しています。

sgcWebSockets Enterprise に含まれます

Modbus とシリアルポートのコンポーネントは、他の sgcWebSockets .NET パッケージと並ぶ esegece.sgcIndustrial パッケージとして、sgcWebSockets Enterprise (Delphi および .NET) と All-Access に含まれています。エディションの比較は、価格ページ (.NET タブ) または .NET 機能比較表をご覧ください。

C# Modbus に関するよくある質問

TsgcModbusTCPClient を作成し、Host、Port、UnitId を設定し、Active = true を設定して ReadHoldingRegisters(address, count) を呼び出します。レジスタごとに 1 つの値を持つ ushort[] が返されます。アドレスは通信上と同じくゼロ始まりです。

保持レジスタには ReadFloat32(address)、入力レジスタには ReadInputFloat32(address) を呼び出します。数値がおかしい場合は、デバイスが 2 つのレジスタを別の順序で格納しています。WordOrder を mwoCDAB、mwoBADC、mwoDCBA のいずれかに設定してください。

はい。RS-485 アダプタで TsgcSerialPort を開き、TsgcModbusRTUClient.SerialPort または TsgcModbusRTUServer.SerialPort に割り当てます。自動方向制御付きのアダプタを使用するか、RTS で切り替えるアダプタでは RtsControl を srcToggle に設定してください。

はい。TsgcModbusTCPServer を作成し、SetHoldingRegister、SetCoil などのセッターで DataModel を設定し、Active = true を設定します。OnReadRequest と OnWriteRequest を処理すると、値をオンデマンドで計算したり、Modbus 例外コードで書き込みを拒否したりできます。

いいえ。クライアントのメソッドは同期でスレッドセーフです。ワーカースレッドから呼び出すか、Task.Run でラップしてください。複数のスレッドまたはタスクが 1 つのクライアントを共有でき、各呼び出しは自分の応答を待ちます。

esegece.sgcIndustrial パッケージは .NET 8、.NET 9、.NET 10、.NET Standard 2.0 を対象としています。シリアルポートは System.IO.Ports を使用するため、Modbus RTU にはそのパッケージがシリアルポートを開けるプラットフォームが必要です。

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

sgcWebSockets .NET についてさらに詳しく

産業用コンポーネント

シリアルポート、Modbus、OPC UA と、完全なコンポーネントリファレンス。

C# OPC UA クライアント

同じ .NET アプリケーションから、Modbus デバイスと並んで OPC UA サーバーの読み取り、書き込み、サブスクライブができます。

C# MQTT クライアント

同じアプリケーションから、Modbus の読み取り値を MQTT ブローカーにパブリッシュします。

C# WebSocket ライブラリ

デバイスのライブデータを表示するダッシュボード向けの WebSocket クライアントとサーバー。

Delphi と C++Builder にも対応

Delphi 7 から Delphi 13 向けに、同じクラス名とメソッドを持つ同じ Modbus コンポーネントを提供します。

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

C# で最初の Modbus レジスタを読む

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