Skip to content

Commit cbb0593

Browse files
authored
Correct references to holding registers in docs
- The library's `HOLDING_REGISTERS` macro was incorrectly documented as `HOLD_REGISTERS`. - The term "holding register" was misspelled "holiding register".
1 parent 284cb68 commit cbb0593

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

Diff for: docs/api.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ long holdingRegisterRead(int id, int address);
6161

6262
- id (slave) - id of target, defaults to 0x00 if not specified
6363
- address start address to use for operation
64-
- holiding register value on success, -1 on failure.
64+
- holding register value on success, -1 on failure.
6565

6666
### `client.inputRegisterRead()`
6767

@@ -167,7 +167,7 @@ int beginTransmission(int id, int type, int address, int nb);
167167

168168
#### Parameters
169169
- id (slave) - id of target, defaults to 0x00 if not specified
170-
- type - type of write to perform, either COILS or HOLD_REGISTERS
170+
- type - type of write to perform, either COILS or HOLDING_REGISTERS
171171
- address start address to use for operation
172172
- nb - number of values to write
173173

@@ -229,7 +229,7 @@ int requestFrom(int id, int type, int address,int nb);
229229

230230
#### Parameters
231231
- id (slave) - id of target, defaults to 0x00 if not specified
232-
type - type of read to perform, either COILS, DISCRETE_INPUTS, HOLD_REGISTERS, or INPUT_REGISTERS
232+
type - type of read to perform, either COILS, DISCRETE_INPUTS, HOLDING_REGISTERS, or INPUT_REGISTERS
233233
- address start address to use for operation
234234
- nb - number of values to read
235235

@@ -551,7 +551,7 @@ long holdingRegisterRead(int id, int address);
551551
#### Parameters
552552
- id (slave) - id of target, defaults to 0x00 if not specified
553553
- address start address to use for operation
554-
- holiding register value on success, -1 on failure.
554+
- holding register value on success, -1 on failure.
555555

556556
### `modbusServer.inputRegisterRead()`
557557

@@ -835,4 +835,3 @@ modbusTCPserver.accept(client);
835835

836836
#### Returns
837837
Nothing
838-

0 commit comments

Comments
 (0)