Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
speed_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 {
75 private:
76 float _speed_m_s{0.f};
77 float _heading_rate_rad_s{0.f};
78
79 public:
86 class Config {
87 public:
88 Config() = default;
89
94 Config& withMaxSpeed(float max_speed_m_s) {
95 _max_speed_m_s = max_speed_m_s;
96 return *this;
97 }
98
103 Config& withMaxHeadingRate(float max_heading_rate_rad_s) {
104 _max_heading_rate_rad_s = max_heading_rate_rad_s;
105 return *this;
106 }
107
108 inline std::optional<float> getMaxSpeed() const { return _max_speed_m_s; }
109 inline std::optional<float> getMaxHeadingRate() const { return _max_heading_rate_rad_s; }
110
111 private:
112 std::optional<float> _max_speed_m_s{};
113 std::optional<float> _max_heading_rate_rad_s{};
114 };
115
116 SpeedRateSetpoint() = default;
117
122 SpeedRateSetpoint(float speed_m_s, float heading_rate_rad_s)
123 : _speed_m_s(speed_m_s), _heading_rate_rad_s(heading_rate_rad_s) {}
124
128 SpeedRateSetpoint& withSpeed(float speed_m_s) {
129 _speed_m_s = speed_m_s;
130 return *this;
131 }
132
136 SpeedRateSetpoint& withHeadingRate(float heading_rate_rad_s) {
137 _heading_rate_rad_s = heading_rate_rad_s;
138 return *this;
139 }
140
141 inline float getSpeed() const { return _speed_m_s; }
142 inline float getHeadingRate() const { return _heading_rate_rad_s; }
143};
144
146} // namespace surface_vehicle
147} // namespace auterion
Mode-wide limits for SpeedRateSetpoint.
Definition speed_rate_control.hpp:86
Config & withMaxSpeed(float max_speed_m_s)
Limits the absolute forward and reverse speed [m/s]. Unset means no limit beyond the flight controlle...
Definition speed_rate_control.hpp:94
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 speed_rate_control.hpp:103
Drive at a given forward speed while turning at a given rate.
Definition speed_rate_control.hpp:74
SpeedRateSetpoint & withHeadingRate(float heading_rate_rad_s)
Sets the yaw rate [rad/s]. Positive turns left (counter-clockwise seen from above).
Definition speed_rate_control.hpp:136
SpeedRateSetpoint & withSpeed(float speed_m_s)
Sets the speed along the body x axis [m/s]. Negative drives in reverse.
Definition speed_rate_control.hpp:128
SpeedRateSetpoint(float speed_m_s, float heading_rate_rad_s)
Definition speed_rate_control.hpp:122