Set Sleep: By Name

ASTER::ACTION::MotionControl::Set The Sleep Parameters; ByName

Pausing the operation of running instances, repeating the stop and resume operation.

A feature to temporarily pause object instances that are being controlled and moved by the motion controller. Timer processing can be set by specifying frame time.

  • Unlike the Stop command, this is a pause command that assumes resumption of movement, and it has a repetition value setting that specifies the number of times to repeat the resumption and stopping of movement.

  • There are two main methods for unregistering instances and motion groups registered with the motion controller.

Method Description
By Name Unregister all by specifying the motion group name.
LPRO Directly Unregister individual instances directly.

Use "By Name" to unregister by motion group and "LPRO Directly" to unregister only matched instances.


Parameter.1

Specification of the motion group name.

If there are two or more registered motion groups, you can set the parameter for the corresponding group by specifying the group name.

Parameter Example Description
"ExMotion1" Setting the parameter for a specified group name.
"" Send an empty string, targeting all registered motion groups.

If you send an empty string without specifying the group name, all currently registered motion groups will be targeted.


Parameter.2

Serializing and sending three parameters in bulk

​
"30, -1, 30"
value Type Description
30 unsigned int FrameTimes ( Sleep ); Time to pause
-1 int Repetition Count Number: -1 = infinite loop, 0 = deactivation
30 unsigned int FrameTimes ( Active Time ); Waiting time until the next Sleep
  • The time unit is the application’s frame time, and negative signs cannot be used.

Notes.1

Parameters that do not meet the format will result in a format error, and the action will be canceled.

​
 " -30 , 9,  -30,"   <!-- Using negative signs for values where negative signs are not allowed, inserting unnecessary commas. -->

Notes.2

To cancel the Sleep command, set repetition to 0.

If you provide a value of +1 or higher for the repetition value, the process will repeatedly enter Sleep mode after the specified waiting time.

value repeats
-1 Repeats infinitely
0 Stops Sleep function
1 Executes only once
2 Repeats twice
3 Repeats three times

Notes.3

Overwriting updates of commands is possible.

If you issue an additional Sleep command to object instances currently in Sleep operation, the parameters will be overwritten with new values.

This specification allows overwriting the number of repetitions of Sleep operation, and at the same time, enables stopping the Sleep function.


Notes.4

The Sleep function is supported by Wrap|Flip, Sinewave, and MoveTowards.

It is not supported by Null and Orbital.

  • Orbital has a special Sleep command that corresponds to angular velocity.