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_rate_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 {
77 private:
78 float _thrust{0.f};
79 float _heading_rate_rad_s{0.f};
80
81 public:
88 class Config {
89 public:
90 Config() = default;
91
96 Config& withMaxThrust(float max_thrust) {
97 _max_thrust = max_thrust;
98 return *this;
99 }
100
105 Config& withMaxHeadingRate(float max_heading_rate_rad_s) {
106 _max_heading_rate_rad_s = max_heading_rate_rad_s;
107 return *this;
108 }
109
110 inline std::optional<float> getMaxThrust() const { return _max_thrust; }
111 inline std::optional<float> getMaxHeadingRate() const { return _max_heading_rate_rad_s; }
112
113 private:
114 std::optional<float> _max_thrust{};
115 std::optional<float> _max_heading_rate_rad_s{};
116 };
117
118 ThrustRateSetpoint() = default;
119
125 ThrustRateSetpoint(float thrust, float heading_rate_rad_s)
126 : _thrust(thrust), _heading_rate_rad_s(heading_rate_rad_s) {}
127
133 _thrust = thrust;
134 return *this;
135 }
136
140 ThrustRateSetpoint& withHeadingRate(float heading_rate_rad_s) {
141 _heading_rate_rad_s = heading_rate_rad_s;
142 return *this;
143 }
144
145 inline float getThrust() const { return _thrust; }
146 inline float getHeadingRate() const { return _heading_rate_rad_s; }
147};
148
150} // namespace surface_vehicle
151} // namespace auterion
Mode-wide limits for ThrustRateSetpoint.
Definition thrust_rate_control.hpp:88
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_rate_control.hpp:96
Config & withMaxHeadingRate(float max_heading_rate_rad_s)
Limits the absolute heading rate [rad/s]. Unset means no limit beyond the flight controller's.
Definition thrust_rate_control.hpp:105
Drive with a given forward thrust while turning at a given rate.
Definition thrust_rate_control.hpp:76
ThrustRateSetpoint(float thrust, float heading_rate_rad_s)
Definition thrust_rate_control.hpp:125
ThrustRateSetpoint & withHeadingRate(float heading_rate_rad_s)
Sets the yaw rate [rad/s]. Positive turns left (counter-clockwise seen from above).
Definition thrust_rate_control.hpp:140
ThrustRateSetpoint & withThrust(float thrust)
Sets the normalized thrust along the body x axis [-], in [-1, 1]. Negative drives in reverse.
Definition thrust_rate_control.hpp:132