Renaming Ambiguous Functions

Hreg() -> hreg()/setHreg()
Ireg() -> ireg()/setIreg()
Ists() -> ists()/setIsts()
Coil() -> coil()/setCoil()

Author: epsilonrt

library.json

@@ -1,6 +1,6 @@
 {
   "name": "Modbus-Arduino",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "keywords": "modbus, server, slave, rtu, tcp",
   "description": "A library that allows your Arduino to communicate via Modbus protocol, acting as a slave. Application layer library (OSI 7), used by all implementations over serial line and TCP/IP.",
   "homepage": "https://github.com/epsilonrt/modbus-arduino",

library.properties

@@ -1,5 +1,5 @@
 name=Modbus-Arduino
-version=1.0.0
+version=1.1.0
 author=Pascal Jean aka epsilonrt,André Sarmento Barbosa
 maintainer=epsilonrt
 sentence=A library that allows your Arduino to communicate via Modbus protocol, acting as a slave.

src/Modbus.cpp

@@ -48,7 +48,7 @@ void Modbus::addReg (word address, word value) {
   }
 }
 
-bool Modbus::Reg (word address, word value) {
+bool Modbus::setReg (word address, word value) {
   TRegister * reg;
   //search for the register address
   reg = this->searchRegister (address);
@@ -62,7 +62,7 @@ bool Modbus::Reg (word address, word value) {
   }
 }
 
-word Modbus::Reg (word address) {
+word Modbus::reg (word address) {
   TRegister * reg;
   reg = this->searchRegister (address);
   if (reg) {
@@ -77,12 +77,12 @@ void Modbus::addHreg (word offset, word value) {
   this->addReg (offset + 40001, value);
 }
 
-bool Modbus::Hreg (word offset, word value) {
-  return Reg (offset + 40001, value);
+bool Modbus::setHreg (word offset, word value) {
+  return setReg (offset + 40001, value);
 }
 
-word Modbus::Hreg (word offset) {
-  return Reg (offset + 40001);
+word Modbus::hreg (word offset) {
+  return reg (offset + 40001);
 }
 
 #ifndef USE_HOLDING_REGISTERS_ONLY
@@ -98,38 +98,38 @@ void Modbus::addIreg (word offset, word value) {
   this->addReg (offset + 30001, value);
 }
 
-bool Modbus::Coil (word offset, bool value) {
-  return Reg (offset + 1, value ? 0xFF00 : 0x0000);
+bool Modbus::setCoil (word offset, bool value) {
+  return setReg (offset + 1, value ? 0xFF00 : 0x0000);
 }
 
-bool Modbus::Ists (word offset, bool value) {
-  return Reg (offset + 10001, value ? 0xFF00 : 0x0000);
+bool Modbus::setIsts (word offset, bool value) {
+  return setReg (offset + 10001, value ? 0xFF00 : 0x0000);
 }
 
-bool Modbus::Ireg (word offset, word value) {
-  return Reg (offset + 30001, value);
+bool Modbus::setIreg (word offset, word value) {
+  return setReg (offset + 30001, value);
 }
 
-bool Modbus::Coil (word offset) {
-  if (Reg (offset + 1) == 0xFF00) {
+bool Modbus::coil (word offset) {
+  if (reg (offset + 1) == 0xFF00) {
     return true;
   }
   else {
     return false;
   }
 }
 
-bool Modbus::Ists (word offset) {
-  if (Reg (offset + 10001) == 0xFF00) {
+bool Modbus::ists (word offset) {
+  if (reg (offset + 10001) == 0xFF00) {
     return true;
   }
   else {
     return false;
   }
 }
 
-word Modbus::Ireg (word offset) {
-  return Reg (offset + 30001);
+word Modbus::ireg (word offset) {
+  return reg (offset + 30001);
 }
 #endif
 
@@ -277,7 +277,7 @@ void Modbus::readRegisters (word startreg, word numregs) {
   word i = 0;
   while (numregs--) {
     //retrieve the value from the register bank for the current register
-    val = this->Hreg (startreg + i);
+    val = this->hreg (startreg + i);
     //write the high byte of the register value
     _frame[2 + i * 2]  = val >> 8;
     //write the low byte of the register value
@@ -291,13 +291,13 @@ void Modbus::readRegisters (word startreg, word numregs) {
 void Modbus::writeSingleRegister (word reg, word value) {
   //No necessary verify illegal value (EX_ILLEGAL_VALUE) - because using word (0x0000 - 0x0FFFF)
   //Check Address and execute (reg exists?)
-  if (!this->Hreg (reg, value)) {
+  if (!this->setHreg (reg, value)) {
     this->exceptionResponse (MB_FC_WRITE_REG, MB_EX_ILLEGAL_ADDRESS);
     return;
   }
 
   //Check for failure
-  if (this->Hreg (reg) != value) {
+  if (this->hreg (reg) != value) {
     this->exceptionResponse (MB_FC_WRITE_REG, MB_EX_SLAVE_FAILURE);
     return;
   }
@@ -339,7 +339,7 @@ void Modbus::writeMultipleRegisters (byte * frame, word startreg, word numoutput
   word i = 0;
   while (numoutputs--) {
     val = (word) frame[6 + i * 2] << 8 | (word) frame[7 + i * 2];
-    this->Hreg (startreg + i, val);
+    this->setHreg (startreg + i, val);
     i++;
   }
 
@@ -389,7 +389,7 @@ void Modbus::readCoils (word startreg, word numregs) {
   word i;
   while (numregs--) {
     i = (totregs - numregs) / 8;
-    if (this->Coil (startreg)) {
+    if (this->coil (startreg)) {
       bitSet (_frame[2 + i], bitn);
     }
     else {
@@ -446,7 +446,7 @@ void Modbus::readInputStatus (word startreg, word numregs) {
   word i;
   while (numregs--) {
     i = (totregs - numregs) / 8;
-    if (this->Ists (startreg)) {
+    if (this->ists (startreg)) {
       bitSet (_frame[2 + i], bitn);
     }
     else {
@@ -499,7 +499,7 @@ void Modbus::readInputRegisters (word startreg, word numregs) {
   word i = 0;
   while (numregs--) {
     //retrieve the value from the register bank for the current register
-    val = this->Ireg (startreg + i);
+    val = this->ireg (startreg + i);
     //write the high byte of the register value
     _frame[2 + i * 2]  = val >> 8;
     //write the low byte of the register value
@@ -518,13 +518,13 @@ void Modbus::writeSingleCoil (word reg, word status) {
   }
 
   //Check Address and execute (reg exists?)
-  if (!this->Coil (reg, (bool) status)) {
+  if (!this->setCoil (reg, (bool) status)) {
     this->exceptionResponse (MB_FC_WRITE_COIL, MB_EX_ILLEGAL_ADDRESS);
     return;
   }
 
   //Check for failure
-  if (this->Coil (reg) != (bool) status) {
+  if (this->coil (reg) != (bool) status) {
     this->exceptionResponse (MB_FC_WRITE_COIL, MB_EX_SLAVE_FAILURE);
     return;
   }
@@ -571,7 +571,7 @@ void Modbus::writeMultipleCoils (byte * frame, word startreg, word numoutputs, b
   word i;
   while (numoutputs--) {
     i = (totoutputs - numoutputs) / 8;
-    this->Coil (startreg, bitRead (frame[6 + i], bitn));
+    this->setCoil (startreg, bitRead (frame[6 + i], bitn));
     //increment the bit index
     bitn++;
     if (bitn == 8) {