Setup ASYS#
Overview#
This feature is responsible for handling the TCP/IP connection between the Automation Driver and ASYS equipment (Asys LaserMark, Ekra Printer, Divisio Depaneler and other equipment compatible with the MES-Socket-Interface specification).
The Automation Driver is configured in passive mode: it opens a TCP/IP port and listens for incoming connections initiated by the equipment.
How To Configure#
To configure the connection between the Automation Driver and the ASYS equipment a set of keys must be set in the IoTMetadataDefinition Smart Table.
- The equipment must be configured to connect to a specific IP address and TCP port.
- The IP address is the address of the host where the Automation Driver is running.
- The TCP port must be a unique value among the unused TCP ports on that host where the driver should
LISTENfor connections from the equipment.
Relevant Artifacts#
The table below describes the properties for this entity type:
| Name | Type | Is Mandatory | Data Type | Description |
|---|---|---|---|---|
| IoTMetadataDefinition | SmartTable | Yes | Metadata configuration for equipment integration |
How It Works#
You can set in IoTMetadataDefinition the appropriate values for your setup.
Every time you change Setup values in IoTMetadataDefinition you must restart the Automation Controller.
IoTMetadataDefinition Base Configuration#
The following keys configure the base behavior of the ASYS driver:
| Name | Value | Description |
|---|---|---|
| Port | TCP Port Number | Listening local socket port for equipment connection. Check equipment configuration for correct value. Defaults to 50000 if not present. |
| ConvertKeyToArray | Message,Tag | Used internally during XML to JSON conversion to force single items to be exposed as arrays with one item. Indicates the message where the tag exists and which XML tags should be converted to arrays. One example is the scenario where one PANEL_OUT_REQ contains only one ITEM, in which case the value should be PANEL_OUT_REQ,ITEM. |
Default Driver Settings#
The driver is started with the following default settings:
| Parameter | Value |
|---|---|
| Reconnect Interval (ms) | 1 |
| Connecting Timeout (ms) | 30000 |
| Mode | Passive |
| Host | 0.0.0.0 |
| IP Stack | 4 |
| Max Clients | 1 |
| Parser Type | Delimiter |
| Delimiter | </ASYS> |
Configuration Example
A minimal configuration that puts the driver in listening mode on port 50000 and converts the ITEM tag inside PANEL_OUT_REQ to an array:
| Resource | ResourceType | Area | Name | Value |
|---|---|---|---|---|
| MES Resource | Port | 50000 | ||
| ConvertKeyToArray | PANEL_OUT_REQ,ITEM |
How To Use#
On Automation startup the driver retrieves the information in IoTMetadataDefinition, puts the configured TCP port in LISTEN state and waits for the equipment to connect.
Implementation Details#
See Protocol and Driver Definition for the Driver Definition, Properties, Events and Commands used by the ASYS integration, and Message Handling for the routing of equipment messages to MES Services and DEEs.
Alive Request#
When we receive ALIVE_REQ message, which can be processed without MES intervention, the controller will process it and respond.
State Change#
When we receive the STATE_CHANGE message from the equipment, the controller will parse its content and propagate the corresponding SEMI-E10 state to MES.
| Received State | MES State |
|---|---|
| Start | Productive |
| Standby | Standby |
| Stop | Standby |
| Error | Unscheduled Down |
| Engineering | Engineering |