system.dnp3.freezeCountersAtTime
note
The following function uses system.dnp3 and the Legacy DNP3 driver. See system.dnp for DNP3 functions using the DNP3 driver.
This function is used in Python Scripting.
Description​
Issues a freeze command on the given counters at the given time for the specified duration.
Client Permission Restrictions​
Permission Type: DNP3 Management
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.
Syntax​
system.dnp3.freezeCountersAtTime(deviceName, absoluteTime, intervalTime, indexes)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | deviceName | The name of the DNP3 device driver. |
| Integer | absoluteTime | The absolute time at which to freeze, in millis. |
| Integer | intervalTime | The interval at which to periodically freeze, in millis. |
| List | indexes | A list of specific indexes on which to issue the freeze command. An empty list will freeze all counters. |
Returns​
Nothing
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
Example #1
# This example shows a request to freeze counters at indexes 2 and 4,
# 5 minutes from the current time, with no interval.
from time import *
fiveMikes = (60 * 1000 * 5) + int(time() * 1000) #ms
system.dnp3.freezeCountersAtTime("Dnp3", fiveMikes, 0, [2, 4])