Skip to content

format.md

Latest commit

 

History

History
92 lines (59 loc) · 1.74 KB

format.md

File metadata and controls

92 lines (59 loc) · 1.74 KB

[Package Name]

Overview

The [package_name] package provides [brief description of functionality, e.g., autonomous navigation, perception, etc.].

This system includes the following modules:

  1. [Module 1]

    • [Description of module 1]
    • [Key features or outputs]

  2. [Module 2]

    • [Description of module 2]
    • [Key features or outputs]

Features

  • [Feature 1]: [Brief description]
  • [Feature 2]: [Brief description]
  • [Feature 3]: [Brief description]
  • [Feature 4]: [Brief description]

Package Structure

Components

[Module 1]

  • [Component 1] (.hpp/cpp)

    • [Description of what it does]
    • [Inputs/outputs or key functionality]

  • [Component 2] (.hpp/cpp)

    • [Description of what it does]
    • [Inputs/outputs or key functionality]

[Module 2]

  • [Component 1] (.hpp/cpp)

    • [Description of what it does]
    • [Inputs/outputs or key functionality]

  • [Component 2] (.hpp/cpp)

    • [Description of what it does]
    • [Inputs/outputs or key functionality]

[Node Name] | Node

Subscriptions

  • [topic_name] ([msg_type])
    [Description of topic]

Publishers

  • [topic_name] ([msg_type])
    [Description of topic]

Services

  • [service_name] ([srv_type])
    • Request: [Request fields]
    • Response: [Response fields]

Actions

  • [action_name] ([action_type])
    • Goal: [Goal fields]
    • Feedback: [Feedback fields]
    • Result: [Result fields]

Parameters

  • [param_name] ([type]) – [Description]
  • [param_name] ([type]) – [Description]

Launch

Start the [node_or_module] with:

ros2 launch [package_name] [launch_file].launch.py