Commit 54c0923c7586e1b36c299f46a8c1e25c87ad8e62

Authored by Jordan Johnson
Committed by Stéphane Raimbault
1 parent 14a43537

Fix doc links

Showing 55 changed files with 185 additions and 185 deletions
docs/index.md
@@ -42,7 +42,7 @@ Ethernet TCP) called backends in *libmodbus*. @@ -42,7 +42,7 @@ Ethernet TCP) called backends in *libmodbus*.
42 42
43 The first step is to allocate and set a `modbus_t` context according to the 43 The first step is to allocate and set a `modbus_t` context according to the
44 required backend (RTU or TCP) with a dedicated function, such as 44 required backend (RTU or TCP) with a dedicated function, such as
45 -[modbus_new_rtu](modbus_new_rtu). 45 +[modbus_new_rtu](modbus_new_rtu.md).
46 The function will return an opaque structure called `modbus_t` containing all 46 The function will return an opaque structure called `modbus_t` containing all
47 necessary information to establish a connection with other Modbus devices 47 necessary information to establish a connection with other Modbus devices
48 according to the selected backend. 48 according to the selected backend.
@@ -69,7 +69,7 @@ always initiated by the master. @@ -69,7 +69,7 @@ always initiated by the master.
69 69
70 Many Modbus devices can be connected together on the same physical link so 70 Many Modbus devices can be connected together on the same physical link so
71 before sending a message, you must set the slave (receiver) with 71 before sending a message, you must set the slave (receiver) with
72 -[modbus_set_slave](mobus_set_slave). If you're running a slave, its slave number 72 +[modbus_set_slave](modbus_set_slave.md). If you're running a slave, its slave number
73 will be used to filter received messages. 73 will be used to filter received messages.
74 74
75 The libmodbus implementation of RTU isn't time based as stated in original 75 The libmodbus implementation of RTU isn't time based as stated in original
@@ -80,17 +80,17 @@ must take care to set a response timeout of slaves less than response timeout of @@ -80,17 +80,17 @@ 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 (ortherwise other slaves may ignore master requests when one of the slave
81 is not responding). 81 is not responding).
82 82
83 -To create a Modbus RTU context, you should use [modbus_new_rtu](modbus_new_rtu). 83 +To create a Modbus RTU context, you should use [modbus_new_rtu](modbus_new_rtu.md).
84 84
85 You can tweak the serial mode with the following functions: 85 You can tweak the serial mode with the following functions:
86 86
87 -- [modbus_rtu_get_serial_mode](modbus_rtu_get_serial_mode)  
88 -- [modbus_rtu_set_serial_mode](modbus_rtu_set_serial_mode)  
89 -- [modbus_rtu_get_rts](modbus_rtu_get_rts)  
90 -- [modbus_rtu_set_rts](modbus_rtu_set_rts)  
91 -- [modbus_rtu_set_custom_rts](modbus_rtu_set_custom_rts)  
92 -- [modbus_rtu_get_rts_delay](modbus_rtu_get_rts_delay)  
93 -- [modbus_rtu_set_rts_delay](modbus_rtu_set_rts_delay) 87 +- [modbus_rtu_get_serial_mode](modbus_rtu_get_serial_mode.md)
  88 +- [modbus_rtu_set_serial_mode](modbus_rtu_set_serial_mode.md)
  89 +- [modbus_rtu_get_rts](modbus_rtu_get_rts.md)
  90 +- [modbus_rtu_set_rts](modbus_rtu_set_rts.md)
  91 +- [modbus_rtu_set_custom_rts](modbus_rtu_set_custom_rts.md)
  92 +- [modbus_rtu_get_rts_delay](modbus_rtu_get_rts_delay.md)
  93 +- [modbus_rtu_set_rts_delay](modbus_rtu_set_rts_delay.md)
94 94
95 ### TCP (IPv4) Context 95 ### TCP (IPv4) Context
96 96
@@ -98,7 +98,7 @@ The TCP backend implements a Modbus variant used for communications over @@ -98,7 +98,7 @@ The TCP backend implements a Modbus variant used for communications over
98 TCP/IPv4 networks. It does not require a checksum calculation as lower layer 98 TCP/IPv4 networks. It does not require a checksum calculation as lower layer
99 takes care of the same. 99 takes care of the same.
100 100
101 -To create a Modbus TCP context, you should use [modbus_new_tcp](modbus_new_tcp). 101 +To create a Modbus TCP context, you should use [modbus_new_tcp](modbus_new_tcp.md).
102 102
103 ### TCP PI (IPv4 and IPv6) Context 103 ### TCP PI (IPv4 and IPv6) Context
104 104
@@ -109,25 +109,25 @@ calculation as lower layer takes care of the same. @@ -109,25 +109,25 @@ calculation as lower layer takes care of the same.
109 Contrary to the TCP IPv4 only backend, the TCP PI backend offers hostname 109 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 1Kb of additional memory.
111 111
112 -Create a Modbus TCP PI context, you should use [modbus_new_tcp_pi](modbus_new_tcp_pi). 112 +Create a Modbus TCP PI context, you should use [modbus_new_tcp_pi](modbus_new_tcp_pi.md).
113 113
114 ## Connection 114 ## Connection
115 115
116 The following functions are provided to establish and close a connection with 116 The following functions are provided to establish and close a connection with
117 Modbus devices: 117 Modbus devices:
118 118
119 -- [modbus_connect](modbus_connect) establishes a connection.  
120 -- [modbus_close](modbus_close) closes a connection.  
121 -- [modbus_flush](modbus_flush) flushed a connection. 119 +- [modbus_connect](modbus_connect.md) establishes a connection.
  120 +- [modbus_close](modbus_close.md) closes a connection.
  121 +- [modbus_flush](modbus_flush.md) flushed a connection.
122 122
123 In RTU, you should define the slave ID of your client with 123 In RTU, you should define the slave ID of your client with
124 -[modbus_set_slave](modbus_set_slave). 124 +[modbus_set_slave](modbus_set_slave.md).
125 125
126 To analyse the exchanged data, you can enable the debug mode with 126 To analyse the exchanged data, you can enable the debug mode with
127 -[modbus_set_debug](modbus_set_debug). 127 +[modbus_set_debug](modbus_set_debug.md).
128 128
129 Once you have completed the communication or at the end of your program, you 129 Once you have completed the communication or at the end of your program, you
130 -should free the resources with the common function, [modbus_free](modbus_free) 130 +should free the resources with the common function, [modbus_free](modbus_free.md)
131 131
132 ## Reads and writes from the client 132 ## Reads and writes from the client
133 133
@@ -137,31 +137,31 @@ send Modbus requests: @@ -137,31 +137,31 @@ send Modbus requests:
137 137
138 To read data: 138 To read data:
139 139
140 -- [modbus_read_bits](modbus_read_bits)  
141 -- [modbus_read_input_bits](modbus_read_input_bits)  
142 -- [modbus_read_registers](modbus_read_registers)  
143 -- [modbus_read_input_registers](modbus_read_input_registers)  
144 -- [modbus_report_slave_id](modbus_report_slave_id) 140 +- [modbus_read_bits](modbus_read_bits.md)
  141 +- [modbus_read_input_bits](modbus_read_input_bits.md)
  142 +- [modbus_read_registers](modbus_read_registers.md)
  143 +- [modbus_read_input_registers](modbus_read_input_registers.md)
  144 +- [modbus_report_slave_id](modbus_report_slave_id.md)
145 145
146 To write data: 146 To write data:
147 147
148 -- [modbus_write_bit](modbus_write_bit)  
149 -- [modbus_write_register](modbus_write_register)  
150 -- [modbus_write_bits](modbus_write_bits)  
151 -- [modbus_write_registers](modbus_write_registers) 148 +- [modbus_write_bit](modbus_write_bit.md)
  149 +- [modbus_write_register](modbus_write_register.md)
  150 +- [modbus_write_bits](modbus_write_bits.md)
  151 +- [modbus_write_registers](modbus_write_registers.md)
152 152
153 To write and read data in a single operation: 153 To write and read data in a single operation:
154 154
155 -- [modbus_write_and_read_registers](modbus_write_and_read_registers) 155 +- [modbus_write_and_read_registers](modbus_write_and_read_registers.md)
156 156
157 To send and receive low-level requests: 157 To send and receive low-level requests:
158 158
159 -- [modbus_send_raw_request](modbus_send_raw_request)  
160 -- [modbus_receive_confirmation](modbus_receive_confirmation) 159 +- [modbus_send_raw_request](modbus_send_raw_request.md)
  160 +- [modbus_receive_confirmation](modbus_receive_confirmation.md)
161 161
162 To reply to an exception: 162 To reply to an exception:
163 163
164 -- [modbus_reply_exception](modbus_reply_exception) 164 +- [modbus_reply_exception](modbus_reply_exception.md)
165 165
166 ## Handling requests from server 166 ## Handling requests from server
167 167
@@ -171,39 +171,39 @@ handle requests: @@ -171,39 +171,39 @@ handle requests:
171 171
172 Data mapping: 172 Data mapping:
173 173
174 -- [modbus_mapping_new](modbus_mapping_new)  
175 -- [modbus_mapping_free](modbus_mapping_free) 174 +- [modbus_mapping_new](modbus_mapping_new.md)
  175 +- [modbus_mapping_free](modbus_mapping_free.md)
176 176
177 Receive: 177 Receive:
178 178
179 -- [modbus_receive](modbus_receive) 179 +- [modbus_receive](modbus_receive.md)
180 180
181 Reply: 181 Reply:
182 182
183 -- [modbus_reply](modbus_reply)  
184 -- [modbus_reply_exception](modbus_reply_exception) 183 +- [modbus_reply](modbus_reply.md)
  184 +- [modbus_reply_exception](modbus_reply_exception.md)
185 185
186 ## Advanced functions 186 ## Advanced functions
187 187
188 Timeout settings: 188 Timeout settings:
189 189
190 -- [modbus_get_byte_timeout](modbus_get_byte_timeout)  
191 -- [modbus_set_byte_timeout](modbus_set_byte_timeout)  
192 -- [modbus_get_response_timeout](modbus_get_response_timeout)  
193 -- [modbus_set_response_timeout](modbus_set_response_timeout) 190 +- [modbus_get_byte_timeout](modbus_get_byte_timeout.md)
  191 +- [modbus_set_byte_timeout](modbus_set_byte_timeout.md)
  192 +- [modbus_get_response_timeout](modbus_get_response_timeout.md)
  193 +- [modbus_set_response_timeout](modbus_set_response_timeout.md)
194 194
195 Error recovery mode: 195 Error recovery mode:
196 196
197 -- [modbus_set_error_recovery](modbus_set_error_recovery) 197 +- [modbus_set_error_recovery](modbus_set_error_recovery.md)
198 198
199 Setter/getter of internal socket: 199 Setter/getter of internal socket:
200 200
201 -- [modbus_set_socket](modbus_set_socket)  
202 -- [modbus_get_socket](modbus_get_socket) 201 +- [modbus_set_socket](modbus_set_socket.md)
  202 +- [modbus_get_socket](modbus_get_socket.md)
203 203
204 Information about header: 204 Information about header:
205 205
206 -- [modbus_get_header_length](modbus_get_header_length) 206 +- [modbus_get_header_length](modbus_get_header_length.md)
207 207
208 ## Data handling 208 ## Data handling
209 209
@@ -220,22 +220,22 @@ Macros for data manipulation: @@ -220,22 +220,22 @@ Macros for data manipulation:
220 220
221 Handling of bits and bytes: 221 Handling of bits and bytes:
222 222
223 -- [modbus_set_bits_from_byte](modbus_set_bits_from_byte)  
224 -- [modbus_set_bits_from_bytes](modbus_set_bits_from_bytes)  
225 -- [modbus_get_byte_from_bits](modbus_get_byte_from_bits) 223 +- [modbus_set_bits_from_byte](modbus_set_bits_from_byte.md)
  224 +- [modbus_set_bits_from_bytes](modbus_set_bits_from_bytes.md)
  225 +- [modbus_get_byte_from_bits](modbus_get_byte_from_bits.md)
226 226
227 Set or get float numbers: 227 Set or get float numbers:
228 228
229 -- [modbus_get_float_abcd](modbus_get_float_abcd)  
230 -- [modbus_set_float_abcd](modbus_set_float_abcd)  
231 -- [modbus_get_float_badc](modbus_get_float_badc)  
232 -- [modbus_set_float_badc](modbus_set_float_badc)  
233 -- [modbus_get_float_cdab](modbus_get_float_cdab)  
234 -- [modbus_set_float_cdab](modbus_set_float_cdab)  
235 -- [modbus_get_float_dcba](modbus_get_float_dcba)  
236 -- [modbus_set_float_dcba](modbus_set_float_dcba)  
237 -- [modbus_get_float](modbus_get_float) **deprecated**  
238 -- [modbus_set_float](modbus_set_float) **deprecated** 229 +- [modbus_get_float_abcd](modbus_get_float_abcd.md)
  230 +- [modbus_set_float_abcd](modbus_set_float_abcd.md)
  231 +- [modbus_get_float_badc](modbus_get_float_badc.md)
  232 +- [modbus_set_float_badc](modbus_set_float_badc.md)
  233 +- [modbus_get_float_cdab](modbus_get_float_cdab.md)
  234 +- [modbus_set_float_cdab](modbus_set_float_cdab.md)
  235 +- [modbus_get_float_dcba](modbus_get_float_dcba.md)
  236 +- [modbus_set_float_dcba](modbus_set_float_dcba.md)
  237 +- [modbus_get_float](modbus_get_float.md) **deprecated**
  238 +- [modbus_set_float](modbus_set_float.md) **deprecated**
239 239
240 ## Error handling 240 ## Error handling
241 241
@@ -247,7 +247,7 @@ shall return either a NULL value (if returning a pointer) or a negative value @@ -247,7 +247,7 @@ shall return either a NULL value (if returning a pointer) or a negative value
247 247
248 The *modbus_strerror()* function is provided to translate libmodbus-specific 248 The *modbus_strerror()* function is provided to translate libmodbus-specific
249 error codes into error message strings; for details refer to 249 error codes into error message strings; for details refer to
250 -[modbus_strerror](modbus_strerror). 250 +[modbus_strerror](modbus_strerror.md).
251 251
252 ## Miscellaneous 252 ## Miscellaneous
253 253
docs/modbus_close.md
@@ -37,4 +37,4 @@ modbus_free(ctx); @@ -37,4 +37,4 @@ modbus_free(ctx);
37 37
38 ## See also 38 ## See also
39 39
40 -- [modbus_connect](modbus_connect) 40 +- [modbus_connect](modbus_connect.md)
docs/modbus_connect.md
@@ -37,4 +37,4 @@ if (modbus_connect(ctx) == -1) { @@ -37,4 +37,4 @@ if (modbus_connect(ctx) == -1) {
37 37
38 ## See also 38 ## See also
39 39
40 -- [modbus_close](modbus_close) 40 +- [modbus_close](modbus_close.md)
docs/modbus_get_byte_from_bits.md
@@ -22,5 +22,5 @@ The function shall return a byte containing the bits read. @@ -22,5 +22,5 @@ The function shall return a byte containing the bits read.
22 22
23 ## See also 23 ## See also
24 24
25 -- [modbus_set_bits_from_byte](modbus_set_bits_from_byte)  
26 -- [modbus_set_bits_from_bytes](modbus_set_bits_from_bytes) 25 +- [modbus_set_bits_from_byte](modbus_set_bits_from_byte.md)
  26 +- [modbus_set_bits_from_bytes](modbus_set_bits_from_bytes.md)
docs/modbus_get_byte_timeout.md
@@ -33,6 +33,6 @@ modbus_get_byte_timeout(ctx, &to_sec, &to_usec); @@ -33,6 +33,6 @@ modbus_get_byte_timeout(ctx, &to_sec, &to_usec);
33 33
34 ## See also 34 ## See also
35 35
36 -- [modbus_set_byte_timeout](modbus_set_byte_timeout)  
37 -- [modbus_get_response_timeout](modbus_get_response_timeout)  
38 -- [modbus_set_response_timeout](modbus_set_response_timeout) 36 +- [modbus_set_byte_timeout](modbus_set_byte_timeout.md)
  37 +- [modbus_get_response_timeout](modbus_get_response_timeout.md)
  38 +- [modbus_set_response_timeout](modbus_set_response_timeout.md)
docs/modbus_get_float.md
@@ -26,6 +26,6 @@ The function shall return a float. @@ -26,6 +26,6 @@ The function shall return a float.
26 26
27 ## See also 27 ## See also
28 28
29 -- [modbus_set_float](modbus_set_float)  
30 -- [modbus_set_float_dcba](modbus_set_float_dcba)  
31 -- [modbus_get_float_dcba](modbus_get_float_dcba) 29 +- [modbus_set_float](modbus_set_float.md)
  30 +- [modbus_set_float_dcba](modbus_set_float_dcba.md)
  31 +- [modbus_get_float_dcba](modbus_get_float_dcba.md)
docs/modbus_get_float_abcd.md
@@ -23,7 +23,7 @@ The function shall return a float. @@ -23,7 +23,7 @@ The function shall return a float.
23 23
24 ## See also 24 ## See also
25 25
26 -- [modbus_set_float_abcd](modbus_set_float_abcd)  
27 -- [modbus_get_float_badc](modbus_get_float_badc)  
28 -- [modbus_get_float_cdab](modbus_get_float_cdab)  
29 -- [modbus_get_float_dcba](modbus_get_float_dcba) 26 +- [modbus_set_float_abcd](modbus_set_float_abcd.md)
  27 +- [modbus_get_float_badc](modbus_get_float_badc.md)
  28 +- [modbus_get_float_cdab](modbus_get_float_cdab.md)
  29 +- [modbus_get_float_dcba](modbus_get_float_dcba.md)
docs/modbus_get_float_badc.md
@@ -23,7 +23,7 @@ The function shall return a float. @@ -23,7 +23,7 @@ The function shall return a float.
23 23
24 ## See also 24 ## See also
25 25
26 -- [modbus_set_float_badc](modbus_set_float_badc)  
27 -- [modbus_get_float_abcd](modbus_get_float_abcd)  
28 -- [modbus_get_float_cdab](modbus_get_float_cdab)  
29 -- [modbus_get_float_dcba](modbus_get_float_dcba) 26 +- [modbus_set_float_badc](modbus_set_float_badc.md)
  27 +- [modbus_get_float_abcd](modbus_get_float_abcd.md)
  28 +- [modbus_get_float_cdab](modbus_get_float_cdab.md)
  29 +- [modbus_get_float_dcba](modbus_get_float_dcba.md)
docs/modbus_get_float_cdab.md
@@ -23,7 +23,7 @@ The function shall return a float. @@ -23,7 +23,7 @@ The function shall return a float.
23 23
24 ## See also 24 ## See also
25 25
26 -- [modbus_set_float_cdab](modbus_set_float_cdab)  
27 -- [modbus_get_float_abcd](modbus_get_float_abcd)  
28 -- [modbus_get_float_badc](modbus_get_float_badc)  
29 -- [modbus_get_float_dcba](modbus_get_float_dcba) 26 +- [modbus_set_float_cdab](modbus_set_float_cdab.md)
  27 +- [modbus_get_float_abcd](modbus_get_float_abcd.md)
  28 +- [modbus_get_float_badc](modbus_get_float_badc.md)
  29 +- [modbus_get_float_dcba](modbus_get_float_dcba.md)
docs/modbus_get_float_dcba.md
@@ -23,7 +23,7 @@ The function shall return a float. @@ -23,7 +23,7 @@ The function shall return a float.
23 23
24 ## See also 24 ## See also
25 25
26 -- [modbus_set_float_dcba](modbus_set_float_dcba)  
27 -- [modbus_get_float_abcd](modbus_get_float_abcd)  
28 -- [modbus_get_float_badc](modbus_get_float_badc)  
29 -- [modbus_get_float_cdab](modbus_get_float_cdab) 26 +- [modbus_set_float_dcba](modbus_set_float_dcba.md)
  27 +- [modbus_get_float_abcd](modbus_get_float_abcd.md)
  28 +- [modbus_get_float_badc](modbus_get_float_badc.md)
  29 +- [modbus_get_float_cdab](modbus_get_float_cdab.md)
docs/modbus_get_indication_timeout.md
@@ -34,6 +34,6 @@ modbus_get_indication_timeout(ctx, &to_sec, &to_usec); @@ -34,6 +34,6 @@ modbus_get_indication_timeout(ctx, &to_sec, &to_usec);
34 34
35 ## See also 35 ## See also
36 36
37 -- [modbus_set_indication_timeout](modbus_set_indication_timeout)  
38 -- [modbus_get_response_timeout](modbus_get_response_timeout)  
39 -- [modbus_set_response_timeout](modbus_set_response_timeout) 37 +- [modbus_set_indication_timeout](modbus_set_indication_timeout.md)
  38 +- [modbus_get_response_timeout](modbus_get_response_timeout.md)
  39 +- [modbus_set_response_timeout](modbus_set_response_timeout.md)
docs/modbus_get_response_timeout.md
@@ -35,6 +35,6 @@ modbus_set_response_timeout(ctx, 0, 0); @@ -35,6 +35,6 @@ modbus_set_response_timeout(ctx, 0, 0);
35 35
36 ## See also 36 ## See also
37 37
38 -- [modbus_set_response_timeout](modbus_set_response_timeout)  
39 -- [modbus_get_byte_timeout](modbus_get_byte_timeout)  
40 -- [modbus_set_byte_timeout](modbus_set_byte_timeout) 38 +- [modbus_set_response_timeout](modbus_set_response_timeout.md)
  39 +- [modbus_get_byte_timeout](modbus_get_byte_timeout.md)
  40 +- [modbus_set_byte_timeout](modbus_set_byte_timeout.md)
docs/modbus_get_slave.md
@@ -26,4 +26,4 @@ return -1 and set errno to one of the values defined below. @@ -26,4 +26,4 @@ return -1 and set errno to one of the values defined below.
26 26
27 ## See also 27 ## See also
28 28
29 -- [modbus_set_slave](modbus_set_slave) 29 +- [modbus_set_slave](modbus_set_slave.md)
docs/modbus_get_socket.md
@@ -22,4 +22,4 @@ successful. Otherwise it shall return -1 and set errno. @@ -22,4 +22,4 @@ successful. Otherwise it shall return -1 and set errno.
22 22
23 ## See also 23 ## See also
24 24
25 -- [modbus_set_socket](modbus_set_socket) 25 +- [modbus_set_socket](modbus_set_socket.md)
docs/modbus_mapping_free.md
@@ -21,4 +21,4 @@ There is no return values. @@ -21,4 +21,4 @@ There is no return values.
21 21
22 ## See also 22 ## See also
23 23
24 -- [modbus_mapping_new](modbus_mapping_new) 24 +- [modbus_mapping_new](modbus_mapping_new.md)
docs/modbus_mapping_new.md
@@ -17,7 +17,7 @@ input bits, registers and inputs registers. The pointers are stored in @@ -17,7 +17,7 @@ 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.
18 18
19 This function is equivalent to a call of the 19 This function is equivalent to a call of the
20 -[modbus_mapping_new_start_address](modbus_mapping_new_start_address) function 20 +[modbus_mapping_new_start_address](modbus_mapping_new_start_address.md) function
21 with all start addresses to `0`. 21 with all start addresses to `0`.
22 22
23 If it isn't necessary to allocate an array for a specific type of data, you can 23 If it isn't necessary to allocate an array for a specific type of data, you can
@@ -56,5 +56,5 @@ if (mb_mapping == NULL) { @@ -56,5 +56,5 @@ if (mb_mapping == NULL) {
56 56
57 ## See also 57 ## See also
58 58
59 -- [modbus_mapping_free](modbus_mapping_free)  
60 -- [modbus_mapping_new_start_address](modbus_mapping_new_start_address) 59 +- [modbus_mapping_free](modbus_mapping_free.md)
  60 +- [modbus_mapping_new_start_address](modbus_mapping_new_start_address.md)
docs/modbus_mapping_new_start_address.md
@@ -81,5 +81,5 @@ if (mb_mapping == NULL) { @@ -81,5 +81,5 @@ if (mb_mapping == NULL) {
81 81
82 ## See also 82 ## See also
83 83
84 -- [modbus_mapping_new](modbus_mapping_new)  
85 -- [modbus_mapping_free](modbus_mapping_free) 84 +- [modbus_mapping_new](modbus_mapping_new.md)
  85 +- [modbus_mapping_free](modbus_mapping_free.md)
docs/modbus_mask_write_register.md
@@ -26,5 +26,5 @@ errno. @@ -26,5 +26,5 @@ errno.
26 26
27 ## See also 27 ## See also
28 28
29 -- [modbus_read_registers](modbus_read_registers)  
30 -- [modbus_write_registers](modbus_write_registers) 29 +- [modbus_read_registers](modbus_read_registers.md)
  30 +- [modbus_write_registers](modbus_write_registers.md)
docs/modbus_new_rtu.md
@@ -36,8 +36,8 @@ The `stop_bits` argument specifies the bits of stop, the allowed values are 1 @@ -36,8 +36,8 @@ The `stop_bits` argument specifies the bits of stop, the allowed values are 1
36 and 2. 36 and 2.
37 37
38 Once the `modbus_t` structure is initialized, you must set the slave of your 38 Once the `modbus_t` structure is initialized, you must set the slave of your
39 -device with [modbus_set_slave](modbus_set_slave) and connect to the serial bus with  
40 -[modbus_connect](modbus_connect). 39 +device with [modbus_set_slave](modbus_set_slave.md) and connect to the serial bus with
  40 +[modbus_connect](modbus_connect.md).
41 41
42 ## Return value 42 ## Return value
43 43
@@ -73,5 +73,5 @@ if (modbus_connect(ctx) == -1) { @@ -73,5 +73,5 @@ if (modbus_connect(ctx) == -1) {
73 73
74 ## See also 74 ## See also
75 75
76 -- [modbus_new_tcp](modbus_new_tcp)  
77 -- [modbus_free](modbus_free) 76 +- [modbus_new_tcp](modbus_new_tcp.md)
  77 +- [modbus_free](modbus_free.md)
docs/modbus_new_tcp.md
@@ -56,5 +56,5 @@ if (modbus_connect(ctx) == -1) { @@ -56,5 +56,5 @@ if (modbus_connect(ctx) == -1) {
56 56
57 ## See also 57 ## See also
58 58
59 -- [modbus_tcp_listen](modbus_tcp_listen)  
60 -- [modbus_free](modbus_free) 59 +- [modbus_tcp_listen](modbus_tcp_listen.md)
  60 +- [modbus_free](modbus_free.md)
docs/modbus_new_tcp_pi.md
@@ -57,6 +57,6 @@ if (modbus_connect(ctx) == -1) { @@ -57,6 +57,6 @@ if (modbus_connect(ctx) == -1) {
57 57
58 ## See also 58 ## See also
59 59
60 -- [modbus_new_tcp](modbus_new_tcp)  
61 -- [modbus_tcp_pi_listen](modbus_tcp_pi_listen)  
62 -- [modbus_free](modbus_free) 60 +- [modbus_new_tcp](modbus_new_tcp.md)
  61 +- [modbus_tcp_pi_listen](modbus_tcp_pi_listen.md)
  62 +- [modbus_free](modbus_free.md)
docs/modbus_read_bits.md
@@ -32,5 +32,5 @@ shall return -1 and set errno. @@ -32,5 +32,5 @@ shall return -1 and set errno.
32 32
33 ## See also 33 ## See also
34 34
35 -- [modbus_write_bit](modbus_write_bit)  
36 -- [modbus_write_bits](modbus_write_bits) 35 +- [modbus_write_bit](modbus_write_bit.md)
  36 +- [modbus_write_bits](modbus_write_bits.md)
docs/modbus_read_input_bits.md
@@ -32,4 +32,4 @@ successful. Otherwise it shall return -1 and set errno. @@ -32,4 +32,4 @@ successful. Otherwise it shall return -1 and set errno.
32 32
33 ## See also 33 ## See also
34 34
35 -- [modbus_read_input_registers](modbus_read_input_registers) 35 +- [modbus_read_input_registers](modbus_read_input_registers.md)
docs/modbus_read_input_registers.md
@@ -34,6 +34,6 @@ successful. Otherwise it shall return -1 and set errno. @@ -34,6 +34,6 @@ successful. Otherwise it shall return -1 and set errno.
34 34
35 ## See also 35 ## See also
36 36
37 -- [modbus_read_input_bits](modbus_read_input_bits)  
38 -- [modbus_write_register](modbus_write_register)  
39 -- [modbus_write_registers](modbus_write_registers) 37 +- [modbus_read_input_bits](modbus_read_input_bits.md)
  38 +- [modbus_write_register](modbus_write_register.md)
  39 +- [modbus_write_registers](modbus_write_registers.md)
docs/modbus_read_registers.md
@@ -61,5 +61,5 @@ modbus_free(ctx); @@ -61,5 +61,5 @@ modbus_free(ctx);
61 61
62 ## See also 62 ## See also
63 63
64 -- [modbus_write_register](modbus_write_register)  
65 -- [modbus_write_registers](modbus_write_registers) 64 +- [modbus_write_register](modbus_write_register.md)
  65 +- [modbus_write_registers](modbus_write_registers.md)
docs/modbus_receive.md
@@ -17,7 +17,7 @@ socket of the context `ctx`. This function is used by Modbus slave/server to @@ -17,7 +17,7 @@ socket of the context `ctx`. This function is used by Modbus slave/server to
17 receive and analyze indication request sent by the masters/clients. 17 receive and analyze indication request sent by the masters/clients.
18 18
19 If you need to use another socket or file descriptor than the one defined in the 19 If you need to use another socket or file descriptor than the one defined in the
20 -context `ctx`, see the function [modbus_set_socket](modbus_set_socket). 20 +context `ctx`, see the function [modbus_set_socket](modbus_set_socket.md).
21 21
22 ## Return value 22 ## Return value
23 23
@@ -28,5 +28,5 @@ shall return -1 and set errno. @@ -28,5 +28,5 @@ shall return -1 and set errno.
28 28
29 ## See also 29 ## See also
30 30
31 -- [modbus_set_socket](modbus_set_socket)  
32 -- [modbus_reply](modbus_reply) 31 +- [modbus_set_socket](modbus_set_socket.md)
  32 +- [modbus_reply](modbus_reply.md)
docs/modbus_receive_confirmation.md
@@ -40,4 +40,4 @@ rc = modbus_receive_confirmation(ctx, rsp); @@ -40,4 +40,4 @@ rc = modbus_receive_confirmation(ctx, rsp);
40 40
41 ## See also 41 ## See also
42 42
43 -- [modbus_send_raw_request](modbus_send_raw_request) 43 +- [modbus_send_raw_request](modbus_send_raw_request.md)
docs/modbus_reply.md
@@ -36,4 +36,4 @@ See also the errors returned by the syscall used to send the response (eg. send @@ -36,4 +36,4 @@ See also the errors returned by the syscall used to send the response (eg. send
36 36
37 ## See also 37 ## See also
38 38
39 -- [modbus_reply_exception](modbus_reply_exception) 39 +- [modbus_reply_exception](modbus_reply_exception.md)
docs/modbus_reply_exception.md
@@ -42,4 +42,4 @@ successful. Otherwise it shall return -1 and set errno. @@ -42,4 +42,4 @@ successful. Otherwise it shall return -1 and set errno.
42 42
43 ## See also 43 ## See also
44 44
45 -- [modbus_reply](modbus_reply) 45 +- [modbus_reply](modbus_reply.md)
docs/modbus_rtu_get_rts.md
@@ -32,4 +32,4 @@ return -1 and set errno. @@ -32,4 +32,4 @@ return -1 and set errno.
32 32
33 ## See also 33 ## See also
34 34
35 -- [modbus_rtu_set_rts](modbus_rtu_set_rts) 35 +- [modbus_rtu_set_rts](modbus_rtu_set_rts.md)
docs/modbus_rtu_get_rts_delay.md
@@ -28,4 +28,4 @@ microseconds if successful. Otherwise it shall return -1 and set errno. @@ -28,4 +28,4 @@ microseconds if successful. Otherwise it shall return -1 and set errno.
28 28
29 ## See also 29 ## See also
30 30
31 -- [modbus_rtu_set_rts_delay](modbus_rtu_set_rts_delay) 31 +- [modbus_rtu_set_rts_delay](modbus_rtu_set_rts_delay.md)
docs/modbus_rtu_set_rts.md
@@ -66,4 +66,4 @@ modbus_free(ctx); @@ -66,4 +66,4 @@ modbus_free(ctx);
66 66
67 ## See also 67 ## See also
68 68
69 -- [modbus_rtu_get_rts](modbus_rtu_get_rts) 69 +- [modbus_rtu_get_rts](modbus_rtu_get_rts.md)
docs/modbus_rtu_set_rts_delay.md
@@ -28,4 +28,4 @@ Otherwise it shall return -1 and set errno. @@ -28,4 +28,4 @@ Otherwise it shall return -1 and set errno.
28 28
29 ## See also 29 ## See also
30 30
31 -- [modbus_rtu_get_rts_delay](modbus_rtu_get_rts_delay) 31 +- [modbus_rtu_get_rts_delay](modbus_rtu_get_rts_delay.md)
docs/modbus_send_raw_request.md
@@ -54,4 +54,4 @@ modbus_free(ctx); @@ -54,4 +54,4 @@ modbus_free(ctx);
54 54
55 ## See also 55 ## See also
56 56
57 -- [modbus_receive_confirmation](modbus_receive_confirmation) 57 +- [modbus_receive_confirmation](modbus_receive_confirmation.md)
docs/modbus_set_bits_from_byte.md
@@ -23,5 +23,5 @@ There is no return values. @@ -23,5 +23,5 @@ There is no return values.
23 23
24 ## See also 24 ## See also
25 25
26 -- [modbus_set_bits_from_byte](modbus_set_bits_from_byte)  
27 -- [modbus_set_bits_from_bytes](modbus_set_bits_from_bytes) 26 +- [modbus_set_bits_from_byte](modbus_set_bits_from_byte.md)
  27 +- [modbus_set_bits_from_bytes](modbus_set_bits_from_bytes.md)
docs/modbus_set_bits_from_bytes.md
@@ -22,5 +22,5 @@ There is no return values. @@ -22,5 +22,5 @@ There is no return values.
22 22
23 ## See also 23 ## See also
24 24
25 -- [modbus_set_bits_from_byte](modbus_set_bits_from_byte)  
26 -- [modbus_get_byte_from_bits](modbus_get_byte_from_bits) 25 +- [modbus_set_bits_from_byte](modbus_set_bits_from_byte.md)
  26 +- [modbus_get_byte_from_bits](modbus_get_byte_from_bits.md)
docs/modbus_set_byte_timeout.md
@@ -37,7 +37,7 @@ errno. @@ -37,7 +37,7 @@ errno.
37 37
38 ## See also 38 ## See also
39 39
40 -- [modbus_get_byte_timeout](modbus_get_byte_timeout)  
41 -- [modbus_get_response_timeout](modbus_get_response_timeout)  
42 -- [modbus_set_response_timeout](modbus_set_response_timeout) 40 +- [modbus_get_byte_timeout](modbus_get_byte_timeout.md)
  41 +- [modbus_get_response_timeout](modbus_get_response_timeout.md)
  42 +- [modbus_set_response_timeout](modbus_set_response_timeout.md)
43 w 43 w
docs/modbus_set_float.md
@@ -25,5 +25,5 @@ There is no return values. @@ -25,5 +25,5 @@ There is no return values.
25 25
26 ## See also 26 ## See also
27 27
28 -- [modbus_get_float](modbus_get_float)  
29 -- [modbus_set_float_dcba](modbus_set_float_dcba) 28 +- [modbus_get_float](modbus_get_float.md)
  29 +- [modbus_set_float_dcba](modbus_set_float_dcba.md)
docs/modbus_set_float_abcd.md
@@ -22,7 +22,7 @@ There is no return values. @@ -22,7 +22,7 @@ There is no return values.
22 22
23 ## See also 23 ## See also
24 24
25 -- [modbus_get_float_abcd](modbus_get_float_abcd)  
26 -- [modbus_set_float_badc](modbus_set_float_badc)  
27 -- [modbus_set_float_cdab](modbus_set_float_cdab)  
28 -- [modbus_set_float_dcba](modbus_set_float_dcba) 25 +- [modbus_get_float_abcd](modbus_get_float_abcd.md)
  26 +- [modbus_set_float_badc](modbus_set_float_badc.md)
  27 +- [modbus_set_float_cdab](modbus_set_float_cdab.md)
  28 +- [modbus_set_float_dcba](modbus_set_float_dcba.md)
docs/modbus_set_float_badc.md
@@ -22,7 +22,7 @@ There is no return values. @@ -22,7 +22,7 @@ There is no return values.
22 22
23 ## See also 23 ## See also
24 24
25 -- [modbus_get_float_badc](modbus_get_float_badc)  
26 -- [modbus_set_float_abcd](modbus_set_float_abcd)  
27 -- [modbus_set_float_cdab](modbus_set_float_cdab)  
28 -- [modbus_set_float_dcba](modbus_set_float_dcba) 25 +- [modbus_get_float_badc](modbus_get_float_badc.md)
  26 +- [modbus_set_float_abcd](modbus_set_float_abcd.md)
  27 +- [modbus_set_float_cdab](modbus_set_float_cdab.md)
  28 +- [modbus_set_float_dcba](modbus_set_float_dcba.md)
docs/modbus_set_float_cdab.md
@@ -23,7 +23,7 @@ There is no return values. @@ -23,7 +23,7 @@ There is no return values.
23 23
24 ## See also 24 ## See also
25 25
26 -- [modbus_get_float_cdab](modbus_get_float_cdab)  
27 -- [modbus_set_float_abcd](modbus_set_float_abcd)  
28 -- [modbus_set_float_badc](modbus_set_float_badc)  
29 -- [modbus_set_float_dcba](modbus_set_float_dcba) 26 +- [modbus_get_float_cdab](modbus_get_float_cdab.md)
  27 +- [modbus_set_float_abcd](modbus_set_float_abcd.md)
  28 +- [modbus_set_float_badc](modbus_set_float_badc.md)
  29 +- [modbus_set_float_dcba](modbus_set_float_dcba.md)
docs/modbus_set_float_dcba.md
@@ -22,6 +22,6 @@ There is no return values. @@ -22,6 +22,6 @@ There is no return values.
22 22
23 ## See also 23 ## See also
24 24
25 -- [modbus_get_float_dcba](modbus_get_float_dcba)  
26 -- [modbus_set_float](modbus_set_float)  
27 -- [modbus_get_float](modbus_get_float) 25 +- [modbus_get_float_dcba](modbus_get_float_dcba.md)
  26 +- [modbus_set_float](modbus_set_float.md)
  27 +- [modbus_get_float](modbus_get_float.md)
docs/modbus_set_indication_timeout.md
@@ -31,6 +31,6 @@ errno. @@ -31,6 +31,6 @@ errno.
31 31
32 ## See also 32 ## See also
33 33
34 -- [modbus_get_indication_timeout](modbus_get_indication_timeout)  
35 -- [modbus_get_response_timeout](modbus_get_response_timeout)  
36 -- [modbus_set_response_timeout](modbus_set_response_timeout) 34 +- [modbus_get_indication_timeout](modbus_get_indication_timeout.md)
  35 +- [modbus_get_response_timeout](modbus_get_response_timeout.md)
  36 +- [modbus_set_response_timeout](modbus_set_response_timeout.md)
docs/modbus_set_response_timeout.md
@@ -46,6 +46,6 @@ modbus_set_response_timeout(ctx, 0, 200000); @@ -46,6 +46,6 @@ modbus_set_response_timeout(ctx, 0, 200000);
46 46
47 ## See also 47 ## See also
48 48
49 -- [modbus_get_response_timeout](modbus_get_response_timeout)  
50 -- [modbus_get_byte_timeout](modbus_get_byte_timeout)  
51 -- [modbus_set_byte_timeout](modbus_set_byte_timeout) 49 +- [modbus_get_response_timeout](modbus_get_response_timeout.md)
  50 +- [modbus_get_byte_timeout](modbus_get_byte_timeout.md)
  51 +- [modbus_set_byte_timeout](modbus_set_byte_timeout.md)
docs/modbus_set_slave.md
@@ -69,4 +69,4 @@ if (modbus_connect(ctx) == -1) { @@ -69,4 +69,4 @@ if (modbus_connect(ctx) == -1) {
69 69
70 ## See also 70 ## See also
71 71
72 -- [modbus_get_slave](modbus_get_slave) 72 +- [modbus_get_slave](modbus_get_slave.md)
docs/modbus_set_socket.md
@@ -42,4 +42,4 @@ if (FD_ISSET(master_socket, &rdset)) { @@ -42,4 +42,4 @@ if (FD_ISSET(master_socket, &rdset)) {
42 42
43 ## See also 43 ## See also
44 44
45 -- [modbus_get_socket](modbus_get_socket) 45 +- [modbus_get_socket](modbus_get_socket.md)
docs/modbus_tcp_accept.md
@@ -41,6 +41,6 @@ modbus_free(ctx); @@ -41,6 +41,6 @@ modbus_free(ctx);
41 41
42 ## See also 42 ## See also
43 43
44 -- [modbus_tcp_pi_accept](modbus_tcp_pi_accept)  
45 -- [modbus_tcp_listen](modbus_tcp_listen)  
46 -- [modbus_tcp_pi_listen](modbus_tcp_pi_listen) 44 +- [modbus_tcp_pi_accept](modbus_tcp_pi_accept.md)
  45 +- [modbus_tcp_listen](modbus_tcp_listen.md)
  46 +- [modbus_tcp_pi_listen](modbus_tcp_pi_listen.md)
docs/modbus_tcp_listen.md
@@ -15,7 +15,7 @@ int modbus_tcp_listen(modbus_t *ctx, int nb_connection); @@ -15,7 +15,7 @@ int modbus_tcp_listen(modbus_t *ctx, int nb_connection);
15 15
16 The *modbus_tcp_listen()* function shall create a socket and listen to maximum 16 The *modbus_tcp_listen()* function shall create a socket and listen to maximum
17 `nb_connection` incoming connections on the specified IP address. The context 17 `nb_connection` incoming connections on the specified IP address. The context
18 -`ctx` must be allocated and initialized with [modbus_new_tcp](modbus_new_tcp) before to 18 +`ctx` must be allocated and initialized with [modbus_new_tcp](modbus_new_tcp.md) before to
19 set the IP address to listen, if IP address is set to NULL or '0.0.0.0', any addresses will be 19 set the IP address to listen, if IP address is set to NULL or '0.0.0.0', any addresses will be
20 listen. 20 listen.
21 21
@@ -57,6 +57,6 @@ modbus_free(ctx); @@ -57,6 +57,6 @@ modbus_free(ctx);
57 57
58 ## See also 58 ## See also
59 59
60 -- [modbus_new_tcp](modbus_new_tcp)  
61 -- [modbus_tcp_accept](modbus_tcp_accept)  
62 -- [modbus_tcp_pi_listen](modbus_tcp_pi_listen) 60 +- [modbus_new_tcp](modbus_new_tcp.md)
  61 +- [modbus_tcp_accept](modbus_tcp_accept.md)
  62 +- [modbus_tcp_pi_listen](modbus_tcp_pi_listen.md)
docs/modbus_tcp_pi_accept.md
@@ -41,6 +41,6 @@ modbus_free(ctx); @@ -41,6 +41,6 @@ modbus_free(ctx);
41 41
42 ## See also 42 ## See also
43 43
44 -- [modbus_tcp_pi_accept](modbus_tcp_pi_accept)  
45 -- [modbus_tcp_listen](modbus_tcp_listen)  
46 -- [modbus_tcp_pi_listen](modbus_tcp_pi_listen) 44 +- [modbus_tcp_pi_accept](modbus_tcp_pi_accept.md)
  45 +- [modbus_tcp_listen](modbus_tcp_listen.md)
  46 +- [modbus_tcp_pi_listen](modbus_tcp_pi_listen.md)
docs/modbus_tcp_pi_listen.md
@@ -14,7 +14,7 @@ int modbus_tcp_pi_listen(modbus_t *ctx, int nb_connection); @@ -14,7 +14,7 @@ int modbus_tcp_pi_listen(modbus_t *ctx, int nb_connection);
14 14
15 The *modbus_tcp_pi_listen()* function shall create a socket and listen to 15 The *modbus_tcp_pi_listen()* function shall create a socket and listen to
16 maximum `nb_connection` incoming connections on the specified nodes. The 16 maximum `nb_connection` incoming connections on the specified nodes. The
17 -context *ctx* must be allocated and initialized with [modbus_new_tcp_pi](modbus_new_tcp_pi) 17 +context *ctx* must be allocated and initialized with [modbus_new_tcp_pi](modbus_new_tcp_pi.md)
18 before to set the node to listen, if node is set to NULL or '0.0.0.0', any addresses will be 18 before to set the node to listen, if node is set to NULL or '0.0.0.0', any addresses will be
19 listen. 19 listen.
20 20
@@ -50,6 +50,6 @@ modbus_free(ctx); @@ -50,6 +50,6 @@ modbus_free(ctx);
50 50
51 ## See also 51 ## See also
52 52
53 -- [modbus_new_tcp_pi](modbus_new_tcp_pi)  
54 -- [modbus_tcp_pi_accept](modbus_tcp_pi_accept)  
55 -- [modbus_tcp_listen](modbus_tcp_listen) 53 +- [modbus_new_tcp_pi](modbus_new_tcp_pi.md)
  54 +- [modbus_tcp_pi_accept](modbus_tcp_pi_accept.md)
  55 +- [modbus_tcp_listen](modbus_tcp_listen.md)
docs/modbus_write_and_read_registers.md
@@ -38,6 +38,6 @@ it shall return -1 and set errno. @@ -38,6 +38,6 @@ it shall return -1 and set errno.
38 38
39 ## See also 39 ## See also
40 40
41 -- [modbus_read_registers](modbus_read_registers)  
42 -- [modbus_write_register](modbus_write_register)  
43 -- [modbus_write_registers](modbus_write_registers) 41 +- [modbus_read_registers](modbus_read_registers.md)
  42 +- [modbus_write_register](modbus_write_register.md)
  43 +- [modbus_write_registers](modbus_write_registers.md)
docs/modbus_write_bit.md
@@ -24,5 +24,5 @@ errno. @@ -24,5 +24,5 @@ errno.
24 24
25 ## See also 25 ## See also
26 26
27 -- [modbus_read_bits](modbus_read_bits)  
28 -- [modbus_write_bits](modbus_write_bits) 27 +- [modbus_read_bits](modbus_read_bits.md)
  28 +- [modbus_write_bits](modbus_write_bits.md)
docs/modbus_write_bits.md
@@ -29,5 +29,5 @@ shall return -1 and set errno. @@ -29,5 +29,5 @@ shall return -1 and set errno.
29 29
30 ## See also 30 ## See also
31 31
32 -- [modbus_read_bits](modbus_read_bits)  
33 -- [modbus_write_bit](modbus_write_bit) 32 +- [modbus_read_bits](modbus_read_bits.md)
  33 +- [modbus_write_bit](modbus_write_bit.md)
docs/modbus_write_register.md
@@ -24,5 +24,5 @@ errno. @@ -24,5 +24,5 @@ errno.
24 24
25 ## See also 25 ## See also
26 26
27 -- [modbus_read_registers](modbus_read_registers)  
28 -- [modbus_write_registers](modbus_write_registers) 27 +- [modbus_read_registers](modbus_read_registers.md)
  28 +- [modbus_write_registers](modbus_write_registers.md)
docs/modbus_write_registers.md
@@ -24,5 +24,5 @@ successful. Otherwise it shall return -1 and set errno. @@ -24,5 +24,5 @@ successful. Otherwise it shall return -1 and set errno.
24 24
25 ## See also 25 ## See also
26 26
27 -- [modbus_write_register](modbus_write_register)  
28 -- [modbus_read_registers](modbus_read_registers) 27 +- [modbus_write_register](modbus_write_register.md)
  28 +- [modbus_read_registers](modbus_read_registers.md)