Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gimbal v2 - note that FLAGS_YAW_LOCK is still valid #532

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
6 changes: 4 additions & 2 deletions en/services/gimbal_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,10 @@ The [GIMBAL_DEVICE_ATTITUDE_STATUS.flags](#GIMBAL_DEVICE_ATTITUDE_STATUS) field
For older devices, if neither of the flags above are set, the yaw frame must be inferred from the `GIMBAL_DEVICE_FLAGS_YAW_LOCK`.
If it is set, the yaw is relative to North, otherwise to the front of the vehicle.

> **Note** Manufacturers working on new gimbal devices should set either `GIMBAL_DEVICE_FLAGS_YAW_IN_VEHICLE_FRAME` or `GIMBAL_DEVICE_FLAGS_YAW_IN_EARTH_FRAME`.
> Components recieving the message should also handle `GIMBAL_DEVICE_FLAGS_YAW_LOCK` for backwards compatibility with older devices.
Manufacturers working on new gimbal devices should use either `GIMBAL_DEVICE_FLAGS_YAW_IN_VEHICLE_FRAME` or `GIMBAL_DEVICE_FLAGS_YAW_IN_EARTH_FRAME` in `GIMBAL_DEVICE_ATTITUDE_STATUS` to report the yaw frame.
Components recieving the message should also handle `GIMBAL_DEVICE_FLAGS_YAW_LOCK` for backwards compatibility with older devices.

> **Note** `GIMBAL_DEVICE_FLAGS_YAW_LOCK` must still be used when _setting_ an attitude target (in [GIMBAL_DEVICE_SET_ATTITUDE.flags](#GIMBAL_DEVICE_SET_ATTITUDE)), in order to specify that the target angles are relative to North.

Choose a reason for hiding this comment

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

In addition to GIMBAL_DEVICE_SET_ATTITUDE, it should also be used in the MAV_CMD_DO_GIMBAL_MANAGER_PITCHYAW and GIMBAL_MANAGER_SET_PITCHYAW.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks @rmackay9 , but those use GIMBAL_MANAGER_FLAGS flags (same same name, but not the same thing)

Copy link

@rmackay9 rmackay9 Mar 20, 2024

Choose a reason for hiding this comment

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

ok. To be a bit nitpicky, it's not "target angles are relative to North", it is just "target yaw is relative to North". Target roll and pitch are always relative to the horizon I think.

EDIT: actually I guess we're just talking about set-attitude which always uses Quaternions..

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Be as nit picky as you can. This correct?

Suggested change
> **Note** `GIMBAL_DEVICE_FLAGS_YAW_LOCK` must still be used when _setting_ an attitude target (in [GIMBAL_DEVICE_SET_ATTITUDE.flags](#GIMBAL_DEVICE_SET_ATTITUDE)), in order to specify that the target angles are relative to North.
> **Note** `GIMBAL_DEVICE_FLAGS_YAW_LOCK` must still be used when _setting_ an attitude target (in [GIMBAL_DEVICE_SET_ATTITUDE.flags](#GIMBAL_DEVICE_SET_ATTITUDE)), in order to specify that the target yaw is relative to North.

Copy link
Contributor

Choose a reason for hiding this comment

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

It applies to pitch/yaw as well as the quaternion.

Copy link
Member

@Davidsastresas Davidsastresas Mar 20, 2024

Choose a reason for hiding this comment

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

Indeed. Maybe we should explicitly indicate this, somebody integrating a new gimbal in development, if not super familiarized with quaternions, could see really weird values on the angles and could not realize it is because of these flags being wrong.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Add a github suggestion.


## Message/Command/Enum Summary

Expand Down