4.9 Action

This page explains the action components.

4.9.1 Shell Command#

This component executes any shell command by using collected data.
When the component receives data from the input port, it executes the shell command specified by a parameter.
For the string specifying the shell command, you can use the received data name, type, value, or timestamp.

4.9.1.1 Basic Information#

The basic information of Shell Command is as follows:

4.9.1.2 Settings#

The Shell Command settings are as follows:

4.9.2 Send Mail#

This component sends e-mails using the collected data.
When the component receives data from the input port, it sends an e-mail with the given information to the specified address.

4.9.2.1 Basic Information#

The basic information of Send mail is as follows:

4.9.2.2 Settings#

The Send mail settings are as follows:

4.9.2.2.1 Available Variables for Send mail#

4.9.2.3 Test Connection#

You can test connection with the specified destination by following the steps below:

1. Open the settings screen for the registered Send mail.

2. Press [Test].

   

3. Test connection is attempted with the specified destination, and the result is displayed at the bottom of the settings screen.

   

4.9.3 PLC Writing#

This component writes values to PLC registers.
When it receives trigger data from the input port, a value can be written to the specified register of the PLC.
Fix values, trigger data values, and data values of other components can be specified as values to be written.

4.9.3.1 Basic Information#

The basic information of PLC Writing is as follows:

4.9.3.2 Setting Method#

You can set up PLC Writing by following the steps below:

1. Add a component that has an output port. For instructions on how to add components, see Adding Components.

2. Start the added component and output data. For instructions on how to start components, see Starting/Stopping Components.

3. Add PLC Writing. For instructions on how to add components, see Adding Components.

4. Select the added component as the component to connect to the input port.

   

5. Enter the following component information.

   1. TCP/IP Connection

      

      Item	Description
      Name	Enter a name for the component. Note: Must be different from any other component name.
      Autostart disable	Set to ON to disable the component’s Autostart.
      Manufacturer	Select the manufacturer of the connecting PLC. Note: You can select from the following manufacturers: - Mitsubishi - Jtekt - Omron - Keyence - Panasonic
      Machine type	Select the machine type of the connecting PLC. Note: Machine types that can be selected depend on the manufacturer.
      Host	Host or IP address of the connecting PLC
      Port	Port for connecting PLC
      Connect timeout (ms)	Maximum time spent on connecting to a PLC
      Write timeout (ms)	Maximum time spent on writing a value
      Keep connect	Do not disconnect the connection to the PLC each time a query is made.

   2. Serial Connection

      

      Item	Description
      Device	Enter the serial communication device to use
      Baud rate	Select the baud rate for serial communication
      Data bit	Select the data bits for serial communication
      Stop bit	Select the stop bits for serial communication
      Parity bit	Select the parity bits for serial communication
      Bureau no	Enter the bureau number for Mitsubishi 3C frame
      Sum check	Set to ON to perform sum check for Mitsubishi 3C frame

6. Select a trigger specification method from the following:

   

   Item	Description
   Set After Receiving Data Definitions	From the list of data received by the input port, select the data that will trigger writing.
   Set by regular expression	A regular expression is input, and among data received by the input port, the matching data is the trigger for writing.

7. Enter the following items for the data to be set:

   

   Item	Description
   (If the Setting Option is “Set by regular expression”)
   Component	From the data received by the input port, the regular expression that represents the component name for the data to be the trigger for writing
   Trigger data	From the data received by the input port, the regular expression that represents the data name for the data to be the trigger for writing
   (If the Setting Option is “Set After Receiving Data Definitions”)
   Component	From the data received by the input port, select the component to be the trigger for writing.
   Trigger data	From the data received by the input port, select the data to be the trigger for writing.
   (Common)
   Address	Address of register to which the value is written
   Program	Program number of register to which the value is written Note: Available only when the manufacturer is Jtekt.
   Data type	Data type of register to which the value is written
   Num array	Range to which value is written from among the consecutive registers starting from the input address
   Value type	- Fix value: Enter a fixed value as the Write value. - Component: Select the data received by the input port as the Write value. - Event: Trigger data value is written.
   Write value	Enter a value of the selected Value type. Note: Cannot be entered when the Value type is Event.
   Enable	To write or not

   Examples of Regular Expression Input

   Here are examples of regular expression input:

   • Matches only “data1”: data1
   • Matches only data with “abc” in name: .*abc.*
   • Matches only data whose name starts with “abc”: abc.*
   • Matches only data whose name ends with “abc”: .*abc

8. Press [Save].

   

9. Start the component. For instructions on how to start components, see Starting/Stopping Components.

4.9.3.3 Test Connection#

You can test connection with the specified destination by following the steps below:

1. Open the settings screen for the registered PLC Writing.

2. Press [Test].

   

3. Test connection is attempted with the specified destination, and the result is displayed at the bottom of the settings screen.

   

4.9.3.4 Auto address setting#

With some PLCs, you can set addresses automatically at once by reading the file output by the ladder editing tool.

1. In the ladder editing tool, output the created ladder as a file. The output file format differs depending on the PLC manufacturer and machine type. Sample files are provided below:

   • Mitsubishi MELSEC-Q series (QnA compatible 3E frame), MELSEC-iQ-R series (QnA compatible 3E frame)

     Download sample file

   • Omron SYSMAC CS/CJ/CP/NSJ series (FINS)

     Download sample file

2. Press [Auto address setting].

   

3. Select the file that you output with the ladder editing tool.

4. The address is automatically set based on the file.

4.9.4 Modbus Writing#

This component writes a value to the specified address of a Modbus compatible device.
When trigger data is received from the input port, this component acts as the master of Modbus and writes a value to the specified register of the Modbus slave device.
Fix values, trigger data values, and data values of other components can be specified as values to be written.

4.9.4.1 Basic Information#

The basic information of Modbus Writing is as follows:

4.9.4.2 Setting Method#

You can set up Modbus Writing by following the steps below:

1. Add a component that has an output port. For instructions on how to add components, see Adding Components.

2. Start the added component and output data. For instructions on how to start components, see Starting/Stopping Components.

3. Add Modbus Writing. For instructions on how to add components, see Adding Components.

4. Select the added component as the component to connect to the input port.

   

5. Enter the following component information.

   • When TCP is selected as the communication method

     

   • When RTU is selected as the communication method

     

   Item	Description
   Name	Enter a name for the component. Note: Must be different from any other component name.
   Autostart disable	Set to ON to disable the component’s Autostart.
   Communication method	Select TCP or RTU
   Host	Host name or IP address of the connecting device ※Available when communication method is TCP
   Port	Port for the connecting device ※Available when communication method is TCP
   Device	Serial communication device to use ※Available when communication method is RTU
   Baud rate	Baud rate for serial communication ※Selectable when communication method is RTU
   Serial mode	Serial communication mode ※Selectable when communication method is RTU
   Data bit	Data bits for serial communication ※Selectable when communication method is RTU
   Stop bit	Stop bits for serial communication ※Selectable when communication method is RTU
   Parity bit	Parity bits for serial communication ※Selectable when communication method is RTU
   Endian	Byte order of the value to be written
   Connect timeout (ms)	Maximum time spent on connecting to a device
   Write timeout (ms)	Maximum time spent on writing a value
   Slave ID	Slave ID of connecting device

6. Select a trigger specification method from the following:

   

   Item	Description
   Set After Receiving Data Definitions	From the list of data received by the input port, select the data that will trigger writing.
   Set by regular expression	A regular expression is input, and among data received by the input port, the matching data is the trigger for writing.

7. Enter the following items for the data to be set:

   

   Item	Description
   (If the Setting Option is “Set by regular expression”)
   Component	From the data received by the input port, the regular expression that represents the component name for the data to be the trigger for writing
   Trigger data	From the data received by the input port, the regular expression that represents the data name for the data to be the trigger for writing
   (If the Setting Option is “Set After Receiving Data Definitions”)
   Component	From the data received by the input port, select the component to be the trigger for writing.
   Trigger data	From the data received by the input port, select the component to be the trigger for writing.
   (Common)
   Type	Type of register to which the value is written
   Address	Address of register to which the value is written Note: According to Modbus specifications, the address range is usually set to "1 to 65536," but when setting in SpeeDBee Synapse, it is necessary to set an address range shorter by 1, specifically, as "0 to 65535."
   Data type	Data type of register to which the value is written
   Num array	Range to which value is written from among the consecutive registers starting from the input address
   Endian	Byte order of data to be written Note: If "-," the endianness of the entire data is applied.
   Value type	- Fix value: Enter a fixed value as the Write value. - Component: Select the data received by the input port as the Write value. - Event: Trigger data value is written.
   Write value	Enter a value of the selected Value type. Note: Cannot be entered when the Value type is Event.
   Enable	To write or not

   Examples of Regular Expression Input

   Here are examples of regular expression input:

   • Matches only “data1”: data1
   • Matches only data with “abc” in name: .*abc.*
   • Matches only data whose name starts with “abc”: abc.*
   • Matches only data whose name ends with “abc”: .*abc

8. Press [Save].

   

9. Start the component. For instructions on how to start components, see Starting/Stopping Components.

4.9.4.3 Test Connection#

You can test connection with the specified destination by following the steps below:

1. Open the settings screen for the registered Modbus Writing.

2. Press [Test].

   

3. Test connection is attempted with the specified destination, and the result is displayed at the bottom of the settings screen.

   

4.9.5 EtherNet/IP Writing#

This component writes a value to the specified address of an EtherNet/IP-enabled device.
When the component receives trigger data from the input port, it acts as an originator, connects to the EtherNet/IP-enabled device, and writes an arbitrary value to the specified variable.

4.9.5.1 Basic Information#

The basic information of EtherNet/IP Writing is as follows:

4.9.5.2 Setting Option#

You can set up EtherNet/IP Writing by following the steps below:

1. Add a component that has an output port. For instructions on how to add components, see Adding Components.

2. Start the added component and output data. For instructions on how to start components, see Starting/Stopping Components.

3. Add EtherNet/IP Writing. For instructions on how to add components, see Adding Components.

4. Select the added component as the component to connect to the input port.

   

5. Enter the following component information.

   

   Item	Description
   Name	Enter a name for the component. Note: Must be different from any other component name.
   Autostart disable	Set to ON to disable the component’s Autostart.
   Host	Enter the host name or IP address of the EtherNet/IP-enabled device.
   Port	Enter the port for the EtherNet/IP-enabled device.
   Connect timeout(ms)	Enter the timeout duration for connecting.

6. Select a trigger specification method from the following:

   

   Item	Description
   Set After Receiving Data Definitions	From the list of data received by the input port, select the data that will trigger writing.
   Set by regular expression	A regular expression is input, and among data received by the input port, the matching data is the trigger for writing.

7. Enter the following items for the data to be set:

   

   Item	Description
   (If the Setting Option is “Set by regular expression”)
   Component	From the data received by the input port, the regular expression that represents the component name for the data to be the trigger for writing
   Trigger data	From the data received by the input port, the regular expression that represents the data name for the data to be the trigger for writing
   (If the Setting Option is “Set After Receiving Data Definitions”)
   Component	From the data received by the input port, select the component to be the trigger for writing.
   Trigger data	From the data received by the input port, select the component to be the trigger for writing.
   (Common)
   Setting Option	Select the setting option for the data to be acquired.
   Variable name	Enter a tag name. Note: This item can be entered only when the Setting Option is Variable Name.
   Struct	Set to ON to register multiple members. Note: This item can be set only when the Setting Option is Variable Name.
   Class ID	Enter a Class ID. Note: This can be entered only when the Setting Option is CIPObject.
   Instance ID	Enter an Instance ID. Note: This can be entered only when the Setting Option is CIPObject.
   Attribute ID	Enter an Attribute ID. Note: This can be entered only when the Setting Option is CIPObject.
   Attribute settings	Check when entering Attribute ID. Note: This can be manipulated only when the Setting Option is CIPObject.
   Data type	Data type of member
   Array size	Array size of member Note: This item can be manipulated only when the Setting Option is Variable Name.
   Value type	- Fix value: Enter a fixed value as the Write value. - Component: Select the data received by the input port as the Write value. - Event: Trigger data value is written.
   Write value	Enter a value of the selected Value type. Note: Cannot be entered when the Value type is Event.

   Examples of Regular Expression Input

   Here are examples of regular expression input:

   • Matches only “data1”: data1
   • Matches only data with “abc” in name: .*abc.*
   • Matches only data whose name starts with “abc”: abc.*
   • Matches only data whose name ends with “abc”: .*abc

8. Press [Save].

   

9. Start the component. For instructions on how to start components, see Starting/Stopping Components.

4.9.5.3 Test Connection#

You can test connection with the specified destination by following the steps below:

1. Open the settings screen for the registered EtherNet/IP Writing.

2. Press [Test].

   

3. Test connection is attempted with the specified destination, and the result is displayed at the bottom of the settings screen.

   

4.9.5.4 Auto variable setting#

Variables can be automatically set by converting the global variable information exported by Sysmac Studio to a text file into a specified format and reading it.

1. Convert the global variable information exported by Sysmac Studio to a text file with the following column information:

   • HOST
   • NAME
   • DATATYPE
   • ADDRESS
   • COMMENT
   • TAGLINK
   • RW
   • POU
   Example

   HOST    NAME    DATATYPE    ADDRESS COMMENT TAGLINK RW  POU
           b_test  BOOL        test1           TRUE    RW  
           i_test  UINT        test2           TRUE    RW  
           s_test  STRING(256) test3           TRUE    RW  
   

2. Press [AUTO VARIABLE SETTING].

   

3. Select the prepared text file.

4. The variable is automatically set based on the file.

4.9.6 MQTT Client#

This component performs publish/subscribe to the same MQTT broker.
When file type data is received from the input port, its contents are published to the MQTT broker.
Subscribed data is output from the output port as file type data.

4.9.6.1 Basic Information#

The basic information of MQTT Client is as follows:

4.9.6.2 Settings#

The MQTT Client settings are as follows:

4.9.6.3 Test Connection#

You can test connection with the specified destination by following the steps below:

1. Open the settings screen for the registered MQTT Client.

2. Press [Test].

   

3. Test connection is attempted with the specified destination, and the result is displayed at the bottom of the settings screen.