Difference between revisions of "Modbus Utility"

From HSYCO
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:Manager]]
 
[[Category:Manager]]
 
[[File:Manager Modbus Utility Icon.png|class=appIcon]]
 
[[File:Manager Modbus Utility Icon.png|class=appIcon]]
The BACnet Utility application allows you to find all BACnet/IP devices available on the network, to show all objects of a device, and all properties and values of any object instance. It also supports writing values to writable properties.
+
The Modbus Utility is an application that allows you to easily setup repetitive polling read requests and monitor the performance and status of each request.
Whenever a BACnet I/O Server is defined in HSYCO, the BACnet Utility will appear among the applications of the manager.
 
  
To discover all BACnet/IP devices, simply leave the BACnet Device ID field empty and press the browse icon. If the browser finds any BACnet devices, they will be listed in a pop-up selection box, with device ID, vendor ID and IP address.
+
Each read request is defined with a repeat interval in seconds. The Modbus Utility internal scheduler will try to repeat the execution of each request as close as possible to the preset interval. It will also sequence all requests to the same Modbus I/O server so they never overlap.
  
 +
You can optionally assign a variable to each request for conditional execution. If a variable is defined, it has to exist and have value “1” to activate the request polling. Requests that are not active are highlighted in grey.
  
[[File:ModbusUtility1.png|border|600px|center|BACnet utility.]]
+
The optional "Error Tolerance" parameter is used to set the number of consecutive errors accepted before the Modbus error data point is set to report an error condition. The default is zero, so that even a single error will set the error data point. For example, setting the error tolerance to two means that up to two consecutive errors will be tolerated, and only the third consecutive error will set the error data point.
  
 +
The optional "Error Skip Interval" defines for how long the Modbus Utility should stop executing a Modbus request if an error occurs.
  
Touch a line to select that device, and the browser will show all object instances for that device.
 
  
 +
[[File:ModbusUtility1.png|border|600px|center|Modbus Utility]]
  
{{tip|The BACnet I/O Server doesn't support segmented messages. Segmented messages could be required to return the list of all object instances of a device. Because of this, the BACnet Utility may not be able to browse devices having a lot of object instances.}}
 
  
 +
The Modbus Utility tracks the actual repeat interval and compares it with the defined interval. If the difference is more than 25% from the target value, the request is marked as “slow” and highlighted in yellow. The difference between defined and actual interval is reported in the “delta” field.
  
Touch any object instance to show all properties and values for that object.
+
Requests that return errors are also tracked and highlighted in red.
To manually update the values, simply press the browse icon again. You can also enter a refresh interval in seconds and press browse to automatically refresh values.
 
  
 +
The minimum and maximum response time is also tracked for each request, and displayed in the “min. time” and “max. time” fields in the requests list.
  
[[File:ModbusUtility2.png|border|600px|center|BACnet utility.]]
+
You can reset the status, delta, minimum and maximum time using the “refresh” button.
  
 +
You can use filters to only show a subset of requests in the user interface. Entering a text in the search field will only show requests having a data point name that contains the search text. You can also filter by status, selecting slow, skipped, errors, or successful requests.
  
Properties that are writable, are highlighted. Touch any writable property to fill the fields in the write box, then set the new value and priority if needed, then press the write icon to write the new value to the device.
+
{{note|Note that filters act globally, so if you set a filter all other users will also share the same view of the filtered list. Also note that, to reduce performance overhead, the status and performance data in the list of requests stops being updated after about 60 seconds of inactivity. This is also shared by all users. The refresh of requests’ data has no effect on the actual request scheduler, that runs independently and is never interrupted.}}
 +
 
 +
 
 +
[[File:ModbusUtility2.png|border|600px|center|Modbus Utility]]
 +
 
 +
 
 +
The Modbus Utility configuration is stored in a human readable file named modbus-scheduler.ini and located in HSYCO’s main directory. If you manually edit this file, it will be automatically reloaded within a few seconds after it is saved. In a high availability setup, the Modbus Utility is also automatically mirrored from the master to the slave server.

Latest revision as of 13:04, 14 October 2020

Manager Modbus Utility Icon.png The Modbus Utility is an application that allows you to easily setup repetitive polling read requests and monitor the performance and status of each request.

Each read request is defined with a repeat interval in seconds. The Modbus Utility internal scheduler will try to repeat the execution of each request as close as possible to the preset interval. It will also sequence all requests to the same Modbus I/O server so they never overlap.

You can optionally assign a variable to each request for conditional execution. If a variable is defined, it has to exist and have value “1” to activate the request polling. Requests that are not active are highlighted in grey.

The optional "Error Tolerance" parameter is used to set the number of consecutive errors accepted before the Modbus error data point is set to report an error condition. The default is zero, so that even a single error will set the error data point. For example, setting the error tolerance to two means that up to two consecutive errors will be tolerated, and only the third consecutive error will set the error data point.

The optional "Error Skip Interval" defines for how long the Modbus Utility should stop executing a Modbus request if an error occurs.


Modbus Utility


The Modbus Utility tracks the actual repeat interval and compares it with the defined interval. If the difference is more than 25% from the target value, the request is marked as “slow” and highlighted in yellow. The difference between defined and actual interval is reported in the “delta” field.

Requests that return errors are also tracked and highlighted in red.

The minimum and maximum response time is also tracked for each request, and displayed in the “min. time” and “max. time” fields in the requests list.

You can reset the status, delta, minimum and maximum time using the “refresh” button.

You can use filters to only show a subset of requests in the user interface. Entering a text in the search field will only show requests having a data point name that contains the search text. You can also filter by status, selecting slow, skipped, errors, or successful requests.

Note that filters act globally, so if you set a filter all other users will also share the same view of the filtered list. Also note that, to reduce performance overhead, the status and performance data in the list of requests stops being updated after about 60 seconds of inactivity. This is also shared by all users. The refresh of requests’ data has no effect on the actual request scheduler, that runs independently and is never interrupted.


Modbus Utility


The Modbus Utility configuration is stored in a human readable file named modbus-scheduler.ini and located in HSYCO’s main directory. If you manually edit this file, it will be automatically reloaded within a few seconds after it is saved. In a high availability setup, the Modbus Utility is also automatically mirrored from the master to the slave server.