Oops fix OR on RS485 settings (1c5d969)
[libmodbus.git] / NEWS
blobad366bb50d6babcc0fb8d96e96193e524102f978
1 libmodbus 3.1.4 (2016-05-28)
2 ============================
4 - C_PROG_RANLIB is rendered obsolete by LT_INIT
5 - Improve ifdef around bswap_16 for __CYGWIN__
6 - Improve Cygwin support. Thanks to StalderT.
7 - Another round of DRY in modbus_reply()
8 - Rename raw_rep to raw_rsp in unit-test-client
9 - Fix wrong function name in debug message
10 - Fix handling of invalid function code (closes #315)
11 - Add debug message on unknown function and new unit test
12 - DRY in modbus_reply by improving response_exception()
13 - Fix typo in 3053bd0adb
14 - CID 69145 - Argument cannot be negative in unit-test-server
15 - CID 69142 - Unchecked return value in unit-test-server
16 - Fix CID 69140 - Bad bit shift operation (coverity) in tests
17 - Rewrite and rename README as README.md in tests/
18 - Github's contributing and issue template files
19 - Fix small leak (64 bytes in TCP) in unit-test-client
20 - Add unit-tests.sh to tarball
21 - Add ./configure.scan to .gitignore
22 - Move setting of option inside the relevant conditional group
23 - Add links to new modbus_*_float_* functions in index
24 - Slight change to modbus_report_slave_id doc.
26 libmodbus 3.1.3 (2016-05-11)
27 ============================
29 - New bswap macros for Max OSX by Jakob Bysewski.
30 - Fix "wildcard address" in TCP IPv6 by Shoichi Sakane.
31 - Introduce offsets in modbus mappings with modbus_mapping_new_start_address.
32   Thanks to Michael Heimpold and Stéphane Raimbault.
33 - Fix address range in random-test-client.
34   Thanks to Martin Galvan.
35 - Add an option to disable tests compilation by Yegor Yefremov.
36 - Define MSG_DONTWAIT to MSG_NONBLOCK on AIX (#294).
37   Thanks to Fabrice Cantos.
38 - Fix building when byteswap.h is not defined by Tomasz Mon.
39 - Add some more macros for data manipulation and documentation.
40 - Remove duplicate install of modbus.h (closes #290).
41   Thanks to Daniel Sutcliffe.
42 - Move MIGRATION and README.md to dist_doc_DATA target.
43 - Change order of few functions in modbus RTU code.
44 - Add entries for modbus_rtu_[get|set]_delay in documentation index.
45 - Implemented runtime configurable RTS delay by Jimmy Bergström.
46 - Add an entry in libmodbus index page for modbus_rtu_set_custom_rts.
47 - Add support for user defined RTS toggle function by Jimmy
48   Bergström.
49 - Added ILLEGAL_DATA_ADDRESS tests for modbus_write_register[|s].
50   Thanks to Andrey Skvortsov.
51 - Update documentation of modbus_rtu_set_rts
52 - Fix rts signal switch time by Hiromasa Ihara.
53 - Improve new_rtu and set_slave documentation (related to #276).
54 - Fix late check of ctx in modbus_reply[|_exception] (closes #269).
55 - Wait the server for 1 second before running tests (help Travis).
56 - A libmodbus context isn't thread safe and won't be (closes #246).
57 - Fix buffer overflow in modbus_mask_write_register (#265).
58 - Minor adjustments to README about AsciiDoc.
59 - Export MODBUS_MAX_ADU_LENGTH and documentation (ref #241).
60 - Explicit check against Modbus broadcast address.
61 - Do not reply on broadcast requests (fixes #153). Thanks to Michael.
62 - Add Travis support.
63 - Run unit tests with standard: make check (closes #205, closes #238).
64   This patch has been developed by Andrey Skvortsov, Michael Heimpold
65   and Stéphane Raimbault.
66 - modbus_send_raw_request: limit request length (fixes #207).
67   Thanks to Hanno Neuer for spotting this security flaw.
68 - Add new contributors to AUTHORS
69 - Introduce SPDX license identifiers. Thanks to Michael Heimpold.
71 libmodbus 3.1.2 (2015-02-13)
72 ============================
74 If you still want to listen any addresses in your TCP IPv4 server, you must now
75 set the IP address to NULL in modbus_new_tcp before listening. Now,
76 modbus_tcp_listen only listen the IP address set in the Modbus context (see
77 documentation).
79 This release introduces API changes on modbus_get_byte_timeout,
80 modbus_get_response_timeout, modbus_set_byte_timeout,
81 modbus_set_response_timeout to ease writing of language bindings.
83 - Rewrite documentation building system
84 - Fix timeouts in unit tests
85 - Don't flush on illegal address errors in single write functions
86 - Fix compilation on compilers not supporting c99 mode.
87   Thanks to Michael Heimpold.
88 - Update license for the tests in Debian packaging (#221)
89 - Move check of device earlier to avoid a free call
90 - Unit test for baud rate check and error message.
91 - Fix crash modbus_new_rtu when baud is 0.
92   Thank you to Daniel Schürmann.
93 - Removed function prototype without implementation
94   Thank you Andrej Skvortzov.
95 - Switch test programs to a BSD license
96 - Fix remote buffer overflow vulnerability on write requests
97 - Avoid twice connect() in source code (closes #194)
98 - Fix compilation with MinGW (GCC 4.8.1) under Win7 (closes #163)
99   Thank you MarjanTomas and SwissKnife.
100 - Fix TCP IPv4 modbus_connect() on win32 (closes #100 and #165)
101   Thank you Petr Gladkiy and Marjan Tomas.
102 - Fix 24a05ebd3c0 - win32: init of modbus_tcp_pi_listen (#187)
103 - INADDR_* macros are defined in host byte order
104 - Filter of IP addresses in IPv4 server (closes #190)
105 - Allow to listen any hosts in IPv6 (closes #32)
106 - Define and public export of MODBUS_MAX_PDU_LENGTH (closes #167)
107 - Truncate data from response in report_slave_id to new max arg (closes #167)
108 - Fix response timeout modification on connect (closes #80)
109 - New API to set/get response and byte timeouts.
110   New unit tests and updated documentation.
111 - Export Modbus function codes supported by libmodbus
112 - Fix bandwidth-server-one (closes #152)
113 - Check debug flag in RTU code
114 - Remove warnings caused by shadowed 'index' variable.
115   Thanks to Åke Forslund.
116 - Use accept4 in TCP PI if available
117 - Add documentation for tcp[_pi]_accept (closes #31)
118 - Fix mistake in modbus_tcp_listen documentation
119 - Add documentation for modbus_tcp_pi_listen
120 - Fix for MinGW and Windows (#144, #169, #175, #180, #181, #187)
121   Thanks to Marjan Tomas.
122 - Many other fixes (#134, #157, #158, #183, #184) and improvements.
124 libmodbus 3.1.1 (2013-10-06)
125 ============================
127 More robust to exploits, more compliant and better handling of connect/close
128 sequences. Windows support still broken.
130 - New unit tests
131 - Fix remote buffer overflow vulnerability (closes #25, #105)
132 - Explain how to define response timeouts when many RTU slaves
133 - Fix receiving of incorrect queries in write_single and mask_write_register
134   Thanks to James Nutaro.
135 - Check return value of autoreconf.
136   Thanks to Lauri Nurmi
137 - Constant for broacast and test ordering
138 - Fix the fix of device string check
139 - Various changes to try to improve *broken* Windows support
140 - Try to fix MinGW compilation
141 - Portable use of bswap_32
142 - Improve support of MacOS X
143 - Fix socket value on init/close
144 - Returns -1 on invalid mode in modbus_rtu_set_rts
145 - Protect all public functions against invalid context
146 - Sleep for delay of response timeout before reconnect (closes #77).
147   Thanks to Karl Palsson.
148 - Baud rate until 4,000,000 (POSIX), 1,000,000 (Windows) (closes #93)
149 - New modbus_get|set_float_dcba to get|set float in inversed byte order
150 - Remove unsupported -Wtype-limits for GCC < 4.3.5 (closes #109)
151 - Enable out-of-source build. Thanks to Yegor Yefremov.
152 - Fix alignment problem on ARMv5 platform
153 - Improvement to Debian package. Thanks to Alexander Klauer.
154 - Improve support of VS 2005. Thanks to Petr Gladkiy.
155 - Add documentation for modbus_mask_write_register (closes #91).
156   Thanks to Martijn de Gouw.
157 - Avoid C99 declaration in win32 section code (closes #92).
158   Thanks to oldfaber and endrelovas.
159 - Add a windows scripting host configure file.
160   Thanks to oldfaber and Stéphane Raimbault.
161 - Fix typo in modbus_strerror documentation. Thanks to Mirko Rajkovaca.
162 - Rename reserved C++ keywords of modbus_mask_write_register.
163   Thanks Tobias Doerffel.
164 - Another quick workaround for deficient OS (closes #63)
165 - Add support for Mask Write Register
166 - Fix missing close on socket in random-test-server.
167   Thanks to Damian Zieliński.
168 - Use nonblocking sockets on Win32 and OS X/iOS too.
169   Thanks to Julian Raschke.
170 - Fix all compilations warnings spotted by new compilation flags
171 - Major update of build system
172 - Calculate RTS activation time by send length
173 - Dynamic memory allocation of device name (closes #11)
174 - Add unit tests for modbus_mapping_new
175 - Add Visual Studio 2008 project files by oldfaber
176 - Fix missing argument in synopsis section of modbus_rtu_set_serial_mode
177 - Fix wrong constant names to create version number
178 - More compilation fixes for Windows by oldfaber.
179 - Fix wrong constant names to create version number.
180   Thanks to Denis Davydov.
182 libmodbus 3.1.0 (2012-06-22)
183 ============================
185 Major changes to handle many slaves in RTU mode, non blocking connections and
186 RTS flow control.
188 - Fixes for Microsoft Visual C++ compiler
189 - Fixes for Windows. Thanks to oldfaber
190 - Return value of _modbus_tcp_pi_connect() on failure (closes #61)
191 - Avoid ioctl call on non-RS485 ports. Thanks to Michael Haberler
192 - Display node and service in PI and port in IPv4 at connection
193 - Return -1 on getaddrinfo error and print error in debug mode
194 - More robust way to establish the connection in non blocking mode
195 - TCP - Socket in non blocking mode by default. Thanks to Thomas Stalder
196 - Apply CLOEXEC flag for TCP protocol independent too (IPv6)
197 - New RTU receive() to ignore confirmation from other slaves (closes #18)
198 - Move RTU filtering in CRC check to avoid useless call to modbus_reply
199 - Unique transaction identifier by TCP connection
200 - Use accept4 with SOCK_CLOEXEC when available (Linux)
201 - Open fd and socket with the CLOEXEC flag when available
202 - Exception response on report slave ID wasn't detected (closes #27)
203 - Provides a way to disable the byte timeout (Alex Stapleton)
204 - Added slave ID check for response messages (Alex Stapleton)
205 - RTS flow control with modbus_rtu_set_rts and modbus_rtu_get_rts
206   functions by Torello Querci <tquerci@gmail.com> and Stéphane Raimbault.
208 libmodbus 3.0.4 (2012-05-08)
209 ============================
211 - autogen.sh creates symlinks instead of copies
212 - Add missing m4 directory (closes #103)
213 - Fix alignment problem on ARMv5 platform
214   Thanks to Alexander Dahl
215 - Remove useless test on error_recovery argument
216   Thanks to Carlos Tangerino
218 libmodbus 3.0.3 (2012-05-25)
219 ============================
221 - Fix another Visual C++ 2008/2010 deficiency (closes #53)
222 - Add -lsocket to compile on QNX
223 - Fix TCP PI init under Windows.
224   Thanks to oldfaber.
225 - Fix a missing free in random-test-client
226   Thanks again to Stefan Finzel.
227 - Fix OMG bug in modbus_mapping_free not freeing memory.
228   Thanks to Stefan Finzel for the bug report.
229 - Fix semicolon typo and unistd.h include under Windows.
230   Thanks to Andrew Kravchuk.
232 libmodbus 3.0.2 (2012-01-16)
233 ============================
235 - Update Debian package
236 - Documentation fixes and additions
237 - Add missing C++ macros in public headers.
238   Thanks to Bernhard Agthe.
239 - Protects modbus_mapping_free against NULL argument.
240   Thanks to Andrea Mattia
241 - Fix check on file doc/libmodbus.7 in acinclude.m4 (closes #28)
242 - Close file descriptor when the settings don't apply in RTU.
243   Original patch provided by Thomas Stalder.
244 - unit-test.h is now generated to avoid config.h dependency.
245 - Request for Windows Sockets specification version 2.2 instead of 2.0
246   Thanks to Pavel Mazniker for the report.
248 libmodbus 3.0.1 (2011-07-18)
249 ============================
251 - Avoid useless serial_mode integer when TIOCSRS485 isn't supported
252 - Fix compilation failure on Windows (RS485 support) by Tobias Doerffel
253   <tobias.doerffel@gmail.com>
254 - Properly check TIOCSRS485 define by Matthijs Kool
255 - Rename package to libmodbus5 to fix lintian warning
257 libmodbus 3.0.0 (2011-07-11)
258 ============================
260 - Revert libmodbus licence from LGPLv3 to LGPLv2.1 to avoid
261   incompatibility with GPLv2 program. This change has been approved
262   by Tobias Doerffel, Florian octo Forster and Hannu Vuolasaho.
263 - Enable RS485 support only when available
264 - Export modbus_set/get_serial_mode functions on all platforms
265 - API change for read/write multiple registers function:
266     * modbus_read_and_write_registers -> modbus_write_and_read_registers
267   The function name was confusing because the write operation is performed
268   before the read. Take care to swap the arguments in the migration process.
269 - Documentation of modbus_write_and_read_registers, modbus_mapping_new/free,
270   report_slave_id. modbus_get_byte_from_bits, modbus_set_bits_from_byte(s),
271   modbus_[gs]et_float, modbus_reply and modbus_reply_exception.
272 - Enhanced report slave ID
273 - New RPM spec file to package documentation and development files
275 libmodbus 2.9.4 (2011-06-05)
276 ============================
278 - IPv6 support
279   Make the TCP implementation "protocol independent" by Florian Forster
280   and Stéphane Raimbault.
281 - Fix compilation on Windows 7 (x64) with MinGW/MSYS and GCC 4.5
282   Reported by Patsy Kaye.
283 - Documentation of libmodbus functions with AsciiDoc (man and HTML) by Stéphane
284   Raimbault
285 - Avoid an iteration in flush function
286 - New functions to send and receive raw requests (modbus_send_raw_request,
287   modbus_receive_confirmation)
288 - Fix flush function of TCP backend on Windows
289 - API changes for server/slave:
290     * modbus_receive doesn't take socket/fd argument anymore
291     * new function modbus_set_socket to set socket/fd
292 - API changes for timeout functions:
293     * modbus_get_timeout_begin -> modbus_get_response_timeout
294     * modbus_set_timeout_begin -> modbus_set_response_timeout
295     * modbus_get_timeout_end -> modbus_get_byte_timeout
296     * modbus_set_timeout_end -> modbus_set_byte_timeout
297 - Fix longstanding limitation of server to wait forever
298 - New functions modbus_set/get_serial_mode by Manfred Gruber and Stéphane
299   Raimbault for RS485 communications
300 - Improved recovery mode (see modbus_set_error_recovery documentation) for
301   data link and protocol errors.
302 - Fix compilation issue with Microsoft Visual Studio 2008.
303   Reported by Allan Cornet.
305 libmodbus 2.9.3 (2011-01-14)
306 ============================
308 - Major rewriting of the message reading (no more timeouts on exception)
309   by Stéphane Raimbault
310 - New function to reply to an indication with an exception message
311   modbus_reply_exception()
312 - New function modbus_get_header_length(modbus_t *ctx)
313 - New functions to manipulate data:
314     * MODBUS_GET_INT32_FROM_INT16
315     * MODBUS_GET_INT16_FROM_INT8
316     * MODBUS_SET_INT16_TO_INT8
317 - Fix GH-2. Read/write were swapped in _FC_READ_AND_WRITE_REGISTERS
318 - Install an ignore handler for SIGPIPE on *BSD
319   Original patch by Jason Oster.
320 - Fix closing of Win32 socket.
321   Reported by Petr Parýzek.
322 - Fix unit identifier not copied by the TCP server.
323   Reported by Antti Manninen.
324 - Fix missing modbus_flush() in unit tests
325 - Fixes for OpenBSD by Barry Grumbine and Jason Oster
328 libmodbus 2.9.2 (2010-12-05)
329 ============================
331 - Win32 support by Tobias Doerffel
332 - Split source code around RTU and TCP (backends)
333 - Rename modbus_[listen|accept] to modbus_tcp_[listen|accept]
334 - Remove slave argument from modbus_new_rtu()
335 - Check received function code
336 - Fix segfault in bandwidth-server-many-up on inet_ntoa() call
337 - Fix unit test of report slave ID in RTU
338 - Fix GH-3. Remove inclusion of config.h in modbus.h
339 - Correctly detect if we are cross-compiling for win32 by Kirill Smelkov.
340 - Fix setting of the broadcast address
343 libmodbus 2.9.1 (2010-08-16)
344 ============================
346 - Brand new API (see MIGRATION notes)!
347 - Remove the internal function set_message_length_tcp
348 - Restore slave ID (server ID) argument in functions
349 - Error conventions of POSIX systems and error recover
350 - Parity setting is now a single char ('N', 'E' or 'O')
351 - Report slave ID server side
352 - OpenBSD support by Anibal Limón.
353 - New read and write registers function by Hannu Vuolasaho.
354 - Versioning infrastructure
355   Inspired by the Clutter project and the work done by Florian Forster.
356 - Fix the broadcast constant (255 -> 0)
357   Reported by David Olivari.
358 - Fix #463299 - New functions to define the timeouts of begin and end of trame
359   Original patch by Sisyph (eric-paul).
360 - Fix #591142 - Slave id check should be disabled in TCP connection
361   Reported by aladdinwu.
364 libmodbus 2.1.0 (2010-03-24)
365 ============================
367 - New API to read and write float values by Stéphane Raimbault and Florian
368   Forster.
369 - New API for slave server (see MIGRATION)
370 - New slave server able to handle multiple connections
371 - Slave only replies to broadcast queries or queries with its slave ID
372 - Improved Modbus protocol conformance
373 - modbus_param_t is smaller (2 int removed)
374 - Better error management and SIGPIPE signal is blocked
375 - Faster
376 - Fix #333455 - Cygwin IPTOS_LOWDELAY not supported on cygwin
377   Reported by Jeff Laughlin and Yishin Li.
378 - Fix #375926 - modbus.c:164: error: `MSG_DONTWAIT' undeclared
379   Reported and tested by Yishin Li.
380 - Fix #378981 - CRC error on RTU response doesn't return negative value
381   Reported by Henrik Munktell.
382 - Fix report slave ID request
383   Patch (bzr) provided by Paul Fertser.
384 - Fix #425604 - Conditional jump or move depends on uninitialised value(s)
385   Occurs on first occurence of slave timeout.
386   Reported by Henrik Munktell.
387 - Fix #457200 - FreeBSD support
388   Patch provided by Norbert Koch.
390 Other changes:
392 - The code is now published and developed on
393   http://github.com/stephane/libmodbus
394 - Waf support has been removed
397 libmodbus 2.0.3 (2009-03-22)
398 ============================
400 - Fix CRC error when a slave RTU send a response.
401   Thanks to Justin Carroll to have reported and tested my patch.
402 - Remove an assignment in compute_response_length()
403 - Remove duplicate counter in read_io_status()
404 - Fix #274511 reported by 'Kylesch'
405   Invalid error check in modbus_init_listen_tcp
408 libmodbus 2.0.2 (2008-08-10)
409 ============================
410 - Fix a bug reported by email by Davide Pippa
411   The function modbus_receive must check the number of values
412   indicated in the response accordingly to the query.
413 - Fix #241006 reported by Jesus Hernandez Tapia
414   modbus_check_response() crashes on an invalid exception code
415 - Reduce the number of function calls (read_reg_response and
416   preset_response have been removed)
417 - Add a new unit test for bad response
418 - Catch the timeout even if the length is equal to a exception trame
419 - Test only msg_length_computed on change
420 - Many comments and cleanups
423 libmodbus 2.0.1 (2008-07-02)
424 ============================
426 - Include libmodbus.spec in the tarball
427 - Fix #241006 reported by Jesus Hernandez Tapia
428   modbus_check_response() crashes on an invalid exception code
431 libmodbus 2.0.0 (2008-05-18)
432 ============================
434 - Slave API
435   https://blueprints.launchpad.net/libmodbus/+spec/slave-api
436 - No more glib dependency
437   https://blueprints.launchpad.net/libmodbus/+spec/glib-dependency
438 - Unit testing and many test programs
439 - Waf build support
440   https://blueprints.launchpad.net/libmodbus/+spec/waf-support
441 - MacOS X support by Matthew Butch
442   https://blueprints.launchpad.net/libmodbus/+spec/macosx-support
443 - Unit testing (unit-test-slave and unit-test-master)
444 - Port number is now defined at initialisation by Dirk Reusch
445 - Better memory management (uint8_t *data and packing of
446   modbus_param_t)
447 - Better error management
448 - Declare many static functions and const arrays
449 - Enhance an integer division
450 - The GNU licences LGPL and GPL are in version 3
451 - Debian and RPM packages (#224496)
452 - Many cleanups
453 - Fix #159443 reported by Stefan Bisanz
454   Index of incoming data in force multiple coils function
455 - Fix #161989 reported by Konstantinos Togias
456   Serial device paths more than 10 chars long (eg. /dev/ttyUSB0) don't
457   fit to modbus_param_t -> device char[11] var.
458 - Fix #188189 reported by Chris Hellyar
459   Compute_response_size() no entry for read_input_status()
460 - Fix #191039 reported by Todd Denniston
461   modbus.h is not installed at prefix.
462 - Fix #211460 reported by Todd Denniston
463   With TCP, automatic reconnect on error may not be desired.
464 - Fix #224485 reported by Todd Denniston
465   libmodbus does not link with c++ code.
466 - Fix #224496 reported by Todd Denniston
467   It is easier to install on rpm based systems with a spec file.
470 libmodbus 1.2.5 (2008-05-18)
471 ============================
473 - Fix #224485 reported by Todd Denniston
474   libmodbus does not link with c++ code.
477 libmodbus 1.2.4 (2008-03-14)
478 ============================
480 - Fix #191039 reported by Todd Denniston
481   modbus.h is not installed at prefix.
484 libmodbus 1.2.3 (2008-02-03)
485 ============================
487 - Fix #188189 reported by Chris Hellyar
488   Compute_response_size() no entry for read_input_status()
489 - Fix #181887 reported by Jesus Hernandez Tapia.
490   Slave address in build_request_packet_tcp() is hardcoded as 0xFF.
493 libmodbus 1.2.2 (2007-11-12)
494 ============================
496 - Fix #161989 reported by Konstantinos Togias
497   Serial device paths more than 10 chars long (eg. /dev/ttyUSB0) don't
498   fit to modbus_param_t -> device char[11] var.
499 - Structure is also bit better 'packed' to conserve memory (see the
500   trunk for a real enhancement).
503 libmodbus 1.2.1 (2007-11-02)
504 ============================
506 - Fix #159443 reported by Stefan Bisanz
507   Index of incoming data in force multiple coils function
508 - Deleted useless code in check_crc16()
509 - Untabify source code
510 - Changed author's email to Stéphane Raimbault
513 libmodbus 1.2.0 (2007-05-10)
514 ============================
516 - FIX Compilation GCC-4.0
517 - Project name in autogen.sh