Skip to content

Conversation

hamishwillee
Copy link
Contributor

@hamishwillee hamishwillee commented Mar 20, 2025

This attempts to work out how we should document vehicle command uorb topics, and falls out of https://github.com/PX4/PX4-user_guide/issues/3649.

Historically these were internal, reflecting the "result" of a MAVLink command/message after converting to whatever frame is used to represent the command internally. Now though these are used in ROS, so they are part of the "Public API". We need to document them clearly in terms of units and conventions so they can be used.

My assertion is that every one of these needs units and a frame added. I've started with MAV_CMD_NAV_TAKEOFF and SET_GPS_GLOBAL_ORIGIN as these were mentioned in linked issue.

@MaEtUgR and/or @sfuhrer Questions inline. If we broadly agree this approach, I'll roll it out further/properly.

Copy link
Contributor Author

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sfuhrer Are you OK with merging this?

The convention you would be accepting is:

  • All must have pipes/placeholders for 7 items.
  • No whitespace before after pipes (|) within the table.
  • Anything |Empty| will become |Unused|
  • Capitalisation of first letter of each entry unless that doesn't make sense in context.
  • Capitalisation of the comment.
  • [m] used for units. [@range -pi, pi], [@invalid NAN]

If so I might do another PR to do all that general tidy stuff.

sfuhrer
sfuhrer previously approved these changes Apr 29, 2025
Copy link
Contributor

@sfuhrer sfuhrer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it yes.

@hamishwillee hamishwillee enabled auto-merge (squash) May 1, 2025 08:37
@hamishwillee hamishwillee merged commit 9cf3e83 into main May 1, 2025
65 of 67 checks passed
@hamishwillee hamishwillee deleted the pr_hamishwillee-vehicle_command_docs branch May 1, 2025 08:37
@hamishwillee
Copy link
Contributor Author

Thanks. I'll do a follow up PR to do the generic fixes next week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants