implement Logic/Wire addressing in ModbusClients

csharp/Lib/Protocols/Modbus/Clients/Endianness.cs

@@ -1,10 +0,0 @@
-namespace InnovEnergy.Lib.Protocols.Modbus.Clients;
-
-[Flags]
-public enum Endianness
-{
-    LittleEndian32BitIntegers = 0,
-    LittleEndian32Floats = 0,
-    BigEndian32BitIntegers = 1,
-    BigEndian32Floats = 2,
-}

csharp/Lib/Protocols/Modbus/Clients/ModbusClient.cs

@@ -1,6 +1,8 @@
 using InnovEnergy.Lib.Protocols.Modbus.Connections;
 using InnovEnergy.Lib.Protocols.Modbus.Conversions;
-using static InnovEnergy.Lib.Protocols.Modbus.Clients.Endianness;
+using InnovEnergy.Lib.Protocols.Modbus.Protocol;
+using static InnovEnergy.Lib.Protocols.Modbus.Protocol.MultiRegisterEndianness;
+using static InnovEnergy.Lib.Protocols.Modbus.Protocol.RegisterIndexing;
 
 namespace InnovEnergy.Lib.Protocols.Modbus.Clients;
 
@@ -11,9 +13,10 @@ using Coils = IReadOnlyList<Boolean>;
 
 public abstract class ModbusClient
 {
-    protected ModbusConnection Connection { get; }
+    protected ModbusConnection        Connection       { get; }
-    protected Byte             SlaveId    { get; }
+    protected Byte                    SlaveId          { get; }
-    protected Endianness       Endianness { get; }
+    protected RegisterIndexing        RegisterIndexing { get; }
+    protected MultiRegisterEndianness Endianness       { get; }
 
 
     // TODO: add additional functions: coils...
@@ -41,12 +44,20 @@ public abstract class ModbusClient
         return WriteRegisters(writeAddress, (IReadOnlyList<UInt16>)values);
     }
     
-    protected ModbusClient(ModbusConnection connection, Byte slaveId, Endianness endianness = LittleEndian32BitIntegers | LittleEndian32Floats)
+    protected ModbusClient(ModbusConnection connection, 
+                                       Byte slaveId,
+                           RegisterIndexing registerIndexing = OneBased,
+                    MultiRegisterEndianness endianness = LittleEndian)
     {
-        Connection = connection;
+        Connection       = connection;
-        SlaveId    = slaveId;
+        SlaveId          = slaveId;
-        Endianness = endianness;
+        RegisterIndexing = registerIndexing;
+        Endianness       = endianness;
     }
 
     public void CloseConnection() => Connection.Close();
-}
+    
+    protected UInt16 LogicToWire(UInt16 address) => RegisterIndexing.LogicToSerialized(address);
+    protected UInt16 SerializedToLogic(UInt16 address) => RegisterIndexing.SerializedToLogic(address);
+}
+

csharp/Lib/Protocols/Modbus/Clients/ModbusRtuClient.cs

@@ -30,7 +30,9 @@ public class ModbusRtuClient : ModbusClient
 
     public override ModbusRegisters ReadInputRegisters(UInt16 readAddress, UInt16 nValues)
     {
-        var cmd = new ReadInputRegistersCommandFrame(SlaveId, readAddress, nValues);
+        var wireReadAddress = LogicToWire(readAddress);
+        
+        var cmd = new ReadInputRegistersCommandFrame(SlaveId, wireReadAddress, nValues);
         var crc = CalcCrc(cmd);
 
         // TX
@@ -54,7 +56,9 @@ public class ModbusRtuClient : ModbusClient
 
     public override ModbusRegisters ReadHoldingRegisters(UInt16 readAddress, UInt16 nValues)
     {
-        var cmd = new ReadHoldingRegistersCommandFrame(SlaveId, readAddress, nValues);
+        var wireReadAddress = LogicToWire(readAddress);
+        
+        var cmd = new ReadHoldingRegistersCommandFrame(SlaveId, wireReadAddress, nValues);
         var crc = CalcCrc(cmd.Data);
 
         // TX
@@ -82,7 +86,9 @@ public class ModbusRtuClient : ModbusClient
 
     public override UInt16 WriteRegisters(UInt16 writeAddress, UInt16s values)
     {
-        var cmd = new WriteRegistersCommandFrame(SlaveId, writeAddress, values);
+        var wireWriteAddress = LogicToWire(writeAddress);
+        
+        var cmd = new WriteRegistersCommandFrame(SlaveId, wireWriteAddress, values);
         var crc = CalcCrc(cmd);
         var nToRead = cmd.ExpectedResponseSize + CrcSize;
 
@@ -105,10 +111,16 @@ public class ModbusRtuClient : ModbusClient
 
     public override ModbusRegisters ReadWriteRegisters(UInt16 readAddress, UInt16 nbToRead, UInt16 writeAddress, UInt16s registersToWrite)
     {
-        var cmd = new ReadWriteRegistersCommandFrame(SlaveId, readAddress, nbToRead, writeAddress, registersToWrite);
+        var wireReadAddress = LogicToWire(readAddress);
+        var wireWriteAddress = LogicToWire(writeAddress);
+        
+        var cmd = new ReadWriteRegistersCommandFrame(SlaveId, 
+                                                     wireReadAddress,
+                                                     nbToRead, 
+                                                     wireWriteAddress, 
+                                                     registersToWrite);
         var crc = CalcCrc(cmd);
 
-        
         // TX
         cmd.Data.Concat(crc).Apply(Connection.Transmit); 
 

csharp/Lib/Protocols/Modbus/Clients/ModbusTcpClient.cs

@@ -1,10 +1,11 @@
 using System.Diagnostics;
 using InnovEnergy.Lib.Protocols.Modbus.Connections;
 using InnovEnergy.Lib.Protocols.Modbus.Conversions;
+using InnovEnergy.Lib.Protocols.Modbus.Protocol;
 using InnovEnergy.Lib.Protocols.Modbus.Protocol.Frames.Commands;
 using InnovEnergy.Lib.Protocols.Modbus.Protocol.Frames.Replies;
 using InnovEnergy.Lib.Protocols.Modbus.Tcp;
-using static InnovEnergy.Lib.Protocols.Modbus.Clients.Endianness;
+using static InnovEnergy.Lib.Protocols.Modbus.Protocol.MultiRegisterEndianness;
 
 namespace InnovEnergy.Lib.Protocols.Modbus.Clients;
 
@@ -20,16 +21,21 @@ public class ModbusTcpClient : ModbusClient
     private UInt16 NextId() => unchecked(++_Id);
 
 
-    public ModbusTcpClient(ModbusConnection connection, Byte slaveId, Endianness endianness = LittleEndian32BitIntegers | LittleEndian32Floats) : base(connection, slaveId, endianness)
+    public ModbusTcpClient(ModbusConnection connection, 
+                                       Byte slaveId, 
+                           RegisterIndexing registerIndexing = RegisterIndexing.OneBased, 
+                    MultiRegisterEndianness endianness = LittleEndian) : base(connection, slaveId, registerIndexing, endianness)
     {
     }
 
     
     public override IReadOnlyList<Boolean> ReadDiscreteInputs(UInt16 readAddress, UInt16 nValues)
     {
+        var wireReadAddress = LogicToWire(readAddress);
+
         var id  = NextId(); // TODO: check response id
         
-        var cmd = new ReadDiscreteInputsCommandFrame(SlaveId, readAddress, nValues);
+        var cmd = new ReadDiscreteInputsCommandFrame(SlaveId, wireReadAddress, nValues);
         var hdr = new MbapHeader(id, cmd.Data.Count);  
         var frm = new ModbusTcpFrame(hdr, cmd);         
 
@@ -46,9 +52,10 @@ public class ModbusTcpClient : ModbusClient
 
     public override ModbusRegisters ReadInputRegisters(UInt16 readAddress, UInt16 nValues)
     {
+        var wireReadAddress = LogicToWire(readAddress);
         var id  = NextId(); // TODO: check response id
-        
+
-        var cmd = new ReadInputRegistersCommandFrame(SlaveId, readAddress, nValues);
+        var cmd = new ReadInputRegistersCommandFrame(SlaveId, wireReadAddress, nValues);
         var hdr = new MbapHeader(id, cmd.Data.Count);
         var frm = new ModbusTcpFrame(hdr, cmd);
 
@@ -65,12 +72,15 @@ public class ModbusTcpClient : ModbusClient
         return new ModbusRegisters(readAddress, verified.RegistersRead.ToArray());
     }
 
+    
+
 
     public override ModbusRegisters ReadHoldingRegisters(UInt16 readAddress, UInt16 nValues)
     {
+        var wireReadAddress = LogicToWire(readAddress);
+
         var id  = NextId(); // TODO: check response id
-        
+        var cmd = new ReadHoldingRegistersCommandFrame(SlaveId, wireReadAddress, nValues);
-        var cmd = new ReadHoldingRegistersCommandFrame(SlaveId, readAddress, nValues);
         var hdr = new MbapHeader(id, cmd.Data.Count);
         var frm = new ModbusTcpFrame(hdr, cmd);
 
@@ -84,14 +94,15 @@ public class ModbusTcpClient : ModbusClient
 
         var verified = cmd.VerifyResponse(rxFrm);
 
-        return new ModbusRegisters(readAddress, verified.RegistersRead.ToArray());
+        return new ModbusRegisters(readAddress, verified.RegistersRead.ToArray()); // TODO
     }
 
     public override UInt16 WriteMultipleCoils(UInt16 writeAddress, Coils coils)
     {
+        var wireWriteAddress = LogicToWire(writeAddress);
+         
         var id  = NextId(); // TODO: check response id
-                
+        var cmd = new WriteCoilsCommandFrame(SlaveId, wireWriteAddress, coils);
-        var cmd = new WriteCoilsCommandFrame(SlaveId, writeAddress, coils);
         var hdr = new MbapHeader(id, cmd.Data.Count);
         var frm = new ModbusTcpFrame(hdr, cmd);
 
@@ -109,9 +120,10 @@ public class ModbusTcpClient : ModbusClient
     
     public override UInt16 WriteRegisters(UInt16 writeAddress, UInt16s values)
     {
+        var wireWriteAddress = LogicToWire(writeAddress);
+
         var id  = NextId(); // TODO: check response id
-        
+        var cmd = new WriteRegistersCommandFrame(SlaveId, wireWriteAddress, values);
-        var cmd = new WriteRegistersCommandFrame(SlaveId, writeAddress, values);
         var hdr = new MbapHeader(id, cmd.Data.Count);
         var frm = new ModbusTcpFrame(hdr, cmd);
 
@@ -130,9 +142,17 @@ public class ModbusTcpClient : ModbusClient
 
     public override ModbusRegisters ReadWriteRegisters(UInt16 readAddress, UInt16 nbToRead, UInt16 writeAddress, UInt16s registersToWrite)
     {
+        var wireReadAddress  = LogicToWire(readAddress);
+        var wireWriteAddress = LogicToWire(writeAddress);
+        
         var id  = NextId(); // TODO: check response id
         
-        var cmd = new ReadWriteRegistersCommandFrame(SlaveId, readAddress, nbToRead, writeAddress, registersToWrite);
+        var cmd = new ReadWriteRegistersCommandFrame(SlaveId, 
+                                                     wireReadAddress, 
+                                                     nbToRead, 
+                                                     wireWriteAddress, 
+                                                     registersToWrite);
+        
         var hdr = new MbapHeader(id, cmd.Data.Count);
         var frm = new ModbusTcpFrame(hdr, cmd);
 
@@ -146,7 +166,7 @@ public class ModbusTcpClient : ModbusClient
 
         var verified = cmd.VerifyResponse(rxFrm);
 
-        return new ModbusRegisters(readAddress, verified.RegistersRead.ToArray());
+        return new ModbusRegisters(readAddress, verified.RegistersRead.ToArray()); // TODO
     }
 
 }