CNS Structure

EquipmentConstants

Each SECS equipment needs equipment constants for configuration purposes. The pre-defined constants in this section must be configured to fulfill the functionality of the fundamental GEM requirements. The Node IDs of equipment constants need the prefix ECID_ which stands for Equipment Constants ID. Additional equipment constants can be added but their use case must be implemented on the application side and are not automatically considered in the gateway manager. For the host only gathering their data and changing their values is supported via the corresponding messages.

Events

Event notification is a fundamental GEM requirement and therefore mandatory for the SECS Gateway. The configuration via CNS is described in this section. For further details on the event notification and event reports see SEMI E5 S6F11/13 message and to SEMI E30 section 7.3.1.2

Each SECS equipment needs an events structure node. Events can be added dynamically in the CNS structure. They are automatically considered by the gateway manager, if trigger DPs are linked. The structure of the node IDs for events and all underlying child nodes is defined in the following table:

Event and Report configuration

A CEID such as CEID_4000 can be used for an event named ControlOnline-Offline. Trigger DPEs can be configured as child nodes below CEID_4000 and can optionally define matching values via the OA:SECS property.

The report structure can be configured below a report node such as RPTID_1000. Report DPEs define the values transferred to the host when the event is triggered. For annotated event reports, report values can use VID_<Unsigned ID> node ids.

Events and reports can also be created via CTRL-Scripts and the SECS Gateway library function secsgw_createEventOrReport (in secsGateway.ctl)

Mandatory Events

Events are in general not mandatory, but the following events for the control state must be configured to get the correct information from the host about the equipment's control state:

• ControlOnline-Offline
• ControlLocal
• ControlRemote

When creating CNS gateway or equipment structures via the corresponding buttons, these events get automatically created.

PLCControlState

The control state is an essential SECS equipment feature which is required for the operation of the equipment and host message exchange. Therefore, it is mandatory to configure the corresponding CNS nodes. For further information on the control state model, refer to the SEMI E30 standard, section 6.5.

The PLCControlState CNS node has child nodes which hold configuration (Config) and command (Command) DP nodes. The child nodes are described in the following table:

OA:SECS

To fully configure the SECS Gateway, the CNS-property OA:SECS is used for specifying event trigger values on event trigger DP nodes or for defining the "Connected" state on the PLCConnState node of an equipment. The property must be defined as a JSON array containing numbers. The CNS panels in the plantmodel editor's SECS section already take care of that, but if a CTRL-script is used the property can be set and queried via the functions cnsSetProperty and cnsGetProperty.

Example for setting the OA:SECS property:

main()
{
  dyn_int diSecsValues = makeDynInt(1, 2, 3);
  string sSecsValuesEncoded = jsonEncode(diSecsValues);
  cnsSetProperty("System1.View1:Node3.Node1", "OA:SECS", sSecsValuesEncoded);
}

Example for reading the OA:SECS property:

main()
{
  string sJsonValues; 
  cnsGetProperty("System1.View1:Node3.Node1", "OA:SECS", sJsonValues);
  dyn_int diSecsValues = jsonDecode(sJsonValues);
  DebugTN(diSecsValues); // dyn_int [1, 2, 3]
}