Parameter Editor

The Parameter Editor enables the configuration of symbol metadata for symbols in a Publisher channel. As a prerequisite, the Publisher channel must be configured to use the "TwinCAT JSON" data format. New symbol parameters can then be added by right-clicking on a symbol and selecting Add Symbol Parameter.

Parameter Editor 1:

This adds a new symbol parameter entry to the Parameter Editor. The data type, name and value of the new parameter can then be defined.

Parameter Editor 2:

A result of the above configuration can look like this when using the TwinCAT JSON data format. In this configuration, the variable "GVL_nodes_dynamic.dyn_scalar_UI8" was configured with the symbol parameters Min, Max and Unit. These parameters are added to the "MetaData" section of the TwinCAT JSON-formatted message.

{
  "Timestamp": "2020-09-28T12:32:49.0370000+02:00",
  "GroupName": "Publisher",
  "Values": {
    "GVL_nodes_dynamic.dyn_scalar_UI8": 259096147,
    "GVL_nodes_dynamic.dyn_scalar_UI1": 83,
    "GVL_nodes_dynamic.dyn_scalar_UI2": 32339,
    "GVL_nodes_dynamic.dyn_scalar_UI4": 259096147
  },
  "MetaData": {
    "GVL_nodes_dynamic.dyn_scalar_UI8": {
      "Timestamp": "2020-09-28T12:32:49.0350000+02:00",
      "Min": -10,
      "Max": 100,
      "Unit": "Celsius"
    },
    "GVL_nodes_dynamic.dyn_scalar_UI1": {
      "Timestamp": "2020-09-28T12:32:49.0350000+02:00"
    },
    "GVL_nodes_dynamic.dyn_scalar_UI2": {
      "Timestamp": "2020-09-28T12:32:49.0350000+02:00"
    },
    "GVL_nodes_dynamic.dyn_scalar_UI4": {
      "Timestamp": "2020-09-28T12:32:49.0350000+02:00"
    }
  }
}

Parameters can also be added to a channel, adding metadata properties to the root message. Example:

Parameter Editor 3:

As a result, the root message now contains a static metadata property called "Room", which has the value "LivingRoom":

{
  "Timestamp": "2020-09-30T09:55:58.1160000+02:00",
  "GroupName": "Publisher",
  "Room": "LivingRoom",
  "Values": {
    "GVL_nodes_dynamic.dyn_scalar_UI8": 267266470,
    "GVL_nodes_dynamic.dyn_scalar_UI1": 166,
    "GVL_nodes_dynamic.dyn_scalar_UI2": 10662,
    "GVL_nodes_dynamic.dyn_scalar_UI4": 267266470
    },
  "MetaData": {
    "GVL_nodes_dynamic.dyn_scalar_UI8": {
      "Timestamp": "2020-09-30T09:55:58.1140000+02:00",
      "Min": -10,
      "Max": 100,
      "Unit": "Celsius"
    },
    "GVL_nodes_dynamic.dyn_scalar_UI1": {
      "Timestamp": "2020-09-30T09:55:58.1140000+02:00"
    },
    "GVL_nodes_dynamic.dyn_scalar_UI2": {
      "Timestamp": "2020-09-30T09:55:58.1140000+02:00"
    },
    "GVL_nodes_dynamic.dyn_scalar_UI4": {
      "Timestamp": "2020-09-30T09:55:58.1140000+02:00"
    }
  }
}