To define a trigger that executes when an Omron
unsolicited message is sent, follow the steps for defining
a new trigger.
For complete information on defining projects and triggers,
see Defining a
trigger.
Every trigger identifies the trigger event type, which identifies when the trigger will be executed.
The PLC Logic Events category will list
the available event types, based on the drivers that are
installed on the node.
The Omron driver supports the receipt of two types of
unsolicited messages from Omron PLCs:
- The Omron event type will support the receipt of SEND(090) or RECV(098) messages from CJ and CS PLC’s.
- The Omron (CIP) event type will
support the receipt of unsolicited messages from NJ
PLCs.
Omron event type trigger
To define a trigger that executes when an Omron SEND(090) or an Omron RECV(098) unsolicited message is received, select the Omron trigger event type. The event panel will change to display the parameters that the trigger needs to process an unsolicited message. Each unsolicited message type has parameters that are unique to that type of message.
Omron event type trigger - SEND(090) command parameters
The following parameters are displayed on the trigger
definition panel when the Omron SEND(090) command is
selected.
| Parameter | Description |
|---|---|
| Device Name | Pick the name of a defined Omron PLC device. |
| Command Code | If you want to receive data from the PLC, use command SEND(090). |
| Address | The address can be any positive integer. It is a unique (user defined) number for unsolicited message identification. It is used to match the unsolicited message to a trigger and allows multiple triggers to reference a single PLC. If there are no started triggers that match the address value, the unsolicited message will be discarded. |
| Requested Word Count | The expected count of the data to be sent from the PLC in the request. |
| Requested Data Type | The expected data type of the data to be sent from the PLC in the request. |
Omron event type trigger - SEND(090) event variables
The trigger event variables that are available to trigger actions that have input or source parameters for Omron SEND(090) messages are:
| Event Variable | Data type | Description |
|---|---|---|
| Address | UINT2 | The unique (user defined) number for unsolicited message identification.This is also the value in the Address field in the event tab for this trigger. |
| Data | Array of data | This is the data sent by the Omron PLC. It can be a single data item, or it can be an array based on the Requested Word Count parameter. The data type of the data is based on the Requested Data Type parameter. |
| Device Name | String | The name of the device that sent the Omron SEND(090) message. |
The event variables that are returned to the PLC upon
completion of the trigger are available to trigger actions
that have output or destination parameters:
| Event Variable | Data type | Description |
|---|---|---|
| ResultStatus | INT2 | An integer value that will be returned to the PLC to signify the success or failure status of the trigger that received the Omron SEND(090) message. This value will be returned to the PLC upon completion of the trigger. |
Omron event type trigger - RECV(098) command parameters
The following parameters are displayed on the trigger
definition panel when the Omron RECV(098) command is
selected.
| Parameter | Description |
|---|---|
| Device Name | Pick the name of a defined Omron PLC device. |
| Command Code | If you want to send data back to the PLC, use command RECV(098). |
| Address | The address can be any positive integer. It is a unique (user defined) number for unsolicited message identification. It is used to match the unsolicited message to a trigger and allows multiple triggers to reference a single PLC. If there are no started triggers that match the address value, the unsolicited message will be discarded. |
| Response Word Count | The count of the data to be sent back to the PLC when the trigger completes. |
| Response Data Type | The data type of the data to be sent back to the PLC when the trigger completes. |
Omron event type trigger - RECV(098) event variables
The trigger event variables that are available to trigger actions that have input or source parameters are:
| Event Variable | Data type | Description |
|---|---|---|
| Address | UINT2 | The unique (user defined) number for unsolicited message identification.This is also the value in the Address field in the event tab for this trigger. |
| Device Name | String | The name of the device that sent the Omron RECV(098) message. |
The event variables that are returned to the PLC upon
completion of the trigger are available to trigger actions
that have output or destination parameters:
| Event Variable | Data type | Description |
|---|---|---|
| Data | Array of data | This is the data to send back to the Omron PLC. It can be a single data item, or it can be an array based on the Response Word Count parameter. The data type of the data is based on the Response Data Type parameter. |
| ResultCount |
INT2 |
The count of the data to be sent back to the PLC when the trigger completes. |
| ResultStatus | IINT2 | An integer value that will be returned to the PLC to signify the success or failure status of the trigger that received the Omron RECV(098) message. This value will be returned to the PLC upon completion of the trigger. |
Omron (CIP) event type trigger
To define a trigger that executes when an Omron CIP unsolicited message is received, select the Omron (CIP) trigger event type. The event panel will change to display the parameters that the trigger needs to process an unsolicited message. Each unsolicited message type has parameters that are unique to that type of message.
Omron (CIP) event type trigger - CIPUCMMSEND parameters
The following parameters are displayed on the trigger
definition panel when the CIPUCMMSEND command is selected.
The values entered in these parameters must match the
values that were entered in the Sysmac Studio software when
the unsolicited message was defined.
| Parameter | Description |
|---|---|
| Device Name | Select the name of a defined Omron CIP Listener device. |
| Access List | The access list allows you to specify an IP address filter associated with this trigger. This Omron (CIP) event trigger may receive messages from multiple Omron NJ PLCs. The IP addresses defined in the access list can be used to limit the Omron NJ PLCs (by IP address) that will cause this trigger to be executed. |
| Command | Select the
CIPUCMMSEND
command. |
| Service Code (Hex) | This is a display only field and is presented to indicate the service code associated with the CIPUCMMSEND message. |
| Class (Hex) | The type or class of object to which the service is to be sent. |
| Instance | The instance of the object to which the service is to be sent. |
| Attribute (Hex) | The attribute of the object to which the service is to be sent. |
| Input Length (Bytes) | This is the total number of bytes of data the unsolicited message will send. |
| Input Data Type | Select the data type that matches the data in the message. |
Omron (CIP) event type trigger - CIPUCMMSEND event variables
The trigger event variables that are available to trigger actions that have input or source parameters for CIPUCMMSEND messages are:
| Event Variable | Data type | Description |
|---|---|---|
| Attribute | UINT2 | The attribute code of the object identified in the message. This is also the value in the Attribute field in the event tab for this trigger. |
| Class | UINT2 | The code that identifies the type or class of the object identified in the message. This is also the value in the Class field in the event tab for this trigger. |
| Data | Array of data | This is the data on the Omron NJ PLC. It is sent by the ladder logic running on the PLC as part of the CIPUCMMSEND message. The type of data in the array is defined in the Input Data Type field on the event definition panel for this trigger. |
| Data Length | INT4 | The length of the message in bytes. This is also the value in the Input Length (Bytes) field in the event tab for this trigger. |
| Instance | UINT2 | The code that identifies the instance of the object identified in the message. This is also the value in the Instance field in the event tab for this trigger. |
| IP Address | String, length 32 characters | The IP address of the PLC that sent the message. |
| Service Code | UINT1 | The code that identifies the service identified in the message. This is also the value in the Service Code field in the event tab for this trigger. |
The event variables that are returned to the PLC upon
completion of the trigger are available to trigger actions
that have output or destination parameters:
| Event Variable | Data type | Description |
|---|---|---|
| ResultStatus | UINT1 | An integer value that will be returned to the PLC to signify the success or failure status of the trigger that received the CIPUCMMSEND message. This value will be returned to the PLC upon completion of the trigger. |
Omron (CIP) event type trigger - CIPUCMMWRITE parameters
The following parameters are displayed on the trigger
definition panel when the CIPUCMMWRITE command is selected.
The values entered in these parameters must match the
values that were entered in the Sysmac Studio software when
the unsolicited message was defined.
| Parameter | Description |
|---|---|
| Device Name | Select the name of the device that will send the unsolicited message. The devices in this list will be limited to those that are of the Omron CIP Listener type when the Omron(CIP) trigger event type is selected. |
| Access List | The access list allows you to specify an IP address filter associated with this trigger. This Omron (CIP) event trigger may receive messages from multiple Omron NJ PLCs. The IP addresses defined in the access list can be used to limit the Omron NJ PLCs (by IP address) that will cause this trigger to be executed. |
| Command | Select the CIPUCMMWRITE command. |
| Destination | The name of the destination point of this message. This name does not have to match any variable or tag on the node. It is provided to differentiate between one CIPCUMMWRITE message and another. |
| Element Count | The length of the message to process. This value is represented as a number of elements and can be thought of as the size of the array of elements to follow in the message. |
| Input Data Type | Select the data type that matches the data in the message. |
Omron (CIP) event type trigger - CIPUCMMWRITE event variables
The trigger event variables that are available to trigger actions that have input or source parameters for CIPUCMMWRITE messages are:
| Event Variable | Data type | Description |
|---|---|---|
| Data | Array of data | This is the data on the Omron NJ PLC. It is sent by the ladder logic running on the PLC as part of the CIPUCMMWRITE message. The type of data in the array is defined in the Input Data Type field on the event definition panel for this trigger. |
| Data Length | INT4 | The length of the message in bytes. This is a product of the value in the Element Count field in the event tab for this trigger, multiplied by the size in bytes of one of those elements. |
| Destination | String, length 64 characters | The name of the variable in the CIPUCMMWRITE message. This is also the value in the Destination field in the event tab for this trigger. |
| IP Address | String, length 32 characters | The IP address of the PLC that sent the message. |
The event variables that are returned to the PLC upon
completion of the trigger are available to trigger actions
that have output or destination parameters:
| Event Variable | Data type | Description |
|---|---|---|
| ResultStatus | UINT1 | An integer value that will be returned to the PLC to signify the success or failure status of the trigger that received the CIPUCMMWRITE message. This value will be returned to the PLC upon completion of the trigger. |