ArduinoModbus
ArduinoModbus copied to clipboard
Documentation of return values in ModbusServer.h and Arduino Reference does not match source code
The documentation of return values in ModbusServer.h for configure functions are reversed from the actual source code. This error then shows up in the Arduino Reference site.
Comments in src/ModbusServer.h claiming return value of 0 on success, 1 on failure
https://github.com/arduino-libraries/ArduinoModbus/blob/12c32ce59f033d013af733116c3273a4f1331dc8/src/ModbusServer.h#L32-L40
Source code in src/ModbusServer.cpp showing a return value of 0 on failure, 1 on success:
https://github.com/arduino-libraries/ArduinoModbus/blob/12c32ce59f033d013af733116c3273a4f1331dc8/src/ModbusServer.cpp#L53-L77
Error showing in Arduino Reference:
https://www.arduino.cc/reference/en/libraries/arduinomodbus/modbusserver.configurecoils/
This is the case for:
configureCoils()configureDiscreteInputs()configureHoldingRegisters()configureInputRegisters()poll()