for merge

Author: emelianov

README.md

@@ -12,8 +12,6 @@ http://www.modbus.org/docs/Modbus_Messaging_Implementation_Guide_V1_0b.pdf
 
 ## Features
 
-Keep alive and ESP32 support added to original library. This features is under testing.
-
 <ul>
 <li>Operates as a slave</li>
 <li>Supports Modbus IP (TCP)</li>
@@ -29,6 +27,12 @@ Keep alive and ESP32 support added to original library. This features is under t
     <li>0x0F - Write Multiple Coils</li>
     <li>0x10 - Write Multiple Registers</li>
 </ul>
+<li>Callbacks for</li>
+<ul>
+    <li> - Incoming IP connection</li>
+    <li> - Read specific Register</li>
+    <li> - Write specific Register</li>
+</ul>
 </ul>
 
 <b>Notes:</b>
@@ -54,18 +58,96 @@ Thus, only the following functions are supported:
 </ul>
 
 
-## How to
+## API
+
+### Add [multiple] regs
+```
+bool addReg(uint16_t address, uint16_t value = 0, uint16_t numregs = 1)
+bool addHreg(uint16_t offset, uint16_t value = 0, uint16_t numregs = 1)
+bool addCoil(uint16_t offset, bool value = false, uint16_t numregs = 1)
+bool addIsts(uint16_t offset, bool value = false, uint16_t numregs = 1)
+bool addIreg(uint16_t offset, uint16_t value = 0, uint16_t nemregs = 1)
+```
+### Write regs
+```
+bool Reg(uint16_t address, uint16_t value)
+bool Hreg(uint16_t offset, uint16_t value)
+bool Coil(uint16_t offset, bool value)
+bool Ists(uint16_t offset, bool value)
+bool Ireg(uint16_t offset, uint16_t value)
+```
+### Read regs
+```
+uint16_t Reg(uint16_t address)
+uint16_t Hreg(uint16_t offset)
+bool Coil(uint16_t offset)
+bool Ists(uint16_t offset)
+uint16_t Ireg(uint16_t offset)
+```
+### Callbacks
+```
+bool onGet(uint16_t address, cbModbus cb = cbDefault, uint16_t numregs = 1)
+bool onSet(uint16_t address, cbModbus cb = cbDefault, uint16_t numregs = 1)
+void onConnect(cbModbusConnect cb)
+typedef uint16_t (*cbModbus)(TRegister* reg, uint16_t val)
+typedef bool (*cbModbusConnect)(IPAddress ip)
+```
+### Macros
+```
+#define COIL(n)
+#define ISTS(n)
+#define IREG(n)
+#define HREG(n)
+#define COIL_VAL(v)
+#define COIL_BOOL(v)
+#define ISTS_VAL(v)
+#define ISTS_BOOL(v)
+```
+### ModBus IP specific
+```
+void begin()
+void task()
+```
+
+### Callback example
 
 ```
-This README is under development, for now, see the examples of the library.
+bool coil = false; // Define external variable to get/set value
+uint16_t cbCoilSet(TRegister* reg, uint16_t val) {	// 'reg' is pointer to reg to modify, 'val' is new register value
+  coil = COIL_BOOL(val);
+  return val;	// Returns value to be saved to TRegister structure
+}
+uint16_t cbCoilGet(TRegister* reg, uint16_t val) {
+  return COIL_VAL(coil);	// Returns value to be returned to ModBus master as reply for current request
+}
+bool cbConn(IPAddress ip) {
+	Serial.println(ip);
+	return true;		// Return 'true' to allow connection or 'false' to drop connection
+}
+ModbusIP mb;	// ModbusIP object
+void setup() {
+...
+  mb.onConnect(cbConn);   // Add callback on connection event
+  mb.begin();
+  mb.addCoil(COIL_NR);     // Add Coil
+  mb.onSet(COIL(COIL_NR), cbCoilSet); // Add callback on Coil COIL_NR value set
+  mb.onGet(COIL(COIL_NR), cbCoilGet); // Add callback on Coil COIL_NR value get
+...
+}
+void loop() {
+...
+	mb.task();
+...
+}
 ```
 
+
 ## Contributions
 
 https://github.com/emelianov/modbus-esp8266<br>
 [email protected]
 
-Original version:
+Original version:<br>
 http://github.com/andresarmento/modbus-esp8266<br>
 prof (at) andresarmento (dot) com
 

examples/TestCallback/TestCallback.ino

@@ -20,8 +20,11 @@
 //Modbus Registers Offsets (0-9999)
 const int LED_COIL = 100;
 //Used Pins
-const int ledPin = D4; // Builtin ESP8266 LED
-
+#ifdef ESP8266
+ const int ledPin = D4; // Builtin ESP8266 LED
+#else
+ const int ledPin = TX; // ESP32 TX LED
+#endif
 //ModbusIP object
 ModbusIP mb;
 
@@ -50,14 +53,14 @@ void setup() {
 
   Serial.println("");
   Serial.println("WiFi connected");  
-  Serial.println("IP address: ");
+  Serial.print("IP address: ");
   Serial.println(WiFi.localIP());
 
   mb.onConnect(cbConn);   // Add callback on connection event
   mb.begin();
 
   pinMode(ledPin, OUTPUT);
-  mb.addCoil(LED_COIL);     // Add Coil
+  mb.addReg(COIL(LED_COIL));       // Add Coil. The same as mb.addCoil(COIL_BASE, false, LEN)
   mb.onSet(COIL(LED_COIL), cbLed); // Add callback on Coil LED_COIL value set
 }
 

examples/TestMassOperations/TestMassOperations.ino

@@ -0,0 +1,79 @@
+/*
+  Modbus-Arduino Example - Publish multiple DI as coils (Modbus IP ESP8266/ESP32)
+  
+  Original library
+  Copyright by André Sarmento Barbosa
+  http://github.com/andresarmento/modbus-arduino
+
+  Current version
+  (c)2017 Alexander Emelianov ([email protected])
+  https://github.com/emelianov/modbus-esp8266
+*/
+
+#ifdef ESP8266
+ #include <ESP8266WiFi.h>
+#else	//ESP32
+ #include <WiFi.h>
+#endif
+#include <ModbusIP_ESP8266.h>
+
+//Used Pins
+#ifdef ESP8266
+ uint8_t pinList[] = {D0, D1, D2, D3, D4, D5, D6, D7, D8};
+#else	//ESP32
+  uint8_t pinList[] = {12, 13, 14, 14, 16, 17, 18, 21, 22, 23};
+#endif
+#define LEN sizeof(pinList)/sizeof(uint8_t)
+
+//ModbusIP object
+ModbusIP mb;
+
+// Callback function to read corresponding DI
+uint16_t cbRead(TRegister* reg, uint16_t val) {
+  if(reg->address < COIL_BASE)
+    return 0;
+  uint8_t offset = reg->address - COIL_BASE;
+  if(offset >= LEN)
+    return 0; 
+  return COIL_VAL(digitalRead(pinList[offset]));
+}
+// Callback function to write-protect DI
+uint16_t cbWrite(TRegister* reg, uint16_t val) {
+  return reg->value;
+}
+
+// Callback function for client connect. Returns true to allow connection.
+bool cbConn(IPAddress ip) {
+  Serial.println(ip);
+  return true;
+}
+ 
+void setup() {
+  Serial.begin(74880);
+ 
+  WiFi.begin("ssid", "password");
+  
+  while (WiFi.status() != WL_CONNECTED) {
+    delay(500);
+    Serial.print(".");
+  }
+ 
+  Serial.println("");
+  Serial.println("WiFi connected");  
+  Serial.print("IP address: ");
+  Serial.println(WiFi.localIP());
+  for (uint8_t i = 0; i < LEN; i++)
+    pinMode(pinList[i], INPUT);
+  mb.onConnect(cbConn);   // Add callback on connection event
+  mb.begin();
+
+  mb.addReg(COIL(COIL_BASE), COIL_VAL(false), LEN); // Add Coils. The same as mb.addCoil(COIL_BASE, false, LEN)
+  mb.onGet(COIL(COIL_BASE), cbRead, LEN); // Add callback on Coils value get
+  mb.onSet(COIL(COIL_BASE), cbWrite, LEN);
+}
+
+void loop() {
+   //Call once inside loop() - all magic here
+   mb.task();
+   yield();
+}

keywords.txt

@@ -9,7 +9,7 @@ begin          	KEYWORD2
 task            KEYWORD2
 onGet			KEYWORD2
 onSet			KEYWORD2
-onConnect			KEYWORD2
+onConnect		KEYWORD2
 
 # Constants (LITERAL1)
 

library.properties

@@ -1,5 +1,5 @@
 name=modbus-esp8266
-version=0.1
+version=1.1
 author=Andre Sarmento Barbosa
 maintainer=Alexander Emelianov<[email protected]>
 sentence=Modbus Library for ESP8266/ESP32