ModbusIpMaster.cs 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. using System.Threading.Tasks;
  2. namespace NModbus.Device
  3. {
  4. /// <summary>
  5. /// Modbus IP master device.
  6. /// </summary>
  7. public class ModbusIpMaster : ModbusMaster
  8. {
  9. /// <summary>
  10. /// Modbus IP master device.
  11. /// </summary>
  12. /// <param name="transport">Transport used by this master.</param>
  13. public ModbusIpMaster(IModbusTransport transport)
  14. : base(transport)
  15. {
  16. }
  17. /// <summary>
  18. /// Reads from 1 to 2000 contiguous coils status.
  19. /// </summary>
  20. /// <param name="startAddress">Address to begin reading.</param>
  21. /// <param name="numberOfPoints">Number of coils to read.</param>
  22. /// <returns>Coils status.</returns>
  23. public bool[] ReadCoils(ushort startAddress, ushort numberOfPoints)
  24. {
  25. return base.ReadCoils(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  26. }
  27. /// <summary>
  28. /// Asynchronously reads from 1 to 2000 contiguous coils status.
  29. /// </summary>
  30. /// <param name="startAddress">Address to begin reading.</param>
  31. /// <param name="numberOfPoints">Number of coils to read.</param>
  32. /// <returns>A task that represents the asynchronous read operation.</returns>
  33. public Task<bool[]> ReadCoilsAsync(ushort startAddress, ushort numberOfPoints)
  34. {
  35. return base.ReadCoilsAsync(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  36. }
  37. /// <summary>
  38. /// Reads from 1 to 2000 contiguous discrete input status.
  39. /// </summary>
  40. /// <param name="startAddress">Address to begin reading.</param>
  41. /// <param name="numberOfPoints">Number of discrete inputs to read.</param>
  42. /// <returns>Discrete inputs status.</returns>
  43. public bool[] ReadInputs(ushort startAddress, ushort numberOfPoints)
  44. {
  45. return base.ReadInputs(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  46. }
  47. /// <summary>
  48. /// Asynchronously reads from 1 to 2000 contiguous discrete input status.
  49. /// </summary>
  50. /// <param name="startAddress">Address to begin reading.</param>
  51. /// <param name="numberOfPoints">Number of discrete inputs to read.</param>
  52. /// <returns>A task that represents the asynchronous read operation.</returns>
  53. public Task<bool[]> ReadInputsAsync(ushort startAddress, ushort numberOfPoints)
  54. {
  55. return base.ReadInputsAsync(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  56. }
  57. /// <summary>
  58. /// Reads contiguous block of holding registers.
  59. /// </summary>
  60. /// <param name="startAddress">Address to begin reading.</param>
  61. /// <param name="numberOfPoints">Number of holding registers to read.</param>
  62. /// <returns>Holding registers status.</returns>
  63. public ushort[] ReadHoldingRegisters(ushort startAddress, ushort numberOfPoints)
  64. {
  65. return base.ReadHoldingRegisters(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  66. }
  67. /// <summary>
  68. /// Asynchronously reads contiguous block of holding registers.
  69. /// </summary>
  70. /// <param name="startAddress">Address to begin reading.</param>
  71. /// <param name="numberOfPoints">Number of holding registers to read.</param>
  72. /// <returns>A task that represents the asynchronous read operation.</returns>
  73. public Task<ushort[]> ReadHoldingRegistersAsync(ushort startAddress, ushort numberOfPoints)
  74. {
  75. return base.ReadHoldingRegistersAsync(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  76. }
  77. /// <summary>
  78. /// Reads contiguous block of input registers.
  79. /// </summary>
  80. /// <param name="startAddress">Address to begin reading.</param>
  81. /// <param name="numberOfPoints">Number of holding registers to read.</param>
  82. /// <returns>Input registers status.</returns>
  83. public ushort[] ReadInputRegisters(ushort startAddress, ushort numberOfPoints)
  84. {
  85. return base.ReadInputRegisters(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  86. }
  87. /// <summary>
  88. /// Asynchronously reads contiguous block of input registers.
  89. /// </summary>
  90. /// <param name="startAddress">Address to begin reading.</param>
  91. /// <param name="numberOfPoints">Number of holding registers to read.</param>
  92. /// <returns>A task that represents the asynchronous read operation.</returns>
  93. public Task<ushort[]> ReadInputRegistersAsync(ushort startAddress, ushort numberOfPoints)
  94. {
  95. return base.ReadInputRegistersAsync(Modbus.DefaultIpSlaveUnitId, startAddress, numberOfPoints);
  96. }
  97. /// <summary>
  98. /// Writes a single coil value.
  99. /// </summary>
  100. /// <param name="coilAddress">Address to write value to.</param>
  101. /// <param name="value">Value to write.</param>
  102. public void WriteSingleCoil(ushort coilAddress, bool value)
  103. {
  104. base.WriteSingleCoil(Modbus.DefaultIpSlaveUnitId, coilAddress, value);
  105. }
  106. /// <summary>
  107. /// Asynchronously writes a single coil value.
  108. /// </summary>
  109. /// <param name="coilAddress">Address to write value to.</param>
  110. /// <param name="value">Value to write.</param>
  111. /// <returns>A task that represents the asynchronous write operation.</returns>
  112. public Task WriteSingleCoilAsync(ushort coilAddress, bool value)
  113. {
  114. return base.WriteSingleCoilAsync(Modbus.DefaultIpSlaveUnitId, coilAddress, value);
  115. }
  116. /// <summary>
  117. /// Write a single holding register.
  118. /// </summary>
  119. /// <param name="registerAddress">Address to write.</param>
  120. /// <param name="value">Value to write.</param>
  121. public void WriteSingleRegister(ushort registerAddress, ushort value)
  122. {
  123. base.WriteSingleRegister(Modbus.DefaultIpSlaveUnitId, registerAddress, value);
  124. }
  125. /// <summary>
  126. /// Asynchronously writes a single holding register.
  127. /// </summary>
  128. /// <param name="registerAddress">Address to write.</param>
  129. /// <param name="value">Value to write.</param>
  130. /// <returns>A task that represents the asynchronous write operation.</returns>
  131. public Task WriteSingleRegisterAsync(ushort registerAddress, ushort value)
  132. {
  133. return base.WriteSingleRegisterAsync(Modbus.DefaultIpSlaveUnitId, registerAddress, value);
  134. }
  135. /// <summary>
  136. /// Write a block of 1 to 123 contiguous registers.
  137. /// </summary>
  138. /// <param name="startAddress">Address to begin writing values.</param>
  139. /// <param name="data">Values to write.</param>
  140. public void WriteMultipleRegisters(ushort startAddress, ushort[] data)
  141. {
  142. base.WriteMultipleRegisters(Modbus.DefaultIpSlaveUnitId, startAddress, data);
  143. }
  144. /// <summary>
  145. /// Asynchronously writes a block of 1 to 123 contiguous registers.
  146. /// </summary>
  147. /// <param name="startAddress">Address to begin writing values.</param>
  148. /// <param name="data">Values to write.</param>
  149. /// <returns>A task that represents the asynchronous write operation.</returns>
  150. public Task WriteMultipleRegistersAsync(ushort startAddress, ushort[] data)
  151. {
  152. return base.WriteMultipleRegistersAsync(Modbus.DefaultIpSlaveUnitId, startAddress, data);
  153. }
  154. /// <summary>
  155. /// Force each coil in a sequence of coils to a provided value.
  156. /// </summary>
  157. /// <param name="startAddress">Address to begin writing values.</param>
  158. /// <param name="data">Values to write.</param>
  159. public void WriteMultipleCoils(ushort startAddress, bool[] data)
  160. {
  161. base.WriteMultipleCoils(Modbus.DefaultIpSlaveUnitId, startAddress, data);
  162. }
  163. /// <summary>
  164. /// Asynchronously writes a sequence of coils.
  165. /// </summary>
  166. /// <param name="startAddress">Address to begin writing values.</param>
  167. /// <param name="data">Values to write.</param>
  168. /// <returns>A task that represents the asynchronous write operation</returns>
  169. public Task WriteMultipleCoilsAsync(ushort startAddress, bool[] data)
  170. {
  171. return base.WriteMultipleCoilsAsync(Modbus.DefaultIpSlaveUnitId, startAddress, data);
  172. }
  173. /// <summary>
  174. /// Performs a combination of one read operation and one write operation in a single MODBUS transaction.
  175. /// The write operation is performed before the read.
  176. /// Message uses default TCP slave id of 0.
  177. /// </summary>
  178. /// <param name="startReadAddress">Address to begin reading (Holding registers are addressed starting at 0).</param>
  179. /// <param name="numberOfPointsToRead">Number of registers to read.</param>
  180. /// <param name="startWriteAddress">Address to begin writing (Holding registers are addressed starting at 0).</param>
  181. /// <param name="writeData">Register values to write.</param>
  182. public ushort[] ReadWriteMultipleRegisters(
  183. ushort startReadAddress,
  184. ushort numberOfPointsToRead,
  185. ushort startWriteAddress,
  186. ushort[] writeData)
  187. {
  188. return base.ReadWriteMultipleRegisters(
  189. Modbus.DefaultIpSlaveUnitId,
  190. startReadAddress,
  191. numberOfPointsToRead,
  192. startWriteAddress,
  193. writeData);
  194. }
  195. /// <summary>
  196. /// Asynchronously performs a combination of one read operation and one write operation in a single Modbus transaction.
  197. /// The write operation is performed before the read.
  198. /// </summary>
  199. /// <param name="startReadAddress">Address to begin reading (Holding registers are addressed starting at 0).</param>
  200. /// <param name="numberOfPointsToRead">Number of registers to read.</param>
  201. /// <param name="startWriteAddress">Address to begin writing (Holding registers are addressed starting at 0).</param>
  202. /// <param name="writeData">Register values to write.</param>
  203. /// <returns>A task that represents the asynchronous operation.</returns>
  204. public Task<ushort[]> ReadWriteMultipleRegistersAsync(
  205. ushort startReadAddress,
  206. ushort numberOfPointsToRead,
  207. ushort startWriteAddress,
  208. ushort[] writeData)
  209. {
  210. return base.ReadWriteMultipleRegistersAsync(
  211. Modbus.DefaultIpSlaveUnitId,
  212. startReadAddress,
  213. numberOfPointsToRead,
  214. startWriteAddress,
  215. writeData);
  216. }
  217. }
  218. }