Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
Surface Vehicle

Setpoint types for surface vehicles such as boats. More...

Classes

class  auterion::surface_vehicle::GlobalFramePositionSetpoint
 Drive to a position given as latitude and longitude. More...
 
class  auterion::surface_vehicle::LocalFramePositionSetpoint
 Drive to a 2D position in the local frame. More...
 
class  auterion::surface_vehicle::SpeedAttitudeSetpoint
 Drive at a given forward speed while holding a heading. More...
 
class  auterion::surface_vehicle::SpeedRateSetpoint
 Drive at a given forward speed while turning at a given rate. More...
 
class  auterion::surface_vehicle::ThrustAttitudeSetpoint
 Drive with a given forward thrust while holding a heading. More...
 
class  auterion::surface_vehicle::ThrustRateSetpoint
 Drive with a given forward thrust while turning at a given rate. More...
 

Detailed Description

Setpoint types for surface vehicles such as boats.

The following levels of control are available, from highest to lowest:

Setpoint type You send The flight controller handles
auterion::surface_vehicle::LocalFramePositionSetpoint Target position in the local frame (optional start position, speeds) Path tracking, speed, heading, stopping
auterion::surface_vehicle::GlobalFramePositionSetpoint Target latitude/longitude (optional start position, speeds) Path tracking, speed, heading, stopping
auterion::surface_vehicle::SpeedAttitudeSetpoint Forward speed and heading Speed and heading control
auterion::surface_vehicle::SpeedRateSetpoint Forward speed and heading rate Speed and turn rate control
auterion::surface_vehicle::ThrustAttitudeSetpoint Normalized forward thrust and heading Heading control
auterion::surface_vehicle::ThrustRateSetpoint Normalized forward thrust and heading rate Turn rate control

All setpoint types use the SDK conventions: positions in the local ENU frame, headings in ENU (0 is East, positive is counter-clockwise), and heading rates positive when turning left. Thrust is normalized to [-1, 1], negative values drive in reverse. The SDK converts them to the frames that PX4 uses.

A mode can list more than one of these setpoint types and switch between them in auterion::Mode::onUpdateSetpoint.

Note
The setpoints are sent on the surface_vehicle_* uORB topics. The flight controller must run a PX4 build that includes them (Auterion/PX4_firmware_private#3827 or later), and the vehicle must be configured as a surface vehicle. The SDK must be built against a px4_ros2_cpp that provides the surface_vehicle_* setpoint types; with an older one, creating a mode that uses these setpoints throws std::runtime_error, while all other vehicle types are unaffected.