<< Click to Display Table of Contents >>
Client Side Tags |
Item |
Operation |
N1 |
Meaning |
---|---|---|---|
PointName |
Reading and Writing |
1 (one) |
Reads or writes the current value, timestamp, and quality of a point. The PointName Tag must be declared in the ICCPClient.blt file |
PointName:COV |
Reading |
1 (one) |
Reads the COV (Counter of Variations) property of a point, if available |
PointName:Source |
Reading |
1 (one) |
Reads the point's current source. Possible values are 0: Telemetry, 1: Calculated, 2: Entered, or 3: Estimated |
GetDataValue:PointName |
Reading |
1 (one) |
Operation which allows the validation of a tag at the server database, returning the current value if it exists. This tag shall not be used as the main way to get a tag value, because the read process is poll based and may loose events between each read. |
DeviceName |
Reading |
1 (one) |
Reads a device's status. A bit mask where Bit 0 (zero) can be 1: Armed or 0: Not Armed and Bits 1 (one) and 2 (two) can be 0: No Tag, 1: CloseOnlyInhibit, or 2: OpenAndCloseInhibit |
DeviceName:Select |
Writing |
1 (one) |
Requests a Select command in a device. This request may fail if the point is not an SBO type or if any security checks performed by the ICCP Server fails. If the device is declared on a DataSet, the linked Tag with device's status (previous item) shows the configured bit 0 (zero), indicating that this device is in the Armed status, if operation is successful. This Tag can contain any value |
DeviceName:Operate |
Writing |
1 (one) |
Requests an Operate command in a device. This request may fail if the point is not an SBO type and is not in the Armed status, or if any security checks performed by the ICCP Server fails. This Tag must contain the value to send to the ICCP Server. IEC 60870-6-802 standard defines values "0" (zero) and "1" (one) for operations with digital commands, where 0: Trip, Open, Off, or Lower (for Transformers) and 1: Close, On, or Raise (for Transformers) |
DeviceName:Tag |
Reading and Writing |
1 (one) |
A Block with two Elements containing device's Tags. Element 0 (zero) indicates device's status as a bit mask, where bit 0 (zero) can be 1: Armed or 0: Not Armed and bits 1 (one) and 2 (two) can be 0: No Tag, 1: CloseOnlyInhibit, or 2: OpenAndCloseInhibit. Element 1 (one) indicates the reason for tagging in Text format |
DataSetName:GI |
Writing |
1 (one) |
Forces an integrity request for the informed DataSet, with the DSConditions parameter configured to OperatorRequest |
ClientStatus |
Reading |
1 (one) |
Returns the internal status on the ICCP Client side. Possible values are 0: Starting, 1: Reading .ld files, 2: Retrieving directory (GetServerDirectory), or 3: Processing an ld file (Tag Browsing) |
ClientConnection |
Reading |
1 (one) |
Indicates the status of a connection. Possible values are 1: Connected or 0: Not connected |
StartBatchDatabaseUpdate |
Writing |
1 (one) |
Starts a process of batch update to change Client's Bilateral Table. This step is mandatory before using other Tags for edition at run time, such as UpdateDatasetDatabase, UpdatePointDatabase, and UpdateDeviceDatabase |
UpdateDatasetDatabase |
Writing |
1 (one) |
Inserts or updates a DataSet on a Client's database. It must receive a Block with 11 Elements that follows the same order described on the Dataset section of the Bilateral Table file. Values for Elements are 0: DataSetName, 1: Delay, 2: Interval, 3: TLE, 4: BufferTime, 5: IntegrityCheck, 6: DSConditionsRequested, 7: BlockData, 8: Critical, 9: RBE, and 10: ReportAllException |
UpdatePointDatabase |
Writing |
1 (one) |
Inserts or updates a point on a Client's database. It must receive a Block with two, three, four, or five Elements. Values for Elements are 0: Point's name; 1: Point's type, between zero and 15 (0: Discrete, 1: DiscreteQ, 2: DiscreteQTimeTag, 3: DiscreteQTimeTagExtended, 4: DiscreteExtended, 5: Real, 6: RealQ, 7: RealQTimeTag, 8: RealQTimeTagExtended, 9: RealExtended, 10: State, 11: StateQ, 12: StateQTimeTag, 13: StateQTimeTagExtended, 14: StateExtended, or 15: Tag_Value); 2: Scope (0: VCC or 1: ICC, default); 3: Source (0: Telemetry, default, 1: Calculated, 2: Entered, or 3: Estimated); and 4: DataSet index (zero if it is not linked to a DataSet) |
UpdateDeviceDatabase |
Writing |
1 (one) |
Inserts a device on a Client's database. It must receive a Block with a minimum of two and a maximum of six Elements. Values for Elements are 0: Device's name, an on-demand String; 1: Device's type, an on-demand String. Possible values are N: None, C: CMD, D: SP_DISCRETE, or R: SP_REAL; 2: Scope, optional (0: VCC or 1: ICC); 3: Tagging, optional (0: No or 1: Yes); 4: SBO, optional (0: No or 1: Yes); 5: CheckBackID, optional; and 6: Description, an optional String |
DeleteDatabase |
Writing |
1 (one) |
Deletes all definitions from a Bilateral Table (BLT) file. It must receive a String with the name of the BLT file. This file's name and path are not modified. This Tag must be written only when this Driver starts in Offline mode, allowing to delete the current database, redefine its content, and finally use the SaveDatabase Tag |
SaveDatabase |
Writing |
1 (one) |
Saves a Bilateral Table (BLT) file. It must receive a String with the name of the BLT file. This file's name and path are not modified |