Skip to main content
Version: 7.9

system.dnp3.freezeCountersAtTime

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

TypeParameterDescription
StringdeviceNameThe name of the DNP3 device driver.
IntegerabsoluteTimeThe absolute time at which to freeze, in millis.
IntegerintervalTimeThe interval at which to periodically freeze, in millis.
ListindexesA list of specific indexes on which to issue the freeze command. An empty list will freeze all counters.

Returns

Nothing

Scope

All

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])