Skip to content

Commit dbffaee

Browse files
authored
Merge branch 'stephane:master' into master
2 parents a83083b + b25629b commit dbffaee

22 files changed

+36
-34
lines changed

.clabot

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
"sirsoweird",
2626
"taikiakita",
2727
"vvck",
28-
"woodsnake"
28+
"woodsnake",
29+
"vancepym",
30+
"mek-x"
2931
],
3032
"message": "We require contributors to sign our Contributor License Agreement. In order for us to review and merge your code, please fill https://forms.gle/5635zjphDo5JEJQSA to get added. Your document will be manually checked by the maintainer. Be patient..."
3133
}

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Modbus specification, instead all bytes are sent as fast as possible and a
7777
response or an indication is considered complete when all expected characters
7878
have been received. This implementation offers very fast communication but you
7979
must take care to set a response timeout of slaves less than response timeout of
80-
master (ortherwise other slaves may ignore master requests when one of the slave
80+
master (otherwise other slaves may ignore master requests when one of the slaves
8181
is not responding).
8282

8383
To create a Modbus RTU context, you should use [modbus_new_rtu](modbus_new_rtu.md).
@@ -107,7 +107,7 @@ communications over TCP IPv4 and IPv6 networks. It does not require a checksum
107107
calculation as lower layer takes care of the same.
108108

109109
Contrary to the TCP IPv4 only backend, the TCP PI backend offers hostname
110-
resolution but it consumes about 1Kb of additional memory.
110+
resolution but it consumes about 1 kB of additional memory.
111111

112112
Create a Modbus TCP PI context, you should use [modbus_new_tcp_pi](modbus_new_tcp_pi.md).
113113

docs/modbus_free.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ void modbus_free(modbus_t *ctx);
1212
1313
## Description
1414
15-
The *modbus_free()* function shall free an allocated modbus_t structure.
15+
The *modbus_free()* function shall free an allocated *modbus_t* structure.
1616
1717
## Return value
1818

docs/modbus_get_byte_from_bits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ uint8_t modbus_get_byte_from_bits(const uint8_t *src, int index, unsigned int nb
1414
1515
The *modbus_get_byte_from_bits()* function shall extract a value from many
1616
bits. All `nb_bits` bits from `src` at position `index` will be read as a
17-
single value. To obtain a full byte, set nb_bits to 8.
17+
single value. To obtain a full byte, set `nb_bits` to 8.
1818
1919
## Return value
2020

docs/modbus_get_header_length.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ int modbus_get_header_length(modbus_t *ctx);
1414
1515
The *modbus_get_header_length()* function shall retrieve the current header
1616
length from the backend. This function is convenient to manipulate a message and
17-
so its limited to low-level operations.
17+
so it's limited to low-level operations.
1818
1919
## Return value
2020

docs/modbus_mapping_free.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ void modbus_mapping_free(modbus_mapping_t *mb_mapping);
1212
1313
## Description
1414
15-
The function shall free the four arrays of mb_mapping_t structure and finally
16-
the mb_mapping_t referenced by `mb_mapping`.
15+
The function shall free the four arrays of *modbus_mapping_t* structure and finally
16+
the *modbus_mapping_t* itself referenced by `mb_mapping`.
1717
1818
## Return value
1919

docs/modbus_mapping_new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ modbus_mapping_t* modbus_mapping_new(int nb_bits, int nb_input_bits, int nb_regi
1414
1515
The *modbus_mapping_new()* function shall allocate four arrays to store bits,
1616
input bits, registers and inputs registers. The pointers are stored in
17-
modbus_mapping_t structure. All values of the arrays are initialized to zero.
17+
*modbus_mapping_t* structure. All values of the arrays are initialized to zero.
1818
1919
This function is equivalent to a call of the
2020
[modbus_mapping_new_start_address](modbus_mapping_new_start_address.md) function

docs/modbus_mapping_new_start_address.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ modbus_mapping_t* modbus_mapping_new_start_address(
1818
1919
The `modbus_mapping_new_start_address()` function shall allocate four arrays to
2020
store bits, input bits, registers and inputs registers. The pointers are stored
21-
in modbus_mapping_t structure. All values of the arrays are initialized to zero.
21+
in *modbus_mapping_t* structure. All values of the arrays are initialized to zero.
2222
2323
The different starting addresses make it possible to place the mapping at any
24-
address in each address space. This way, you can give access to the clients at
24+
address in each address space. This way, you can give access to clients to
2525
values stored at high addresses without allocating memory from the address zero,
26-
for eg. to make available registers from 340 to 349, you can use:
26+
for example to make available registers from 340 to 349, you can use:
2727
2828
```c
2929
mb_mapping = modbus_mapping_new_start_address(0, 0, 0, 0, 340, 10, 0, 0);

docs/modbus_new_tcp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ modbus_t *modbus_new_tcp(const char *ip, int port);
1212
1313
## Description
1414
15-
The *modbus_new_tcp()* function shall allocate and initialize a modbus_t
15+
The *modbus_new_tcp()* function shall allocate and initialize a *modbus_t*
1616
structure to communicate with a Modbus TCP IPv4 server.
1717
1818
The `ip` argument specifies the IP address of the server to which the client
1919
wants to establish a connection. A NULL value can be used to listen any addresses in
2020
server mode.
2121
2222
The `port` argument is the TCP port to use. Set the port to
23-
`MODBUS_TCP_DEFAULT_PORT` to use the default one (502). Its convenient to use a
24-
port number greater than or equal to 1024 because its not necessary to have
23+
`MODBUS_TCP_DEFAULT_PORT` to use the default one (502). It's convenient to use a
24+
port number greater than or equal to 1024 because it's not necessary to have
2525
administrator privileges.
2626
2727
## Return value

docs/modbus_new_tcp_pi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ modbus_new_tcp_pi - create a libmodbus context for TCP Protocol Independent
1212
1313
## Description
1414
15-
The *modbus_new_tcp_pi()* function shall allocate and initialize a modbus_t
15+
The *modbus_new_tcp_pi()* function shall allocate and initialize a *modbus_t*
1616
structure to communicate with a Modbus TCP IPv4 or IPv6 server.
1717
1818
The `node` argument specifies the host name or IP address of the host to connect
@@ -21,8 +21,8 @@ listen any addresses in server mode.
2121
2222
The `service` argument is the service name/port number to connect to. To use the
2323
default Modbus port, you can provide an NULL value or the string "502". On many
24-
Unix systems, its convenient to use a port number greater than or equal to 1024
25-
because its not necessary to have administrator privileges.
24+
Unix systems, it's convenient to use a port number greater than or equal to 1024
25+
because it's not necessary to have administrator privileges.
2626
2727
:octicons-tag-24: v3.1.8 handles NULL value for `service` (no *EINVAL* error).
2828

0 commit comments

Comments
 (0)