Skip to content

Correct references to holding registers in docs #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2022
Merged

Correct references to holding registers in docs #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ long holdingRegisterRead(int id, int address);

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

### `client.inputRegisterRead()`

Expand Down Expand Up @@ -167,7 +167,7 @@ int beginTransmission(int id, int type, int address, int nb);

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

Expand Down Expand Up @@ -229,7 +229,7 @@ int requestFrom(int id, int type, int address,int nb);

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

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

### `modbusServer.inputRegisterRead()`

Expand Down Expand Up @@ -835,4 +835,3 @@ modbusTCPserver.accept(client);

#### Returns
Nothing