first initial

Author: electrocoder

README.md

@@ -1,10 +1,10 @@
-# ModbusRTUSlave Arduino Library
+# MBModbusRTUSlave Arduino Library
 
 A simple and flexible Modbus RTU slave library for Arduino.
 
 ## Overview
 
-The `ModbusRTUSlave` library allows Arduino devices to function as Modbus RTU slaves over a serial connection. It supports reading and writing registers via Modbus function codes `0x03` (Read Holding Registers) and `0x06` (Write Single Register), with provisions for LED control based on a designated register value. The library is designed to be customizable, with configurable slave address, LED pin, LED register index, and baud rate.
+The `MBModbusRTUSlave` library allows Arduino devices to function as Modbus RTU slaves over a serial connection. It supports reading and writing registers via Modbus function codes `0x03` (Read Holding Registers) and `0x06` (Write Single Register), with provisions for LED control based on a designated register value. The library is designed to be customizable, with configurable slave address, LED pin, LED register index, and baud rate.
 
 ### Features
 - Supports Modbus RTU protocol (function codes `0x03` and `0x06`).
@@ -29,19 +29,19 @@ The `ModbusRTUSlave` library allows Arduino devices to function as Modbus RTU sl
 1. **Download the Repository**:
    - Clone this repository or download it as a ZIP file:
      ```bash
-     git clone https://github.com/electrocoder/ModbusRTUSlave.git
+     git clone https://github.com/electrocoder/MBModbusRTUSlave.git
      ```
 
 2. **Install to Arduino IDE**:
-   - Move the `ModbusRTUSlave` folder to your Arduino `libraries` directory:
+   - Move the `MBModbusRTUSlave` folder to your Arduino `libraries` directory:
      - Windows: `Documents/Arduino/libraries/`
      - macOS/Linux: `~/Documents/Arduino/libraries/`
    - Restart the Arduino IDE.
 
 3. **Include in Your Sketch**:
    - Add the library to your sketch with:
      ```cpp
-     #include <ModbusRTUSlave.h>
+     #include <MBModbusRTUSlave.h>
      ```
 
 ---
@@ -52,10 +52,10 @@ The `ModbusRTUSlave` library allows Arduino devices to function as Modbus RTU sl
 This example initializes a Modbus slave with default settings and controls an LED based on register 5.
 
 ```cpp
-#include <ModbusRTUSlave.h>
+#include <MBModbusRTUSlave.h>
 
 long modbusBaudRate = 9600;  // Customizable baud rate
-ModbusRTUSlave modbus(0x01, 13, 5);  // Slave address: 0x01, LED pin: 13, LED register: 5
+MBModbusRTUSlave modbus(0x01, 13, 5);  // Slave address: 0x01, LED pin: 13, LED register: 5
 
 void setup() {
   modbus.begin(modbusBaudRate);

examples/ModbusRTUSlaveExample/ModbusRTUSlaveExample.ino renamed to examples/ModbusRTUSlaveExample/MBModbusRTUSlaveExample.ino

@@ -1,5 +1,5 @@
 /*
- * ModbusRTUSlaveExample.ino - Example Sketch for ModbusRTUSlave Library
+ * MBModbusRTUSlaveExample.ino - Example Sketch for MBModbusRTUSlave Library
  *
  * Description: This sketch demonstrates the usage of the ModbusSlave library to configure
  *              an Arduino as a Modbus RTU slave. It controls an LED based on a specific
@@ -15,7 +15,7 @@
  *  - LED connected to pin 13 (onboard LED can be used)
  * 
  * Dependencies:
- *  - ModbusRTUSlave library (version 1.0.0 or higher)
+ *  - MBModbusRTUSlave library (version 1.0.0 or higher)
  * 
  * Usage:
  *  - Upload this sketch to your Arduino.
@@ -24,9 +24,9 @@
  *    - Write 0 to register 5: "01 06 00 05 00 00 [CRC]" (turns LED OFF)
  */
 
-#include "ModbusRTUSlave.h"
+#include "MBModbusRTUSlave.h"
 
-ModbusRTUSlave modbus(0x01, 13, 0, 10);  // Slave address: 0x01, LED pin: 13, LED register: 0, Register count: 10
+MBModbusRTUSlave modbus(0x01, 13, 0, 10);  // Slave address: 0x01, LED pin: 13, LED register: 0, Register count: 10
 long modbusBaudRate = 9600;  // If you want it can be another value like 115200, 19200
 
 void setup() {

examples/ModbusRTUSlaveExample/README.md

@@ -1,4 +1,4 @@
-# ModbusRTUSlave Arduino Library
+# MBModbusRTUSlave Arduino Library
 
 A simple and flexible Modbus RTU slave library for Arduino.
 

keywords.txt

@@ -1,3 +1,3 @@
-ModbusSlave    KEYWORD1
+MBModbusRTUSlave    KEYWORD1
 begin          KEYWORD2
 update         KEYWORD2

library.properties

@@ -1,10 +1,10 @@
-name=ModbusRTUSlave
+name=MBModbusRTUSlave
 version=1.0.0
 author=S.Mersin (electrocoder) <[email protected]>
 maintainer=S.Mersin (electrocoder) <[email protected]>
 sentence=Modbus RTU protocol (function codes `0x03` and `0x06`). This library is a slave implementation of the Modbus RTU protocol.
-paragraph=The `ModbusRTUSlave` library allows Arduino devices to function as Modbus RTU slaves over a serial connection. It supports reading and writing registers via Modbus function codes `0x03` (Read Holding Registers) and `0x06` (Write Single Register), with provisions for LED control based on a designated register value. The library is designed to be customizable, with configurable slave address, LED pin, LED register index, and baud rate.
+paragraph=The `MBModbusRTUSlave` library allows Arduino devices to function as Modbus RTU slaves over a serial connection. It supports reading and writing registers via Modbus function codes `0x03` (Read Holding Registers) and `0x06` (Write Single Register), with provisions for LED control based on a designated register value. The library is designed to be customizable, with configurable slave address, LED pin, LED register index, and baud rate.
 category=Communication
-url=https://github.com/electrocoder/ModbusRTUSlave
+url=https://github.com/electrocoder/MBModbusRTUSlave
 architectures=avr,esp8266,esp32
 license=MIT

src/ModbusRTUSlave.cpp renamed to src/MBModbusRTUSlave.cpp

@@ -1,7 +1,7 @@
 /*
- * ModbusRTUSlave.cpp - Implementation of the Modbus RTU Slave Library for Arduino
+ * MBModbusRTUSlave.cpp - Implementation of the Modbus RTU Slave Library for Arduino
  *
- * Description: This file implements the methods of the ModbusRTUSlave class.
+ * Description: This file implements the methods of the MBModbusRTUSlave class.
  *              It supports Modbus RTU protocol for register reading (0x03) and writing (0x06).
  *              Provides LED control and flexible baud rate adjustments.
  * Author: S.Mersin (electrocoder) <[email protected]> (Assisted by Grok)
@@ -13,9 +13,9 @@
  *       All registers except the LED register are updated with random values.
  */
 
-#include "ModbusRTUSlave.h"
+#include "MBModbusRTUSlave.h"
 
-ModbusRTUSlave::ModbusRTUSlave(uint8_t slaveAddress, uint8_t ledPin, uint8_t ledRegisterIndex, uint16_t registerCount) {
+MBModbusRTUSlave::MBModbusRTUSlave(uint8_t slaveAddress, uint8_t ledPin, uint8_t ledRegisterIndex, uint16_t registerCount) {
   _slaveAddress = slaveAddress;
   _ledPin = ledPin;
   _ledRegisterIndex = ledRegisterIndex;
@@ -34,7 +34,7 @@ ModbusRTUSlave::ModbusRTUSlave(uint8_t slaveAddress, uint8_t ledPin, uint8_t led
   }
 }
 
-void ModbusRTUSlave::begin(long baudRate) {
+void MBModbusRTUSlave::begin(long baudRate) {
   _baudRate = baudRate;
   pinMode(_ledPin, OUTPUT);
   digitalWrite(_ledPin, LOW);
@@ -43,7 +43,7 @@ void ModbusRTUSlave::begin(long baudRate) {
     ;
 }
 
-void ModbusRTUSlave::update() {
+void MBModbusRTUSlave::update() {
   // We assign random values to all registers except the LED register
   for (int i = 0; i < _registerCount; i++) {
     if (i != _ledRegisterIndex)
@@ -71,7 +71,7 @@ void ModbusRTUSlave::update() {
   digitalWrite(_ledPin, modbusRegisters[_ledRegisterIndex] == 1 ? HIGH : LOW);
 }
 
-void ModbusRTUSlave::processReadHoldingRegisters() {
+void MBModbusRTUSlave::processReadHoldingRegisters() {
   uint16_t startAddress = (requestBuffer[2] << 8) | requestBuffer[3];
   uint16_t registerCount = (requestBuffer[4] << 8) | requestBuffer[5];
 
@@ -92,7 +92,7 @@ void ModbusRTUSlave::processReadHoldingRegisters() {
   Serial.write(responseBuffer, 5 + registerCount * 2);
 }
 
-void ModbusRTUSlave::processWriteSingleRegister() {
+void MBModbusRTUSlave::processWriteSingleRegister() {
   uint16_t registerAddress = (requestBuffer[2] << 8) | requestBuffer[3];
   uint16_t registerValue = (requestBuffer[4] << 8) | requestBuffer[5];
 
@@ -109,7 +109,7 @@ void ModbusRTUSlave::processWriteSingleRegister() {
   Serial.write(responseBuffer, 8);
 }
 
-uint16_t ModbusRTUSlave::calculateCRC(uint8_t *buffer, uint8_t length) {
+uint16_t MBModbusRTUSlave::calculateCRC(uint8_t *buffer, uint8_t length) {
   uint16_t crc = 0xFFFF;
   for (uint8_t pos = 0; pos < length; pos++) {
     crc ^= (uint16_t)buffer[pos];
@@ -125,29 +125,29 @@ uint16_t ModbusRTUSlave::calculateCRC(uint8_t *buffer, uint8_t length) {
   return crc;
 }
 
-bool ModbusRTUSlave::checkCRC(uint8_t *buffer, uint8_t length) {
+bool MBModbusRTUSlave::checkCRC(uint8_t *buffer, uint8_t length) {
   uint16_t receivedCRC = (buffer[length + 1] << 8) | buffer[length];
   uint16_t calculatedCRC = calculateCRC(buffer, length);
   return (receivedCRC == calculatedCRC);
 }
 
 // Setter methods
-void ModbusRTUSlave::setSlaveAddress(uint8_t slaveAddress) {
+void MBModbusRTUSlave::setSlaveAddress(uint8_t slaveAddress) {
   _slaveAddress = slaveAddress;
 }
 
-void ModbusRTUSlave::setLedPin(uint8_t ledPin) {
+void MBModbusRTUSlave::setLedPin(uint8_t ledPin) {
   _ledPin = ledPin;
   pinMode(_ledPin, OUTPUT);
 }
 
-void ModbusRTUSlave::setLedRegisterIndex(uint8_t ledRegisterIndex) {
+void MBModbusRTUSlave::setLedRegisterIndex(uint8_t ledRegisterIndex) {
   if (ledRegisterIndex < _registerCount) {
     _ledRegisterIndex = ledRegisterIndex;
   }
 }
 
-void ModbusRTUSlave::setBaudRate(long baudRate) {
+void MBModbusRTUSlave::setBaudRate(long baudRate) {
   _baudRate = baudRate;
   Serial.begin(_baudRate, SERIAL_8N1);
 }

src/ModbusRTUSlave.h renamed to src/MBModbusRTUSlave.h

@@ -1,5 +1,5 @@
 /*
- * ModbusRTUSlave.h - Modbus RTU Slave Library for Arduino
+ * MBModbusRTUSlave.h - Modbus RTU Slave Library for Arduino
  *
  * Description: This library configures Arduino devices as Modbus RTU slaves.
  *              It supports LED control, register reading/writing, and flexible baud rate settings.
@@ -8,18 +8,18 @@
  * Version: 1.0.0
  * License: MIT License
  * 
- * Usage: The ModbusRTUSlave class is initialized with a slave address, LED pin, and LED register index.
+ * Usage: The MBModbusRTUSlave class is initialized with a slave address, LED pin, and LED register index.
  *        Baud rate can be set via the begin() method using a variable.
  */
 
-#ifndef ModbusRTUSlave_h
-#define ModbusRTUSlave_h
+#ifndef MBModbusRTUSlave_h
+#define MBModbusRTUSlave_h
 
 #include <Arduino.h>
 
-class ModbusRTUSlave {
+class MBModbusRTUSlave {
 public:
-  ModbusRTUSlave(uint8_t slaveAddress = 0x01, uint8_t ledPin = 13, uint8_t ledRegisterIndex = 0, uint16_t registerCount = 10); // Constructor
+  MBModbusRTUSlave(uint8_t slaveAddress = 0x01, uint8_t ledPin = 13, uint8_t ledRegisterIndex = 0, uint16_t registerCount = 10); // Constructor
   void begin(long baudRate = 9600);  // Setup function
   void update();                     // Loop function