system.dnp3.directOperateBinary

This function is used in Python Scripting.

Description

Issues a Direct-Operate command for digital control operations at binary output points (CROB).

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.directOperateBinary(deviceName, indexes, opType, tcCode, count, onTime, offTime)

Parameters

Type	Parameter	Description
String	deviceName	The name of the DNP3 device driver.
List	indexes	A list of indexes of the objects to be modified in the outstation.
Integer	opType	The type of the operation. 0=NUL, 1=PULSE_ON, 2=PULSE_OFF, 3=LATCH_ON, 4=LATCH_OFF
Integer	tcCode	The Trip-Close code, used in conjunction with the opType. 0=NUL, 1=CLOSE, 2=TRIP
Integer	count	The number of times the outstation shall execute the operation.
Long	onTime	The duration that the output drive remains active, in millis.
Long	offTime	The duration that the output drive remains non-active, in millis.

Returns

The DNP3 status code of the response, as an integer.

Scope

All

Code Examples

Example #1

# This example shows latching off 3 binary output points with the Direct-Operate command. 
 
off = system.dnp3.LATCH_OFF
system.dnp3.directOperateBinary("Dnp3", [0, 1, 2], off)

Example #2

# This example shows setting a binary output point at index 3 to pulse at 5 second intervals
# with the Direct-Operate command. 
 
pulse = system.dnp3.PULSE_OFF
trip = system.dnp3.TRIP
system.dnp3.directOperateBinary("Dnp3", [3], pulse, trip, onTime=5000, offTime=5000)