Modbus Monitor XPF – User’s Manual

Introduction

The Modbus Monitor XPF application is a versatile tool for facilitating communication between a Windows-based Personal Computer and Modbus Client or Server devices. It can be downloaded from the Microsoft Store or Download Page. This application offers a trial version, allowing users to explore its features before committing to a full license.

One of the standout features of Modbus Monitor XPF is its dual functionality, encompassing both a Modbus Client and a Modbus Server within a single application. This dual capability, combined with support for both Modbus Serial and Modbus TCP protocols, makes it an invaluable tool for various Modbus communication needs.

In this guide, we will walk you through the essential operations of the Modbus Monitor XPF application, providing you with the foundational knowledge needed to get started. You are also welcome to check the YouTube channel for short demonstrations of the features. Additionally, we will delve into some advanced scripting commands for those who have purchased the full license to help you maximize the application’s potential.

Application Window

The main application window of the Modbus Monitor XPF application is organized into several key sections:

1. Quick Access Toolbar: Located at the top, this toolbar includes icons for common actions like ‘Save’, ‘Undo’, and ‘Redo’.
2. Tabs: Below the toolbar, there are multiple tabs such as ‘File’, ‘Home’, and ‘Client’. The active tab is highlighted.
3. Command Buttons: In the middle section, there are buttons labeled ‘Add Device,’ ‘Delete Device,’ and ‘Offset ID,’ among others. These buttons are accompanied by arrows indicating their functions.
4. Dialog Launcher: A small button in the corner of the command section, used to open additional settings or options.
5. Window Portal Area: The bottom section displays different information depending on the selected mode. By default, the Monitor Point list is displayed. When the Log button is toggled, the Log window appears. Similarly, the Web File navigation window is shown when the Online button is toggled. Each area provides relevant information for the tasks being performed.

Ribbon Tabs

The standard Modbus Monitor XPF ribbon contains the following tabs, from left to right:

File – Allows you to jump into the backstage view containing essential file-related commands and application theme settings, license information, file explorer, and links to online resources.

Home – Contains the most frequently used commands such as copying and pasting, Modbus Wizard, list management, etc.

Client—This contains the commands related to Modbus Client (Master), such as Modbus Interface, Timeout, Write Function Codes, Scanner, Chart, Poll Controls, etc.

Contextual Ribbon tabs

In addition to the constant tabs described above, the Modbus Monitor XPF ribbon has context-sensitive tabs, also known as Option Tabs. These tabs appear only when you select a specific item, such as a Log. For example, if you choose the Log option from the Quick Access or Home Tab, the Log – Option tab will appear.

File

Home

Online

View and Download Online Modbus Maps from either (1) released by Modbus Monitor or (2) uploaded by users of the online community. Toggle the Online button in the File group located in the Home tab to activate this feature. An internet connection is required to use this feature.

To Download Files:

1. Click on the Factory Icon [1] and wait for the list to update from the cloud.
2. Click on the File Name from the list of available devices; the file name appears in the text area [6]
3. Click on the Download button [4]
4. The Modbus Map of the devices automatically opens when the file successfully opens after the green check mark [5] appears and the online button closes.

To Upload File:

1. Click on Community icon [2]
2. Click on the Share Icon [3] and choose the local XPF Modbus Map data file
3. Green Check shows [5] when the file is successfully uploaded.
4. Click on the Community Files Maps icon [2] to refresh the list of files in the window.

Modbus Wizard

The Modbus Wizard can add a new monitor point on an empty row. This allows for easy configuration of the monitor point using the GUI instead of manually editing the configuration.

• Dialog Box Launcher: Click to see more options related to the Modbus Wizard.
• View: Click on the row and view the existing configuration.
• Edit: Click on the row and use the combo box to change the Modbus Function, Modbus Address, Data Type, Magic Codes, etc. The Modbus Monitor XPF ensures that the proper unique Magic Codes are added.
• Add: Add a new monitor point by selecting a well-known Modbus Function Type.

List

Manage Monitor Points (also called Row or Item)

• Add (+): New Monitor Point with Default Values
• Remove (-): Selected Monitor Point from Monitor Point List Table
• Delete All : Delete All monitoring points from the Monitor Point List Table 
• Offset:  Set One Based mode. Set Offset to 1 or 0 for the Modbus Address listed in the Address Column.  In other words, address values in the list start with 1 (1-65536) or  0 (0-65535)
• ID: Change ID for all monitoring points.

Filter

Search Name and Address fields to filter the monitoring points based on the search criteria entered in the Filter box.

• Left Number: Shows the row number of the currently selected row. 
• Filter Box: Filters the list match the value in the Name or Address columns.
• Right Number: Shows the total number of monitoring points in the full or filtered list.
• ID Box: Select Server ID (Station ID or Slave ID) to filter the list further.

Evaluate (Validate or Test)

Change the background colors of the Value cell based on the High, Low, and Nominal Limits. Quickly validate the value from the Modbus device and test to see if it is within the valid range.

• Show: Click to extend the toolbar with more options.
• High: Filter the list to show values that have reached the High Limit.
• Nominal: Show monitoring points with Nominal Values.
• Low: Filter the list to show values that have reached the Low Limit.
• Auto: Automatically update the UI with selected filters after each scan.
• Off: Toggle Evaluate (Test) Mode on or off for all monitoring points.

• Show: Click on the three ellipses at the end of the row to see extended information on the Monitoring Point.
• Evaluate: Checkmark to turn the feature on or off.
• Nominal: Choose a color for the Nominal Value range. The nominal range is calculated between the Low Limit and High Limit.
• Low Limit: Choose a color to highlight the Value column when the value equals or exceeds the Low Limit. The value can be numerical or string type.
• High Limit: Choose a color to highlight the Value column when the value equals or exceeds the High Limit. The value can be numerical or string type.
• String: Set the same High and Low Limit for String Data Type.

Events and Communication Log

Switch to the Events Log Window to view Modbus communications and general events. The Monitoring Points area is switched to show event logs in the same area. Use the “Log” button to switch between both views.

• Log Button: Switches between Event Log view and Monitoring Point view (shown with arrows in the picture).
• The Log button is located in the Home tab or Ribbon Header.
• The Events log consumes more processing power and memory to log data at a high rate. Therefore, turn off this feature when not needed.

• Click on the Show Log button to show the Log Window.
• Start/Stop Button: Click Start to Start the communication logging in comma delimited text
• Clear: Clear all logs
• Save As: Save displayed log to text file
• Errors: Show only communication events with Errors
• Scroll: Scroll to the latest communication log.
• The events in the windows are time-stamped with UTC.

Monitor Points – Fields (Columns)

Each Monitor Point (row) provides detailed information beyond the essential Modbus Register, Function Code, and Slave ID, enhancing the Modbus experience. The table below provides a brief description, with more detailed information available in the Monitor Point – Detailed Description Section.

Monitor Point – Detailed Description

1. Name Field
   • Usage: The Name field contains a string value to name the monitoring point (row) for easy cross-reference. It can be used with or without unique tags (Magic Key Codes). The field must not contain a comma “,”.
     • Example: “Water Temperature” or “Water Temperature:16” (Polls 16 continuous Modbus registers, which can later be converted to a string using the “STRING” Data Type below).
     • Extra Magic Key Code: Extra Magic Key Codes can be added to enhance polling and processing, such as Bit Field, Write Only Point, Poll Rate, etc. The Modbus Wizard automatically adds these codes, making it easy so you don’t have to remember them.
       • Modbus Wizard Convenience: The graphical form in the Modbus Wizard adds these codes automatically, making it easy to forget them. (Details on using the Modbus Wizard are below.)
       • String Length
         • Description: Read Modbus string that is spread across many Modbus registers.
         • Format: “:xx”
         • Usage: Add the Colon symbol followed by the number of continuous registers.
         • Example: “:16”
       • Poll Update Rate
         • Description: Poll Rate for each Monitor Point can be controlled by adding a special symbol. In other words, the Poll Update Rate specifies the interval at which the Modbus register is polled on every scan.
         • Format: “@xxxx”
         • Usage: Add “@” symbol followed by the numeric value in milliseconds
         • Example: Model Name@1000 (poll at 1000 milliseconds)
         • Special Values:
           • “@-1” Poll Once the Start button is pushed
           • “@0” Always skip monitor points during polling
       • Bit Fields
         • Description: The 16-bit register value can be used as Bit
       • Format: “.n”
         • Usage: Add the “Period or dot symbol” symbol followed by the index bit number from 0 to 15. .
         • Example: “.8” Grab Bit 8 from 16-bit Modbus register value.
       • Date Time: Display Modbus registers as Date/Time Format
         • Description: Display the value as Date Time, fetch the number of registers, and convert them to standard Date/Time formats.
         • Format: DOS | EPOCH | EPOCHMS | DT2 | DT3 | DT4 | DT4P | DT6 + DATETIME Data Type
         • Usage: Add one Special Magic Code from above to from these possibilities and change the Data Type from INT16 to “DATETIME” for this code to work. See DATETIME Data Type (below) for more information.
         • Example: (1) “DT6” added to Name Field and (2) Data Type = “DATETIME”
       • Multiple Magic Codes: Combining multiple Magic Codes allows for further refinement of the polling action.
         • Example: To get the string value spanning 32 registers only once after polling is started, add “@-1:31” to the Name Field.
         • Explanation: The Name Field contains two Magic codes. One for Poll Rate [1] and the other for String Length [2]. So, the system will poll once [1] at the start with a string length [2] of 32 registers (64 bytes or characters) by combining the String Length and Poll Update Rate options.
2. Address Field
   • Format: The address field uses a 6-digit address scheme combining function code and complete Modbus Address in a single value.
   • Value Range: The first digit is Address Mode + 0 to 65535 (for 0 Base) or 1 to 65536 (for one Base)
     • Address Mode:
       • “0x” for Modbus Function 1 – Coils
       • “1x” for Modbus Function 2 – Discrete Inputs
       • “4x” for Modbus Function 3 – Holding Registers
       • “3x” for Modbus Function 4 – Input Registers
       • Other Modbus Functions – Value Ignored
   • Base: Address is 0-based or 1-based depending on the “One Based” check-mark in the List Tab.
   • Examples:
     • Read 1st Holding Register: 400001 (One based checked, Function 3, Read/Write)
     • Read 1st Holding Register: 400000 (One based unchecked, Function 3, Read/Write)
     • Read 1st Input Register: 300001 (One based checked, Function 4, Read-Only)
     • Read 1st Coil: 000001 (One based checked, 1st Register, Function 1)
     • Read 1st Discrete Input: 100001 (One based checked, Function 2)
3. Unit ID Field
   • Unit ID or Station ID or Slave ID of the register for Master and Server 
   • Byte Value (1-247)
   • Example: 1
4. Gain Field: Scaling factor to multiply the incoming value from Modbus Frame.
5. Offset Field: Factor to add or subtract after gain is applied.
   • The Gain and Offset values are to be multiplied and Offset Added to the result obtained from the remote Server (Client Mode).
   • For example, the Modbus Value field will calculate to 12350 when the gain is set to 10, and the Modbus Server sends a 1235 value.
   • Server Mode: Gain and Offset will be applied before the value is sent to the remote Master. In other word
   • Float Value Column = Gain x [Modbus Value Obtained] + Offset  (Linear Formula)
   • Example: 1.00 (default Gain, Multiple 1), 0.00 (Default, no Offset)
     • Value to be multiplied and Offset Added to result obtained from the Server
     • Server Mode: Gain and Offset will be applied before the value is sent to the remote Master.
6. Data Type Field: ” Convert and show value obtained from remote server after polling the Modbus Monitor point.
   • Display Format
     • BIT Display as BIT
     • INT16 Display as 16-bit Signed value
     • UINT16  Display as 16-bit Unsigned value (Default)
     • INT32 Display as Signed 32-bit value (Two Registers are automatically polled)
     • UINT32 Display as Signed 32-bit value
     • FLOAT32 Display as 32-bit Float
     • INT64 Display as 64-bit Integer
     • UNIT64 Display as 64-bit Unsigned Integer
     • DOUBLE64 64-bit Double Float
     • HEX Display as Hex format
     • STRING Display as Text message
     • DATETIME – Display as Date Time with Magic Code.
       • To make this format work, you need to add a Magic code to the Name field. The processor uses the code (WIN, DT3, DT4, DT5, DT6) in the Name Field (column) to properly request the number of registers required for this display format to decode and display time properly.
       • There is no Modbus standard when it comes to date time, so analyze the manufacturer’s documentation to determine the number of registers required to fetch date and time. Then, simply choose the correct Magic Code from below. Here are the codes:
       • DOS: DOS Time Stamp Y1980, 2 Registers – [YYMMDD] [hhmmss]
       • EPOCH: Unix Epoch, 2 Registers
       • DT2: Same as DOS
       • DT3: Date Time, 3 Registers – [YY|MM] [DD|hh] [mm|ss]
       • DT4: Date Time, 4 Registers – [YY|MM] [DD|hh] [mm|ss] [ms]
       • DT4P: Date Time Y2000 Modbus Plus, 4 Registers – [XX|YY] [MM|DD] [hh|mm] [ms]
       • EPOCHMS: Unit Epoch in Milliseconds (4 Registers)
       • DT6: Date Time, 6 Registers – [YYYY] [MMMM] [DDDD] [HHHH] [ MMMM] [SSSS]
       • Use Swap Type (below) to match the remote device’s Byte Order
       • For more information, please contact support.
7. Swap Type Field
   • Byte and Word Swap when multiple registers are polled based on the Data Type 
   • Swaps multiple Registers based on the selection:
     • ABCD_BE: ABCD swap or Big-Endian (Default)
     • CDBA_LE: CDBA swap or Little-Endian
     • BADC_BEBS: BADC swap or Big-Endian Byte Swap
     • CDAB_LEBS: CDAB swap or Little-Endian Word swap
8. Value Field
   • Red Border shows on error or special message from the scanner. Click on the cell (edit) to see the special message.
   • Server Mode: Send Value as entered to Server based on the Data Type 
   • Modbus Master: Shows value polled from the remote device after applying Swap type, Gain/Offset, and Data Type
   • Modbus Server: Value to send to the remote Master device. Click a cell to change send the new value to send to remote Master (All conversions are applied per settings before sending the new value) 
9. Extended Information

Modbus Client (Tab)

In Client mode, the Modbus Monitor XPF acts as a master device, continuously polling remote Modbus servers to retrieve data. This data is then displayed in a user-friendly format, making it easy to monitor and analyze. The application supports both Modbus Serial and Modbus TCP protocols, ensuring compatibility with a wide range of devices.

The Modbus Monitor XPF’s control panel provides options for configuring the polling rate, which determines how frequently the Modbus registers are polled. This flexibility allows users to tailor the polling frequency to their needs, ensuring timely and accurate data collection.

Overall, the Modbus Monitor XPF’s Client mode is a powerful feature that enhances the application’s functionality, making it an invaluable tool for anyone working with Modbus communication. Whether you’re monitoring industrial equipment, collecting data from remote sensors, or managing a complex network of devices, the Modbus Monitor XPF has you covered.

Scanner – Settings

Poll remote server to discover new Modbus Addresses or build Modbus Map for devices without public Modbus Maps.

1. Start – Start Address to start scanner in 6-digit format
2. Regs – Number of registers or polls to serially scan
3. Data – Assumed Data Type. The program automatically calculates the number of registers (1, 2, 4) to request depending on the Data Type selected
4. Swap – Data Swap for 32 or 64-bit data values
5. ID – Server ID to start scanning

Charts – Data Trends

Modbus charting is essential for anyone working with industrial automation and control systems. With Modbus Monitor XPF, you can effortlessly visualize your Modbus data through time series, making it easier to analyze trends and patterns.

To see the trending data, the monitoring point must be tagged and included in the chart. Enabling the data and choosing an axis (either axis 0 or 1) in the Monitoring Point settings, accessible via the extended button, is as easy as clicking the extended button.

Click the Chart button to switch to the Chart Window. Notice the Chart Option context menu with chart-related controls:

• Save: Saves chart data as a CSV file in the user document.
• Clear: Clears chart data.
• Fit: Adjusts the range to fit the chart to the current view.
• Samples: Sets the buffer size to store data. A value of 0 means all data is stored in the buffer for available memory (the chart does not pan). Any other value controls the size of the window that pans the chart by the buffer size.

Modbus Server

Modbus Server or Slave can be used to learn the Modbus Protocol for beginners and simulate real-world devices for advanced developers needing milliseconds responses to fine-tune the system. The Modbus Server can be started simultaneously on both interfaces (TCP and Serial). This feature allows users to easily simulate Modbus devices for SCADA development without needing physical hardware. The Modbus Server supports multiple servers with a user-friendly Modbus Map, simplifying the setup process. Users can specify the Data Type and Modbus Address, and the application handles the rest. The Modbus Monitor XPF has additional functionality to automatically build a Modbus Map based on client requests (Capture) and simulate real-world sensors by changing values (Simulate). The Modbus Server mode also offers script-based initialization and automation, ensuring efficient and streamlined operations. All Modbus Map and Configuration data can be saved in a standard CSV format for easy documentation and sharing.

Multiple Servers, Multiple Interfaces

One of the key strengths of the Modbus Monitor XPF application is its ability to run multiple servers with two physical interfaces simultaneously. The picture above shows how the TCP and Serial sections are ready for configuration. The TCP server can run concurrently with multiple Serial Ports. For example, the image shows the Modbus TCP server running on Port 502 along with Modbus RTU on COM10, COM11, and COM12, each with its baud rate settings.

Modbus TCP Server Selection

Multiple Servers, Single Interface

It is common practice to run multiple instances of the server on the same interface, such as TCP, by running multiple instances of the Modbus Monitor XPF application, each with different TCP port numbers. For instance, you can run Modbus TCP on Port 502 and Modbus RTU over TCP on Port 602.

Modbus RTU Server Selection

Capture – Modbus Map Traffic Sniffer

Effortlessly sniff Modbus Map traffic from connected clients and automatically build Modbus Maps. This feature is invaluable when Modbus Maps are unknown or unavailable from manufacturers, providing a way to discover the addresses the Modbus Master is using.

• On: Enable the addition of Modbus Monitoring points based on Modbus Requests. Note that the server must be running for this feature to work.
• Off: Disable the Capture or Modbus Traffic sniffer.
• Default Value 0:Fill “0” as the value into the newly created Modbus Map;
• Auto Value: or use the Modbus Register address as the fill value.

Server (Start/Stop) 

Both the Modbus TCP server (when Enabled) and Modbus RTU server start simultaneously (when the COM port is selected).