22
33## Modbus Client
44
5- ### ` coilRead() `
5+ ### ` client. coilRead()`
66
77#### Description
88
@@ -23,7 +23,7 @@ int coilRead(int id, int address);
2323#### Returns
2424coil value on success, -1 on failure.
2525
26- ### ` discreteInputRead() `
26+ ### ` client. discreteInputRead()`
2727
2828#### Description
2929
@@ -44,7 +44,7 @@ int discreteInputRead(int id, int address);
4444#### Returns
4545discrete input value on success, -1 on failure.
4646
47- ### ` holdingRegisterRead() `
47+ ### ` client. holdingRegisterRead()`
4848
4949#### Description
5050
@@ -63,7 +63,7 @@ long holdingRegisterRead(int id, int address);
6363- address start address to use for operation
6464- holiding register value on success, -1 on failure.
6565
66- ### ` inputRegisterRead() `
66+ ### ` client. inputRegisterRead()`
6767
6868#### Description
6969
@@ -84,7 +84,7 @@ long inputRegisterRead(int id, int address);
8484#### Returns
8585input register value on success, -1 on failure.
8686
87- ### ` coilWrite() `
87+ ### ` client. coilWrite()`
8888
8989#### Description
9090
@@ -106,29 +106,7 @@ int coilWrite(int id, int address, uint8_t value);
106106#### Returns
1071071 on success, 0 on failure.
108108
109- ### ` coilWrite() `
110-
111- #### Description
112-
113- Perform a "Write Single Coil" operation for the specified address and value.
114-
115- #### Syntax
116-
117- ```
118- int coilWrite(int address, uint8_t value);
119- int coilWrite(int id, int address, uint8_t value);
120- ```
121-
122- #### Parameters
123- - id (slave) - id of target, defaults to 0x00 if not specified
124- - address address to use for operation
125- - value coi -l value to write
126-
127-
128- #### Returns
129- 1 on success, 0 on failure.
130-
131- ### ` holdingRegisterWrite() `
109+ ### ` client.holdingRegisterWrite() `
132110
133111#### Description
134112
@@ -150,7 +128,7 @@ int holdingRegisterWrite(int id, int address, uint16_t value);
150128#### Returns
1511291 on success, 0 on failure.
152130
153- ### ` registerMaskWrite() `
131+ ### ` client. registerMaskWrite()`
154132
155133#### Description
156134
@@ -173,7 +151,7 @@ int registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask);
173151#### Returns
1741521 on success, 0 on failure.
175153
176- ### ` beginTransmission() `
154+ ### ` client. beginTransmission()`
177155
178156#### Description
179157
@@ -197,7 +175,7 @@ int beginTransmission(int id, int type, int address, int nb);
197175#### Returns
1981761 on success, 0 on failure
199177
200- ### ` write() `
178+ ### ` client. write()`
201179
202180#### Description
203181
@@ -216,7 +194,7 @@ int write(unsigned int value);
216194#### Returns
2171951 on success, 0 on failure
218196
219- ### ` endTransmission() `
197+ ### ` client. endTransmission()`
220198
221199#### Description
222200
235213#### Returns
2362141 on success, 0 on failure
237215
238- ### ` requestFrom() `
216+ ### ` client. requestFrom()`
239217
240218#### Description
241219
@@ -259,7 +237,7 @@ type - type of read to perform, either COILS, DISCRETE_INPUTS, HOLD_REGISTERS, o
259237#### Returns
2602380 on failure, number of values read on success
261239
262- ### ` available() `
240+ ### ` client. available()`
263241
264242#### Description
265243
278256#### Returns
279257number of values available for reading use read()
280258
281- ### ` read() `
259+ ### ` client. read()`
282260
283261#### Description
284262
297275#### Returns
298276-1 on failure, value on success
299277
300- ### ` lastError() `
278+ ### ` client. lastError()`
301279
302280#### Description
303281
316294#### Returns
317295Last error reason as a C string
318296
319- ### ` end() `
297+ ### ` client. end()`
320298
321299#### Description
322300
@@ -337,7 +315,7 @@ nothing
337315
338316## ModbusRTUClient Class
339317
340- ### ` begin() `
318+ ### ` modbusRTUClient. begin()`
341319
342320#### Description
343321
@@ -375,7 +353,7 @@ ModbusTCPClient(client);
375353#### Parameters
376354- Client - to use for the transport
377355
378- ### ` begin() `
356+ ### ` modbusTCPClient. begin()`
379357
380358#### Description
381359
@@ -395,7 +373,7 @@ modbusTCPClient.begin(ip, port);
395373#### Returns
3963741 on success, 0 on failure
397375
398- ### ` connected() `
376+ ### ` modbusTCPClient. connected()`
399377
400378#### Description
401379
414392#### Returns
415393Returns true if the client is connected, false if not.
416394
417- ### ` stop() `
395+ ### ` modbusTCPClient. stop()`
418396
419397#### Description
420398
@@ -435,7 +413,7 @@ Nothing
435413
436414## ModbusServer Class
437415
438- ### ` configureCoils() `
416+ ### ` modbusServer. configureCoils()`
439417
440418#### Description
441419
@@ -455,7 +433,7 @@ int configureCoils(int startAddress, int nb);
455433#### Returns
4564340 on success, 1 on failure
457435
458- ### ` configureDiscreteInputs() `
436+ ### ` modbusServer. configureDiscreteInputs()`
459437
460438#### Description
461439
@@ -475,7 +453,7 @@ int configureDiscreteInputs(int startAddress, int nb);
475453#### Returns
4764540 on success, 1 on failure
477455
478- ### ` configureHoldingRegisters() `
456+ ### ` modbusServer. configureHoldingRegisters()`
479457
480458#### Description
481459
@@ -495,7 +473,7 @@ int configureHoldingRegisters(int startAddress, int nb);
495473#### Returns
4964740 on success, 1 on failure
497475
498- ### ` configureInputRegisters() `
476+ ### ` modbusServer. configureInputRegisters()`
499477
500478#### Description
501479
@@ -515,7 +493,7 @@ int configureInputRegisters(int startAddress, int nb);
515493#### Returns
5164940 on success, 1 on failure
517495
518- ### ` coilRead() `
496+ ### ` modbusServer. coilRead()`
519497
520498#### Description
521499
@@ -536,7 +514,7 @@ int coilRead(int id, int address);
536514#### Returns
537515coil value on success, -1 on failure.
538516
539- ### ` discreteInputRead() `
517+ ### ` modbusServer. discreteInputRead()`
540518
541519#### Description
542520
@@ -557,7 +535,7 @@ int discreteInputRead(int id, int address);
557535#### Returns
558536discrete input value on success, -1 on failure.
559537
560- ### ` holdingRegisterRead() `
538+ ### ` modbusServer. holdingRegisterRead()`
561539
562540#### Description
563541
@@ -575,7 +553,7 @@ long holdingRegisterRead(int id, int address);
575553- address start address to use for operation
576554- holiding register value on success, -1 on failure.
577555
578- ### ` inputRegisterRead() `
556+ ### ` modbusServer. inputRegisterRead()`
579557
580558#### Description
581559
@@ -596,7 +574,7 @@ long inputRegisterRead(int id, int address);
596574#### Returns
597575input register value on success, -1 on failure.
598576
599- ### ` coilWrite() `
577+ ### ` modbusServer. coilWrite()`
600578
601579#### Description
602580
@@ -618,7 +596,7 @@ int coilWrite(int id, int address, uint8_t value);
618596#### Returns
6195971 on success, 0 on failure.
620598
621- ### ` holdingRegisterWrite() `
599+ ### ` modbusServer. holdingRegisterWrite()`
622600
623601#### Description
624602
@@ -640,7 +618,7 @@ int holdingRegisterWrite(int id, int address, uint16_t value);
640618#### Returns
6416191 on success, 0 on failure.
642620
643- ### ` registerMaskWrite() `
621+ ### ` modbusServer. registerMaskWrite()`
644622
645623#### Description
646624
@@ -662,7 +640,7 @@ int registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask);
662640#### Returns
6636411 on success, 0 on failure.
664642
665- ### ` discreteInputWrite() `
643+ ### ` modbusServer. discreteInputWrite()`
666644
667645#### Description
668646
@@ -682,7 +660,7 @@ int discreteInputWrite(int address, uint8_t value);
682660#### Returns
6836611 on success, 0 on failure.
684662
685- ### ` writeDiscreteInputs() `
663+ ### ` modbusServer. writeDiscreteInputs()`
686664
687665#### Description
688666
@@ -703,7 +681,7 @@ int writeDiscreteInputs(int address, uint8_t values[], int nb);
703681#### Returns
7046821 on success, 0 on failure.
705683
706- ### ` inputRegisterWrite() `
684+ ### ` modbusServer. inputRegisterWrite()`
707685
708686#### Description
709687
@@ -723,7 +701,7 @@ int inputRegisterWrite(int address, uint16_t value);
723701#### Returns
7247021 on success, 0 on failure.
725703
726- ### ` writeInputRegisters() `
704+ ### ` modbusServer. writeInputRegisters()`
727705
728706#### Description
729707
@@ -743,7 +721,7 @@ int writeInputRegisters(int address, uint16_t values[], int nb);
743721#### Returns
7447221 on success, 0 on failure.
745723
746- ### ` poll() `
724+ ### ` modbusServer. poll()`
747725
748726#### Description
749727
761739#### Returns
762740nothing
763741
764- ### ` end() `
742+ ### ` modbusServer. end()`
765743
766744#### Description
767745
@@ -781,7 +759,7 @@ nothing
781759
782760## ModbusRTUServer Class
783761
784- ### ` begin() `
762+ ### ` modbusRTUServer. begin()`
785763
786764#### Description
787765
@@ -819,7 +797,7 @@ ModbusTCPServer();
819797#### Parameters
820798None
821799
822- ### ` begin() `
800+ ### ` modbusTCPServer. begin()`
823801
824802#### Description
825803
@@ -839,7 +817,7 @@ modbusTCPserver.begin(id);
839817#### Returns
8408181 on success, 0 on failure
841819
842- ### ` accept() `
820+ ### ` modbusTCPServer. accept()`
843821
844822#### Description
845823
0 commit comments