Difference between revisions of "Modbus Service"

From ESS-WIKI
Jump to: navigation, search
Line 199: Line 199:
  
  
= Application Case =
+
= Real Application Case =
 
 
'''<span style="font-size:large;">ADAM-4117 8-channel Analog Input Module</span>'''
 
 
 
<span style="font-size:larger;">1. H.W. Environment & Configuration</span>
 
 
 
 
 
 
 
<span style="font-size:larger;">[[File:Adam-4117-01.png|600x560px|Adam-4117-01.png]]</span>
 
 
 
 
 
 
 
<span style="font-size:larger;">2. Setup&nbsp;Modbus register from ADAM utility: AdamApax .NET Utility</span>
 
 
 
<span style="font-size:larger;">2.1 Download&nbsp;AdamApax .NET Utility from URL [http://support.advantech.com/Support/DownloadSRDetail_New.aspx?SR_ID=1-2AKUDB&Doc_Source=Download http://support.advantech.com/Support/DownloadSRDetail_New.aspx?SR_ID=1-2AKUDB&Doc_Source=Download] and install it to your Gateway.</span>
 
 
 
<span style="font-size:larger;">2.2 Launch&nbsp;AdamApax .NET Utility,&nbsp;select COM port which ADAM module is connected, right click on the COM port you selected and click "Search Device" to detect your ADAM-4117.</span>
 
 
 
 
 
 
 
[[File:Adam-4117-04.png|680x500px|Adam-4117-04.png]]
 
 
 
 
 
 
 
<span style="font-size:larger;">2.3 After ADAM-4117 appeared, click on it to check its settings or change the default settings for your H.W. configuration.</span>
 
 
 
[[File:Adam-4117-06.png|680x500px|Adam-4117-06.png]]
 
 
 
 
 
 
 
[[File:Adam-4117-07.png|680x500px|Adam-4117-07.png]]
 
 
 
 
 
 
 
[[File:Adam-4117-08.png|680x500px|Adam-4117-08.png]]
 
 
 
 
 
 
 
<span style="font-size:larger;">2.4&nbsp;Provide a stable 12V voltage power to Vin0.</span>
 
 
 
[[File:Adam-4117-10.jpg|600x600px|Adam-4117-10.jpg]]
 
 
 
 
 
 
 
<span style="font-size:larger;">2.5&nbsp;Check the value of Channel 0 from AdamApax .NET Utility, the value of Vin0 is 12.108V.</span>
 
 
 
[[File:Adam-4117-11.png|680x500px|Adam-4117-11.png]]
 
 
 
 
 
 
 
<span style="font-size:larger;">2.6&nbsp;Check the value of Modbus Location 40001 from AdamApax .NET Utility, the value is 52900. ( 12.108 / 15 * 65536 = 52900.66 )</span>
 
 
 
[[File:Adam-4117-12.png|680x500px|Adam-4117-12.png]]
 
 
 
 
 
 
 
<span style="font-size:larger;">3. Gateway Modbus_Handler configuration</span>
 
 
 
<span style="font-size:larger;">3.1 Edit Modbus_Handler.ini for the ADAM's configuration.</span>
 
<pre>[Platform]
 
Interval=1
 
#Interval: The time delay between two modbus access round in second.&nbsp;
 
Delay=0
 
#Delay: The time delay between two modbus access in millisecond.
 
#Delay=0 means no delay.
 
Log=0
 
 
 
Name=ADAM-4117
 
Protocol=Modbus_RTU
 
SlavePort=COM1
 
Baud=9600
 
Parity=None
 
DataBits=8
 
StopBits=1
 
 
 
[Devices]
 
numberOfDevices=1
 
Device0=Modbus_Device0.ini
 
 
 
#DeviceN: Modbus device files with detail register address mapping&nbsp;
 
</pre>
 
 
 
 
 
 
 
<span style="font-size:larger;">3.2 Edit Modbus_Device0.ini for ADAM-4117 modbus location configuration.</span>
 
<pre>[DeviceInfo]
 
# For Modbus_TCP
 
#UnitID=1
 
# For Modbus_RTU
 
SlaveID=1
 
 
 
[Holding Registers]
 
numberOfR=3
 
R0=0,Vin0,0,65535,1,V,0,""
 
R1=1,Vin1,0,65535,1,V,0,""
 
R2=2,Vin2,0,65535,1,V,0,""
 
 
 
;tag = offset, name, min, max, precision, unit, data type, lua script
 
 
 
;tag&nbsp;&nbsp; &nbsp;Base Address
 
;B&nbsp;&nbsp; &nbsp;00001-->Coils
 
;IB&nbsp;&nbsp; &nbsp;10001-->Discrete Inputs
 
;IR&nbsp;&nbsp; &nbsp;30001-->Input Registers
 
;R&nbsp;&nbsp; &nbsp;40001-->Holding Registers
 
 
 
;data type
 
;0->16-bit operation
 
;1->32-bit float no swap
 
;2->32-bit float byte and word swap
 
;3->32-bit float byte swap
 
;4->32-bit float word swap
 
;5->32-bit unsigned int no swap
 
;6->32-bit unsigned int word swap
 
;7->32-bit signed int no swap
 
;8->32-bit signed int word swap
 
 
 
</pre>
 
 
 
 
 
 
 
<span style="font-size:larger;">3.2 Restart Agent_Modbus_Handler from Task Manager, login RMM 3.3 to check the values that ADAM-4117 and Gateway uploaded.</span>
 
 
 
<span style="font-size:larger;">[[File:Adam-4117-13.png|800x600px|Adam-4117-13.png]]</span>
 
 
 
 
 
 
 
<span style="font-size:larger;">3.3&nbsp;Use Lua convert function to transfer modbus value to voltage value, open&nbsp;Modbus_Device0.ini and give Vin0~Vin2 Lua scripts&nbsp;as "modbus_val*15/65536".</span>
 
<pre>[DeviceInfo]
 
# For Modbus_TCP
 
#UnitID=1
 
# For Modbus_RTU
 
SlaveID=1
 
 
 
[Holding Registers]
 
numberOfR=3
 
R0=0,Vin0,0,15,1,V,0,"modbus_val*15/65536"
 
R1=1,Vin1,0,15,1,V,0,"modbus_val*15/65536"
 
R2=2,Vin2,0,15,1,V,0,"modbus_val*15/65536"
 
 
 
;tag = offset, name, min, max, precision, unit, data type, lua script
 
 
 
</pre>
 
 
 
 
 
 
 
<span style="font-size:larger;">3.4 Login RMM 3.3 again to check the values that ADAM-4117 and Gateway uploaded, the value is already converted to voltage value.</span>
 
 
 
<span style="font-size:larger;">[[File:Adam-4117-14.png|800x600px|Adam-4117-14.png]]</span>
 
 
 
 
 
 
 
  
 +
[[Modbus_Handler_V2.0_Real_Application_Case|Real Application Case: ADAM-4117]]
  
 
= Release =
 
= Release =

Revision as of 12:01, 10 August 2018

Introduction

Modbus enables communication among many devices connected to the same network, for example, a system that measures temperature and humidity and communicates the results to a computer. Modbus is often used to connect a supervisory computer with a remote terminal unit (RTU) in supervisory control and data acquisition (SCADA) systems.

Many of the data types are named from its use in driving relays: a single-bit physical output is called a coil, and a single-bit physical input is called a discrete input or a contact.

Modbus Service is a Windows/Linux system service for WISE Agent to read sensor data from Modbus device or write data into Modbus device. After sensor ata are acquired, WISE Agent will upload the data to the WISE-PaaS Cloud.


Installation

1. Double click Agent_Modbus_Handler_2.0.0.exe to start installation.

2. Click "Next" on the Welcome screen.

Agent modbus handler 02.png


3. Select Installation Folder and then click "Next" to continue.

Agent modbus handler 03.png


4. Click "Install" on the Ready to Install screen to continue.

Agent modbus handler 04.png


5. Installation completed, click "Finish" button to exit the Setup Wizard.

Agent modbus handler 06.png



Configuration

1. Open File Explorer and change target folder to the Modbus Service installation folder.

2. Open and edit the file Mobus_Handler.ini

2.1 Give a Name for the platform.

2.2 Set the Protocol.

For the modbus TCP devices:

Protocol=Modbus_TCP

ClientIP=(IP address of Modbus TCP devices)

ClientPort=(Port of Modbus TCP devices)  

Modbus_Handler.ini Example:

[Platform]
Name=WISE-4012E
Protocol=Modbus_TCP
ClientIP=127.0.0.1
ClientPort=502

Interval=3
#Interval: The time delay between two modbus access round in second.
Delay=0
#Delay: The time delay between two modbus access in millisecond.
#Delay=0 means no delay.
Log=0

[Devices]
numberOfDevices=2
Device0=Modbus_Device0.ini
Device1=Modbus_Device1.ini


For the modbus RTU devices:

Protocol=Modbus_RTU

SlavePort=(The serial port's device node of the Gateway which connect to Modbus RTU devices)

Baud=(The baud rate for the serial port to communicate with Modbus RTU device)

Parity=(The parity of the serial port)

DataBits=(The data bits of the serial port)              

StopBits=(The stop bits of the serial port) 


Example:

[Platform]
Name=EKI-XXXX
Protocol=Modbus_RTU
SlavePort=COM1
Baud=19200
Parity=None
DataBits=8
StopBits=1

Interval=3
#Interval: The time delay between two modbus access round in second.
Delay=0
#Delay: The time delay between two modbus access in millisecond.
#Delay=0 means no delay.
Log=0

[Devices]
numberOfDevices=2
Device0=Modbus_Device0.ini
Device1=Modbus_Device1.ini


2.3 Set Modbus devices detail configuration.

Modbus_Device0.ini Example:

[DeviceInfo]
# For Modbus_TCP
UnitID=1
# For Modbus_RTU
#SlaveID=1

[Coils]
numberOfB=3
B0=0,LED0
B1=1,LED1
B2=2,LED2


Modbus_Device1.ini Example:

[DeviceInfo]
# For Modbus_TCP
UnitID=2
# For Modbus_RTU
#SlaveID=2

[Discrete Inputs]
numberOfIB=3
IB0=0,Switch0
IB1=1,Switch1
IB2=2,Switch2

EdgeSense Linux Docker version

How to config Modbus Service and Restart Service

$cd ${Installed path}/Installer/packages/Plugins/docker-edgesense-image-x86/EdgeSense/EService-Modbus/config
$sudo vim Modbus_Handler.ini
$sudo docker restart service-modbus


JSON Format for upload data

{
   "Modbus_Handler":{
      "Platform":{
         "bn":"Platform",
         "e":[{"n":"Version","sv":"2.0.0"},
              {"n":"Description","sv":"This service is Modbus Service"},
              {"n":"Protocol","sv":"Modbus_TCP"},
              {"n":"Name","sv":"WISE-4012E"},
              {"n":"ClientIP","sv":"127.0.0.1"},
              {"n":"ClientPort","sv":"502"},
              {"n":"Connection","bv":true}]
      },
      "Modbus_Device0":{
         "bn":"Modbus_Device0",
         "e":[{"n":"UnitID","sv":"1"}],
         "Coils":{
            "bn":"Coils",
            "e":[{"n":"LED0","bv":true},
                 {"n":"LED1","bv":true},
                 {"n":"LED2","bv":false}]
         }
      },
      "Modbus_Device1":{
         "bn":"Modbus_Device1",
         "e":[{"n":"UnitID","sv":"2"}],
         "Discrete Inputs":{
            "bn":"Discrete Inputs",
            "e":[{"n":"Switch0","bv":false},
                 {"n":"Switch1","bv":true},
                 {"n":"Switch2","bv":false}]
         }
      }
   }
}


Real Application Case

Real Application Case: ADAM-4117

Release

This is an overview that displays Modbus Service versions and some stats and numbers for each release.

Index Version Date Platform OS Release Note
1 v2.0.0 2018/5/17 x86_64 CPU Windows  Agent Modbus Handler v2.0.0 Release Note
2 v2.0.1 2018/8/6 x86_64 CPU
Windows
Agent Modbus Handler v2.0.1 Release Note