PX4 ROS 2 Interface Library
Library to interface with PX4 from a companion computer using ROS 2
Loading...
Searching...
No Matches
px4_ros2::SurfaceVehicleCourseSetpointType Class Reference

Setpoint type for surface vehicle course control. More...

#include <px4_ros2/control/setpoint_types/experimental/surface_vehicle/course.hpp>

Inheritance diagram for px4_ros2::SurfaceVehicleCourseSetpointType:
px4_ros2::SetpointBase

Public Member Functions

 SurfaceVehicleCourseSetpointType (Context &context)
 
SetpointType getSetpointType () override
 
float desiredUpdateRateHz () override
 
void update (float course, std::optional< float > speed={}, std::optional< float > yaw={})
 Send a course setpoint to the flight controller.
 
- Public Member Functions inherited from px4_ros2::SetpointBase
 SetpointBase (Context &context)
 
std::shared_ptr< SetpointBase > getSharedPtr ()
 
virtual void clearOptionalRequirements (px4_msgs::msg::SetpointConfigReply &setpoint_config_reply)
 
void setShouldActivateCallback (const ShouldActivateCB &should_activate_cb)
 
void setActive (bool active)
 

Additional Inherited Members

- Public Types inherited from px4_ros2::SetpointBase
using ShouldActivateCB = std::function< void()>
 
using SetpointType = decltype(px4_msgs::msg::SetpointConfig::type)
 
- Protected Member Functions inherited from px4_ros2::SetpointBase
void onUpdate ()
 

Detailed Description

Setpoint type for surface vehicle course control.

Can be used for surface vehicles, i.e. rovers and boats. The vehicle tracks a course over ground. There is no desired track, so a sideways offset is not corrected. To follow a desired track, use SurfaceVehiclePositionSetpointType instead.

Member Function Documentation

◆ desiredUpdateRateHz()

float px4_ros2::SurfaceVehicleCourseSetpointType::desiredUpdateRateHz ( )
inlineoverridevirtual

Reimplemented from px4_ros2::SetpointBase.

◆ getSetpointType()

SetpointType px4_ros2::SurfaceVehicleCourseSetpointType::getSetpointType ( )
inlineoverridevirtual

Returns one of px4_msgs::msg::SetpointType::TYPE_*

Implements px4_ros2::SetpointBase.

◆ update()

void px4_ros2::SurfaceVehicleCourseSetpointType::update ( float  course,
std::optional< float >  speed = {},
std::optional< float >  yaw = {} 
)

Send a course setpoint to the flight controller.

Parameters
course[rad] Course over ground to hold in NED frame. Takes values in [-pi, pi].
speed[m/s] Cruising speed (Optional, defaults to maximum speed). A negative value drives the vehicle in reverse along the course. Takes values in [-inf, inf].
yaw[rad] Only for omnidirectional vehicles: vehicle yaw setpoint (in NED) while holding the course (Optional, currently unused by PX4). Takes values in [-pi, pi].

The documentation for this class was generated from the following file: