淺談C#使用TCP/IP與ModBus進行通訊

1. ModBus的 Client/Server模型
2. 資料包格式及MBAP header (MODBUS Application Protocol header)
3. 大小端轉換
4. 事務標識和緩衝清理
5. 範例程式碼

 

0. MODBUS MESSAGING ON TCP/IP IMPLEMENTATION GUIDE

    ：http://www.modbus.org/docs/Modbus_Messaging_Implementation_Guide_V1_0b.pdf

 

1. ModBus的 Client/Server模型

 

    Client與Server之間有兩種通訊方式：一種是TCP/IP，另一種是通過串口(Serial Port)，本文重點介紹第一種通訊方式。第二種方式留了介面，暫時還沒有實現。

 

2. 資料包格式及MBAP header (MODBUS Application Protocol header)    2.1 資料包格式

    資料交換過程中，資料包的格式由三部分組成：協議頭 + 功能碼 + 資料(請求或接受的資料)。
    這裡主要用到下列兩個功能碼（十進位）：
    3: 讀取寄存器中的值（Read Multiple Register）
    16: 往寄存器中寫值（Write Multiple Register）

 

   2.2 MBAP header

   

    協議頭具體包括下列4個欄位：
(1) Transaction Identifier：事務ID標識，Client每發送一個Request資料包的時候，需要帶上該標識；當Server響應該請求的時候，會把該標識複製到Response中；這樣用戶端就可以進行容錯判斷，防止資料包發串了。
(2) Protocal Identifier：協議標識，ModBus協議中，該值為0；
(3) Length：整個資料包中，從當個前這個位元組之後開始計算，後續資料量的大小(按byte計算)。
(4) Unit Identifier：-_-

 

3. 大小端轉換

    ModBus使用Big-Endian表示地址和資料項目。因此在發送或者接受資料的過程中，需要對資料進行轉換。

3.1 判斷大小端

    對於整數1，在兩種機器上有兩種不同的標示方式，如所示；因此，我們可以用&操作符來取其地址，再轉換成指向byte的指標(byte*)，最後再取該指標的值；若得到的byte值為1，則為Little-Endian，否則為Big-Endian。

   1: unsafe

   2: {

   3:     int tester = 1;

   4:     bool littleEndian = (*(byte*)(&tester)) == (byte)1;

   5: }

 

3.2 整數/浮點數轉換成Byte數組

    .Net提供了現成的API，可以BitConverter.GetBytes(value)和BitConverter.ToXXOO(Byte[] data)來進行轉換。下面的代碼對該轉換進行了封裝，加入了Little-Endian轉Big-Endian的處理（以int為例）：

   1: public class ValueHelper //Big-Endian可以直接轉換

   2: {

   3:         public virtual Byte[] GetBytes(int value)

   4:         {

   5:             return BitConverter.GetBytes(value);

   6:         }

   7:         public virtual int GetInt(byte[] data)

   8:         {

   9:             return BitConverter.ToInt32(data, 0);

  10:         }

  11: }

  12:  

  13: internal class LittleEndianValueHelper : ValueHelper //Little-Endian，轉換時需要做翻轉處理。

  14: {

  15:         public override Byte[] GetBytes(int value)

  16:         {

  17:             return this.Reverse(BitConverter.GetBytes(value));

  18:         }

  19:         public virtual int GetInt(byte[] data)

  20:         {

  21:             return BitConverter.ToInt32(this.Reverse(data), 0);

  22:         }

  23:         private Byte[] Reverse(Byte[] data)

  24:         {

  25:             Array.Reverse(data);

  26:             return data;

  27:         }

  28: }

 

4. 事務標識和緩衝處理    4.1 Transaction Identifier

    上面2.2節中提到，Client每發送一個Request資料包的時候，需要帶上一個標識；當Server響應該請求的時候，會把該標識複製到Response中，返回給Client。這樣Client就可以用來判斷資料包有沒有發串。在程式中，可以可以用一個變數及記錄該標識：

   1: private byte dataIndex = 0;

   2:  

   3: protected byte CurrentDataIndex

   4: {

   5:        get { return this.dataIndex; }

   6: }

   7:  

   8: protected byte NextDataIndex()

   9: {

  10:        return ++this.dataIndex;

  11: }

   每次Client發送資料的時候，調用NextDataIndex()來取得事務標識；接著當Client讀取Server的傳回值的時候，需要判斷資料包中的資料標識是否與發送時的標誌一致；如果一致，則認為資料包有效；否則丟掉無效的資料包。

 

    4.2 緩衝處理

    上節中提到，如果Client接收到的響應資料包中的標識，與發送給Server的資料標識不一致，則認為Server返回的資料包無效，並丟棄該資料包。

    如果只考慮正常情況，即資料木有差錯，Client每次發送請求後，其請求包裡麵包含需要讀取的寄存器數量，能算出從Server返回的資料兩大小，這樣就能確定讀完Server返回的所有緩衝區中的資料；每次互動後，Socket緩衝區中都為空白，則整個過程沒有問題。但是問題是：如果Server端出錯，或者資料串包等異常情況下，Client不能確定Server返回的資料包(佔用的緩衝區)有多大；如果緩衝區中的資料沒有讀完，下次再從緩衝區中接著讀的時候，資料包必然是不正確的，而且會錯誤會一直延續到後續的讀取操作中。

    因此，每次讀取資料時，要麼全部讀完緩衝區中的資料，要麼讀到錯誤的時候，就必須清楚緩衝區中剩餘的資料。網上搜了半天，木有找到Windows下如何清理Socket緩衝區的。有篇文章倒是提到一個狠招，每次讀完資料後，直接把Socket給哢嚓掉；然後下次需要讀取或發送資料的時候，再重建立立Socket串連。

    回過頭再來看，其實，在Client與Server進行互動的過程中，Server每次返回的資料量都不大，也就一個MBAP Header + 幾十個寄存器的值。因此，另一個處理方式，就是每次讀取儘可能多的資料(多過緩衝區中的資料量)，多讀的內容，再忽略掉。暫時這麼處理，期待有更好的解決方案。

 

5. 原始碼5.1 類圖結構：

 

5.2 使用樣本

(1) 寫入資料：

   1: this.Wrapper.Send(Encoding.ASCII.GetBytes(this.tbxSendText.Text.Trim()));

   2:  

   3: public override void Send(byte[] data)

   4: {

   5:     //[0]:填充0，清掉剩餘的寄存器

   6:     if (data.Length < 60)

   7:     {

   8:         var input = data;

   9:         data = new Byte[60];

  10:         Array.Copy(input, data, input.Length);

  11:     }

  12:     this.Connect();

  13:     List<byte> values = new List<byte>(255);

  14:  

  15:     //[1].Write Header：MODBUS Application Protocol header

  16:     values.AddRange(ValueHelper.Instance.GetBytes(this.NextDataIndex()));//1~2.(Transaction Identifier)

  17:     values.AddRange(new Byte[] { 0, 0 });//3~4:Protocol Identifier,0 = MODBUS protocol

  18:     values.AddRange(ValueHelper.Instance.GetBytes((byte)(data.Length + 7)));//5~6:後續的Byte數量

  19:     values.Add(0);//7:Unit Identifier:This field is used for intra-system routing purpose.

  20:     values.Add((byte)FunctionCode.Write);//8.Function Code : 16 (Write Multiple Register)

  21:     values.AddRange(ValueHelper.Instance.GetBytes(StartingAddress));//9~10.起始地址

  22:     values.AddRange(ValueHelper.Instance.GetBytes((short)(data.Length / 2)));//11~12.寄存器數量

  23:     values.Add((byte)data.Length);//13.資料的Byte數量

  24:  

  25:     //[2].增加資料

  26:     values.AddRange(data);//14~End:需要發送的資料

  27:  

  28:     //[3].寫資料

  29:     this.socketWrapper.Write(values.ToArray());

  30:  

  31:     //[4].防止連續讀寫引起前台UI線程阻塞

  32:     Application.DoEvents();

  33:  

  34:     //[5].讀取Response: 寫完後會返回12個byte的結果

  35:     byte[] responseHeader = this.socketWrapper.Read(12);

  36: }

(2) 讀取資料：

   1: this.tbxReceiveText.Text = Encoding.ASCII.GetString(this.Wrapper.Receive());

   2:  

   3:         public override byte[] Receive()

   4:         {

   5:             this.Connect();

   6:             List<byte> sendData = new List<byte>(255);

   7:  

   8:             //[1].Send

   9:             sendData.AddRange(ValueHelper.Instance.GetBytes(this.NextDataIndex()));//1~2.(Transaction Identifier)

  10:             sendData.AddRange(new Byte[] { 0, 0 });//3~4:Protocol Identifier,0 = MODBUS protocol

  11:             sendData.AddRange(ValueHelper.Instance.GetBytes((short)6));//5~6:後續的Byte數量（針對讀請求，後續為6個byte）

  12:             sendData.Add(0);//7:Unit Identifier:This field is used for intra-system routing purpose.

  13:             sendData.Add((byte)FunctionCode.Read);//8.Function Code : 3 (Read Multiple Register)

  14:             sendData.AddRange(ValueHelper.Instance.GetBytes(StartingAddress));//9~10.起始地址

  15:             sendData.AddRange(ValueHelper.Instance.GetBytes((short)30));//11~12.需要讀取的寄存器數量

  16:             this.socketWrapper.Write(sendData.ToArray()); //發送讀請求

  17:  

  18:             //[2].防止連續讀寫引起前台UI線程阻塞

  19:             Application.DoEvents();

  20:  

  21:             //[3].讀取Response Header : 完後會返回8個byte的Response Header

  22:             byte[] receiveData = this.socketWrapper.Read(256);//緩衝區中的資料總量不超過256byte，一次讀256byte，防止殘餘資料影響下次讀取

  23:             short identifier = (short)((((short)receiveData[0]) << 8) + receiveData[1]);

  24:  

  25:             //[4].讀取返回資料：根據ResponseHeader，讀取後續的資料

  26:             if (identifier != this.CurrentDataIndex) //請求的資料標識與返回的標識不一致，則丟掉資料包

  27:             {

  28:                 return new Byte[0];

  29:             }

  30:             byte length = receiveData[8];//最後一個位元組，記錄寄存器中資料的Byte數

  31:             byte[] result = new byte[length];

  32:             Array.Copy(receiveData, 9, result, 0, length);

  33:             return result;

  34:         }

(3) 測試發送和讀取：

ModBus-TCP Client Tool（可以從網上下載，用來測試）中，可以點擊“Edit Values”，修改寄存器中的值；然後再在測試程式中，點擊“接收”，可以解析到修改後的值。這裡只是測試發送和接收字串，如果需要處理複雜的數字/字串組合啥的，就需要自己定義資料格式和解析方式了。

 

5.3 代碼下載

CSharpModBusExample

 

原文連結：http://www.cnblogs.com/happyhippy/archive/2011/07/17/2108976.html