|
Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
|
Drive to a 2D position in the local frame. More...
#include <auterion_sdk/control/surface_vehicle/local_frame_position_control.hpp>
Classes | |
| class | Config |
| Mode-wide defaults for LocalFramePositionSetpoint. More... | |
Public Member Functions | |
| LocalFramePositionSetpoint (const Eigen::Vector2f &position_en_m) | |
| LocalFramePositionSetpoint & | withPosition (const Eigen::Vector2f &position_en_m) |
| Sets the target position (East, North) in the local frame [m]. | |
| LocalFramePositionSetpoint & | withPosition (const Eigen::Vector3f &position_enu_m) |
| Sets the target position from a 3D local ENU position [m]. The height (z) is ignored, so you can pass auterion::LocalPosition::position_enu_m directly. | |
| LocalFramePositionSetpoint & | withStartPosition (const Eigen::Vector2f &start_position_en_m) |
| Sets the start of the line that the vehicle follows to the target (East, North) [m]. | |
| Eigen::Vector2f | getPosition () const |
| std::optional< Eigen::Vector2f > | getStartPosition () const |
Public Member Functions inherited from auterion::surface_vehicle::detail::PositionSetpointSpeedsBase< LocalFramePositionSetpoint > | |
| LocalFramePositionSetpoint & | withCruisingSpeed (float cruising_speed_m_s) |
| Sets the speed to drive at on the way to the target [m/s]. | |
| LocalFramePositionSetpoint & | withArrivalSpeed (float arrival_speed_m_s) |
| Sets the speed the vehicle has when it reaches the target [m/s]. | |
| std::optional< float > | getCruisingSpeed () const |
| std::optional< float > | getArrivalSpeed () const |
Drive to a 2D position in the local frame.
The vehicle turns towards the target and drives a straight line to it. The flight controller handles path tracking, speed and stopping. This is the easiest way to make a boat go somewhere. For targets given as latitude and longitude, use GlobalFramePositionSetpoint.
Frames and units:
Defaults:
The target position is required. Returning a setpoint without a finite target position from auterion::Mode::onUpdateSetpoint throws std::invalid_argument.
Example:
|
inlineexplicit |
| position_en_m | Target position (East, North) in the local frame [m]. |
|
inline |
Sets the start of the line that the vehicle follows to the target (East, North) [m].
Use this to follow an exact track, e.g. a survey line, instead of the line from the current position. If not set, the line starts at the vehicle's current position.