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

Receiver

Set this parameter according to the object that actually receives the DO. You can select either the robot, Standard Interface or Adapter. If Adapter is selected, please enter the “Adapter Name.” In addition, there can be multiple receivers.

If this parameter is not configured, the software cannot send the DO to the receiver.

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.