Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
thrust_attitude_control.hpp
1/****************************************************************************
2 *
3 * Copyright 2026 Auterion AG. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors
16 * may be used to endorse or promote products derived from this software without
17 * specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 ****************************************************************************/
32
33#pragma once
34
35#include <cmath>
36#include <optional>
37
38namespace auterion {
39namespace surface_vehicle {
79 private:
80 float _thrust{0.f};
81 std::optional<float> _heading_rad{};
82
83 public:
90 class Config {
91 public:
92 Config() = default;
93
98 Config& withMaxThrust(float max_thrust) {
99 _max_thrust = max_thrust;
100 return *this;
101 }
102
103 inline std::optional<float> getMaxThrust() const { return _max_thrust; }
104
105 private:
106 std::optional<float> _max_thrust{};
107 };
108
109 ThrustAttitudeSetpoint() = default;
110
117 ThrustAttitudeSetpoint(float thrust, float heading_rad)
118 : _thrust(thrust), _heading_rad(heading_rad) {}
119
125 _thrust = thrust;
126 return *this;
127 }
128
134 _heading_rad = heading_rad;
135 return *this;
136 }
137
138 inline float getThrust() const { return _thrust; }
139 inline std::optional<float> getHeading() const { return _heading_rad; }
140};
141
143} // namespace surface_vehicle
144} // namespace auterion
Mode-wide limits for ThrustAttitudeSetpoint.
Definition thrust_attitude_control.hpp:90
Config & withMaxThrust(float max_thrust)
Limits the absolute forward and reverse thrust [-], in [0, 1]. Unset means a limit of 1 (full thrust)...
Definition thrust_attitude_control.hpp:98
Drive with a given forward thrust while holding a heading.
Definition thrust_attitude_control.hpp:78
ThrustAttitudeSetpoint & withThrust(float thrust)
Sets the normalized thrust along the body x axis [-], in [-1, 1]. Negative drives in reverse.
Definition thrust_attitude_control.hpp:124
ThrustAttitudeSetpoint & withHeading(float heading_rad)
Sets the heading in the local ENU frame [rad]. 0 is East, positive is counter-clockwise.
Definition thrust_attitude_control.hpp:133
ThrustAttitudeSetpoint(float thrust, float heading_rad)
Definition thrust_attitude_control.hpp:117