Execute loop at fixed frequency
rosrate object uses the
rateControl (Robotics System Toolbox) superclass to inherit most of its properties and methods. The
main difference is that
rateControl uses the ROS node as a source for
time information. Therefore, it can use the ROS simulation or wall clock time (see the
rosinit creates a ROS master in
MATLAB®, the global node uses wall clock time.
The performance of the
rosrate object and the ability to maintain
DesiredRate value depends on the publishing of the clock
information in ROS.
The scheduling resolution of your operating system and the level of other system activity can affect rate execution accuracy. As a result, accurate rate timing is limited to 100 Hz for execution of MATLAB code. To improve performance and execution speeds, use code generation.
rate = rosrate(
Rate object, which enables you to execute a
loop at a fixed frequency,
DesiredRate. The time source
is linked to the time source of the global ROS node, which requires you to
connect MATLAB to a ROS network using
rate = ros.Rate(
Rate object that operates loops at a fixed rate
based on the time source linked to the specified ROS node,
DesiredRate— Desired execution rate
Desired execution rate of loop, specified as a scalar in hertz. When using
waitfor, the loop operates every
DesiredRate seconds, unless the loop takes longer. It
then begins the next loop based on the specified
DesiredPeriod— Desired time period between executions
Desired time period between executions, specified as a scalar in seconds.
This property is equal to the inverse of
TotalElapsedTime— Elapsed time since construction or reset
Elapsed time since construction or reset, specified as a scalar in seconds.
OverrunAction— Method for handling overruns
Method for handling overruns, specified as one of these character vectors:
'drop' — waits until the next time
interval equal to a multiple of
'slip' — immediately executes the
Each code section calls
waitfor (Robotics System Toolbox) at the end of execution.
IsSimulationTime— Indicator if simulation or wall clock time is used
Indicator if simulation or wall clock time is used, returned as
Rate object is using the
ROS simulation time to regulate the rate of loop execution.
Initialize the ROS master and node.
Launching ROS Core... Done in 0.97633 seconds. Initializing ROS master on http://192.168.0.10:53810. Initializing global node /matlab_global_node_76237 with NodeURI http://bat800801glnxa64:46485/
Create a rate object that runs at 1 Hz.
r = rosrate(1);
Start loop that prints iteration and time elapsed. Use
waitfor to pause the loop until the next time interval. Reset
r prior to the loop execution. Notice that each iteration executes at a 1-second interval.
reset(r) for i = 1:10 time = r.TotalElapsedTime; fprintf('Iteration: %d - Time Elapsed: %f\n',i,time) waitfor(r); end
Iteration: 1 - Time Elapsed: 0.006124 Iteration: 2 - Time Elapsed: 1.002008 Iteration: 3 - Time Elapsed: 2.002146 Iteration: 4 - Time Elapsed: 3.001937 Iteration: 5 - Time Elapsed: 4.004087 Iteration: 6 - Time Elapsed: 5.001628 Iteration: 7 - Time Elapsed: 6.000712 Iteration: 8 - Time Elapsed: 7.001059 Iteration: 9 - Time Elapsed: 8.000901 Iteration: 10 - Time Elapsed: 9.001328
Shut down the ROS network.
Shutting down global node /matlab_global_node_76237 with NodeURI http://bat800801glnxa64:46485/ Shutting down ROS master on http://192.168.0.10:53810.
Initialize the ROS master and node.
Launching ROS Core... .Done in 1.0856 seconds. Initializing ROS master on http://192.168.0.10:53294. Initializing global node /matlab_global_node_97996 with NodeURI http://bat800801glnxa64:33547/
node = ros.Node('/testTime');
Using Master URI http://localhost:53294 from the global node to connect to the ROS master.
ros.Rate object running at 20 Hz.
r = ros.Rate(node,20);
Reset the object to restart the timer and run the loop for 30 iterations. Insert code you want to run in the loop before calling
reset(r) for i = 1:30 % User code goes here. waitfor(r); end
Shut down ROS node.
Shutting down global node /matlab_global_node_97996 with NodeURI http://bat800801glnxa64:33547/ Shutting down ROS master on http://192.168.0.10:53294.
Usage notes and limitations:
statistics object function is not supported.