Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

Issues a freeze command on the given counters at the given time for the specified duration.

Panel
titleClient 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.

Panel
titleSyntax

system.dnp3.freezeCountersAtTime(deviceName, absoluteTime, intervalTime, [ indexes])

  • Parameters

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.  [optional]An empty list will freeze all counters. 

  • Returns

Nothing

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Examples
Code Block
languagepy
# 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])
Panel
titleKeywords

system dnp3 freezeCountersAtTime, dnp3.freezeCountersAtTime