function code |
This field indicates the function code for
the message to the remote device. See the DNP protocol reference
manual for a description of the various function codes.
|
No check is performed on this field's contents. Some
function codes may not make sense to use (e.g. function code zero,
confirm). |
|
object group |
This field, along with the object
variation field, specifies the type of object to be addressed in the
remote device. No limitation is placed on this value so that custom
objects can be included (see Extending the
DNP 3.0 Scan Task). See the DNP protocol reference manual for
a description of the various objects. |
object variation |
This field, along with the object group
field, specifies the type of object to be addressed in the remote
device. See the DNP protocol reference manual for a description of
the various object variations. |
qualifier |
This field indicates how the range of
objects is to be used and interpreted by the remote device. This
value is used as a hint for filling in the qualifier field in the
message sent to the remote device. The following values are
recognized:
Qualifier |
Description |
0 |
the range is to be interpreted as an 8 bit index |
1 |
the range is to be interpreted as a 16 bit index |
2 |
the range is to be interpreted as a 32 bit index |
3 |
the range is to be interpreted as an 8 bit absolute
address |
4 |
the range is to be interpreted as a 16 bit absolute
address |
5 |
the range is to be interpreted as a 32 bit absolute
address |
6 |
the range is ignored, and that all objects of the
given type are referred to |
7 |
specifies a single item as an 8 bit address |
8 |
specifies a single item as a 16 bit address |
9 |
specifies a single item as a 32 bit address |
|
Typical values would be zero, three, six and seven.
The scan task will automatically adjust this upwards if required.
For example, if a range start of 8000 was used, the scan task would
change the qualifier from zero to one. |
|
range start |
This field, along with the "range length"
field, specifies which objects are to be addressed. |
range length |
This field, along with the "range start"
field, specifies which objects are to be addressed. |
time |
This field specifies a database cross
reference to retrieve on and off times for relay controls, etc. This
cross reference should point to either a scalar value (will be used
for both on and off times) or a vector of two values of rtUINT32
data type. For a vector, the first value is the on time, while the
second value is the off time. This value must be specified
for objects that require it, otherwise an error will occur and the
request failed.
This field is also used for the File Identifier object
(Object 70, variation 01). This value can optionally point to a
table attribute that contains two rtByte (can be rtBytes4 to
rtBytes256) fields as follows:
Field Number |
Field Name |
DE Type |
Possible Values |
0 |
item name |
rtBYTES |
(see below) |
1 |
item value |
rtBYTES |
(see below) |
The first field contains the item name and
the second field the corresponding value for the file identifier
header values as follows:
Item Name |
Item Value |
Name_Size |
Specifies the file name size. If this value is not
specified, the value will be calculated from the supplied file name. |
File_Type |
Specifies the file type to use. The default if not
specified is zero (8-bit binary). |
Attributes |
Specifies the file attributes to use. The default if
not specified is zero (regular file). |
Start_Record |
Specifies the start record. The default if not
specified is zero. |
End_Record |
Specifies the end record. The default if not specified
is 65535 (whole file). |
File_Size |
Specifies the file size to use. The default if not
specified is the actual file size. |
Time_Of_Creation |
Specifies the time of creation values. The default is
zero. |
Permission |
Specifies the permission. The default if not specified
is the actual file permissions. |
File_ID |
Specifies the file ID. The default is zero. |
Owner_ID |
Specifies the owner ID. The default if not specified
is the actual file owner's user ID. |
Group_ID |
Specifies the group ID. The default if not specified
is the actual file owner's group ID. |
File_Function |
Specifies the file function. The default if not
specified is READ (9) if in the scan input table, and WRITE (3) if
in the scan output table. |
File_Name |
Specifies the file name. There is no default
for this value. This value must be specified if this object is used
in the scan input table. When this object is used in the scan output
table, the value written can be used to specify the file name. |
|
Actual file default values are only used
when a file is sent using either the APPEND (0), INSERT
(2) or WRITE (3) file functions. |
|
Values are converted using the rtStrToType (3)
call. |
|
control code |
This field specifies the control code
value for certain objects (e.g. relay controls). |
status result |
This field specifies a database cross
reference where the status byte returned from some objects will be
saved into the database. If this is empty, the status byte will be
ignored. |