Difference between revisions of "Modbus RTU Master"

From Control Solutions IoTServer Documentation
Jump to navigation Jump to search
(Read Maps)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Status ==
 
== Status ==
=== Error Counts ===
+
=== [[Modbus RTU Master Error Counts]] ===
=== Read Data ===
+
=== [[Modbus RTU Master Read Data]] ===
=== Write Data ===
+
=== [[Modbus RTU Master Write Data]] ===
 
== Configuration ==
 
== Configuration ==
 +
[[File:Modbus RTU master configuration tabs.jpg]]
  
 +
Select Modbus RTU Master from the sidebar menu to access Modbus RTU Master Configuration. The Modbus RTU Master Configuration page will have the tabs illustrated above. Click on the tabs to navigate to the areas of interest which are described in detail at the links below.
  
When you select the Modbus RTU Master option, this page defaults to showing you the initial Modbus Read maps available in the device.
+
You may edit individual maps first navigating to the tab/page listing those items. Then click the edit icon (pencil). This will take you to the respective "Edit" page listed below.
 
+
   
 
+
=== [[Modbus RTU Master Read Maps]] ===
[[File:Modbus RTU Master Main.png]]
+
=== [[Modbus RTU Master Read Map Edit]] ===
 
+
=== [[Modbus RTU Master Write Maps]] ===
 
+
=== [[Modbus RTU Master Write Map Edit]] ===
The sections along the top of this page indicate what option you are working on.  These are Read map, Write map, Port Settings, and Config File.  Selecting one of these options will take you to that particular section for configuration of the device.  This page defaults to the overview of the Read Map section for configuring this portion of the gateway.
+
=== [[Modbus RTU Master Port Settings]] ===
 
+
=== [[Modbus RTU Master Config File]] ===
 
+
== Reference Information ==
=== Read Maps ===
 
 
 
Read maps allow you to read other Modbus RTU slave devices, and save the data read locally.
 
 
 
Here is a description of the different fields available on this page.
 
 
 
If there are more entries than what can fit on a page, this will allow you to scroll through the list of read rules
 
 
 
[[File:Show_Entries.png]] - Controls how many Modbus Read rules are displayed per page.
 
 
 
[[File:Search.png]] - Allows you to search through the list of rules, for a specific number, phrase, etc.
 
 
 
To delete an individual read map simply select the [[File:Trashcan.png]] icon for the map, and acknowledge this is to be deleted.
 
 
 
If there are more entries than what can fit on a page, use the [[File:Previous-Next.png]] to scroll to the next or previous page(s).
 
 
 
You will need to allocate a number of maps in this device, before they can be used.  This information is entered on this line:[[File:AddNewMaps1.png]]
 
.  You will enter the number of maps you want added here:. The location of where these should be added is selected here: [[File:Modify_Insert_Location.png]].  Your options are: before a specified map number, or the end of the list.
 
 
 
You also have the capability of copying map(s) that already exist
 
[[File:Modify RTU Copy Map.png]].  You will need to select the map or range of maps you would like copied
 
[[File:Modify RTU Copy Range.png]], and the location of where these are to be inserted in the existing list
 
[[File:Modify RTU Copy Loc.png]]. These can be inserted anywhere in the current list, or have these appended to the end of the current list.
 
 
 
 
 
Related Quick Links:
 
 
 
[[Modbus RTU Master Read Map Edit]]
 
 
 
[[Modbus RTU Master]]
 
 
 
[[Modbus TCP Server]]
 
 
 
[[Modbus TCP Client]]
 
 
 
 
 
 
 
==== [[Modbus RTU Master Read Map Edit]] ====
 
 
 
To create a Modbus RTU Read map, there is a form that needs to be filled in.  Here is the page for modifying a Read Map.
 
[[File:Modify RTU Read Map.png]]
 
 
 
 
 
Here is a description for all of the fields on this page:
 
 
 
[[File:Modify RTU Read Map Type.png]] - Here you select the register type that needs to be read from the slave device.  The MOdbus register types supported are: None, Coil, Discrete Input, Input, and Holding registers.
 
Note: Selecting "None" effectively turns off this read rule, but does not delete it.
 
 
 
 
 
[[File:Modify RTU Read Map Number.png]] - This is the register number / address that is supposed to be read from the slave device.  Depending on your user settings, you will either enter the Modbus register number (shown here), Modbus address, or use Modicon notation for this field.
 
 
 
 
 
[[File:Modify RTU Read Map Format.png]] - Here you enter the data format and size that should be used for this read.  The valid data types are Integer (int), Floating point IEEE 754 format (Real), Character (Char) and Modd10 (mod10).  Some of these data types can of options associated with them.  Int can be signed or unsigned, and can have a length of 1, 2, or 4 registers long.  Real, can be either 2, or 4 registers long.  Char can be upto 63 registers long.  Mod10 has the options of 2, 3, or 4 registers based on the definition of the format.
 
 
 
 
 
[[File:Modify RTU Read Map Slave.png]] - This is the slave / unit number of the device you want to retrieve the data from.
 
 
 
Once a register has been read, additional items, can be performed on the value read.  This can be to: extract out a bit, or portion of the data, apply a scale factor, or apply an offset value to the value read, if needed.
 
 
 
 
 
[[File:Modify RTU Read Map Mask.png]] - Is used to extract our data from the register.  This can be a single bit, all the way up to the entire register.  The data entered here needs to be entered in Hexadecimal format.  Often Modbus may have each bit in an Unsigned Integer value represent a single status bit.  This allows one register to contain sixteen individual values.  Another usage of this would be if the 16-bit register actually contained two 8-bit values.  One in the lower half of the register, the other in the upper half of the register.  See appendix '''????''' for additional information on bit mask and extracting portions of a register.
 
 
 
 
 
[[File:Modify RTU Read Map ScaleOffset.png]] - From that point you can perform scaling and apply an offset to the result if necessary.  Scaling applies the formula y=mx+b.  When reading from the slave, the raw data is multiplied by the scale factor, then the offset is added to produce the resulting present value.  When writing to the slave, the offset is first subtracted from the present value, and that result is divided by the scale factor to produce the raw data actually written to the slave device.
 
NOTE: If a scale factor is not given (zero is entered), no scaling will be performed, as if slope=1 and intercept=0.
 
 
 
 
 
[[File:Modify_RTU_Poll_Period.png]] - This sets the rate the point is to be polled from the slave device, and the
 
[[File:Modify RTU SaveLocal.png]] location in this gateway where this data is to be saved (Local Object).
 
 
 
=== [[Write Maps]] ===
 
==== [[Modbus RTU Master Write Map Edit]] ====
 
=== Port Settings ===
 
=== Config File ===
 
 
==== [[Modbus RTU Master XML Files]] ====
 
==== [[Modbus RTU Master XML Files]] ====
 
==== [[Modbus RTU Master CSV Files]] ====
 
==== [[Modbus RTU Master CSV Files]] ====

Latest revision as of 15:45, 2 May 2019

Status

Modbus RTU Master Error Counts

Modbus RTU Master Read Data

Modbus RTU Master Write Data

Configuration

Modbus RTU master configuration tabs.jpg

Select Modbus RTU Master from the sidebar menu to access Modbus RTU Master Configuration. The Modbus RTU Master Configuration page will have the tabs illustrated above. Click on the tabs to navigate to the areas of interest which are described in detail at the links below.

You may edit individual maps first navigating to the tab/page listing those items. Then click the edit icon (pencil). This will take you to the respective "Edit" page listed below.

Modbus RTU Master Read Maps

Modbus RTU Master Read Map Edit

Modbus RTU Master Write Maps

Modbus RTU Master Write Map Edit

Modbus RTU Master Port Settings

Modbus RTU Master Config File

Reference Information

Modbus RTU Master XML Files

Modbus RTU Master CSV Files