Notify

You are viewing an old version of the documentation. You can switch to the documentation of the latest version by clicking the top-right corner of the page.

Function

This Step is used to send messages to external services.

Usage Scenario

This Step is usually used in scenarios where an external device is required for the communication.

Parameter Description

General Parameters of Non-Move Steps

Skip Execution
None

Default setting. Do not skip the current Step.

Simulation only

Skip the current Step during simulation. The exit port is specified by Out Port When Skip.

Always

Skip the current Step when the project is simulating or running. The exit port is specified by Out Port When Skip.

Instruction

When Simulation only or Always is selected, the current Step will be skipped and the subsequent Step will be executed when running the project. If this parameter is set to None in “Check DI” Step in the project, and there is no external input signal during simulation, the project will be stopped when executing to this Step. In this case, setting the parameter to Simulation only or Always enables the simulation to continue.

Out Port When Skip

This parameter will take effect when Skip Execution is set to Simulation only or Always. It specifies the exit port when skipping a Step.

Adapter Name

This parameter specifies the Adapter that will receive the message from this Step. If there are multiple Notify Steps in the project, the Adapter Name set in the Steps should be the same.

Message

The customized message. The Adapter executes different logic according to the content of the message. For example, you can set the message to finish if the branch operation ends.

Action When Failed

Description: This parameter specifies the action of the software when the notification message is not sent successfully.

Value:

  • Warning: Send a warning message (default value).

  • Retry: Try to re-send the message.

  • Throw: Discard the notify Step.

Need Robot Stop

If this parameter is selected, the robot will pause when the project executes to this Step. If this parameter is not selected, the robot will keep moving while the Step sends the message.

Timeout

If the message fails to be sent after the timeout period (unit: ms), the robot will perform the Action When Failed.

Application Examples

As shown in the figures below, an Adapter Name is set, and a finish message will be sent to the Adapter if the software fails to plan a path.

notify 1
notify 2

We Value Your Privacy

We use cookies to provide you with the best possible experience on our website. By continuing to use the site, you acknowledge that you agree to the use of cookies. If you decline, a single cookie will be used to ensure you're not tracked or remembered when you visit this website.