Skip to content

ogma-cli: Add minimal example demonstrating ROS 2 backend #289

@ivanperez-keera

Description

@ivanperez-keera

Description

To facilitate adoption of Ogma, we want to have a collection of examples that demonstrate the most common use cases.

A demonstration of how to use the ROS 2 backend to generate a minimal application would be a good starting point for users that want to generate monitors for ROS 2.

Type

  • Feature: New manual page.

Additional context

None.

Requester

  • Ivan Perez.

Method to check presence of bug

Not applicable (not a bug).

Expected result

A README, together with any necessary auxiliary files, is present in the examples directory. When the steps described in the README are followed, a simple monitoring application for ROS 2 is generated and demonstrated.

The instructions are easy to follow for users not familiar with Ogma.

Desired result

A README, together with any necessary auxiliary files, is present in the examples directory. When the steps described in the README are followed, a simple monitoring application for ROS 2 is generated and demonstrated.

The instructions are easy to follow for users not familiar with Ogma.

Proposed solution

Add under examples/ a README page with a minimal example of a monitoring application.

Demonstrate the elements of the example, how to invoke Ogma, how to compile the results, and how to run it.

Provide any necessary auxiliary files in the same directory.

Further notes

None.

Metadata

Metadata

Labels

CR:Status:ClosedAdmin only: Change request that has been completedCR:Type:FeatureAdmin only: Change request pertaining to new features requested

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions