This plugin intends at converting PIVOT data from/to OPCUA north plugin.
The filter implements the Fledge Filter plugin interface (see filter_plugins).
See Plugins configuration design for examples and details
The "config
" parameter of "plugin_init
" call shall include :
exchanged_data
" category with the same content as provided to the OPCUA north plugin. This section is mandatory so that the filter plugin can convert the PIVOT type to OPCUA type.Notes :
alternate_mapping_rule
" option in its parameters.The <Root> key of PIVOT object can be:
Reading key | Content |
---|---|
PIVOT.GTIS | Tele Signal |
PIVOT.GTIM | Tele Measurement |
PIVOT.GTIC | Tele Control |
In the following table: <type>
is equal to
The "BscTyp" is not supported currently.
The plugin is not responsible for checking that the conversion matches its actual role: typically if the plugin is attached to a North OPCUA service, it will be expected to convert OPCUA to PIVOT, but will anyway convert PIVOT to OPCUA if receiving PIVOT instead of OPCUA as reading. This consistency must be ensured by configuration.
Thus the rules for the conversion is:
For TM/TS, the filter receives PIVOT reading (from south) and creates a corresponding OPC UA reading. The created OPCUA reading has the following JSON equivalent format ("data object"):
{ "data_object":{ "do_cot": <int>, "do_confirmation": <int>, "do_comingfrom": <string>, "do_id": <string>, "do_type": <string>, "do_quality": <int>, "do_ts_quality": <int>, "do_value_quality": <string>, "do_source": <string>, "do_ts": <int>, "do_ts_org": <string>, "do_ts_validity": <string>, "do_value": <depends on data type...> } } |
The content under <Root> will convert the pivot to a opcua object as follow:
Key | Type | Default Value | opcua.data_object.<...> | Note |
---|---|---|---|---|
<Root>.Cause.stVal | Integer | Mandatory | do_cot | See Cause of Transmission |
<Root>.Confirmation.stVal | Boolean | false | do_confirmation | |
<Root>.ComingFrom | String | Mandatory | do_comingfrom | Any protocol name ("iec104" ,"opcua", ...) |
<Root>.Identifier | String | Mandatory | do_id do_type | do_id = PIVOT ID do_type = "opcua_sps" | "opcua_dps" | "opcua_mvi" | "opcua_mvf". Other types not supported in current version. |
| PIVOT : Object | 0 | do_quality | OR-Mask of following values:
|
<Root>.<type>.t.TimeQuality | Integer | 0 | do_ts_quality | OR-Mask of following values:
|
<Root>.<type>.q.Source | String | "process" | do_source | "process" | "substituted" |
<Root>.<type>.q.Validity | String | Mandatory | do_value_quality | "good" | "invalid" | "reserved" | "questionable" |
<Root>.<type>.t.SecondSinceEpoch | Integer | 0 | do_ts | Unit = seconds since Epoch (January, 1st 1970) |
<Root>.TmOrg.stVal | String | "genuine" | do_ts_org | "genuine" | "substituted" |
<Root>.TmValidity.stVal | String | "good" | do_ts_validity | "good" | "invalid" | "reserved" | "questionable" |
<Root>.SpsTyp.stVal | Boolean | Mandatory | do_value | |
<Root>.DpsTyp.stVal | String | Mandatory | do_value | |
<Root>.MvTyp.mag.f | Float | Mandatory | do_value | |
<Root>.MvTyp.mag.i | Integer | Mandatory | do_value |
Converting commands implies two different use case:
The conversion rules are details below.
opcua_operation.<...> | PIVOT field ("PIVOT.GTIC".<...>) | Type | Default value | Note |
---|---|---|---|---|
co_id | Identifier | String | PIVOT identifier. | |
co_se | Select.stVal | Boolean | false | - 0 is mapped with false, for Execute - 1 is mapped with true, for Select before Execute |
N.A. | ComingFrom | String | "opcua" | This plugin always uses the value "opcua" when converting to PIVOT |
co_type | <type> | String | "opcua_spc" | "opcua_dpc". | |
co_test | <type>.q.test | Boolean | false | |
co_ts | <type>.t.SecondSinceEpoch | Integer | ||
co_value |
| Float | Float 32 | |
co_value |
| String | intermediate-state | off | on | bad-state | |
co_value | IncTyp.ctlVal | Integer | Int 32 | |
co_value | SpcTyp.ctlVal | Boolean | 0 or 1 | |
co_value | BscTyp.ctlVal | String | stop | lower | higher | reserved |
PIVOT field ("PIVOT.GTIC".<...>) | opcua_reply field | Type | Default value | Note |
---|---|---|---|---|
Identifier | ro_id | String | PIVOT identifier. | |
Confirmation.stVal | ro_reply | Boolean | Converts the values as follow:
| |
<All other fields are ignored> |