Skip to content

Conversation

hamishwillee
Copy link
Contributor

This fixes up the ActuatorServos UORB topic to match the evolving doc standard (for similar, see #24818, #24662 , #24789).

This particular version closely maps ActuatorMotors, which is being updated in #24818

Solution

  • Single space for comments etc
  • Sentence capitalize comments
  • Enum values after the field that uses them
  • Uses the following markup
    • [<value>] to mark units
    • [@enum <value>] to mark allowed values
    • [@range <minValue>,<maxValue>] to mark ranges - inclusive
    • [@invalid <value>] to mark the invalid/not-supplied value

Changelog Entry

For release notes:

Fix actuator_servos message definition

Other comments

See inline notes

@hamishwillee hamishwillee requested a review from MaEtUgR May 14, 2025 04:12
float32[8] control # range: [-1, 1], where 1 means maximum positive position,
# -1 maximum negative,
# and NaN maps to disarmed
float32[8] control # [@range -1, 1] Normalized output. 1 means maximum positive position. -1 maximum negative position (if not supported by the output, <0 maps to NaN). NaN maps to disarmed.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note, the bit " (if not supported by the output, <0 maps to NaN)" is NEW here - it comes from the ActuatorMotors. Is it also true for servos (if not I will remove)

@hamishwillee hamishwillee force-pushed the hamishwillee-uorb-ActuatorServos branch from 86e3d06 to bbe026d Compare June 12, 2025 01:37
@hamishwillee
Copy link
Contributor Author

Self merging. Docs only change that matches the standard. Failing tests unrelated.

@hamishwillee hamishwillee merged commit 3b35676 into main Jun 12, 2025
68 of 69 checks passed
@hamishwillee hamishwillee deleted the hamishwillee-uorb-ActuatorServos branch June 12, 2025 08:46
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.

1 participant