system.dnp3

note

The following functions use system.dnp3 and the Legacy DNP3 driver. See system.dnp for DNP3 functions using the DNP3 driver.

DNP3 Functions

The following functions give you access to interact with the DNP3 devices.

📄️ directOperateAnalog

Issues a Select-And-Operate command to set an analog value in an analog output point.

📄️ directOperateBinary

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

📄️ freezeAnalogs

Issues a freeze command on the given analog outputs.

📄️ freezeAnalogsAtTime

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

📄️ freezeCounters

Issues a freeze command on the given counters.

📄️ freezeCountersAtTime

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

📄️ selectOperateAnalog

Issues a Select-And-Operate command to set an analog value in an analog output point.

📄️ selectOperateBinary

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

Functions by Scope

Gateway

• directOperateAnalog
• directOperateBinary
• freezeAnalogs
• freezeAnalogsAtTime
• freezeCounters
• freezeCountersAtTime
• selectOperateAnalog
• selectOperateBinary

Vision

• directOperateAnalog
• directOperateBinary
• freezeAnalogs
• freezeAnalogsAtTime
• freezeCounters
• freezeCountersAtTime
• selectOperateAnalog
• selectOperateBinary

Perspective

• directOperateAnalog
• directOperateBinary
• freezeAnalogs
• freezeAnalogsAtTime
• freezeCounters
• freezeCountersAtTime
• selectOperateAnalog
• selectOperateBinary

Constants

• system.dnp3.NUL = 0
• system.dnp3.PULSE_ON = 1
• system.dnp3.PULSE_OFF = 2
• system.dnp3.LATCH_ON = 3
• system.dnp3.LATCH_OFF = 4
• system.dnp3.CLOSE = 1
• system.dnp3.TRIP = 2

Status Codes

Many of the dnp3 functions return a status code. Those codes and their meaning are listed below.

Code Number	Identifier Name	Description
0	SUCCESS	Request accepted, initiated, or queued.
1	TIMEOUT	Request no accepted because the operate message was received after the arm timer timed out. The arm timer was started when the select operation for the same point was received.
2	NO_SELECT	Request no accepted because no previous matching select request exists. (An operate message was sent to activate an output that was not previously armed with a matching select message).
3	FORMAT_ERROR	Request not accepted because there were formatting errors in the control request (either select, operate, or direct operate).
4	NOT_SUPPORTED	Request not accepted because a control operation is not supported for this point.
5	ALREADY_ACTIVE	Request not accepted, because the control queue is full or the point is already active.
6	HARDWARE_ERROR	Request not accepted because of control hardware problems.
7	LOCAL	Request not accepted because Local/Remote switch is in Local position.
8	TOO_MANY_OBJS	Request not accepted because too many objects appeared in the same request.
9	NOT_AUTHORIZED	Request not accepted because of insufficient authorization.
10	AUTOMATION_INHIBIT	Request not accepted because it was prevented or inhibited by a local automation process.
11	PROCESSING_LIMITED	Request not accepted because the device cannot process any more activities than are presently in progress.
12	OUT_OF_RANGE	Request not accepted because the value is outside the acceptable range permitted for this point.
13 to 125	RESERVED	Reserved for future use.
126	NON_PARTICIPATING	Sent in request messages indicating that the outstation will not issue or perform the control operation.
127	UNDEFINED	Request not accepted because of some other undefined reason.