提交 | 用户 | 时间
|
e46d3b
|
1 |
<?xml version="1.0"?> |
懒 |
2 |
<doc> |
|
3 |
<assembly> |
|
4 |
<name>EasyModbus</name> |
|
5 |
</assembly> |
|
6 |
<members> |
|
7 |
<member name="T:EasyModbus.ModbusClient"> |
|
8 |
<summary> |
|
9 |
Implements a ModbusClient. |
|
10 |
</summary> |
|
11 |
</member> |
|
12 |
<member name="M:EasyModbus.ModbusClient.#ctor(System.String,System.Int32)"> |
|
13 |
<summary> |
|
14 |
Constructor which determines the Master ip-address and the Master Port. |
|
15 |
</summary> |
|
16 |
<param name="ipAddress">IP-Address of the Master device</param> |
|
17 |
<param name="port">Listening port of the Master device (should be 502)</param> |
|
18 |
</member> |
|
19 |
<member name="M:EasyModbus.ModbusClient.#ctor(System.String)"> |
|
20 |
<summary> |
|
21 |
Constructor which determines the Serial-Port |
|
22 |
</summary> |
|
23 |
<param name="serialPort">Serial-Port Name e.G. "COM1"</param> |
|
24 |
</member> |
|
25 |
<member name="M:EasyModbus.ModbusClient.#ctor"> |
|
26 |
<summary> |
|
27 |
Parameterless constructor |
|
28 |
</summary> |
|
29 |
</member> |
|
30 |
<member name="M:EasyModbus.ModbusClient.Connect"> |
|
31 |
<summary> |
|
32 |
Establish connection to Master device in case of Modbus TCP. Opens COM-Port in case of Modbus RTU |
|
33 |
</summary> |
|
34 |
</member> |
|
35 |
<member name="M:EasyModbus.ModbusClient.Connect(System.String,System.Int32)"> |
|
36 |
<summary> |
|
37 |
Establish connection to Master device in case of Modbus TCP. |
|
38 |
</summary> |
|
39 |
</member> |
|
40 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToFloat(System.Int32[])"> |
|
41 |
<summary> |
|
42 |
Converts two ModbusRegisters to Float - Example: EasyModbus.ModbusClient.ConvertRegistersToFloat(modbusClient.ReadHoldingRegisters(19,2)) |
|
43 |
</summary> |
|
44 |
<param name="registers">Two Register values received from Modbus</param> |
|
45 |
<returns>Connected float value</returns> |
|
46 |
</member> |
|
47 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToFloat(System.Int32[],EasyModbus.ModbusClient.RegisterOrder)"> |
|
48 |
<summary> |
|
49 |
Converts two ModbusRegisters to Float, Registers can by swapped |
|
50 |
</summary> |
|
51 |
<param name="registers">Two Register values received from Modbus</param> |
|
52 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
53 |
<returns>Connected float value</returns> |
|
54 |
</member> |
|
55 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToInt(System.Int32[])"> |
|
56 |
<summary> |
|
57 |
Converts two ModbusRegisters to 32 Bit Integer value |
|
58 |
</summary> |
|
59 |
<param name="registers">Two Register values received from Modbus</param> |
|
60 |
<returns>Connected 32 Bit Integer value</returns> |
|
61 |
</member> |
|
62 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToInt(System.Int32[],EasyModbus.ModbusClient.RegisterOrder)"> |
|
63 |
<summary> |
|
64 |
Converts two ModbusRegisters to 32 Bit Integer Value - Registers can be swapped |
|
65 |
</summary> |
|
66 |
<param name="registers">Two Register values received from Modbus</param> |
|
67 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
68 |
<returns>Connecteds 32 Bit Integer value</returns> |
|
69 |
</member> |
|
70 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToLong(System.Int32[])"> |
|
71 |
<summary> |
|
72 |
Convert four 16 Bit Registers to 64 Bit Integer value Register Order "LowHigh": Reg0: Low Word.....Reg3: High Word, "HighLow": Reg0: High Word.....Reg3: Low Word |
|
73 |
</summary> |
|
74 |
<param name="registers">four Register values received from Modbus</param> |
|
75 |
<returns>64 bit value</returns> |
|
76 |
</member> |
|
77 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToLong(System.Int32[],EasyModbus.ModbusClient.RegisterOrder)"> |
|
78 |
<summary> |
|
79 |
Convert four 16 Bit Registers to 64 Bit Integer value - Registers can be swapped |
|
80 |
</summary> |
|
81 |
<param name="registers">four Register values received from Modbus</param> |
|
82 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
83 |
<returns>Connected 64 Bit Integer value</returns> |
|
84 |
</member> |
|
85 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToDouble(System.Int32[])"> |
|
86 |
<summary> |
|
87 |
Convert four 16 Bit Registers to 64 Bit double prec. value Register Order "LowHigh": Reg0: Low Word.....Reg3: High Word, "HighLow": Reg0: High Word.....Reg3: Low Word |
|
88 |
</summary> |
|
89 |
<param name="registers">four Register values received from Modbus</param> |
|
90 |
<returns>64 bit value</returns> |
|
91 |
</member> |
|
92 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToDouble(System.Int32[],EasyModbus.ModbusClient.RegisterOrder)"> |
|
93 |
<summary> |
|
94 |
Convert four 16 Bit Registers to 64 Bit double prec. value - Registers can be swapped |
|
95 |
</summary> |
|
96 |
<param name="registers">four Register values received from Modbus</param> |
|
97 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
98 |
<returns>Connected double prec. float value</returns> |
|
99 |
</member> |
|
100 |
<member name="M:EasyModbus.ModbusClient.ConvertFloatToRegisters(System.Single)"> |
|
101 |
<summary> |
|
102 |
Converts float to two ModbusRegisters - Example: modbusClient.WriteMultipleRegisters(24, EasyModbus.ModbusClient.ConvertFloatToTwoRegisters((float)1.22)); |
|
103 |
</summary> |
|
104 |
<param name="floatValue">Float value which has to be converted into two registers</param> |
|
105 |
<returns>Register values</returns> |
|
106 |
</member> |
|
107 |
<member name="M:EasyModbus.ModbusClient.ConvertFloatToRegisters(System.Single,EasyModbus.ModbusClient.RegisterOrder)"> |
|
108 |
<summary> |
|
109 |
Converts float to two ModbusRegisters Registers - Registers can be swapped |
|
110 |
</summary> |
|
111 |
<param name="floatValue">Float value which has to be converted into two registers</param> |
|
112 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
113 |
<returns>Register values</returns> |
|
114 |
</member> |
|
115 |
<member name="M:EasyModbus.ModbusClient.ConvertIntToRegisters(System.Int32)"> |
|
116 |
<summary> |
|
117 |
Converts 32 Bit Value to two ModbusRegisters |
|
118 |
</summary> |
|
119 |
<param name="intValue">Int value which has to be converted into two registers</param> |
|
120 |
<returns>Register values</returns> |
|
121 |
</member> |
|
122 |
<member name="M:EasyModbus.ModbusClient.ConvertIntToRegisters(System.Int32,EasyModbus.ModbusClient.RegisterOrder)"> |
|
123 |
<summary> |
|
124 |
Converts 32 Bit Value to two ModbusRegisters Registers - Registers can be swapped |
|
125 |
</summary> |
|
126 |
<param name="intValue">Double value which has to be converted into two registers</param> |
|
127 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
128 |
<returns>Register values</returns> |
|
129 |
</member> |
|
130 |
<member name="M:EasyModbus.ModbusClient.ConvertLongToRegisters(System.Int64)"> |
|
131 |
<summary> |
|
132 |
Converts 64 Bit Value to four ModbusRegisters |
|
133 |
</summary> |
|
134 |
<param name="longValue">long value which has to be converted into four registers</param> |
|
135 |
<returns>Register values</returns> |
|
136 |
</member> |
|
137 |
<member name="M:EasyModbus.ModbusClient.ConvertLongToRegisters(System.Int64,EasyModbus.ModbusClient.RegisterOrder)"> |
|
138 |
<summary> |
|
139 |
Converts 64 Bit Value to four ModbusRegisters - Registers can be swapped |
|
140 |
</summary> |
|
141 |
<param name="longValue">long value which has to be converted into four registers</param> |
|
142 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
143 |
<returns>Register values</returns> |
|
144 |
</member> |
|
145 |
<member name="M:EasyModbus.ModbusClient.ConvertDoubleToRegisters(System.Double)"> |
|
146 |
<summary> |
|
147 |
Converts 64 Bit double prec Value to four ModbusRegisters |
|
148 |
</summary> |
|
149 |
<param name="doubleValue">double value which has to be converted into four registers</param> |
|
150 |
<returns>Register values</returns> |
|
151 |
</member> |
|
152 |
<member name="M:EasyModbus.ModbusClient.ConvertDoubleToRegisters(System.Double,EasyModbus.ModbusClient.RegisterOrder)"> |
|
153 |
<summary> |
|
154 |
Converts 64 Bit double prec. Value to four ModbusRegisters - Registers can be swapped |
|
155 |
</summary> |
|
156 |
<param name="doubleValue">double value which has to be converted into four registers</param> |
|
157 |
<param name="registerOrder">Desired Word Order (Low Register first or High Register first</param> |
|
158 |
<returns>Register values</returns> |
|
159 |
</member> |
|
160 |
<member name="M:EasyModbus.ModbusClient.ConvertRegistersToString(System.Int32[],System.Int32,System.Int32)"> |
|
161 |
<summary> |
|
162 |
Converts 16 - Bit Register values to String |
|
163 |
</summary> |
|
164 |
<param name="registers">Register array received via Modbus</param> |
|
165 |
<param name="offset">First Register containing the String to convert</param> |
|
166 |
<param name="stringLength">number of characters in String (must be even)</param> |
|
167 |
<returns>Converted String</returns> |
|
168 |
</member> |
|
169 |
<member name="M:EasyModbus.ModbusClient.ConvertStringToRegisters(System.String)"> |
|
170 |
<summary> |
|
171 |
Converts a String to 16 - Bit Registers |
|
172 |
</summary> |
|
173 |
<param name="registers">Register array received via Modbus</param> |
|
174 |
<returns>Converted String</returns> |
|
175 |
</member> |
|
176 |
<member name="M:EasyModbus.ModbusClient.calculateCRC(System.Byte[],System.UInt16,System.Int32)"> |
|
177 |
<summary> |
|
178 |
Calculates the CRC16 for Modbus-RTU |
|
179 |
</summary> |
|
180 |
<param name="data">Byte buffer to send</param> |
|
181 |
<param name="numberOfBytes">Number of bytes to calculate CRC</param> |
|
182 |
<param name="startByte">First byte in buffer to start calculating CRC</param> |
|
183 |
</member> |
|
184 |
<member name="M:EasyModbus.ModbusClient.ReadDiscreteInputs(System.Int32,System.Int32)"> |
|
185 |
<summary> |
|
186 |
Read Discrete Inputs from Server device (FC2). |
|
187 |
</summary> |
|
188 |
<param name="startingAddress">First discrete input to read</param> |
|
189 |
<param name="quantity">Number of discrete Inputs to read</param> |
|
190 |
<returns>Boolean Array which contains the discrete Inputs</returns> |
|
191 |
</member> |
|
192 |
<member name="M:EasyModbus.ModbusClient.ReadCoils(System.Int32,System.Int32)"> |
|
193 |
<summary> |
|
194 |
Read Coils from Server device (FC1). |
|
195 |
</summary> |
|
196 |
<param name="startingAddress">First coil to read</param> |
|
197 |
<param name="quantity">Numer of coils to read</param> |
|
198 |
<returns>Boolean Array which contains the coils</returns> |
|
199 |
</member> |
|
200 |
<member name="M:EasyModbus.ModbusClient.ReadHoldingRegisters(System.Int32,System.Int32)"> |
|
201 |
<summary> |
|
202 |
Read Holding Registers from Master device (FC3). |
|
203 |
</summary> |
|
204 |
<param name="startingAddress">First holding register to be read</param> |
|
205 |
<param name="quantity">Number of holding registers to be read</param> |
|
206 |
<returns>Int Array which contains the holding registers</returns> |
|
207 |
</member> |
|
208 |
<member name="M:EasyModbus.ModbusClient.ReadInputRegisters(System.Int32,System.Int32)"> |
|
209 |
<summary> |
|
210 |
Read Input Registers from Master device (FC4). |
|
211 |
</summary> |
|
212 |
<param name="startingAddress">First input register to be read</param> |
|
213 |
<param name="quantity">Number of input registers to be read</param> |
|
214 |
<returns>Int Array which contains the input registers</returns> |
|
215 |
</member> |
|
216 |
<member name="M:EasyModbus.ModbusClient.WriteSingleCoil(System.Int32,System.Boolean)"> |
|
217 |
<summary> |
|
218 |
Write single Coil to Master device (FC5). |
|
219 |
</summary> |
|
220 |
<param name="startingAddress">Coil to be written</param> |
|
221 |
<param name="value">Coil Value to be written</param> |
|
222 |
</member> |
|
223 |
<member name="M:EasyModbus.ModbusClient.WriteSingleRegister(System.Int32,System.Int32)"> |
|
224 |
<summary> |
|
225 |
Write single Register to Master device (FC6). |
|
226 |
</summary> |
|
227 |
<param name="startingAddress">Register to be written</param> |
|
228 |
<param name="value">Register Value to be written</param> |
|
229 |
</member> |
|
230 |
<member name="M:EasyModbus.ModbusClient.WriteMultipleCoils(System.Int32,System.Boolean[])"> |
|
231 |
<summary> |
|
232 |
Write multiple coils to Master device (FC15). |
|
233 |
</summary> |
|
234 |
<param name="startingAddress">First coil to be written</param> |
|
235 |
<param name="values">Coil Values to be written</param> |
|
236 |
</member> |
|
237 |
<member name="M:EasyModbus.ModbusClient.WriteMultipleRegisters(System.Int32,System.Int32[])"> |
|
238 |
<summary> |
|
239 |
Write multiple registers to Master device (FC16). |
|
240 |
</summary> |
|
241 |
<param name="startingAddress">First register to be written</param> |
|
242 |
<param name="values">register Values to be written</param> |
|
243 |
</member> |
|
244 |
<member name="M:EasyModbus.ModbusClient.ReadWriteMultipleRegisters(System.Int32,System.Int32,System.Int32,System.Int32[])"> |
|
245 |
<summary> |
|
246 |
Read/Write Multiple Registers (FC23). |
|
247 |
</summary> |
|
248 |
<param name="startingAddressRead">First input register to read</param> |
|
249 |
<param name="quantityRead">Number of input registers to read</param> |
|
250 |
<param name="startingAddressWrite">First input register to write</param> |
|
251 |
<param name="values">Values to write</param> |
|
252 |
<returns>Int Array which contains the Holding registers</returns> |
|
253 |
</member> |
|
254 |
<member name="M:EasyModbus.ModbusClient.Disconnect"> |
|
255 |
<summary> |
|
256 |
Close connection to Master Device. |
|
257 |
</summary> |
|
258 |
</member> |
|
259 |
<member name="M:EasyModbus.ModbusClient.Finalize"> |
|
260 |
<summary> |
|
261 |
Destructor - Close connection to Master Device. |
|
262 |
</summary> |
|
263 |
</member> |
|
264 |
<member name="P:EasyModbus.ModbusClient.Connected"> |
|
265 |
<summary> |
|
266 |
Returns "TRUE" if Client is connected to Server and "FALSE" if not. In case of Modbus RTU returns if COM-Port is opened |
|
267 |
</summary> |
|
268 |
</member> |
|
269 |
<member name="P:EasyModbus.ModbusClient.IPAddress"> |
|
270 |
<summary> |
|
271 |
Gets or Sets the IP-Address of the Server. |
|
272 |
</summary> |
|
273 |
</member> |
|
274 |
<member name="P:EasyModbus.ModbusClient.Port"> |
|
275 |
<summary> |
|
276 |
Gets or Sets the Port were the Modbus-TCP Server is reachable (Standard is 502). |
|
277 |
</summary> |
|
278 |
</member> |
|
279 |
<member name="P:EasyModbus.ModbusClient.UDPFlag"> |
|
280 |
<summary> |
|
281 |
Gets or Sets the UDP-Flag to activate Modbus UDP. |
|
282 |
</summary> |
|
283 |
</member> |
|
284 |
<member name="P:EasyModbus.ModbusClient.UnitIdentifier"> |
|
285 |
<summary> |
|
286 |
Gets or Sets the Unit identifier in case of serial connection (Default = 0) |
|
287 |
</summary> |
|
288 |
</member> |
|
289 |
<member name="P:EasyModbus.ModbusClient.Baudrate"> |
|
290 |
<summary> |
|
291 |
Gets or Sets the Baudrate for serial connection (Default = 9600) |
|
292 |
</summary> |
|
293 |
</member> |
|
294 |
<member name="P:EasyModbus.ModbusClient.Parity"> |
|
295 |
<summary> |
|
296 |
Gets or Sets the of Parity in case of serial connection |
|
297 |
</summary> |
|
298 |
</member> |
|
299 |
<member name="P:EasyModbus.ModbusClient.StopBits"> |
|
300 |
<summary> |
|
301 |
Gets or Sets the number of stopbits in case of serial connection |
|
302 |
</summary> |
|
303 |
</member> |
|
304 |
<member name="P:EasyModbus.ModbusClient.ConnectionTimeout"> |
|
305 |
<summary> |
|
306 |
Gets or Sets the connection Timeout in case of ModbusTCP connection |
|
307 |
</summary> |
|
308 |
</member> |
|
309 |
<member name="P:EasyModbus.ModbusClient.SerialPort"> |
|
310 |
<summary> |
|
311 |
Gets or Sets the serial Port |
|
312 |
</summary> |
|
313 |
</member> |
|
314 |
<member name="P:EasyModbus.ModbusClient.LogFileFilename"> |
|
315 |
<summary> |
|
316 |
Gets or Sets the Filename for the LogFile |
|
317 |
</summary> |
|
318 |
</member> |
|
319 |
<member name="T:EasyModbus.Exceptions.SerialPortNotOpenedException"> |
|
320 |
<summary> |
|
321 |
Exception to be thrown if serial port is not opened |
|
322 |
</summary> |
|
323 |
</member> |
|
324 |
<member name="T:EasyModbus.Exceptions.ConnectionException"> |
|
325 |
<summary> |
|
326 |
Exception to be thrown if Connection to Modbus device failed |
|
327 |
</summary> |
|
328 |
</member> |
|
329 |
<member name="T:EasyModbus.Exceptions.FunctionCodeNotSupportedException"> |
|
330 |
<summary> |
|
331 |
Exception to be thrown if Modbus Server returns error code "Function code not supported" |
|
332 |
</summary> |
|
333 |
</member> |
|
334 |
<member name="T:EasyModbus.Exceptions.QuantityInvalidException"> |
|
335 |
<summary> |
|
336 |
Exception to be thrown if Modbus Server returns error code "quantity invalid" |
|
337 |
</summary> |
|
338 |
</member> |
|
339 |
<member name="T:EasyModbus.Exceptions.StartingAddressInvalidException"> |
|
340 |
<summary> |
|
341 |
Exception to be thrown if Modbus Server returns error code "starting adddress and quantity invalid" |
|
342 |
</summary> |
|
343 |
</member> |
|
344 |
<member name="T:EasyModbus.Exceptions.ModbusException"> |
|
345 |
<summary> |
|
346 |
Exception to be thrown if Modbus Server returns error code "Function Code not executed (0x04)" |
|
347 |
</summary> |
|
348 |
</member> |
|
349 |
<member name="T:EasyModbus.Exceptions.CRCCheckFailedException"> |
|
350 |
<summary> |
|
351 |
Exception to be thrown if CRC Check failed |
|
352 |
</summary> |
|
353 |
</member> |
|
354 |
<member name="T:EasyModbus.ModbusProtocol"> |
|
355 |
<summary> |
|
356 |
Modbus Protocol informations. |
|
357 |
</summary> |
|
358 |
</member> |
|
359 |
<member name="P:EasyModbus.TCPHandler.LocalIPAddress"> |
|
360 |
When making a server TCP listen socket, will listen to this IP address. |
|
361 |
</member> |
|
362 |
<member name="M:EasyModbus.TCPHandler.#ctor(System.Int32)"> |
|
363 |
<summary> |
|
364 |
Listen to all network interfaces. |
|
365 |
</summary> |
|
366 |
<param name="port">TCP port to listen</param> |
|
367 |
</member> |
|
368 |
<member name="M:EasyModbus.TCPHandler.#ctor(System.Net.IPAddress,System.Int32)"> |
|
369 |
<summary> |
|
370 |
Listen to a specific network interface. |
|
371 |
</summary> |
|
372 |
<param name="localIPAddress">IP address of network interface to listen</param> |
|
373 |
<param name="port">TCP port to listen</param> |
|
374 |
</member> |
|
375 |
<member name="T:EasyModbus.ModbusServer"> |
|
376 |
<summary> |
|
377 |
Modbus TCP Server. |
|
378 |
</summary> |
|
379 |
</member> |
|
380 |
<member name="P:EasyModbus.ModbusServer.LocalIPAddress"> |
|
381 |
<summary> |
|
382 |
When creating a TCP or UDP socket, the local IP address to attach to. |
|
383 |
</summary> |
|
384 |
</member> |
|
385 |
<member name="P:EasyModbus.ModbusServer.LogFileFilename"> |
|
386 |
<summary> |
|
387 |
Gets or Sets the Filename for the LogFile |
|
388 |
</summary> |
|
389 |
</member> |
|
390 |
<member name="T:EasyModbus.StoreLogData"> |
|
391 |
<summary> |
|
392 |
Store Log-Data in a File |
|
393 |
</summary> |
|
394 |
</member> |
|
395 |
<member name="M:EasyModbus.StoreLogData.#ctor"> |
|
396 |
<summary> |
|
397 |
Private constructor; Ensures the access of the class only via "instance" |
|
398 |
</summary> |
|
399 |
</member> |
|
400 |
<member name="P:EasyModbus.StoreLogData.Instance"> |
|
401 |
<summary> |
|
402 |
Returns the instance of the class (singleton) |
|
403 |
</summary> |
|
404 |
<returns>instance (Singleton)</returns> |
|
405 |
</member> |
|
406 |
<member name="M:EasyModbus.StoreLogData.Store(System.String)"> |
|
407 |
<summary> |
|
408 |
Store message in Log-File |
|
409 |
</summary> |
|
410 |
<param name="message">Message to append to the Log-File</param> |
|
411 |
</member> |
|
412 |
<member name="M:EasyModbus.StoreLogData.Store(System.String,System.DateTime)"> |
|
413 |
<summary> |
|
414 |
Store message in Log-File including Timestamp |
|
415 |
</summary> |
|
416 |
<param name="message">Message to append to the Log-File</param> |
|
417 |
<param name="timestamp">Timestamp to add to the same Row</param> |
|
418 |
</member> |
|
419 |
<member name="P:EasyModbus.StoreLogData.Filename"> |
|
420 |
<summary> |
|
421 |
Gets or Sets the Filename to Store Strings in a File |
|
422 |
</summary> |
|
423 |
</member> |
|
424 |
</members> |
|
425 |
</doc> |