VantagePointDisplay.com Vantage Point Online Reference
Search:
Contents
Display Legacy Contents

IndexBookmarkPrint

Home > Vantage Point Server > Configuration Files > Legacy INI Configuration > Devices > Modbus

Modbus

A device section starts with <Device> and ends with </Device>. You will need a separate Device section for each device you want this Vantage Point Server to query. We recommend using a comment immediately after the opening tag to provide a long description of the device.

  • Device Type – MODBUS_TCP

  • Device Description – A short description of the device, contained within double-quotes (").

  • PortID – The PortID that you assigned to the device in the Comm Ports section.

  • Device Address – This is the Modbus Slave ID, a value between 1 and 255.

  • Device Bus Number – 0

  • Interval Seconds – The frequency devices are queried for new values.

  • TimeOut Seconds – How many seconds the Vantage Point Server will wait for a response from a devices before it times out.

  • Unreliable TimeOutSec – How many seconds the Vantage Point Server is to go without any response from a device before it marks that the device as Unreliable. The Vantage Point Server will then report the unreliable status to the Vantage Point Presentation.

1 <PointServer>                                                                                                                                                                    
2  
3     <Device> 'Device Long Description
4         '                                                  Device      Device      Interval     TimeOut     Unreliable
5         'Device Type     Device Description     PortID     Address     Bus Num     Seconds      Seconds     TimeOutSec
6         '-----------     ------------------     ------     -------     -------     --------     -------     ----------
7          MODBUS_TCP      "Short Description"    3          1           0           4.0          4.0         300 'Default is 300
8  
9         <Points>
10  
11         </Points>
12  
13     </Device>
14  
15 </PointServer>

Points Subsection Parameters

A Points subsection starts with <Points> and ends with </Points> and it is contained within a Device subsection. A Device subsection can have only one Points subsection. It contains every Point on a Device from which you want to retrieve data but not necessarily every point available on the Device.
  • Point TagA short name that identifies the point and must be unique within the entire configuration file.

  • Point Address –This is a composite of four values – in order, the Modbus Register Address, the Modbus Function Code, the Data Length, and the Data Multiplier – separated by colons. These individual values can be found in the device's documentation, which was likely provided by the manufacturer and usually can be found on the manufacturer's website.

  • Type

    • RB: Any device that returns a binary value (ie, 0 or 1, True or False).

    • RS: Any device that returns a text value.

    • R: All other devices.

  • Point Description – Contained within double quotes, this is a brief description of the point.

  • Number of Entries – The maximum number of history records stored for this calculation.

    • Auto or Optimized: Sets the Interval to Hourly and records 336 hourly records, 60 daily records, and 120 monthly into history.

    • Numeric Value: Sets the maximum number to the value indicated.

    • Default (-): Designated by a hyphen, default stores only the last record.

  • Value Type

    • Accumulated, Accum, Total, Totalize, Meter, or Metered: An aggregate value for the specified Interval is recorded in history.

    • Minimum or Min: The lowest value received in the specified Interval is recorded in history.

    • Maximum or Max: The highest value received in the specified Interval is recorded in history.

    • Average or Avg: The average of all values received in the specified Interval is recorded in history.

    • Instantaneous, Instant, Inst, or (-): The last value received in the specified Interval is recorded in history. If no value type is specified, it will default to this.

  • Interval – The frequency in which the result of the calculation is stored in history.

    • Minute

    • Hour or Hourly

    • Day or Daily

    • Month or Monthly

  • Multiplier – Multiplies the Interval by the value indicated. The default value, indicated with a hyphen, is 1. (An hourly interval with a multiplier of 3 would record entries 3 times an hour, or every 20 minutes.)

  • Rollover – Some points return an accumulating value that resets to zero once it reaches a maximum value (eg, a meter). This setting adds the accumulated value reached at the reset to the values now received. The default, designated by a hyphen, is zero.

1 <PointServer>                                                                                                                                                               
2  
3     <Device>
4  
5         <Points>
6             '                                                               Num Of      Value
7             'Point Tag     Point Address     Type     Point Description     Entries     Type      Interval     Multiplier     Rollover
8             '---------     -------------     ----     -----------------     -------     -----     --------     ----------     --------
9              P_mb1         100:3:32L:/10     R        "P1 Example"          auto        accum     -            -              1000000
10              P_mb2         102:3:32L:/10     R        "P2 Example"          auto        inst      -            -              -
11              P_mb3         104:3:16L:/10     R        "P3 Example"          129600      min       minute       -              -
12              P_mb4         105:3:32L:/10     R        "P4 Example"          518400      max       hour         0.5            -
13              P_mb5         107:3:32L:/10     R        "P5 Example"          129600      avg       day          1              -
14              P_mb6         109:3:32L:/10     R        "P6 Example"          518400      inst      month        0.5            -
15  
16         </Points>
17  
18     </Device>
19  
20 </PointServer>

Complete Modbus Device Sample Configuration

1     <Device> 'Device Long Description                                                                                                                                                       
2         '                                                  Device      Device      Interval     TimeOut     Unreliable
3         'Device Type     Device Description     PortID     Address     Bus Num     Seconds      Seconds     TimeOutSec
4         '-----------     ------------------     ------     -------     -------     --------     -------     ----------
5          MODBUS_TCP      "Short Description"    3          1           0           4.0          4.0         300 'Default is 300
6  
7         <Points>
8             '                                                               Num Of      Value
9             'Point Tag     Point Address     Type     Point Description     Entries     Type      Interval     Multiplier     Rollover
10             '---------     -------------     ----     -----------------     -------     -----     --------     ----------     --------
11              P_mb1         100:3:32L:/10     R        "P1 Example"          auto        accum     -            -              1000000
12              P_mb2         102:3:32L:/10     R        "P2 Example"          auto        inst      -            -              -
13              P_mb3         104:3:16L:/10     R        "P3 Example"          129600      min       minute       -              -
14              P_mb4         105:3:32L:/10     R        "P4 Example"          518400      max       hour         0.5            -
15              P_mb5         107:3:32L:/10     R        "P5 Example"          129600      avg       day          1              -
16              P_mb6         109:3:32L:/10     R        "P6 Example"          518400      inst      month        0.5            -
17  
18         </Points>
19  
20     </Device>


Next Article: Configuring a SNMP Device



See also