Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions rclpy/timers/minimal_timer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Minimal Timer Example

This example demonstrates how to create a simple timer node in ROS 2 using rclpy.

## Overview

ROS 2 timers allow nodes to execute a callback function periodically.
They are commonly used for tasks such as monitoring loops, periodic updates,
or scheduled processing.

This example creates a node that executes a callback every second using
`create_timer()`.

## Running the Example

Run the node with:

```bash
python3 minimal_timer.py

```

You should see log messages printed once per second.

## Example output

Timer callback triggered
Timer callback triggered
Timer callback triggered

## Key Concept

`create_timer()` schedules a callback to be executed periodically.
29 changes: 29 additions & 0 deletions rclpy/timers/minimal_timer/minimal_timer.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import rclpy
from rclpy.node import Node


class MinimalTimer(Node):

def __init__(self):
super().__init__('minimal_timer')

timer_period = 1.0
self.timer = self.create_timer(timer_period, self.timer_callback)

def timer_callback(self):
self.get_logger().info('Timer callback triggered')


def main(args=None):
rclpy.init(args=args)

minimal_timer = MinimalTimer()

rclpy.spin(minimal_timer)

minimal_timer.destroy_node()
rclpy.shutdown()


if __name__ == '__main__':
main()
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import rclpy
from rclpy.node import Node


class MinimalTimer(Node):

def __init__(self):
super().__init__('minimal_timer')

timer_period = 1.0
self.timer = self.create_timer(timer_period, self.timer_callback)

def timer_callback(self):
self.get_logger().info('Timer callback triggered')


def main(args=None):
rclpy.init(args=args)

minimal_timer = MinimalTimer()

rclpy.spin(minimal_timer)

minimal_timer.destroy_node()
rclpy.shutdown()


if __name__ == '__main__':
main()
17 changes: 17 additions & 0 deletions rclpy/topics/examples_rclpy_minimal_timer/package.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0"?>
<package format="3">
<name>examples_rclpy_minimal_timer</name>
<version>0.0.0</version>
<description>Minimal rclpy timer example demonstrating create_timer usage.</description>

<maintainer email="yadnyeshwarasa@gmail.com">Yadnyeshwar Sakhare</maintainer>
<license>Apache-2.0</license>

<buildtool_depend>ament_python</buildtool_depend>

<exec_depend>rclpy</exec_depend>

<test_depend>ament_lint_auto</test_depend>
<test_depend>ament_lint_common</test_depend>

</package>
25 changes: 25 additions & 0 deletions rclpy/topics/examples_rclpy_minimal_timer/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
from setuptools import setup

package_name = 'examples_rclpy_minimal_timer'

setup(
name=package_name,
version='0.0.0',
packages=[package_name],
data_files=[
('share/ament_index/resource_index/packages',
['resource/' + package_name]),
('share/' + package_name, ['package.xml']),
],
install_requires=['setuptools'],
zip_safe=True,
maintainer='Yadnyeshwar Sakhare',
maintainer_email='yadnyeshwarasa@gmail.com',
description='Minimal rclpy timer example demonstrating create_timer() usage.',
license='Apache License 2.0',
entry_points={
'console_scripts': [
'minimal_timer = examples_rclpy_minimal_timer.minimal_timer:main',
],
},
)
Empty file.