Initial documention

Author: sandeepmistry

README.adoc

@@ -1,5 +1,9 @@
 = Modbus Library for Arduino =
 
+Use Modbus with your Arduino. 
+
+Using the RS485 shields, like the MKR 485 shield. This library depends on the ArduinoRS485 library.
+
 For more information about this library please visit us at
 http://www.arduino.cc/en/Reference/ArduinoModbus
 

library.properties

@@ -2,8 +2,8 @@ name=ArduinoModbus
 version=1.0.0
 author=Arduino
 maintainer=Arduino <info@arduino.cc>
-sentence=
-paragraph=
+sentence=Use Modbus equipment with your Arduino.
+paragraph=Using the RS485 shields, like the MKR 485 shield. This library depends on the RS485 library.
 category=Communication
 url=http://www.arduino.cc/en/Reference/ArduinoModbus
 architectures=*

src/ModbusClient.cpp

@@ -165,7 +165,7 @@ int ModbusClient::writeCoils(int address, const uint8_t values[], int nb)
   return 1;
 }
 
-int ModbusClient::writeRegister(int address, uint16_t value)
+int ModbusClient::writeHoldingRegister(int address, uint16_t value)
 {
   if (modbus_write_register(_mb, address, value) < 0) {
     return 0;
@@ -174,7 +174,7 @@ int ModbusClient::writeRegister(int address, uint16_t value)
   return 1;
 }
 
-int ModbusClient::writeRegisters(int address, const uint16_t values[], int nb)
+int ModbusClient::writeHoldingRegisters(int address, const uint16_t values[], int nb)
 {
   if (modbus_write_registers(_mb, address, nb, values) < 0) {
     return 0;

src/ModbusClient.h

@@ -29,27 +29,184 @@ extern "C" {
 class ModbusClient {
 
 public:
+  /**
+   * Set the (slave) id to use for read and write operations.
+   * Defaults to 0x00 (broadcast).
+   *
+   * @param id id to use
+   */
   void setId(int id);
 
+  /**
+   * Perform a "Read Coils" operation for the specified address for a single
+   * coil.
+   *
+   * @param address address to use for operation
+   *
+   * @return coil value on success, -1 on failure.
+   */
   int readCoil(int address);
+
+  /**
+   * Perform a "Read Coils" operation for the specified address and number of
+   * coils.
+   *
+   * @param address start address to use for operation
+   * @param values array of bytes to store coil values
+   * @param nb number of coils to read
+   *
+   * @return 1 success, 0 on failure.
+   */
   int readCoils(int address, uint8_t values[], int nb);
+
+  /**
+   * Perform a "Read Discrete Inputs" operation for the specified address for a
+   * single discrete input.
+   *
+   * @param address address to use for operation
+   *
+   * @return discrete input value on success, -1 on failure.
+   */
   int readDiscreteInput(int address);
+
+  /**
+   * Perform a "Read Discrete Inputs" operation for the specified address and 
+   * number of inputs.
+   *
+   * @param address start address to use for operation
+   * @param values array of bytes to store discrete input values
+   * @param nb number of discrete inputs to read
+   *
+   * @return 1 success, 0 on failure.
+   */
   int readDiscreteInputs(int address, uint8_t values[], int nb);
+
+  /**
+   * Perform a "Read Holding Registers" operation for a single holding
+   * register.
+   *
+   * @param address start address to use for operation
+   *
+   * @return holiding register value on success, -1 on failure.
+   */
   long readHoldingRegister(int address);
+
+  /**
+   * Perform a "Read Holding Registers" operation for the specified address and
+   * number of holding registers.
+   *
+   * @param address start address to use for operation
+   * @param values array of words to store holding register values
+   * @param nb number of holding registers to read
+   *
+   * @return 1 success, 0 on failure.
+   */
   int readHoldingRegisters(int address, uint16_t values[], int nb);
+
+  /**
+   * Perform a "Read Input Registers" operation for a single input
+   * register.
+   *
+   * @param address address to use for operation
+   *
+   * @return input register value on success, -1 on failure.
+   */
   long readInputRegister(int address);
+
+  /**
+   * Perform a "Read Input Registers" operation for the specified address and
+   * number of input registers.
+   *
+   * @param address start address to use for operation
+   * @param values array of words to store input register values
+   * @param nb number of holding input to read
+   *
+   * @return 1 success, 0 on failure.
+   */
   int readInputRegisters(int address, uint16_t values[], int nb);
 
+  /**
+   * Perform a "Write Single Coil" operation for the specified address and
+   * value.
+   *
+   * @param address address to use for operation
+   * @param value coil value to write
+   *
+   * @return 1 on success, 0 on failure.
+   */
   int writeCoil(int address, uint8_t value);
+
+  /**
+   * Perform a "Write Multiple Coils" operation for the specified address and
+   * values.
+   *
+   * @param address start address to use for operation
+   * @param values array of coil values to write
+   * @param nb number of coil values to write
+   *
+   * @return 1 on success, 0 on failure.
+   */
   int writeCoils(int address, const uint8_t values[], int nb);
-  int writeRegister(int address, uint16_t value);
-  int writeRegisters(int address, const uint16_t values[], int nb);
+
+  /**
+   * Perform a "Write Single Holding Register" operation for the specified
+   * address and value.
+   *
+   * @param address address to use for operation
+   * @param value holding register value to write
+   *
+   * @return 1 on success, 0 on failure.
+   */
+  int writeHoldingRegister(int address, uint16_t value);
+
+  /**
+   * Perform a "Write Multiple Holding Registers" operation for the specified
+   * address and values.
+   *
+   * @param address start address to use for operation
+   * @param values array of holding register values to write
+   * @param nb number of holding register values to write
+   *
+   * @return 1 on success, 0 on failure.
+   */
+  int writeHoldingRegisters(int address, const uint16_t values[], int nb);
+
+  /**
+   * Perform a "Mask Write Registers" operation for the specified
+   * address, AND mask and OR mask.
+   *
+   * @param address address to use for operation
+   * @param andMask AND mask to use for operation
+   * @param orMask OR mask to use for operation
+   *
+   * @return 1 on success, 0 on failure.
+   */
   int maskWriteRegister(int address, uint16_t andMask, uint16_t orMask);
 
+  /**
+   * Perform a "Read/Write Registers" operation.
+   *
+   * @param writeAddress write address to use for operation
+   * @param writeValues array of words to write
+   * @param writeNb number of registers to write
+   * @param readAddress read address to use for operation
+   * @param readValues array of words to store register values
+   * @param readNb number of registers to read
+   *
+   * @return 1 on success, 0 on failure.
+   */
   int writeAndReadRegisters(int writeAddress, const uint16_t writeValues[], int writeNb, int readAddress, uint16_t readValues[], int readNb);
 
+  /**
+   * Read the last error reason as a string
+   *
+   * @return Last error reason as a C string
+   */
   const char* lastError();
 
+  /**
+   * Stop the client and clean up
+   */
   void end();
 
 protected:

src/ModbusRTUClient.cpp

@@ -34,9 +34,9 @@ ModbusRTUClientClass::~ModbusRTUClientClass()
 {
 }
 
-int ModbusRTUClientClass::begin(unsigned long baudRate, uint16_t config)
+int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config)
 {
-  modbus_t* mb = modbus_new_rtu(baudRate, config);
+  modbus_t* mb = modbus_new_rtu(baudrate, config);
 
   return ModbusClient::begin(mb);
 }

src/ModbusRTUClient.h

@@ -27,8 +27,15 @@ class ModbusRTUClientClass : public ModbusClient {
   ModbusRTUClientClass();
   virtual ~ModbusRTUClientClass();
 
-  int begin(unsigned long baudRate, uint16_t config = SERIAL_8N1);
-  void end();
+  /**
+   * Start the Modbus RTU client with the specified parameters
+   *
+   * @param baudrate Baud rate to use
+   * @param config serial config. to use defaults to SERIAL_8N1
+   *
+   * Return 1 on success, 0 on failure
+   */
+  int begin(unsigned long baudrate, uint16_t config = SERIAL_8N1);
 };
 
 extern ModbusRTUClientClass ModbusRTUClient;

src/ModbusTCPClient.h

@@ -27,11 +27,23 @@
 
 class ModbusTCPClient : public ModbusClient {
 public:
+  /**
+   * ModbusTCPClient constructor
+   *
+   * @param client Client to use for TCP connection
+   */
   ModbusTCPClient(Client& client);
   virtual ~ModbusTCPClient();
 
+  /**
+   * Start the Modbus TCP client with the specified parameters
+   *
+   * @param ip IP Address of the Modbus server
+   * @param port TCP port number of Modbus server, defaults to 502
+   *
+   * Return 1 on success, 0 on failure
+   */
   int begin(IPAddress ip, uint16_t port = 502);
-  void end();
 
 private:
   Client* _client;