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_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 {
76 private:
77 float _speed_m_s{0.f};
78 std::optional<float> _heading_rad{};
79
80 public:
87 class Config {
88 public:
89 Config() = default;
90
95 Config& withMaxSpeed(float max_speed_m_s) {
96 _max_speed_m_s = max_speed_m_s;
97 return *this;
98 }
99
100 inline std::optional<float> getMaxSpeed() const { return _max_speed_m_s; }
101
102 private:
103 std::optional<float> _max_speed_m_s{};
104 };
105
106 SpeedAttitudeSetpoint() = default;
107
113 SpeedAttitudeSetpoint(float speed_m_s, float heading_rad)
114 : _speed_m_s(speed_m_s), _heading_rad(heading_rad) {}
115
120 _speed_m_s = speed_m_s;
121 return *this;
122 }
123
128 SpeedAttitudeSetpoint& withHeading(float heading_rad) {
129 _heading_rad = heading_rad;
130 return *this;
131 }
132
133 inline float getSpeed() const { return _speed_m_s; }
134 inline std::optional<float> getHeading() const { return _heading_rad; }
135};
136
138} // namespace surface_vehicle
139} // namespace auterion
Mode-wide limits for SpeedAttitudeSetpoint.
Definition speed_attitude_control.hpp:87
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_attitude_control.hpp:95
Drive at a given forward speed while holding a heading.
Definition speed_attitude_control.hpp:75
SpeedAttitudeSetpoint & withHeading(float heading_rad)
Sets the heading in the local ENU frame [rad]. 0 is East, positive is counter-clockwise.
Definition speed_attitude_control.hpp:128
SpeedAttitudeSetpoint & withSpeed(float speed_m_s)
Sets the speed along the body x axis [m/s]. Negative drives in reverse.
Definition speed_attitude_control.hpp:119
SpeedAttitudeSetpoint(float speed_m_s, float heading_rad)
Definition speed_attitude_control.hpp:113