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.md: Add clarification about gimbal yaw frame #531

Merged
merged 3 commits into from
Mar 15, 2024
Merged
Changes from 2 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
13 changes: 13 additions & 0 deletions en/services/gimbal_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,19 @@ This signals that the gimbal manager also is also acting as the gimbal device.

Also see [how to address non-MAVLink gimbal devices](#non_mavlink_gimbal_device_addressing).

#### How to interpret `GIMBAL_DEVICE_ATTITUDE_STATUS` yaw gimbal angle

The [GIMBAL_DEVICE_ATTITUDE_STATUS.flags](#GIMBAL_DEVICE_ATTITUDE_STATUS) field must report the frame used for reported yaw values as **either**:

- `GIMBAL_DEVICE_FLAGS_YAW_IN_VEHICLE_FRAME`: Yaw is relative to vehicle.
- `GIMBAL_DEVICE_FLAGS_YAW_IN_EARTH_FRAME`: Yaw is relative to north.

Older devices may use the deprecated `GIMBAL_DEVICE_FLAGS_YAW_LOCK` to indicate that the yaw is relative to north, and un-set to indicate that yaw is relative to the vehicle.
This should only be checked if the two flags above are not set!
hamishwillee marked this conversation as resolved.
Show resolved Hide resolved

> **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.

## Message/Command/Enum Summary

### Gimbal Manager Messages
Expand Down