Skip to content
Modbus slave library for ESP8266-Arduino
Branch: master
Clone or download
yaacov Merge pull request #5 from per1234/keywords_txt-multiple-tabs
Use a single tab field separator in keywords.txt
Latest commit 1860997 Jul 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples/simple
extras
src
.gitignore
LICENSE
README.md
keywords.txt
library.properties

README.md

ModbusSlaveTCP

ModbusSlave library for ESP8266-Arduino

This modbus slave library uses callbacks to handle modbus requests. Handler functions are called on modbus request, and the users can implement them in their sketch.

ModbusSlave is fun and easy to use

Register a handler function:

slave.cbVector[CB_READ_REGISTERS] = ReadAnalogIn;

Implement it:

void ReadAnalogIn(uint8_t fc, uint16_t address, uint16_t length) {
    for (int i = 0; i < length; i++)
        slave.writeRegisterToBuffer(i, analogRead(address + i));
}

And thats it, your sketch is modbus enabled. (see the full examples for more detail)



Install

Download the zip package, and install it into your Arduino IDE.

See the Arduino tutorial about installing 3rd party libraries: https://www.arduino.cc/en/Guide/Libraries#toc4

Competabilty

This class implements:
  • FC1 "Read Coil Status"
  • FC2 "Read Input Status"
  • FC3 "Read Holding Registers"
  • FC4 "Read Input Registers"
  • FC5 "Force Single Coil"
  • FC16 "Preset Multiple Registers"

Callback vector

Users register handler functions into the callback vector.

Slots

The callback vector has 4 slots for request handlers:

  • slave.cbVector[CB_READ_COILS] - called on FC1 and FC2
  • slave.cbVector[CB_WRITE_COIL] - called on FC5
  • slave.cbVector[CB_READ_REGISTERS] - called on FC3 and FC4
  • slave.cbVector[CB_WRITE_MULTIPLE_REGISTERS] - called on FC16
Handler function

handler functions must return void and take:

  • uint8_t fc - request function code
  • uint16_t address - first register / first coil address
  • uint16_t length / status - length of data / coil status
Function codes
  • FC_READ_COILS = 1
  • FC_READ_DISCRETE_INPUT = 2
  • FC_READ_REGISTERS = 3
  • FC_READ_INPUT_REGISTERS = 4
  • FC_WRITE_COIL = 5
  • FC_WRITE_MULTIPLE_REGISTERS = 16

Reading and writing to the request / response buffer
  • uint16_t readRegisterFromBuffer(int offset) : read one register value from the request buffer.
  • void writeCoilToBuffer(int offset, uint16_t state) : write one coil state into the answer buffer.
  • void writeRegisterToBuffer(int offset, uint16_t value) : write one register value into the answer buffer.

Examples


handle "Force Single Coil" as arduino digitalWrite
#include <ESP8266WiFi.h>
#include <ModbusSlaveTCP.h>

const char* ssid = "....";
const char* pass = "....";

Modbus slave(1); // slave id = 1

void setup() {
    // connect to WiFi
    WiFi.begin(ssid, pass);
    while (WiFi.status() != WL_CONNECTED) delay(500);
    
    // register one handler functions
    // if a callback handler is not assigned to a modbus command 
    // the default handler is called. 
    // default handlers return a valid but empty replay.
    slave.cbVector[CB_WRITE_COIL] = writeDigitlOut;
    
    // start slave at port 502
    slave.begin(); // start listen on port 502
}

void loop() {
    // listen for modbus commands con serial port
    slave.poll();
}

// Handel Force Single Coil (FC=05)
void writeDigitlOut(uint8_t fc, uint16_t address, uint16_t status) {
    if (status == HIGH) {
        digitalWrite(address, HIGH);
    } else {
        digitalWrite(address, LOW);
    }
}

handle "Read Input Registers" as arduino analogRead
#include <ESP8266WiFi.h>
#include <ModbusSlaveTCP.h>

const char* ssid = "....";
const char* pass = "....";

Modbus slave(1); // slave id = 1

void setup() {
    // connect to WiFi
    WiFi.begin(ssid, pass);
    while (WiFi.status() != WL_CONNECTED) delay(500);
    
    // register handler functions
    slave.cbVector[CB_READ_REGISTERS] = ReadAnalogIn;
    
    // start slave at port 502
    slave.begin(); // start listen on port 502
}

void loop() {
    // listen for modbus commands con serial port
    slave.poll();
}

// Handel Read Input Registers (FC=04)
void ReadAnalogIn(uint8_t fc, uint16_t address, uint16_t length) {
    // we only answer to function code 4
    if (fc != FC_READ_INPUT_REGISTERS) return;
    
    // write registers into the answer buffer
    for (int i = 0; i < length; i++) {
      slave.writeRegisterToBuffer(i, analogRead(address + i));
    }
}
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.