Skip to main content

pamoja_mavlink_offboard_local_velocity

pamoja_ffi::mavlink_protocol

Function pamoja_mavlink_offboard_local_velocity 

Source 
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_mavlink_offboard_local_velocity(
    header: PamojaMavlinkHeader,
    time_boot_ms: u32,
    coordinate_frame: u8,
    target_system: u8,
    target_component: u8,
    vx: f32,
    vy: f32,
    vz: f32,
    out_frame: *mut *mut PamojaMavlinkFrame,
) -> PamojaStatus
Expand description

Builds a local-frame velocity setpoint frame.

§Arguments

  • header - the addressing fields to stamp on the frame.
  • time_boot_ms - the sender’s boot timestamp, in milliseconds.
  • coordinate_frame - the MAV_FRAME of the setpoint.
  • target_system - the target system id.
  • target_component - the target component id.
  • vx, vy, vz - the velocity, in metres per second in the chosen frame.
  • out_frame - set to the SET_POSITION_TARGET_LOCAL_NED frame, which the caller releases with pamoja_mavlink_frame_free.

§Returns

PamojaStatus::Ok on success.

§Errors

Returns PamojaStatus::InvalidArgument if out_frame is null.

§Safety

out_frame must point at writable storage for one pointer.